Documentation Index
Fetch the complete documentation index at: https://terminal49.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Class: TrackingRequestManager
Extends
Constructors
Constructor
new TrackingRequestManager(transport, defaultFormat?): TrackingRequestManager
Parameters
| Parameter | Type | Default value |
|---|
transport | Transport | undefined |
defaultFormat | ResponseFormat | 'raw' |
Returns
TrackingRequestManager
Inherited from
BaseManager.constructor
Methods
create()
create(params): Promise<any>
Parameters
| Parameter | Type |
|---|
params | { refNumbers?: string[]; requestNumber: string; requestType: TrackingRequestType; scac?: string; shipmentTags?: string[]; } |
params.refNumbers? | string[] |
params.requestNumber | string |
params.requestType | TrackingRequestType |
params.scac? | string |
params.shipmentTags? | string[] |
Returns
Promise<any>
createFromInfer()
createFromInfer(number, options?): Promise<{ infer: any; trackingRequest: any; }>
Parameters
Returns
Promise<{ infer: any; trackingRequest: any; }>
get()
get(id, options?): Promise<any>
Parameters
| Parameter | Type |
|---|
id | string |
options? | CallOptions & object |
Returns
Promise<any>
inferNumber()
inferNumber(number): Promise<any>
Parameters
| Parameter | Type |
|---|
number | string |
Returns
Promise<any>
iterate()
iterate(filters?, options?): AsyncGenerator<TrackingRequest, void, unknown>
Parameters
| Parameter | Type |
|---|
filters | TrackingRequestListFilters | undefined |
options? | Omit<ListOptions, "page"> |
Returns
AsyncGenerator<TrackingRequest, void, unknown>
list()
list(filters?, options?): Promise<any>
Parameters
Returns
Promise<any>
update()
update(id, attrs, options?): Promise<any>
Parameters
| Parameter | Type |
|---|
id | string |
attrs | Record<string, any> |
options? | CallOptions |
Returns
Promise<any>
