whitelabels_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.whitelabels_api module

class edgeimpulse_api.api.whitelabels_api.WhitelabelsApi(api_client=None)

Bases: object

create_whitelabel(create_whitelabel_request: CreateWhitelabelRequest, **kwargs)

Create a new white label

Create a new white label

  • Parameters

    • create_whitelabel_request (CreateWhitelabelRequest) – (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

delete_whitelabel(whitelabel_identifier: StrictInt, **kwargs)

Deletes a white label

Deletes the white label with the given id.

  • Parameters

    • whitelabel_identifier (int) – Whitelabel ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_all_impulse_blocks(whitelabel_identifier: StrictInt, **kwargs)

Get impulse blocks

Lists all possible DSP and ML blocks available for this white label.

  • Parameters

    • whitelabel_identifier (int) – Whitelabel ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_all_whitelabels(**kwargs)

List the registered white labels

Retrieve the list of registered white labels.

  • Parameters

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_whitelabel(whitelabel_identifier: StrictInt, **kwargs)

White label information

Retrieve all the information about this white label.

  • Parameters

    • whitelabel_identifier (int) – Whitelabel ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_whitelabel_domain(whitelabel_identifier: StrictInt, **kwargs)

Get white label domain

Get a white label domain given its unique identifier.

  • Parameters

    • whitelabel_identifier (int) – Whitelabel ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

update_deployment_targets(whitelabel_identifier: StrictInt, update_whitelabel_deployment_targets_request: UpdateWhitelabelDeploymentTargetsRequest, **kwargs)

Update deployment targets

Update some or all of the deployment targets enabled for this white label.

  • Parameters

    • whitelabel_identifier (int) – Whitelabel ID (required)

    • update_whitelabel_deployment_targets_request (UpdateWhitelabelDeploymentTargetsRequest) – (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

Last updated

Was this helpful?