Skip to main content

Function: carrierService()

carrierService(client): object

Defined in: service/CarrierService.ts:17

Service class for Carrier-related GraphQL operations

Parameters

client

GraphQLClient

Returns

createCarrier()

createCarrier(input): Promise<Carrier>

Creates a new carrier *

Parameters

input

CarrierCreateInput

Carrier creation input data *

Returns

Promise<Carrier>

Promise<Carrier> The created carrier

deleteCarrier()

deleteCarrier(id): Promise&lt;boolean>

Deletes a carrier *

Parameters

id

number

Carrier ID to delete *

Returns

Promise&lt;boolean>

Promise<boolean> Success status

getCarrier()

getCarrier(id): Promise&lt;Carrier>

Fetches a single carrier by ID *

Parameters

id

number

Carrier ID to fetch *

Returns

Promise&lt;Carrier>

Promise<Carrier> The carrier data

getCarriers()

getCarriers(input?): Promise&lt;CarriersResponse>

Fetches a list of carriers with search criteria *

Parameters

input?

CarriersSearchInput

Carrier search input parameters *

Returns

Promise&lt;CarriersResponse>

Promise<CarriersResponse> The carriers response data

updateCarrier()

updateCarrier(variables): Promise&lt;Carrier>

Updates an existing carrier *

Parameters

variables

CarrierUpdateVariables

Carrier update input data *

Returns

Promise&lt;Carrier>

Promise<Carrier> The updated carrier