AccessApi

class optimeering_beta.AccessApi(api_client=None)

Collection of methods to interact with AccessApi

create_api_key(access_post_key, _request_timeout=None)

Post Access

Creates a new access key. Guide on Authentication: https://docs.optimeering.com/getting-started/auth/

Parameters:

access_post_key (AccessPostKey) – (required)

Returns:

Returns the result object.

Return type:

AccessKeyPostResponse

Example:

>>> from optimeering_beta import Configuration, OptimeeringClient
>>> configuration = Configuration(host="https://beta.optimeering.com")
>>> client = OptimeeringClient(configuration=configuration)
>>> # Post data point - replace ... with correct dataformat documented above
>>> response = client.access_api.create_api_key(...)

delete_key(id, _request_timeout=None)

Drop Key

Deletes an api key by its id.

Parameters:

id (int) – (required)

Returns:

Returns the result object.

Return type:

bool

Example:

>>> from optimeering_beta import Configuration, OptimeeringClient
>>> configuration = Configuration(host="https://beta.optimeering.com")
>>> client = OptimeeringClient(configuration=configuration)
>>> # Post data point - replace ... with correct dataformat documented above
>>> response = client.access_api.delete_key(...)

list_my_keys(_request_timeout=None)

List Keys

Lists all the created keys.

Returns:

Returns the result object.

Return type:

List[AccessKeyCreated]

Example:

>>> from optimeering_beta import Configuration, OptimeeringClient
>>> configuration = Configuration(host="https://beta.optimeering.com")
>>> client = OptimeeringClient(configuration=configuration)
>>> # Get filtered data point - replace ... with appropriate filters documented above
>>> response = client.access_api.list_my_keys(...)