organization_blocks_api module#

class edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi(api_client=None)[source]#

Bases: object

add_organization_deploy_block(

organization_id: StrictInt[StrictInt],

name: StrictStr,

docker_container: StrictStr,

description: StrictStr,

cli_arguments: StrictStr,

requests_cpu: float | None = None,

requests_memory: StrictInt | None = None,

limits_cpu: float | None = None,

limits_memory: StrictInt | None = None,

photo: StrictStr | None = None,

integrate_url: StrictStr | None = None,

privileged: StrictBool | None = None,

mount_learn_block: StrictBool | None = None,

supports_eon_compiler: StrictBool | None = None,

show_optimizations: StrictBool | None = None,

category: StrictStr | None = None,

**kwargs,

) → AddOrganizationDeployBlockResponse[source]#

Add deploy block

Adds a deploy block.

Parameters:

organization_id (int) – Organization ID (required)
name (str) – (required)
docker_container (str) – (required)
description (str) – (required)
cli_arguments (str) – (required)
requests_cpu (float) –
requests_memory (int) –
limits_cpu (float) –
limits_memory (int) –
photo (str) –
integrate_url (str) –
privileged (bool) –
mount_learn_block (bool) –
supports_eon_compiler (bool) –
show_optimizations (bool) –
category (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:

AddOrganizationDeployBlockResponse

add_organization_dsp_block(

organization_id: StrictInt[StrictInt],

add_organization_dsp_block_request: AddOrganizationDspBlockRequest,

**kwargs,

) → AddOrganizationDspBlockResponse[source]#

Add dsp block

Adds a dsp block.

Parameters:

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

AddOrganizationDspBlockResponse

add_organization_secret(

organization_id: StrictInt[StrictInt],

add_organization_secret_request: AddOrganizationSecretRequest,

**kwargs,

) → AddOrganizationSecretResponse[source]#

Add secret

Adds a secret.

Parameters:

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

AddOrganizationSecretResponse

add_organization_transfer_learning_block(

organization_id: StrictInt[StrictInt],

add_organization_transfer_learning_block_request: AddOrganizationTransferLearningBlockRequest,

**kwargs,

) → AddOrganizationTransferLearningBlockResponse[source]#

Add transfer learning block

Adds a transfer learning block.

Parameters:

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

AddOrganizationTransferLearningBlockResponse

add_organization_transformation_block(

organization_id: StrictInt[StrictInt],

add_organization_transformation_block_request: AddOrganizationTransformationBlockRequest,

**kwargs,

) → AddOrganizationTransformationBlockResponse[source]#

Add transformation block

Adds a transformation block.

Parameters:

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

AddOrganizationTransformationBlockResponse

delete_organization_deploy_block(

organization_id: StrictInt[StrictInt],

deploy_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete deploy block

Deletes a deploy block.

Parameters:

organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block 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

delete_organization_dsp_block(

organization_id: StrictInt[StrictInt],

dsp_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete dsp block

Deletes a dsp block.

Parameters:

organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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

delete_organization_secret(

organization_id: StrictInt[StrictInt],

secret_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete secret

Deletes a secret

Parameters:

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

delete_organization_transfer_learning_block(

organization_id: StrictInt[StrictInt],

transfer_learning_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete transfer learning block

Deletes a transfer learning block.

Parameters:

organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning 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

delete_organization_transformation_block(

organization_id: StrictInt[StrictInt],

transformation_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete transformation block

Deletes a transformation block.

Parameters:

organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block 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

export_organization_deploy_block(

organization_id: StrictInt[StrictInt],

deploy_id: StrictInt[StrictInt],

**kwargs,

) → ExportBlockResponse[source]#

Export deploy block

Download the source code for this block.

Parameters:

organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block 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:

ExportBlockResponse

export_organization_dsp_block(

organization_id: StrictInt[StrictInt],

dsp_id: StrictInt[StrictInt],

**kwargs,

) → ExportBlockResponse[source]#

Export dsp block

Download the source code for this block.

Parameters:

organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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:

ExportBlockResponse

export_organization_transfer_learning_block(

organization_id: StrictInt[StrictInt],

transfer_learning_id: StrictInt[StrictInt],

**kwargs,

) → ExportBlockResponse[source]#

Export transfer learning block

Download the source code for this block.

Parameters:

organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning 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:

ExportBlockResponse

export_organization_transformation_block(

organization_id: StrictInt[StrictInt],

transformation_id: StrictInt[StrictInt],

**kwargs,

) → ExportBlockResponse[source]#

Export transformation block

Download the source code for this block.

Parameters:

organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block 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:

ExportBlockResponse

get_organization_deploy_block(

organization_id: StrictInt[StrictInt],

deploy_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationDeployBlockResponse[source]#

Get deploy block

Gets a deploy block.

Parameters:

organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block 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:

GetOrganizationDeployBlockResponse

get_organization_dsp_block(

organization_id: StrictInt[StrictInt],

dsp_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationDspBlockResponse[source]#

Get dsp block

Gets a dsp block.

Parameters:

organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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:

GetOrganizationDspBlockResponse

get_organization_transfer_learning_block(

organization_id: StrictInt[StrictInt],

transfer_learning_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationTransferLearningBlockResponse[source]#

Get transfer learning block

Gets a transfer learning block.

Parameters:

organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning 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:

GetOrganizationTransferLearningBlockResponse

get_organization_transformation_block(

organization_id: StrictInt[StrictInt],

transformation_id: StrictInt[StrictInt],

**kwargs,

) → GetOrganizationTransformationBlockResponse[source]#

Get transformation block

Get a transformation block.

Parameters:

organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block 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:

GetOrganizationTransformationBlockResponse

list_organization_deploy_blocks(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationDeployBlocksResponse[source]#

Get deploy blocks

Retrieve all deploy blocks.

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:

ListOrganizationDeployBlocksResponse

list_organization_dsp_blocks(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationDspBlocksResponse[source]#

Get dsp blocks

Retrieve all dsp blocks.

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:

ListOrganizationDspBlocksResponse

list_organization_secrets(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationSecretsResponse[source]#

Get secrets

Retrieve all secrets.

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:

ListOrganizationSecretsResponse

list_organization_transfer_learning_blocks(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationTransferLearningBlocksResponse[source]#

Get transfer learning blocks

Retrieve all transfer learning blocks.

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:

ListOrganizationTransferLearningBlocksResponse

list_organization_transformation_blocks(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationTransformationBlocksResponse[source]#

Get transformation blocks

Retrieve all transformation blocks.

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:

ListOrganizationTransformationBlocksResponse

list_public_organization_transformation_blocks(

organization_id: StrictInt[StrictInt],

**kwargs,

) → ListPublicOrganizationTransformationBlocksResponse[source]#

List public transformation blocks

Retrieve all transformation blocks published by other organizations, available for all organizations.

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:

ListPublicOrganizationTransformationBlocksResponse

retry_organization_dsp_block(

organization_id: StrictInt[StrictInt],

dsp_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Retry connection to dsp block

Retry launch a dsp block.

Parameters:

organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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_deploy_block(

organization_id: StrictInt[StrictInt],

deploy_id: StrictInt[StrictInt],

name: StrictStr | None = None,

docker_container: StrictStr | None = None,

description: StrictStr | None = None,

cli_arguments: StrictStr | None = None,

requests_cpu: float | None = None,

requests_memory: StrictInt | None = None,

limits_cpu: float | None = None,

limits_memory: StrictInt | None = None,

photo: StrictStr | None = None,

integrate_url: StrictStr | None = None,

privileged: StrictBool | None = None,

mount_learn_block: StrictBool | None = None,

supports_eon_compiler: StrictBool | None = None,

show_optimizations: StrictBool | None = None,

category: StrictStr | None = None,

**kwargs,

) → GenericApiResponse[source]#

Update deploy block

Updates a deploy block. Only values in the body will be updated.

Parameters:

organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block ID. (required)
name (str) –
docker_container (str) –
description (str) –
cli_arguments (str) –
requests_cpu (float) –
requests_memory (int) –
limits_cpu (float) –
limits_memory (int) –
photo (str) –
integrate_url (str) –
privileged (bool) –
mount_learn_block (bool) –
supports_eon_compiler (bool) –
show_optimizations (bool) –
category (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:

GenericApiResponse

update_organization_dsp_block(

organization_id: StrictInt[StrictInt],

dsp_id: StrictInt[StrictInt],

update_organization_dsp_block_request: UpdateOrganizationDspBlockRequest,

**kwargs,

) → GenericApiResponse[source]#

Update dsp block

Updates a dsp block. Only values in the body will be updated.

Parameters:

organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)
update_organization_dsp_block_request (UpdateOrganizationDspBlockRequest) – (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_transfer_learning_block(

organization_id: StrictInt[StrictInt],

transfer_learning_id: StrictInt[StrictInt],

update_organization_transfer_learning_block_request: UpdateOrganizationTransferLearningBlockRequest,

**kwargs,

) → GenericApiResponse[source]#

Update transfer learning block

Updates a transfer learning block. Only values in the body will be updated.

Parameters:

organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning ID (required)
update_organization_transfer_learning_block_request (UpdateOrganizationTransferLearningBlockRequest) – (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_transformation_block(

organization_id: StrictInt[StrictInt],

transformation_id: StrictInt[StrictInt],

update_organization_transformation_block_request: UpdateOrganizationTransformationBlockRequest,

**kwargs,

) → GenericApiResponse[source]#

Update transformation block

Updates a transformation block. Only values in the body will be updated.

Parameters:

organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block ID. (required)
update_organization_transformation_block_request (UpdateOrganizationTransformationBlockRequest) – (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