ShippingMethodService

ShippingMethodService

Contains methods relating to ShippingMethod entities.

Signature

class ShippingMethodService {
  constructor(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, channelService: ChannelService, configArgService: ConfigArgService, translatableSaver: TranslatableSaver, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService)
  findAll(ctx: RequestContext, options?: ListQueryOptions<ShippingMethod>, relations: RelationPaths<ShippingMethod> = []) => Promise<PaginatedList<Translated<ShippingMethod>>>;
  async findOne(ctx: RequestContext, shippingMethodId: ID, includeDeleted:  = false, relations: RelationPaths<ShippingMethod> = []) => Promise<Translated<ShippingMethod> | undefined>;
  async create(ctx: RequestContext, input: CreateShippingMethodInput) => Promise<Translated<ShippingMethod>>;
  async update(ctx: RequestContext, input: UpdateShippingMethodInput) => Promise<Translated<ShippingMethod>>;
  async softDelete(ctx: RequestContext, id: ID) => Promise<DeletionResponse>;
  async assignShippingMethodsToChannel(ctx: RequestContext, input: AssignShippingMethodsToChannelInput) => Promise<Array<Translated<ShippingMethod>>>;
  async removeShippingMethodsFromChannel(ctx: RequestContext, input: RemoveShippingMethodsFromChannelInput) => Promise<Array<Translated<ShippingMethod>>>;
  getShippingEligibilityCheckers(ctx: RequestContext) => ConfigurableOperationDefinition[];
  getShippingCalculators(ctx: RequestContext) => ConfigurableOperationDefinition[];
  getFulfillmentHandlers(ctx: RequestContext) => ConfigurableOperationDefinition[];
  async getActiveShippingMethods(ctx: RequestContext) => Promise<ShippingMethod[]>;
}

Members

constructor

method
type:
(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, channelService: ChannelService, configArgService: ConfigArgService, translatableSaver: TranslatableSaver, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService) => ShippingMethodService

findAll

method
type:
(ctx: RequestContext, options?: ListQueryOptions<ShippingMethod>, relations: RelationPaths<ShippingMethod> = []) => Promise<PaginatedList<Translated<ShippingMethod>>>

findOne

method
type:
(ctx: RequestContext, shippingMethodId: ID, includeDeleted: = false, relations: RelationPaths<ShippingMethod> = []) => Promise<Translated<ShippingMethod> | undefined>

create

method
type:
(ctx: RequestContext, input: CreateShippingMethodInput) => Promise<Translated<ShippingMethod>>

update

method
type:
(ctx: RequestContext, input: UpdateShippingMethodInput) => Promise<Translated<ShippingMethod>>

softDelete

method
type:
(ctx: RequestContext, id: ID) => Promise<DeletionResponse>

assignShippingMethodsToChannel

method
type:
(ctx: RequestContext, input: AssignShippingMethodsToChannelInput) => Promise<Array<Translated<ShippingMethod>>>

removeShippingMethodsFromChannel

method
type:
(ctx: RequestContext, input: RemoveShippingMethodsFromChannelInput) => Promise<Array<Translated<ShippingMethod>>>

getShippingEligibilityCheckers

method
type:
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getShippingCalculators

method
type:
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getFulfillmentHandlers

method
type:
(ctx: RequestContext) => ConfigurableOperationDefinition[]

getActiveShippingMethods

method
type:
(ctx: RequestContext) => Promise<ShippingMethod[]>