Commodity Models

Commodity models for the ACPortal API.

class ab.api.models.commodities.Commodity(*, id=None, description=None, freightClass=None, nmfcCode=None, weightMin=None, weightMax=None, **extra_data)[source]

Bases: ResponseModel

Commodity record — GET /commodity/{id}.

Parameters:

id (str | None)
description (str | None)
freightClass (str | None)
nmfcCode (str | None)
weightMin (float | None)
weightMax (float | None)
extra_data (Any)

id: str | None

description: str | None

freight_class: str | None

nmfc_code: str | None

weight_min: float | None

weight_max: float | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityCreateRequest(*, description=None, freightClass=None, nmfcCode=None, weightMin=None, weightMax=None)[source]

Bases: RequestModel

Body for POST /commodity.

Parameters:

description (str | None)
freightClass (str | None)
nmfcCode (str | None)
weightMin (float | None)
weightMax (float | None)

description: str | None

freight_class: str | None

nmfc_code: str | None

weight_min: float | None

weight_max: float | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityUpdateRequest(*, description=None, freightClass=None, nmfcCode=None)[source]

Bases: RequestModel

Body for PUT /commodity/{id}.

Parameters:

description (str | None)
freightClass (str | None)
nmfcCode (str | None)

description: str | None

freight_class: str | None

nmfc_code: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommoditySearchRequest(*, searchText=None, page=None, pageSize=None)[source]

Bases: SearchableRequestMixin

Search filter for POST /commodity/search.

Parameters:

searchText (str | None)
page (int | None)
pageSize (int | None)

page: int | None

page_size: int | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommoditySuggestionRequest(*, searchText=None)[source]

Bases: SearchableRequestMixin

Suggestion filter for POST /commodity/suggestions.

Parameters:: searchText (str | None)

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityMap(*, id=None, customName=None, commodityId=None, **extra_data)[source]

Bases: ResponseModel

Commodity mapping record — GET /commodity-map/{id}.

Parameters:

id (str | None)
customName (str | None)
commodityId (str | None)
extra_data (Any)

id: str | None

custom_name: str | None

commodity_id: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityMapCreateRequest(*, customName=None, commodityId=None)[source]

Bases: RequestModel

Body for POST /commodity-map.

Parameters:

customName (str | None)
commodityId (str | None)

custom_name: str | None

commodity_id: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityMapUpdateRequest(*, customName=None, commodityId=None)[source]

Bases: RequestModel

Body for PUT /commodity-map/{id}.

Parameters:

customName (str | None)
commodityId (str | None)

custom_name: str | None

commodity_id: str | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.commodities.CommodityMapSearchRequest(*, searchText=None, page=None, pageSize=None)[source]

Bases: SearchableRequestMixin

Search filter for POST /commodity-map/search.

Parameters:

searchText (str | None)
page (int | None)
pageSize (int | None)

page: int | None

page_size: int | None

model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].