client/managers
Classes
| Class | Description |
|---|---|
| BaseManager | - |
| ContainerManager | - |
| DocumentManager | - |
| DocumentSchemaManager | - |
| EmailSubmissionManager | - |
| ShipmentManager | - |
| ShippingLineManager | - |
| TrackingRequestManager | - |
| TradeIntelManager | Trade intelligence: US import bill-of-lading records (US Customs manifests), January 2022 onward, refreshed daily. |
Interfaces
| Interface | Description |
|---|---|
| ContainerAddPartyRoleParams | Parameters for addPartyRole; role is limited to what the spec accepts on this route. |
| CreateDocumentParams | Attributes accepted by DocumentManager.create. |
| CreateTrackingRequestFromInferOptions | - |
| DocumentListFilters | Filters accepted by DocumentManager.list. |
| IterateOptions | Options accepted by BaseManager.createIterator. |
| ShipmentAddPartyRoleParams | Parameters for addPartyRole; role is limited to what the spec accepts on this route. |
| TrackingRequestListFilters | - |
| TradeIntelBillOfLadingLookupOptions | Options for TradeIntelManager.lookupBillOfLading. |
| UpdateDocumentParams | Attributes accepted by DocumentManager.update. |
Type Aliases
| Type Alias | Description |
|---|---|
| ContainerUpdateAttributes | Writable container attributes for update. |
| DocumentRotation | - |
| ShipmentUpdateAttributes | Writable shipment attributes. Each list replaces the existing one. |
| TrackingRequestType | - |
| TrackingRequestUpdateAttributes | Writable tracking request attributes. ref_numbers replaces the existing list. |
| TradeIntelBillOfLadingLookup | Response of POST /trade_intel/bills_of_lading/lookup. |
| TradeIntelBreakdown | Response of POST /trade_intel/breakdown. |
| TradeIntelBreakdownRequest | Body of POST /trade_intel/breakdown. |
| TradeIntelCommoditySearchRequest | Body of POST /trade_intel/commodities/search. |
| TradeIntelCommoditySearchResponse | Response of POST /trade_intel/commodities/search. |
| TradeIntelCompanyProfile | Response of POST /trade_intel/companies/profile. |
| TradeIntelCompanyProfileRequest | Body of POST /trade_intel/companies/profile. |
| TradeIntelCompanySearchRequest | Body of POST /trade_intel/companies/search. |
| TradeIntelCompanySearchResponse | Response of POST /trade_intel/companies/search. |
| TradeIntelCompanySearchResult | One importer returned by searchCompanies. |
| TradeIntelContainerLookup | Response of POST /trade_intel/containers/lookup. |
| TradeIntelDimension | A dimension accepted by group_by (trends) and dims (breakdown). |
| TradeIntelFilters | Filters accepted by trends and breakdown. |
| TradeIntelMeasure | A measure accepted by trends and breakdown. |
| TradeIntelMeta | Index window, freshness, and counts returned by GET /trade_intel/meta. |
| TradeIntelTopImporters | Response of POST /trade_intel/importers/top. |
| TradeIntelTopImportersRequest | Body of POST /trade_intel/importers/top. |
| TradeIntelTrends | Response of POST /trade_intel/trends. |
| TradeIntelTrendsRequest | Body of POST /trade_intel/trends. |
Variables
| Variable | Description |
|---|---|
| DEFAULT_ITERATE_MAX_PAGES | Hard safety caps for BaseManager.createIterator. They exist so a no-op or mistakenly broad filter cannot silently walk the entire dataset (and make thousands of requests). They are deliberately large enough not to interfere with realistic pagination, and can be raised per call via maxPages / maxRows when a caller genuinely needs more. |
| DEFAULT_ITERATE_MAX_ROWS | - |