organizations_api module#

class edgeimpulse_api.api.organizations_api.OrganizationsApi(api_client=None)[source]#

Bases: object

add_organization_api_key(

organization_id: StrictInt[StrictInt],

add_organization_api_key_request: AddOrganizationApiKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

Add API key

Add an API key.

Parameters:

organization_id (int) – Organization ID (required)
add_organization_api_key_request (AddOrganizationApiKeyRequest) – (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

add_organization_member(

organization_id: StrictInt[StrictInt],

add_member_request: AddMemberRequest,

**kwargs,

) → GenericApiResponse[source]#

Add member

Add a member to an organization.

Parameters:

organization_id (int) – Organization ID (required)
add_member_request (AddMemberRequest) – (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

create_organization(

create_organization_request: CreateOrganizationRequest,

**kwargs,

) → CreateOrganizationResponse[source]#

Create new organization

Create a new organization. This is an internal API.

Parameters:

create_organization_request (CreateOrganizationRequest) – (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

delete_organization(

organization_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Remove organization

Remove the current organization, and all data associated with it. This is irrevocable!

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:

GenericApiResponse

download_organization_data_export(

organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → None[source]#

Download organization data export

Download a data export for an organization.

Parameters:

organization_id (int) – Organization ID (required)
export_id (int) – Export 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:

None

get_organization_data_export(

organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationDataExportResponse[source]#

Get organization data export

Get a data export for an organization.

Parameters:

organization_id (int) – Organization ID (required)
export_id (int) – Export 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:

GetOrganizationDataExportResponse

get_organization_data_exports(

organization_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetOrganizationDataExportsResponse[source]#

Get all organization data exports

Get all data exports for an organization.

Parameters:

organization_id (int) – Organization ID (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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:

GetOrganizationDataExportsResponse

get_organization_info(

organization_id: StrictInt[StrictInt],

**kwargs,

) → OrganizationInfoResponse[source]#

Organization information

List all information about this organization.

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:

OrganizationInfoResponse

get_organization_metrics(

organization_id: StrictInt[StrictInt],

exclude_edge_impulse_users: StrictBool | None[StrictBool | None] = None,

project_visibility: ProjectVisibility | None[ProjectVisibility | None] = None,

**kwargs,

) → OrganizationMetricsResponse[source]#

Organization metrics

Get general metrics for this organization.

Parameters:

organization_id (int) – Organization ID (required)
exclude_edge_impulse_users (bool) – Whether to exclude Edge Impulse users when counting enterprise entitlements usage
project_visibility (ProjectVisibility) – What project visibility type to include when counting enterprise entitlements usage
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:

OrganizationMetricsResponse

invite_organization_member(

organization_id: StrictInt[StrictInt],

invite_organization_member_request: InviteOrganizationMemberRequest,

**kwargs,

) → GenericApiResponse[source]#

Invite member

Invite a member to an organization.

Parameters:

organization_id (int) – Organization ID (required)
invite_organization_member_request (InviteOrganizationMemberRequest) – (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

list_organization_api_keys(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationApiKeysResponse[source]#

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

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:

ListOrganizationApiKeysResponse

list_organization_projects(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListProjectsResponse[source]#

Get projects

Retrieve all projects for the organization.

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:

ListProjectsResponse

list_organizations(

**kwargs,

) → ListOrganizationsResponse[source]#

List active organizations

Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.

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.

Return type:

ListOrganizationsResponse

remove_organization_member(

organization_id: StrictInt[StrictInt],

remove_member_request: RemoveMemberRequest,

**kwargs,

) → GenericApiResponse[source]#

Remove member

Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.

Parameters:

organization_id (int) – Organization ID (required)
remove_member_request (RemoveMemberRequest) – (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

request_enterprise_trial_extension(

organization_id: StrictInt[StrictInt],

enterprise_upgrade_or_trial_extension_request: EnterpriseUpgradeOrTrialExtensionRequest,

**kwargs,

) → GenericApiResponse[source]#

Request trial extension

Request an extension for an enterprise trial.

Parameters:

organization_id (int) – Organization ID (required)
enterprise_upgrade_or_trial_extension_request (EnterpriseUpgradeOrTrialExtensionRequest) – (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

resend_organization_member_invite(

organization_id: StrictInt[StrictInt],

member_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Resend invitation

Resend an invitation to a member in an organization.

Parameters:

organization_id (int) – Organization ID (required)
member_id (int) – Member 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:

GenericApiResponse

revoke_organization_api_key(

organization_id: StrictInt[StrictInt],

api_key_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Revoke API key

Revoke an API key.

Parameters:

organization_id (int) – Organization ID (required)
api_key_id (int) – API key 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:

GenericApiResponse

set_organization_member_datasets(

organization_id: StrictInt[StrictInt],

member_id: StrictInt[StrictInt],

set_member_datasets_request: SetMemberDatasetsRequest,

**kwargs,

) → GenericApiResponse[source]#

Set member datasets

Set the datasets a guest member has access to in an organization.

Parameters:

organization_id (int) – Organization ID (required)
member_id (int) – Member ID (required)
set_member_datasets_request (SetMemberDatasetsRequest) – (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

set_organization_member_role(

organization_id: StrictInt[StrictInt],

member_id: StrictInt[StrictInt],

set_member_role_request: SetMemberRoleRequest,

**kwargs,

) → GenericApiResponse[source]#

Set member role

Change the role of a member in an organization.

Parameters:

organization_id (int) – Organization ID (required)
member_id (int) – Member ID (required)
set_member_role_request (SetMemberRoleRequest) – (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

test_organization_admin(

organization_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Admin endpoint

Test endpoint that can only be reached with admin rights.

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:

GenericApiResponse

update_organization(

organization_id: StrictInt[StrictInt],

update_organization_request: UpdateOrganizationRequest,

**kwargs,

) → GenericApiResponse[source]#

Update organization

Update organization properties such as name and logo.

Parameters:

organization_id (int) – Organization ID (required)
update_organization_request (UpdateOrganizationRequest) – (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

upload_organization_header(

organization_id: StrictInt[StrictInt],

image: StrictStr | None = None,

**kwargs,

) → UploadAssetResponse[source]#

Upload organization header image

Uploads and updates the organization header image

Parameters:

organization_id (int) – Organization ID (required)
image (str) –
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:

UploadAssetResponse

upload_organization_logo(

organization_id: StrictInt[StrictInt],

image: StrictStr | None = None,

**kwargs,

) → UploadAssetResponse[source]#

Upload organization logo

Uploads and updates the organization logo

Parameters:

organization_id (int) – Organization ID (required)
image (str) –
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:

UploadAssetResponse

upload_organization_readme_image(

organization_id: StrictInt[StrictInt],

image: StrictStr,

**kwargs,

) → UploadReadmeImageResponse[source]#

Upload image for readme

Uploads an image to the user CDN and returns the path.

Parameters:

organization_id (int) – Organization ID (required)
image (str) – (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:

UploadReadmeImageResponse

whitelabel_admin_add_development_board(

organization_id: StrictInt[StrictInt],

development_board_request: DevelopmentBoardRequest | None = None,

**kwargs,

) → DevelopmentBoardCreatedResponse[source]#

White Label Admin - Add a development board to a whitelabel

White label admin only API to add a development board.

Parameters:

organization_id (int) – Organization ID (required)
development_board_request (DevelopmentBoardRequest) –
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:

DevelopmentBoardCreatedResponse

whitelabel_admin_add_organization_api_key(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

admin_add_organization_api_key_request: AdminAddOrganizationApiKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Add organization API key

White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
admin_add_organization_api_key_request (AdminAddOrganizationApiKeyRequest) – (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_add_project_api_key(

organization_id: StrictInt[StrictInt],

project_id: StrictInt[StrictInt],

admin_add_project_api_key_request: AdminAddProjectApiKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Add Project API key

White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.

Parameters:

organization_id (int) – Organization ID (required)
project_id (int) – Project ID (required)
admin_add_project_api_key_request (AdminAddProjectApiKeyRequest) – (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_add_user_to_organization(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

admin_add_organization_user_request: AdminAddOrganizationUserRequest | None = None,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Add user to an organization

White label admin only API to add a user to an organization. If no user is provided, the current user is used.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
admin_add_organization_user_request (AdminAddOrganizationUserRequest) –
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_add_user_to_project(

organization_id: StrictInt[StrictInt],

project_id: StrictInt[StrictInt],

admin_add_project_user_request: AdminAddProjectUserRequest | None = None,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Add user to a project

White label admin only API to add a user to a project. If no user is provided, the current user is used.

Parameters:

organization_id (int) – Organization ID (required)
project_id (int) – Project ID (required)
admin_add_project_user_request (AdminAddProjectUserRequest) –
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_create_organization(

organization_id: StrictInt[StrictInt],

whitelabel_admin_create_organization_request: WhitelabelAdminCreateOrganizationRequest,

**kwargs,

) → CreateOrganizationResponse[source]#

White Label Admin - Create new organization within white label context

Create a new organization. This is an 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_create_organization_export(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

admin_create_organization_data_export_request: AdminCreateOrganizationDataExportRequest,

**kwargs,

) → StartJobResponse[source]#

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
admin_create_organization_data_export_request (AdminCreateOrganizationDataExportRequest) – (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:

StartJobResponse

whitelabel_admin_create_organization_project(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

admin_create_project_request: AdminCreateProjectRequest,

**kwargs,

) → CreateProjectResponse[source]#

White Label Admin - Create a new organization project

White label admin only API to create a new project for an organization.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
admin_create_project_request (AdminCreateProjectRequest) – (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:

CreateProjectResponse

whitelabel_admin_create_organization_usage_report(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

start_date: datetime[datetime],

end_date: datetime[datetime],

**kwargs,

) → StartJobResponse[source]#

White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
start_date (datetime) – Start date (required)
end_date (datetime) – End date (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:

StartJobResponse

whitelabel_admin_create_project(

organization_id: StrictInt[StrictInt],

admin_create_project_request: AdminCreateProjectRequest,

**kwargs,

) → CreateProjectResponse[source]#

White Label Admin - Create a new project within white label context.

Create a new free tier project. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
admin_create_project_request (AdminCreateProjectRequest) – (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:

CreateProjectResponse

whitelabel_admin_delete_organization(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Delete an organization

White label admin only API to delete 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:

GenericApiResponse

whitelabel_admin_delete_organization_export(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Delete organization data export

Delete a data export for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
export_id (int) – Export 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:

GenericApiResponse

whitelabel_admin_delete_organization_usage_report(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Delete usage report

Delete a usage report for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
usage_report_id (int) – Usage report 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:

GenericApiResponse

whitelabel_admin_delete_project(

organization_id: StrictInt[StrictInt],

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Delete a project

White label admin only API to delete a project.

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:

GenericApiResponse

whitelabel_admin_delete_user(

organization_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete a user

White label admin only API to delete 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:

GenericApiResponse

whitelabel_admin_download_organization_usage_report(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → None[source]#

White Label Admin - Download usage report

Download a usage report for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
usage_report_id (int) – Usage report 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:

None

whitelabel_admin_get_info(

organization_id: StrictInt[StrictInt],

**kwargs,

) → GetWhitelabelResponse[source]#

White Label Admin - Get white label information

White label admin only API to get the white label information.

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:

GetWhitelabelResponse

whitelabel_admin_get_metrics(

organization_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetMetricsResponse[source]#

White Label Admin - 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_compute_time_usage(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

start_date: datetime[datetime],

end_date: datetime[datetime],

**kwargs,

) → AdminGetOrganizationComputeTimeUsageResponse[source]#

White Label Admin - Get organization compute time usage

Get compute time usage for an organization over a period of time. This is an API only available to white label admins

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
start_date (datetime) – Start date (required)
end_date (datetime) – End date (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:

AdminGetOrganizationComputeTimeUsageResponse

whitelabel_admin_get_organization_export(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationDataExportResponse[source]#

White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
export_id (int) – Export 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:

GetOrganizationDataExportResponse

whitelabel_admin_get_organization_exports(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → GetOrganizationDataExportsResponse[source]#

White Label Admin - Get all organization data exports

Get all data exports for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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:

GetOrganizationDataExportsResponse

whitelabel_admin_get_organization_info(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

include_deleted: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → AdminOrganizationInfoResponse[source]#

White Label Admin - 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)
include_deleted (bool) – Whether to include deleted entities (users, projects, orgs)
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_organization_usage_report(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

usage_report_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetOrganizationUsageReportResponse[source]#

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
usage_report_id (int) – Usage report 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:

AdminGetOrganizationUsageReportResponse

whitelabel_admin_get_organization_usage_reports(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

limit: StrictInt | None[StrictInt | None] = None,

offset: StrictInt | None[StrictInt | None] = None,

**kwargs,

) → AdminGetOrganizationUsageReportsResponse[source]#

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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:

AdminGetOrganizationUsageReportsResponse

White Label Admin - 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
include_deleted (bool) – Whether to include deleted entities (users, projects, orgs)
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[StrictInt],

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectInfoResponse[source]#

White Label Admin - 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

White Label Admin - 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[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetUserResponse[source]#

White Label Admin - 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[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → AdminGetUserMetricsResponse[source]#

White Label Admin - 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

White Label Admin - 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_remove_development_board(

organization_id: StrictInt[StrictInt],

development_board_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Remove a development board from a whitelabel

White label admin only API to remove a development board.

Parameters:

organization_id (int) – Organization ID (required)
development_board_id (int) – Development board 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:

GenericApiResponse

whitelabel_admin_remove_user_from_organization(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Remove user from an organization

White label admin only API to remove a user from an organization.

Parameters:

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

GenericApiResponse

whitelabel_admin_remove_user_from_project(

organization_id: StrictInt[StrictInt],

project_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Remove user from a project

White label admin only API to remove a user from a project.

Parameters:

organization_id (int) – Organization ID (required)
project_id (int) – Project 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:

GenericApiResponse

whitelabel_admin_restore_organization(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Restore an organization

White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.

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:

GenericApiResponse

whitelabel_admin_update_default_deployment_target(

organization_id: StrictInt[StrictInt],

update_whitelabel_default_deployment_target_request: UpdateWhitelabelDefaultDeploymentTargetRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update default deployment target

White label admin only API to update the default deployment target for this white label.

Parameters:

organization_id (int) – Organization ID (required)
update_whitelabel_default_deployment_target_request (UpdateWhitelabelDefaultDeploymentTargetRequest) – (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_deployment_options_order(

organization_id: StrictInt[StrictInt],

update_whitelabel_deployment_options_order_request: UpdateWhitelabelDeploymentOptionsOrderRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update the order of deployment options in the deployment view

White label admin only API to customize the order of deployment options in the deployment view for this white label.

Parameters:

organization_id (int) – Organization ID (required)
update_whitelabel_deployment_options_order_request (UpdateWhitelabelDeploymentOptionsOrderRequest) – (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_deployment_targets(

organization_id: StrictInt[StrictInt],

update_whitelabel_deployment_targets_request: UpdateWhitelabelDeploymentTargetsRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update deployment targets

White label admin only API to update some or all of the deployment targets enabled for this white label.

Parameters:

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

Return type:

GenericApiResponse

whitelabel_admin_update_development_board(

organization_id: StrictInt[StrictInt],

development_board_id: StrictInt[StrictInt],

development_board_request_update: DevelopmentBoardRequestUpdate | None = None,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update a development board in a whitelabel

White label admin only API to update a development board.

Parameters:

organization_id (int) – Organization ID (required)
development_board_id (int) – Development board ID. (required)
development_board_request_update (DevelopmentBoardRequestUpdate) –
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_development_board_image(

organization_id: StrictInt[StrictInt],

development_board_id: StrictInt[StrictInt],

image: StrictStr | None = None,

**kwargs,

) → UploadAssetResponse[source]#

White Label Admin - Update the image of a whitelabel development board

White label admin only API to update the image of a development board.

Parameters:

organization_id (int) – Organization ID (required)
development_board_id (int) – Development board ID. (required)
image (str) –
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:

UploadAssetResponse

whitelabel_admin_update_info(

organization_id: StrictInt[StrictInt],

update_whitelabel_request: UpdateWhitelabelRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update white label information

White label admin only API to update the white label information.

Parameters:

organization_id (int) – Organization ID (required)
update_whitelabel_request (UpdateWhitelabelRequest) – (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_learning_blocks(

organization_id: StrictInt[StrictInt],

update_whitelabel_learning_blocks_request: UpdateWhitelabelLearningBlocksRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update learning blocks

White label admin only API to update some or all of the learning blocks enabled for this white label.

Parameters:

organization_id (int) – Organization ID (required)
update_whitelabel_learning_blocks_request (UpdateWhitelabelLearningBlocksRequest) – (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_organization(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

admin_update_organization_request: AdminUpdateOrganizationRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - 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_organization_export(

organization_id: StrictInt[StrictInt],

inner_organization_id: StrictInt[StrictInt],

export_id: StrictInt[StrictInt],

admin_update_organization_data_export_request: AdminUpdateOrganizationDataExportRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update organization data export

Update a data export for an organization. This is an API only available to white label admins.

Parameters:

organization_id (int) – Organization ID (required)
inner_organization_id (int) – Organization ID within the context of a white label (required)
export_id (int) – Export ID (required)
admin_update_organization_data_export_request (AdminUpdateOrganizationDataExportRequest) – (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[StrictInt],

project_id: StrictInt[StrictInt],

update_project_request: UpdateProjectRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - 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_theme_colors(

organization_id: StrictInt[StrictInt],

update_theme_colors_request: UpdateThemeColorsRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update theme colors

White label admin only API to update some or all theme colors.

Parameters:

organization_id (int) – Organization ID (required)
update_theme_colors_request (UpdateThemeColorsRequest) – (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_theme_device_logo(

organization_id: StrictInt[StrictInt],

image: StrictStr | None = None,

**kwargs,

) → UploadAssetResponse[source]#

White Label Admin - Update theme device logo

White label admin only API to update the white label theme device logo.

Parameters:

organization_id (int) – Organization ID (required)
image (str) –
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:

UploadAssetResponse

whitelabel_admin_update_theme_favicon(

organization_id: StrictInt[StrictInt],

image: StrictStr,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - Update theme favicon

White label admin only API to update the theme favicon.

Parameters:

organization_id (int) – Organization ID (required)
image (str) – (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_theme_logo(

organization_id: StrictInt[StrictInt],

image: StrictStr | None = None,

**kwargs,

) → UploadAssetResponse[source]#

White Label Admin - Update theme logo

White label admin only API to update the white label theme logo.

Parameters:

organization_id (int) – Organization ID (required)
image (str) –
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:

UploadAssetResponse

whitelabel_admin_update_user(

organization_id: StrictInt[StrictInt],

user_id: StrictInt[StrictInt],

admin_update_user_request: AdminUpdateUserRequest,

**kwargs,

) → GenericApiResponse[source]#

White Label Admin - 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