ai_api_client_sdk.models.base_models module

class ai_api_client_sdk.models.base_models.KeyValue(key: str, value: str, **kwargs)

Bases: object

KeyValue object defines a key-value pair

Parameters:

  • key (str) – key of the pair

  • value (str) – value of the pair

__init__(key: str, value: str, **kwargs)
to_dict()
class ai_api_client_sdk.models.base_models.NameValue(name: str, value: str, **kwargs)

Bases: object

KeyValue object defines a name-value pair

Parameters:

  • name (str) – name of the pair

  • value (str) – value of the pair

__init__(name: str, value: str, **kwargs)
class ai_api_client_sdk.models.base_models.Name(name: str, **kwargs)

Bases: object

KeyValue object defines a name

Parameters:

name (str) – name

__init__(name: str, **kwargs)
class ai_api_client_sdk.models.base_models.QueryResponse(resources: list, count: int, **kwargs)

Bases: object

The QueryResponse object defines the response from the server to a query request

Parameters:

  • resources (list) – List of the resources returned from the server

  • count (int) – Total number of the queried resources

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

__init__(resources: list, count: int, **kwargs)
class ai_api_client_sdk.models.base_models.BasicResponse(id: str, message: str, **kwargs)

Bases: object

The BasicResponse object defines the response from the server

Parameters:

  • id (str) – ID of the relevant resource

  • message (str) – Response message from the server

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

__init__(id: str, message: str, **kwargs)
static from_dict(br_dict: Dict[str, str])

Returns a ai_api_client_sdk.models.base_models.BasicResponse object, created from the values in the dict provided as parameter

Parameters:

br_dict (Dict[str, str]) – Dict which includes the necessary values to create the object

Returns:

An object, created from the values provided

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

class ai_api_client_sdk.models.base_models.BasicErrorResponse(code: str, message: str, request_id: str, target: str, details: Dict = None, **kwargs)

Bases: object

The BasicErrorResponse object defines the response from the server

Parameters:

  • error_code (str) – Error code from the server

  • message (str) – Error message from the server

  • request_id (str) – Request ID

  • target (str, optional) – target

  • details (Dict, optional) – Error details

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

__init__(code: str, message: str, request_id: str, target: str, details: Dict = None, **kwargs)
static from_dict(ber_dict: Dict[str, str])

Returns a ai_api_client_sdk.models.base_models.BasicErrorResponse object, created from the values provided as parameter

Parameters:

ber_dict (Dict[str, str]) – Dict which includes the necessary values to create the object

Returns:

An object, created from the values provided

Return type:

class:ai_api_client_sdk.models.base_models.BasicErrorResponse

class ai_api_client_sdk.models.base_models.BasicModifyRequest(id: str, target_status: TargetStatus, **kwargs)

Bases: object

The BasicModifyRequest object defines the request from client :param id: ID of the relevant resource :type id: str :param target_status: Target Status of the resource :type target_status: class:ai_api_client_sdk.models.target_status.TargetStatus :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

__init__(id: str, target_status: TargetStatus, **kwargs)
to_dict()
class ai_api_client_sdk.models.base_models.BulkModifyErrorResponse(id: str, error: BasicErrorResponse, **kwargs)

Bases: object

The BulkModifyErrorResponse object defines the error response from the server

__init__(id: str, error: BasicErrorResponse, **kwargs)

Creates an error object for a bulk modification call

Parameters:

  • id (str) – ID of the relevant resource

  • error (BasicErrorResponse) – Error object response from the server

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

static from_dict(error_dict: Dict[str, str | Dict])
Parameters:

error_dict (Dict[str, Union[str, Dict]]) – Dict which includes the necessary values to create the object

Returns:

ai_api_client_sdk.models.base_models.BulkModifyErrorResponse object

Return type:

Returns a class

class ai_api_client_sdk.models.base_models.Order(*values)

Bases: Enum

ASC = 'asc'
DESC = 'desc'
class ai_api_client_sdk.models.base_models.Operation(*values)

Bases: Enum

An enumeration.

CREATE = 'CREATE'
UPDATE = 'UPDATE'
DELETE = 'DELETE'
CASCADE_UPDATE = 'CASCADE-UPDATE'