organization_requires_whitelabel_admin_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_requires_whitelabel_admin_api module

class edgeimpulse_api.api.organization_requires_whitelabel_admin_api.OrganizationRequiresWhitelabelAdminApi(api_client=None)

Bases: object

whitelabel_admin_create_organization(organization_id: StrictInt, whitelabel_admin_create_organization_request: WhitelabelAdminCreateOrganizationRequest, **kwargs)

Create new organization within white label context

Create a new organization. This is an internal API only available to white label admins

• Parameters

  • organization_id (int) – Organization ID (required)

  • whitelabel_admin_create_organization_request (WhitelabelAdminCreateOrganizationRequest) – (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.

• Return type

  CreateOrganizationResponse

whitelabel_admin_get_metrics(organization_id: StrictInt, **kwargs)

Get global white label metrics

White label admin only API to get global metrics.

• Parameters

  • organization_id (int) – Organization 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.

• Return type

  AdminGetMetricsResponse

whitelabel_admin_get_organization_info(organization_id: StrictInt, inner_organization_id: StrictInt, **kwargs)

Get organization information

White label admin only API to list all information about an organization.

• Parameters

  • organization_id (int) – Organization ID (required)

  • inner_organization_id (int) – Organization ID within the context of a white label (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.

• Return type

  AdminOrganizationInfoResponse

whitelabel_admin_get_organizations(organization_id: StrictInt, active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)

Get all organizations within a white label

White label admin only API to get the list of all organizations.

• Parameters

  • organization_id (int) – Organization ID (required)

  • active (int) – Whether to search for entities (users, orgs) active in the last X days

  • sort (str) – Fields and order to sort query by

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • search (str) – Search query

  • 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.

• Return type

  AdminGetOrganizationsResponse

whitelabel_admin_get_project(organization_id: StrictInt, project_id: StrictInt, **kwargs)

Get a white label project

White label admin only API to get project information.

• Parameters

  • organization_id (int) – Organization ID (required)

  • project_id (int) – Project 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.

• Return type

  ProjectInfoResponse

whitelabel_admin_get_projects(organization_id: StrictInt, active: Optional[StrictInt] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)

Get all white label projects

White label admin only API to get the list of all projects.

• Parameters

  • organization_id (int) – Organization ID (required)

  • active (int) – Whether to search for entities (users, orgs) active in the last X days

  • sort (str) – Fields and order to sort query by

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • search (str) – Search query

  • 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.

• Return type

  AdminListProjectsResponse

whitelabel_admin_get_user(organization_id: StrictInt, user_id: StrictInt, **kwargs)

Get a white label user

White label admin only API to get information about a user.

• Parameters

  • organization_id (int) – Organization ID (required)

  • user_id (int) – User 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.

• Return type

  AdminGetUserResponse

whitelabel_admin_get_user_metrics(organization_id: StrictInt, user_id: StrictInt, **kwargs)

Get white label user metrics

White label admin only API to get marketing metrics about a user.

• Parameters

  • organization_id (int) – Organization ID (required)

  • user_id (int) – User 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.

• Return type

  AdminGetUserMetricsResponse

whitelabel_admin_get_users(organization_id: StrictInt, active: Optional[StrictInt] = None, tier: Optional[StrictStr] = None, fields: Optional[StrictStr] = None, sort: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, search: Optional[StrictStr] = None, **kwargs)

Get all white label users

White label admin only API to get the list of all registered users.

• Parameters

  • organization_id (int) – Organization ID (required)

  • active (int) – Whether to search for entities (users, orgs) active in the last X days

  • tier (str) – Whether to search for free, pro or enterprise entities (users, projects)

  • fields (str) – Comma separated list of fields to fetch in a query

  • sort (str) – Fields and order to sort query by

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • search (str) – Search query

  • 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.

• Return type

  AdminGetUsersResponse

whitelabel_admin_update_organization(organization_id: StrictInt, inner_organization_id: StrictInt, admin_update_organization_request: AdminUpdateOrganizationRequest, **kwargs)

Update organization

White label admin only API to update organization properties such as name and logo.

• Parameters

  • organization_id (int) – Organization ID (required)

  • inner_organization_id (int) – Organization ID within the context of a white label (required)

  • admin_update_organization_request (AdminUpdateOrganizationRequest) – (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.

• Return type

  GenericApiResponse

whitelabel_admin_update_project(organization_id: StrictInt, project_id: StrictInt, update_project_request: UpdateProjectRequest, **kwargs)

Update white label project

White label admin only API to update project properties.

• Parameters

  • organization_id (int) – Organization ID (required)

  • project_id (int) – Project ID (required)

  • update_project_request (UpdateProjectRequest) – (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.

• Return type

  GenericApiResponse

whitelabel_admin_update_user(organization_id: StrictInt, user_id: StrictInt, admin_update_user_request: AdminUpdateUserRequest, **kwargs)

Update white label user

White label admin only API to update user properties.

• Parameters

  • organization_id (int) – Organization ID (required)

  • user_id (int) – User ID (required)

  • admin_update_user_request (AdminUpdateUserRequest) – (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.

• Return type

  GenericApiResponse