Lookup Models

Lookup models for the ACPortal API.

class ab.api.models.lookup.LookupItemsParams(*, jobDisplayId=None, jobItemId=None)[source]

Bases: RequestModel

Query parameters for GET /lookup/items.

Parameters:

  • jobDisplayId (int | None)

  • jobItemId (str | None)

job_display_id: int | None
job_item_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.lookup.LookupDocumentTypesParams(*, documentSource=None)[source]

Bases: RequestModel

Query parameters for GET /lookup/documentTypes.

Parameters:

documentSource (str | None)

document_source: 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.lookup.LookupDensityClassMapParams(*, carrierApi=None)[source]

Bases: RequestModel

Query parameters for GET /lookup/densityClassMap.

Parameters:

carrierApi (str | None)

carrier_api: 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.lookup.ContactTypeEntity(*, id=None, name=None, description=None, value=None, **extra_data)[source]

Bases: ResponseModel

Contact type — GET /lookup/contactTypes.

Parameters:

  • id (int | None)

  • name (str | None)

  • description (str | None)

  • value (str | None)

  • extra_data (Any)

id: int | None
name: str | None
description: str | None
value: 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.lookup.CountryCodeDto(*, code=None, name=None, id=None, iataCode=None, **extra_data)[source]

Bases: ResponseModel

Country code — GET /lookup/countries.

Parameters:

  • code (str | None)

  • name (str | None)

  • id (str | None)

  • iataCode (str | None)

  • extra_data (Any)

code: str | None
name: str | None
id: str | None
iata_code: 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.lookup.JobStatus(*, id=None, name=None, description=None, key=None, value=None, **extra_data)[source]

Bases: ResponseModel

Job status entry — GET /lookup/jobStatuses.

Parameters:

  • id (int | None)

  • name (str | None)

  • description (str | None)

  • key (str | None)

  • value (str | None)

  • extra_data (Any)

id: int | None
name: str | None
description: str | None
key: str | None
value: 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.lookup.LookupItem(*, id=None, name=None, **extra_data)[source]

Bases: ResponseModel

Generic lookup item — GET /lookup/items.

Parameters:

  • id (str | None)

  • name (str | None)

  • extra_data (Any)

id: str | None
name: 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.lookup.LookupValue(*, id=None, key=None, name=None, value=None, **extra_data)[source]

Bases: ResponseModel

Generic lookup value — GET /lookup/{masterConstantKey}.

Source: MasterData.cs — controller returns id/key/name/value.

Parameters:

  • id (str | None)

  • key (str | None)

  • name (str | None)

  • value (str | None)

  • extra_data (Any)

id: str | None
key: str | None
name: str | None
value: 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.lookup.AccessKey(*, accessKey=None, friendlyName=None, **extra_data)[source]

Bases: ResponseModel

Access key record — GET /lookup/accessKeys.

Source: APIAccessKey.cs — accessKey/friendlyName fields.

Parameters:

  • accessKey (str | None)

  • friendlyName (str | None)

  • extra_data (Any)

access_key: str | None
friendly_name: 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.lookup.AccessKeySetup(*, accessKey=None, friendlyName=None, userId=None, userIdentifier=None, referredById=None, referredBy=None, useAgentSearch=None, allowJobInfoUpdate=None, allowJobInfoUpdateWithoutBookingKey=None, ipProtections=None, parcelTransportationMultiplier=None, parcelAccessorialMultiplier=None, itemsCombineMaxInches=None, usePackLaborCalculation=None, useBasePickupFeeCalculation=None, forceAgentPickup=None, **extra_data)[source]

Bases: ResponseModel

Access key setup details — GET /lookup/accessKey/{accessKey}.

Source: APIAccessKeySetup.cs — includes parent AccessKey fields.

Parameters:

  • accessKey (str | None)

  • friendlyName (str | None)

  • userId (str | None)

  • userIdentifier (int | None)

  • referredById (str | None)

  • referredBy (str | None)

  • useAgentSearch (bool | None)

  • allowJobInfoUpdate (bool | None)

  • allowJobInfoUpdateWithoutBookingKey (bool | None)

  • ipProtections (list | None)

  • parcelTransportationMultiplier (float | None)

  • parcelAccessorialMultiplier (float | None)

  • itemsCombineMaxInches (int | None)

  • usePackLaborCalculation (bool | None)

  • useBasePickupFeeCalculation (bool | None)

  • forceAgentPickup (bool | None)

  • extra_data (Any)

access_key: str | None
friendly_name: str | None
user_id: str | None
user_identifier: int | None
referred_by_id: str | None
referred_by: str | None
allow_job_info_update: bool | None
allow_job_info_update_without_booking_key: bool | None
ip_protections: list | None
parcel_transportation_multiplier: float | None
parcel_accessorial_multiplier: float | None
items_combine_max_inches: int | None
use_pack_labor_calculation: bool | None
use_base_pickup_fee_calculation: bool | None
force_agent_pickup: bool | 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.lookup.DocumentTypeBySource(*, name=None, value=None, documentSource=None, **extra_data)[source]

Bases: ResponseModel

Document type by source — GET /lookup/documentTypes.

Source: DocumentTypeBySource.cs — name/value/documentSource fields.

Parameters:

  • name (str | None)

  • value (int | None)

  • documentSource (int | None)

  • extra_data (Any)

name: str | None
value: int | None
document_source: int | 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.lookup.PPCCampaign(*, id=None, name=None, **extra_data)[source]

Bases: ResponseModel

PPC campaign — GET /lookup/PPCCampaigns.

Source: PPCCampaign.cs — id/name fields.

Parameters:

  • id (int | None)

  • name (str | None)

  • extra_data (Any)

id: int | None
name: 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.lookup.CommonInsuranceSlab(*, id=None, key=None, name=None, value=None, insuranceSlabID=None, transpTypeID=None, deductibleAmount=None, isActive=None, rate=None, revision=None, insuranceType=None, **extra_data)[source]

Bases: ResponseModel

Common insurance slab — GET /lookup/comonInsurance.

Source: Live API — insurance slab entity with rate/deductible fields.

Parameters:

  • id (str | None)

  • key (str | None)

  • name (str | None)

  • value (str | None)

  • insuranceSlabID (str | None)

  • transpTypeID (str | None)

  • deductibleAmount (float | None)

  • isActive (bool | None)

  • rate (float | None)

  • revision (int | None)

  • insuranceType (str | None)

  • extra_data (Any)

id: str | None
key: str | None
name: str | None
value: str | None
insurance_slab_id: str | None
transp_type_id: str | None
deductible_amount: float | None
is_active: bool | None
rate: float | None
revision: int | None
insurance_type: 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.lookup.ParcelPackageType(*, id=None, name=None, code=None, description=None, carrierAPI=None, carrierCode=None, weightLimit=None, lengthLimit=None, widthLimit=None, heightLimit=None, priority=None, weight=None, length=None, width=None, height=None, isActive=None, cost=None, sell=None, **extra_data)[source]

Bases: ResponseModel

Parcel package type — GET /lookup/parcelPackageTypes.

Source: Live API response — full package type entity.

Parameters:

  • id (int | None)

  • name (str | None)

  • code (str | None)

  • description (str | None)

  • carrierAPI (int | None)

  • carrierCode (str | None)

  • weightLimit (float | None)

  • lengthLimit (float | None)

  • widthLimit (float | None)

  • heightLimit (float | None)

  • priority (int | None)

  • weight (float | None)

  • length (float | None)

  • width (float | None)

  • height (float | None)

  • isActive (bool | None)

  • cost (float | None)

  • sell (float | None)

  • extra_data (Any)

id: int | None
name: str | None
code: str | None
description: str | None
carrier_api: int | None
carrier_code: str | None
weight_limit: float | None
length_limit: float | None
width_limit: float | None
height_limit: float | None
priority: int | None
weight: float | None
length: float | None
width: float | None
height: float | None
is_active: bool | None
cost: float | None
sell: 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.lookup.DensityClassEntry(*, rangeEnd=None, value=None, **extra_data)[source]

Bases: ResponseModel

Density-to-class mapping — GET /lookup/densityClassMap.

Source: Live API — GuidSequentialRangeValue shape.

Parameters:

  • rangeEnd (float | None)

  • value (str | None)

  • extra_data (Any)

range_end: float | None
value: 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].