Class: CarrierService
Defined in: service/CarrierService.ts:70
Backwards-compatible class form. New code should call carrierService(client).
Constructors
Constructor
new CarrierService(
client):CarrierService
Defined in: service/CarrierService.ts:72
Parameters
client
Returns
CarrierService
Methods
createCarrier()
createCarrier(
input):Promise<Carrier>
Defined in: service/CarrierService.ts:87
Creates a new carrier
Parameters
input
Carrier creation input data
Returns
Promise<Carrier>
deleteCarrier()
deleteCarrier(
id):Promise<boolean>
Defined in: service/CarrierService.ts:97
Deletes a carrier
Parameters
id
number
Carrier ID to delete
Returns
Promise<boolean>
getCarrier()
getCarrier(
id):Promise<Carrier>
Defined in: service/CarrierService.ts:77
Fetches a single carrier by ID
Parameters
id
number
Carrier ID to fetch
Returns
Promise<Carrier>
getCarriers()
getCarriers(
input?):Promise<CarriersResponse>
Defined in: service/CarrierService.ts:82
Fetches a list of carriers with search criteria
Parameters
input?
Carrier search input parameters
Returns
Promise<CarriersResponse>
updateCarrier()
updateCarrier(
variables):Promise<Carrier>
Defined in: service/CarrierService.ts:92
Updates an existing carrier
Parameters
variables
Carrier update input data
Returns
Promise<Carrier>