BillsofladingClient

class moloni.api.BillsofladingClient(environment: MoloniBaseUrl = MoloniBaseUrl.PROD, *, auth_config: AuthConfig = AuthConfig(client_id=None, client_secret=None, refresh_token=None, username=None, password=None), version: str = 'v1', validate: bool = True, log_level: str = 'INFO')

count(self, data: BillsofladingCountModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingCountModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the BillsofladingCountModel.

• customer_id (Union[str, int]): customer_id of the BillsofladingCountModel.

• date (str): date of the BillsofladingCountModel.

• document_set_id (Union[str, int]): document_set_id of the BillsofladingCountModel.

• number (str): number of the BillsofladingCountModel.

• year (str): year of the BillsofladingCountModel.

• your_reference (str): your_reference of the BillsofladingCountModel.

Returns:

The response from the API.

Return type:

ApiResponse

delete(self, data: BillsofladingDeleteModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingDeleteModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the BillsofladingDeleteModel.

• document_id (Union[str, int]): document_id of the BillsofladingDeleteModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_all(self, data: BillsofladingGetAllModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingGetAllModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the BillsofladingGetAllModel.

• customer_id (Union[str, int]): customer_id of the BillsofladingGetAllModel.

• date (str): date of the BillsofladingGetAllModel.

• document_set_id (Union[str, int]): document_set_id of the BillsofladingGetAllModel.

• number (str): number of the BillsofladingGetAllModel.

• offset (str): offset of the BillsofladingGetAllModel.

• qty (str): qty of the BillsofladingGetAllModel.

• year (str): year of the BillsofladingGetAllModel.

• your_reference (str): your_reference of the BillsofladingGetAllModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_one(self, data: BillsofladingGetOneModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingGetOneModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the BillsofladingGetOneModel.

• customer_id (Union[str, int]): customer_id of the BillsofladingGetOneModel.

• date (str): date of the BillsofladingGetOneModel.

• document_id (Union[str, int]): document_id of the BillsofladingGetOneModel.

• document_set_id (Union[str, int]): document_set_id of the BillsofladingGetOneModel.

• number (str): number of the BillsofladingGetOneModel.

• year (str): year of the BillsofladingGetOneModel.

• your_reference (str): your_reference of the BillsofladingGetOneModel.

Returns:

The response from the API.

Return type:

ApiResponse

insert(self, data: BillsofladingInsertModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingInsertModel, dict]) –

A model instance or dictionary containing the following fields:

• associated_documents (str): associated_documents of the BillsofladingInsertModel.

• company_id (Union[str, int]): company_id of the BillsofladingInsertModel.

• customer_id (Union[str, int]): customer_id of the BillsofladingInsertModel.

• date (str): date of the BillsofladingInsertModel.

• delivery_datetime (str): delivery_datetime of the BillsofladingInsertModel.

• delivery_departure_address (str): delivery_departure_address of the BillsofladingInsertModel.

• delivery_departure_city (str): delivery_departure_city of the BillsofladingInsertModel.

• delivery_departure_country (str): delivery_departure_country of the BillsofladingInsertModel.

• delivery_departure_zip_code (str): delivery_departure_zip_code of the BillsofladingInsertModel.

• delivery_destination_address (str): delivery_destination_address of the BillsofladingInsertModel.

• delivery_destination_city (str): delivery_destination_city of the BillsofladingInsertModel.

• delivery_destination_country (str): delivery_destination_country of the BillsofladingInsertModel.

• delivery_destination_zip_code (str): delivery_destination_zip_code of the BillsofladingInsertModel.

• delivery_method_id (Union[str, int]): delivery_method_id of the BillsofladingInsertModel.

• document_set_id (Union[str, int]): document_set_id of the BillsofladingInsertModel.

• notes (str): notes of the BillsofladingInsertModel.

• products (str): products of the BillsofladingInsertModel.

• related_documents_notes (str): related_documents_notes of the BillsofladingInsertModel.

• status (str): status of the BillsofladingInsertModel.

• vehicle_id (Union[str, int]): vehicle_id of the BillsofladingInsertModel.

• your_reference (str): your_reference of the BillsofladingInsertModel.

Returns:

The response from the API.

Return type:

ApiResponse

set_transport_code(self, data: BillsofladingSetTransportCodeModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingSetTransportCodeModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the BillsofladingSetTransportCodeModel.

• document_id (Union[str, int]): document_id of the BillsofladingSetTransportCodeModel.

• transport_code (str): transport_code of the BillsofladingSetTransportCodeModel.

Returns:

The response from the API.

Return type:

ApiResponse

update(self, data: BillsofladingUpdateModel | dict, **kwargs)

Parameters:

data (Union[BillsofladingUpdateModel, dict]) –

A model instance or dictionary containing the following fields:

• associated_documents (str): associated_documents of the BillsofladingUpdateModel.

• company_id (Union[str, int]): company_id of the BillsofladingUpdateModel.

• customer_id (Union[str, int]): customer_id of the BillsofladingUpdateModel.

• date (str): date of the BillsofladingUpdateModel.

• delivery_datetime (str): delivery_datetime of the BillsofladingUpdateModel.

• delivery_departure_address (str): delivery_departure_address of the BillsofladingUpdateModel.

• delivery_departure_city (str): delivery_departure_city of the BillsofladingUpdateModel.

• delivery_departure_country (str): delivery_departure_country of the BillsofladingUpdateModel.

• delivery_departure_zip_code (str): delivery_departure_zip_code of the BillsofladingUpdateModel.

• delivery_destination_address (str): delivery_destination_address of the BillsofladingUpdateModel.

• delivery_destination_city (str): delivery_destination_city of the BillsofladingUpdateModel.

• delivery_destination_country (str): delivery_destination_country of the BillsofladingUpdateModel.

• delivery_destination_zip_code (str): delivery_destination_zip_code of the BillsofladingUpdateModel.

• delivery_method_id (Union[str, int]): delivery_method_id of the BillsofladingUpdateModel.

• document_id (Union[str, int]): document_id of the BillsofladingUpdateModel.

• document_set_id (Union[str, int]): document_set_id of the BillsofladingUpdateModel.

• notes (str): notes of the BillsofladingUpdateModel.

• products (str): products of the BillsofladingUpdateModel.

• related_documents_notes (str): related_documents_notes of the BillsofladingUpdateModel.

• status (str): status of the BillsofladingUpdateModel.

• vehicle_id (Union[str, int]): vehicle_id of the BillsofladingUpdateModel.

• your_reference (str): your_reference of the BillsofladingUpdateModel.

Returns:

The response from the API.

Return type:

ApiResponse

Models:

class moloni.api.BillsofladingCountModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, number: str | None = None, year: str | None = None, your_reference: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

customer_id: str | int | None

date: str | None

document_set_id: str | int | None

number: str | None

year: str | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingDeleteModel(*, company_id: str | int, document_id: str | int | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

document_id: str | int | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingGetAllModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, number: str | None = None, offset: str | int | None = 0, qty: str | int | None = 25, year: str | None = None, your_reference: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

customer_id: str | int | None

date: str | None

document_set_id: str | int | None

number: str | None

offset: str | int | None

qty: str | int | None

year: str | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'offset': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=0), 'qty': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=25), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingGetOneModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_id: str | int | None = None, document_set_id: str | int | None = None, number: str | None = None, year: str | None = None, your_reference: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

customer_id: str | int | None

date: str | None

document_id: str | int | None

document_set_id: str | int | None

number: str | None

year: str | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingInsertModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, delivery_datetime: str | None = None, delivery_departure_address: str | None = None, delivery_departure_city: str | None = None, delivery_departure_country: str | None = None, delivery_departure_zip_code: str | None = None, delivery_destination_address: str | None = None, delivery_destination_city: str | None = None, delivery_destination_country: str | None = None, delivery_destination_zip_code: str | None = None, delivery_method_id: str | int | None = None, document_set_id: str | int | None = None, notes: str | None = None, products: List[Products] | None = None, related_documents_notes: str | None = None, status: str | None = None, vehicle_id: str | int | None = None, your_reference: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

associated_documents: List[Associated_documents] | None

customer_id: str | int | None

date: str | None

delivery_datetime: str | None

delivery_departure_address: str | None

delivery_departure_city: str | None

delivery_departure_country: str | None

delivery_departure_zip_code: str | None

delivery_destination_address: str | None

delivery_destination_city: str | None

delivery_destination_country: str | None

delivery_destination_zip_code: str | None

delivery_method_id: str | int | None

document_set_id: str | int | None

notes: str | None

products: List[Products] | None

related_documents_notes: str | None

status: str | None

vehicle_id: str | int | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'associated_documents': FieldInfo(annotation=Union[List[Associated_documents], NoneType], required=False, default=None), 'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_datetime': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_method_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vehicle_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingSetTransportCodeModel(*, company_id: str | int, document_id: str | int | None = None, transport_code: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

document_id: str | int | None

transport_code: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'transport_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

class moloni.api.BillsofladingUpdateModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, delivery_datetime: str | None = None, delivery_departure_address: str | None = None, delivery_departure_city: str | None = None, delivery_departure_country: str | None = None, delivery_departure_zip_code: str | None = None, delivery_destination_address: str | None = None, delivery_destination_city: str | None = None, delivery_destination_country: str | None = None, delivery_destination_zip_code: str | None = None, delivery_method_id: str | int | None = None, document_id: str | int | None = None, document_set_id: str | int | None = None, notes: str | None = None, products: List[Products] | None = None, related_documents_notes: str | None = None, status: str | None = None, vehicle_id: str | int | None = None, your_reference: str | None = None)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

company_id: str | int

associated_documents: List[Associated_documents] | None

customer_id: str | int | None

date: str | None

delivery_datetime: str | None

delivery_departure_address: str | None

delivery_departure_city: str | None

delivery_departure_country: str | None

delivery_departure_zip_code: str | None

delivery_destination_address: str | None

delivery_destination_city: str | None

delivery_destination_country: str | None

delivery_destination_zip_code: str | None

delivery_method_id: str | int | None

document_id: str | int | None

document_set_id: str | int | None

notes: str | None

products: List[Products] | None

related_documents_notes: str | None

status: str | None

vehicle_id: str | int | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.

Returns:

The response from the API.

Raises:

ValueError – If the client is not initialized via the connect method.

Example

# Assuming you have a model instance request_model and an API client api_client

..code-block:: python

with request_model.connect(auth_config=auth_config) as api:

response = api.request()

# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'associated_documents': FieldInfo(annotation=Union[List[Associated_documents], NoneType], required=False, default=None), 'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_datetime': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_method_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vehicle_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.