10.4.1. Abstract Base Class for all API Clients¶

class pytan3.api_clients.ApiClient[source]¶

Abstract base class for all ApiClients.

classmethod get_name()[source]¶

Get the ref name of this class for use by load().

Returns:	`str`

classmethod get_type()[source]¶

Get the ref type of this class for use by load_type().

Returns:	`str`

classmethod get_version_req()[source]¶

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:	`dict`

auth_method¶

Get the AuthMethod for this object.

Returns:	`pytan3.auth_methods.AuthMethod`

http_client¶

Get the HTTP Client for this object.

Returns:	`pytan3.http_client.HttpClient`

url¶

Get the URL from ApiClient.http_client.

Returns:	`str`

version¶

Get the platform version from ApiClient.config.

Returns:	`str`

config¶

Get the deserialized config.json from ApiClient.url.

Returns:	`dict`

info¶

Get the deserialized info.json from ApiClient.url.

Returns:	`dict`