@medusajs/types 1.12.0-snapshot-20240406075900 → 1.12.0-snapshot-20240409114424
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/cart/common.d.ts +64 -47
- package/dist/cart/common.d.ts.map +1 -1
- package/dist/cart/mutations.d.ts +14 -13
- package/dist/cart/mutations.d.ts.map +1 -1
- package/dist/cart/mutations.js.map +1 -1
- package/dist/cart/workflows.d.ts +6 -5
- package/dist/cart/workflows.d.ts.map +1 -1
- package/dist/common/rule.d.ts +3 -0
- package/dist/common/rule.d.ts.map +1 -1
- package/dist/customer/common.d.ts +21 -13
- package/dist/customer/common.d.ts.map +1 -1
- package/dist/customer/mutations.d.ts +13 -13
- package/dist/customer/mutations.d.ts.map +1 -1
- package/dist/dal/repository-service.d.ts +1 -1
- package/dist/dal/repository-service.d.ts.map +1 -1
- package/dist/file/index.d.ts +1 -0
- package/dist/file/index.d.ts.map +1 -1
- package/dist/file/index.js +1 -0
- package/dist/file/index.js.map +1 -1
- package/dist/file/provider.d.ts +100 -0
- package/dist/file/provider.d.ts.map +1 -0
- package/dist/file/provider.js +3 -0
- package/dist/file/provider.js.map +1 -0
- package/dist/fulfillment/common/address.d.ts +51 -0
- package/dist/fulfillment/common/address.d.ts.map +1 -1
- package/dist/fulfillment/common/fulfillment-item.d.ts +39 -0
- package/dist/fulfillment/common/fulfillment-item.d.ts.map +1 -1
- package/dist/fulfillment/common/fulfillment-label.d.ts +30 -0
- package/dist/fulfillment/common/fulfillment-label.d.ts.map +1 -1
- package/dist/fulfillment/common/fulfillment-provider.d.ts +24 -0
- package/dist/fulfillment/common/fulfillment-provider.d.ts.map +1 -1
- package/dist/fulfillment/common/fulfillment-set.d.ts +42 -0
- package/dist/fulfillment/common/fulfillment-set.d.ts.map +1 -1
- package/dist/fulfillment/common/fulfillment.d.ts +91 -0
- package/dist/fulfillment/common/fulfillment.d.ts.map +1 -1
- package/dist/fulfillment/common/geo-zone.d.ts +54 -0
- package/dist/fulfillment/common/geo-zone.d.ts.map +1 -1
- package/dist/fulfillment/common/service-zone.d.ts +52 -0
- package/dist/fulfillment/common/service-zone.d.ts.map +1 -1
- package/dist/fulfillment/common/shipping-option-rule.d.ts +51 -0
- package/dist/fulfillment/common/shipping-option-rule.d.ts.map +1 -1
- package/dist/fulfillment/common/shipping-option-type.d.ts +45 -0
- package/dist/fulfillment/common/shipping-option-type.d.ts.map +1 -1
- package/dist/fulfillment/common/shipping-option.d.ts +117 -0
- package/dist/fulfillment/common/shipping-option.d.ts.map +1 -1
- package/dist/fulfillment/common/shipping-profile.d.ts +42 -0
- package/dist/fulfillment/common/shipping-profile.d.ts.map +1 -1
- package/dist/fulfillment/mutations/fulfillment-address.d.ts +39 -0
- package/dist/fulfillment/mutations/fulfillment-address.d.ts.map +1 -1
- package/dist/fulfillment/mutations/fulfillment-item.d.ts +24 -0
- package/dist/fulfillment/mutations/fulfillment-item.d.ts.map +1 -1
- package/dist/fulfillment/mutations/fulfillment-label.d.ts +15 -0
- package/dist/fulfillment/mutations/fulfillment-label.d.ts.map +1 -1
- package/dist/fulfillment/mutations/fulfillment-set.d.ts +32 -2
- package/dist/fulfillment/mutations/fulfillment-set.d.ts.map +1 -1
- package/dist/fulfillment/mutations/fulfillment.d.ts +66 -0
- package/dist/fulfillment/mutations/fulfillment.d.ts.map +1 -1
- package/dist/fulfillment/mutations/geo-zone.d.ts +123 -0
- package/dist/fulfillment/mutations/geo-zone.d.ts.map +1 -1
- package/dist/fulfillment/mutations/service-zone.d.ts +33 -1
- package/dist/fulfillment/mutations/service-zone.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts +21 -0
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-option-type.d.ts +21 -0
- package/dist/fulfillment/mutations/shipping-option-type.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-option.d.ts +71 -1
- package/dist/fulfillment/mutations/shipping-option.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-profile.d.ts +15 -0
- package/dist/fulfillment/mutations/shipping-profile.d.ts.map +1 -1
- package/dist/fulfillment/service.d.ts +1933 -218
- package/dist/fulfillment/service.d.ts.map +1 -1
- package/dist/http/api-key/admin/api-key.d.ts +31 -0
- package/dist/http/api-key/admin/api-key.d.ts.map +1 -0
- package/dist/http/api-key/admin/api-key.js +3 -0
- package/dist/http/api-key/admin/api-key.js.map +1 -0
- package/dist/http/api-key/admin/index.d.ts +2 -0
- package/dist/http/api-key/admin/index.d.ts.map +1 -0
- package/dist/http/api-key/admin/index.js +18 -0
- package/dist/http/api-key/admin/index.js.map +1 -0
- package/dist/http/api-key/index.d.ts +2 -0
- package/dist/http/api-key/index.d.ts.map +1 -0
- package/dist/http/api-key/index.js +18 -0
- package/dist/http/api-key/index.js.map +1 -0
- package/dist/http/common/index.d.ts +2 -0
- package/dist/http/common/index.d.ts.map +1 -0
- package/dist/http/common/index.js +18 -0
- package/dist/http/common/index.js.map +1 -0
- package/dist/http/common/paginated-response.d.ts +6 -0
- package/dist/http/common/paginated-response.d.ts.map +1 -0
- package/dist/http/common/paginated-response.js +3 -0
- package/dist/http/common/paginated-response.js.map +1 -0
- package/dist/http/customer/admin/customer.d.ts +79 -0
- package/dist/http/customer/admin/customer.d.ts.map +1 -0
- package/dist/http/customer/admin/customer.js +3 -0
- package/dist/http/customer/admin/customer.js.map +1 -0
- package/dist/http/customer/admin/index.d.ts +2 -0
- package/dist/http/customer/admin/index.d.ts.map +1 -0
- package/dist/http/customer/admin/index.js +18 -0
- package/dist/http/customer/admin/index.js.map +1 -0
- package/dist/http/customer/index.d.ts +2 -0
- package/dist/http/customer/index.d.ts.map +1 -0
- package/dist/http/customer/index.js +18 -0
- package/dist/http/customer/index.js.map +1 -0
- package/dist/http/fulfillment/admin/fulfillment-set.d.ts +9 -3
- package/dist/http/fulfillment/admin/fulfillment-set.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/service-zone.d.ts +16 -0
- package/dist/http/fulfillment/admin/service-zone.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/shipping-option.d.ts +11 -4
- package/dist/http/fulfillment/admin/shipping-option.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/shipping-profile.d.ts +8 -1
- package/dist/http/fulfillment/admin/shipping-profile.d.ts.map +1 -1
- package/dist/http/index.d.ts +7 -1
- package/dist/http/index.d.ts.map +1 -1
- package/dist/http/index.js +7 -1
- package/dist/http/index.js.map +1 -1
- package/dist/http/pricing/index.d.ts +2 -0
- package/dist/http/pricing/index.d.ts.map +1 -0
- package/dist/http/pricing/index.js +18 -0
- package/dist/http/pricing/index.js.map +1 -0
- package/dist/http/pricing/price.d.ts +8 -0
- package/dist/http/pricing/price.d.ts.map +1 -0
- package/dist/http/pricing/price.js +3 -0
- package/dist/http/pricing/price.js.map +1 -0
- package/dist/http/product-category/admin/index.d.ts +2 -0
- package/dist/http/product-category/admin/index.d.ts.map +1 -0
- package/dist/http/product-category/admin/index.js +18 -0
- package/dist/http/product-category/admin/index.js.map +1 -0
- package/dist/http/product-category/admin/product-category.d.ts +32 -0
- package/dist/http/product-category/admin/product-category.d.ts.map +1 -0
- package/dist/http/product-category/admin/product-category.js +3 -0
- package/dist/http/product-category/admin/product-category.js.map +1 -0
- package/dist/http/product-category/index.d.ts +2 -0
- package/dist/http/product-category/index.d.ts.map +1 -0
- package/dist/http/product-category/index.js +18 -0
- package/dist/http/product-category/index.js.map +1 -0
- package/dist/http/sales-channel/admin/index.d.ts +2 -0
- package/dist/http/sales-channel/admin/index.d.ts.map +1 -0
- package/dist/http/sales-channel/admin/index.js +18 -0
- package/dist/http/sales-channel/admin/index.js.map +1 -0
- package/dist/http/sales-channel/admin/sales-channel.d.ts +25 -0
- package/dist/http/sales-channel/admin/sales-channel.d.ts.map +1 -0
- package/dist/http/sales-channel/admin/sales-channel.js +3 -0
- package/dist/http/sales-channel/admin/sales-channel.js.map +1 -0
- package/dist/http/sales-channel/index.d.ts +2 -0
- package/dist/http/sales-channel/index.d.ts.map +1 -0
- package/dist/http/sales-channel/index.js +18 -0
- package/dist/http/sales-channel/index.js.map +1 -0
- package/dist/http/tax/admin/index.d.ts +2 -0
- package/dist/http/tax/admin/index.d.ts.map +1 -0
- package/dist/http/tax/admin/index.js +18 -0
- package/dist/http/tax/admin/index.js.map +1 -0
- package/dist/http/tax/admin/tax-regions.d.ts +32 -0
- package/dist/http/tax/admin/tax-regions.d.ts.map +1 -0
- package/dist/http/tax/admin/tax-regions.js +3 -0
- package/dist/http/tax/admin/tax-regions.js.map +1 -0
- package/dist/http/tax/index.d.ts +2 -0
- package/dist/http/tax/index.d.ts.map +1 -0
- package/dist/http/tax/index.js +18 -0
- package/dist/http/tax/index.js.map +1 -0
- package/dist/joiner/index.d.ts +2 -2
- package/dist/joiner/index.d.ts.map +1 -1
- package/dist/modules-sdk/index.d.ts +12 -10
- package/dist/modules-sdk/index.d.ts.map +1 -1
- package/dist/order/common.d.ts +111 -45
- package/dist/order/common.d.ts.map +1 -1
- package/dist/order/index.d.ts +1 -0
- package/dist/order/index.d.ts.map +1 -1
- package/dist/order/index.js +1 -0
- package/dist/order/index.js.map +1 -1
- package/dist/order/mutations.d.ts +14 -14
- package/dist/order/mutations.d.ts.map +1 -1
- package/dist/order/mutations.js.map +1 -1
- package/dist/order/service.d.ts +60 -662
- package/dist/order/service.d.ts.map +1 -1
- package/dist/order/workflows.d.ts +8 -0
- package/dist/order/workflows.d.ts.map +1 -0
- package/dist/order/workflows.js +3 -0
- package/dist/order/workflows.js.map +1 -0
- package/dist/payment/common.d.ts +14 -13
- package/dist/payment/common.d.ts.map +1 -1
- package/dist/payment/common.js.map +1 -1
- package/dist/payment/mutations.d.ts +9 -8
- package/dist/payment/mutations.d.ts.map +1 -1
- package/dist/payment/provider.d.ts +6 -5
- package/dist/payment/provider.d.ts.map +1 -1
- package/dist/payment/provider.js.map +1 -1
- package/dist/payment/service.d.ts +1 -0
- package/dist/payment/service.d.ts.map +1 -1
- package/dist/pricing/common/money-amount.d.ts +10 -9
- package/dist/pricing/common/money-amount.d.ts.map +1 -1
- package/dist/pricing/common/price-set.d.ts +9 -8
- package/dist/pricing/common/price-set.d.ts.map +1 -1
- package/dist/pricing/common/price.d.ts +10 -9
- package/dist/pricing/common/price.d.ts.map +1 -1
- package/dist/pricing/workflows.d.ts +10 -20
- package/dist/pricing/workflows.d.ts.map +1 -1
- package/dist/product/common.d.ts +26 -40
- package/dist/product/common.d.ts.map +1 -1
- package/dist/promotion/http.d.ts +14 -0
- package/dist/promotion/http.d.ts.map +1 -0
- package/dist/promotion/http.js +3 -0
- package/dist/promotion/http.js.map +1 -0
- package/dist/promotion/index.d.ts +1 -0
- package/dist/promotion/index.d.ts.map +1 -1
- package/dist/promotion/index.js +1 -0
- package/dist/promotion/index.js.map +1 -1
- package/dist/region/common.d.ts +5 -0
- package/dist/region/common.d.ts.map +1 -1
- package/dist/region/mutations.d.ts +4 -0
- package/dist/region/mutations.d.ts.map +1 -1
- package/dist/tax/common.d.ts +4 -3
- package/dist/tax/common.d.ts.map +1 -1
- package/dist/totals/big-number.d.ts +1 -0
- package/dist/totals/big-number.d.ts.map +1 -1
- package/dist/totals/index.d.ts +24 -0
- package/dist/totals/index.d.ts.map +1 -1
- package/dist/totals/index.js.map +1 -1
- package/dist/workflow/fulfillment/create-shipping-options.d.ts +31 -0
- package/dist/workflow/fulfillment/create-shipping-options.d.ts.map +1 -0
- package/dist/workflow/fulfillment/create-shipping-options.js +3 -0
- package/dist/workflow/fulfillment/create-shipping-options.js.map +1 -0
- package/dist/workflow/fulfillment/index.d.ts +5 -0
- package/dist/workflow/fulfillment/index.d.ts.map +1 -0
- package/dist/workflow/fulfillment/index.js +21 -0
- package/dist/workflow/fulfillment/index.js.map +1 -0
- package/dist/workflow/fulfillment/service-zones.d.ts +21 -0
- package/dist/workflow/fulfillment/service-zones.d.ts.map +1 -0
- package/dist/workflow/fulfillment/service-zones.js +3 -0
- package/dist/workflow/fulfillment/service-zones.js.map +1 -0
- package/dist/workflow/fulfillment/shipping-profiles.d.ts +18 -0
- package/dist/workflow/fulfillment/shipping-profiles.d.ts.map +1 -0
- package/dist/workflow/fulfillment/shipping-profiles.js +3 -0
- package/dist/workflow/fulfillment/shipping-profiles.js.map +1 -0
- package/dist/workflow/fulfillment/update-shipping-options.d.ts +32 -0
- package/dist/workflow/fulfillment/update-shipping-options.d.ts.map +1 -0
- package/dist/workflow/fulfillment/update-shipping-options.js +3 -0
- package/dist/workflow/fulfillment/update-shipping-options.js.map +1 -0
- package/dist/workflow/index.d.ts +1 -0
- package/dist/workflow/index.d.ts.map +1 -1
- package/dist/workflow/index.js +2 -1
- package/dist/workflow/index.js.map +1 -1
- package/package.json +1 -1
package/dist/order/service.d.ts
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
import { FindConfig } from "../common";
|
2
|
+
import { RestoreReturn, SoftDeleteReturn } from "../dal";
|
2
3
|
import { IModuleService } from "../modules-sdk";
|
3
4
|
import { Context } from "../shared-context";
|
4
|
-
import { FilterableOrderAddressProps, FilterableOrderLineItemAdjustmentProps, FilterableOrderLineItemProps, FilterableOrderLineItemTaxLineProps, FilterableOrderProps, FilterableOrderShippingMethodAdjustmentProps, FilterableOrderShippingMethodProps, FilterableOrderShippingMethodTaxLineProps, OrderAddressDTO, OrderChangeDTO, OrderDTO, OrderItemDTO, OrderLineItemAdjustmentDTO, OrderLineItemDTO, OrderLineItemTaxLineDTO, OrderShippingMethodAdjustmentDTO, OrderShippingMethodDTO, OrderShippingMethodTaxLineDTO } from "./common";
|
5
|
-
import { CancelOrderChangeDTO, ConfirmOrderChangeDTO, CreateOrderAddressDTO, CreateOrderAdjustmentDTO, CreateOrderChangeDTO, CreateOrderDTO, CreateOrderLineItemDTO, CreateOrderLineItemForOrderDTO, CreateOrderLineItemTaxLineDTO, CreateOrderShippingMethodAdjustmentDTO, CreateOrderShippingMethodDTO, CreateOrderShippingMethodTaxLineDTO, DeclineOrderChangeDTO, UpdateOrderAddressDTO, UpdateOrderDTO, UpdateOrderItemDTO, UpdateOrderItemWithSelectorDTO, UpdateOrderLineItemDTO, UpdateOrderLineItemTaxLineDTO, UpdateOrderLineItemWithSelectorDTO, UpdateOrderShippingMethodAdjustmentDTO, UpdateOrderShippingMethodTaxLineDTO, UpsertOrderLineItemAdjustmentDTO } from "./mutations";
|
5
|
+
import { FilterableOrderAddressProps, FilterableOrderLineItemAdjustmentProps, FilterableOrderLineItemProps, FilterableOrderLineItemTaxLineProps, FilterableOrderProps, FilterableOrderShippingMethodAdjustmentProps, FilterableOrderShippingMethodProps, FilterableOrderShippingMethodTaxLineProps, OrderAddressDTO, OrderChangeActionDTO, OrderChangeDTO, OrderDTO, OrderItemDTO, OrderLineItemAdjustmentDTO, OrderLineItemDTO, OrderLineItemTaxLineDTO, OrderShippingMethodAdjustmentDTO, OrderShippingMethodDTO, OrderShippingMethodTaxLineDTO } from "./common";
|
6
|
+
import { CancelOrderChangeDTO, ConfirmOrderChangeDTO, CreateOrderAddressDTO, CreateOrderAdjustmentDTO, CreateOrderChangeActionDTO, CreateOrderChangeDTO, CreateOrderDTO, CreateOrderLineItemDTO, CreateOrderLineItemForOrderDTO, CreateOrderLineItemTaxLineDTO, CreateOrderShippingMethodAdjustmentDTO, CreateOrderShippingMethodDTO, CreateOrderShippingMethodTaxLineDTO, DeclineOrderChangeDTO, UpdateOrderAddressDTO, UpdateOrderDTO, UpdateOrderItemDTO, UpdateOrderItemWithSelectorDTO, UpdateOrderLineItemDTO, UpdateOrderLineItemTaxLineDTO, UpdateOrderLineItemWithSelectorDTO, UpdateOrderShippingMethodAdjustmentDTO, UpdateOrderShippingMethodTaxLineDTO, UpsertOrderLineItemAdjustmentDTO } from "./mutations";
|
6
7
|
/**
|
7
8
|
* {summary}
|
8
9
|
*/
|
@@ -157,7 +158,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
157
158
|
* ```
|
158
159
|
*
|
159
160
|
*/
|
160
|
-
update(selector: Partial<
|
161
|
+
update(selector: Partial<FilterableOrderProps>, data: UpdateOrderDTO, sharedContext?: Context): Promise<OrderDTO[]>;
|
161
162
|
/**
|
162
163
|
* This method deletes {return type} by its ID.
|
163
164
|
*
|
@@ -186,21 +187,8 @@ export interface IOrderModuleService extends IModuleService {
|
|
186
187
|
*
|
187
188
|
*/
|
188
189
|
delete(orderId: string, sharedContext?: Context): Promise<void>;
|
189
|
-
|
190
|
-
|
191
|
-
*
|
192
|
-
* @param {FilterableOrderAddressProps} filters - The filters to apply on the retrieved order address.
|
193
|
-
* @param {FindConfig<OrderAddressDTO>} config - The configurations determining how the order address is retrieved. Its properties, such as `select` or `relations`, accept the
|
194
|
-
* attributes or relations associated with a order address.
|
195
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
196
|
-
* @returns {Promise<OrderAddressDTO[]>} The list of {return type}(s).
|
197
|
-
*
|
198
|
-
* @example
|
199
|
-
* ```typescript
|
200
|
-
* await orderModuleService.listAddresses();
|
201
|
-
* ```
|
202
|
-
*
|
203
|
-
*/
|
190
|
+
softDelete<TReturnableLinkableKeys extends string = string>(storeIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
191
|
+
restore<TReturnableLinkableKeys extends string = string>(storeIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
204
192
|
listAddresses(filters?: FilterableOrderAddressProps, config?: FindConfig<OrderAddressDTO>, sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
205
193
|
/**
|
206
194
|
* This method creates {return type}(s)
|
@@ -360,69 +348,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
360
348
|
*
|
361
349
|
*/
|
362
350
|
listLineItems(filters: FilterableOrderLineItemProps, config?: FindConfig<OrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
* @param {CreateOrderLineItemForOrderDTO} data - The order line item for order to be created.
|
367
|
-
* @returns {Promise<OrderLineItemDTO[]>} Represents the completion of an asynchronous operation
|
368
|
-
*
|
369
|
-
* @example
|
370
|
-
* ```typescript
|
371
|
-
* await orderModuleService.addLineItems({
|
372
|
-
* order_id: "123456",
|
373
|
-
* {
|
374
|
-
* product_id: "abc123",
|
375
|
-
* quantity: 2,
|
376
|
-
* unit_price: 1999, // Assuming type is an integer for price in cents
|
377
|
-
* }
|
378
|
-
* });
|
379
|
-
* ```
|
380
|
-
*
|
381
|
-
*/
|
382
|
-
addLineItems(data: CreateOrderLineItemForOrderDTO): Promise<OrderLineItemDTO[]>;
|
383
|
-
/**
|
384
|
-
* This method Represents the completion of an asynchronous operation
|
385
|
-
*
|
386
|
-
* @param {CreateOrderLineItemForOrderDTO[]} data - The order line item for order to be created.
|
387
|
-
* @returns {Promise<OrderLineItemDTO[]>} Represents the completion of an asynchronous operation
|
388
|
-
*
|
389
|
-
* @example
|
390
|
-
* ```typescript
|
391
|
-
* const lineItems: CreateOrderLineItemForOrderDTO[] = [{
|
392
|
-
* order_id: "order_123",
|
393
|
-
* product_id: "prod_456",
|
394
|
-
* quantity: 2,
|
395
|
-
* unit_price: 1999
|
396
|
-
* }];
|
397
|
-
*
|
398
|
-
* const result = await orderModuleService.addLineItems(lineItems);
|
399
|
-
* ```
|
400
|
-
*
|
401
|
-
*/
|
402
|
-
addLineItems(data: CreateOrderLineItemForOrderDTO[]): Promise<OrderLineItemDTO[]>;
|
403
|
-
/**
|
404
|
-
* This method Represents the completion of an asynchronous operation
|
405
|
-
*
|
406
|
-
* @param {string} orderId - The order's ID.
|
407
|
-
* @param {CreateOrderLineItemDTO[]} items - The order line item to be created.
|
408
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
409
|
-
* @returns {Promise<OrderLineItemDTO[]>} Represents the completion of an asynchronous operation
|
410
|
-
*
|
411
|
-
* @example
|
412
|
-
* ```typescript
|
413
|
-
* const result = await orderModuleService.addLineItems("orderIdValue", [
|
414
|
-
* {
|
415
|
-
* title: "Item Title",
|
416
|
-
* requires_shipping: true,
|
417
|
-
* is_discountable: true,
|
418
|
-
* is_tax_inclusive: true,
|
419
|
-
* unit_price: 100,
|
420
|
-
* }
|
421
|
-
* ]);
|
422
|
-
* ```
|
423
|
-
*
|
424
|
-
*/
|
425
|
-
addLineItems(orderId: string, items: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
351
|
+
createLineItems(data: CreateOrderLineItemForOrderDTO): Promise<OrderLineItemDTO[]>;
|
352
|
+
createLineItems(data: CreateOrderLineItemForOrderDTO[]): Promise<OrderLineItemDTO[]>;
|
353
|
+
createLineItems(orderId: string, items: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
426
354
|
/**
|
427
355
|
* This method updates existing {return type}(s).
|
428
356
|
*
|
@@ -466,7 +394,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
466
394
|
* ```
|
467
395
|
*
|
468
396
|
*/
|
469
|
-
updateLineItems(selector: Partial<
|
397
|
+
updateLineItems(selector: Partial<FilterableOrderLineItemProps>, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
470
398
|
/**
|
471
399
|
* This method updates existing {return type}(s).
|
472
400
|
*
|
@@ -487,48 +415,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
487
415
|
*
|
488
416
|
*/
|
489
417
|
updateLineItems(lineId: string, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO>;
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
* @param {string[]} itemIds - The list of {summary}
|
494
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
495
|
-
* @returns {Promise<void>} Resolves when {summary}
|
496
|
-
*
|
497
|
-
* @example
|
498
|
-
* ```typescript
|
499
|
-
* await orderModuleService.removeLineItems(["itemId1", "itemId2"]);
|
500
|
-
* ```
|
501
|
-
*
|
502
|
-
*/
|
503
|
-
removeLineItems(itemIds: string[], sharedContext?: Context): Promise<void>;
|
504
|
-
/**
|
505
|
-
* This method Represents the completion of an asynchronous operation
|
506
|
-
*
|
507
|
-
* @param {string} itemIds - {summary}
|
508
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
509
|
-
* @returns {Promise<void>} Resolves when {summary}
|
510
|
-
*
|
511
|
-
* @example
|
512
|
-
* ```typescript
|
513
|
-
* await orderModuleService.removeLineItems(itemId1);
|
514
|
-
* ```
|
515
|
-
*
|
516
|
-
*/
|
517
|
-
removeLineItems(itemIds: string, sharedContext?: Context): Promise<void>;
|
518
|
-
/**
|
519
|
-
* This method Represents the completion of an asynchronous operation
|
520
|
-
*
|
521
|
-
* @param {Partial<OrderLineItemDTO>} selector - Make all properties in T optional
|
522
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
523
|
-
* @returns {Promise<void>} Resolves when {summary}
|
524
|
-
*
|
525
|
-
* @example
|
526
|
-
* ```typescript
|
527
|
-
* await orderModuleService.removeLineItems({ id: 'item-123' });
|
528
|
-
* ```
|
529
|
-
*
|
530
|
-
*/
|
531
|
-
removeLineItems(selector: Partial<OrderLineItemDTO>, sharedContext?: Context): Promise<void>;
|
418
|
+
deleteLineItems(itemIds: string[], sharedContext?: Context): Promise<void>;
|
419
|
+
deleteLineItems(itemIds: string, sharedContext?: Context): Promise<void>;
|
420
|
+
deleteLineItems(selector: Partial<FilterableOrderLineItemProps>, sharedContext?: Context): Promise<void>;
|
532
421
|
/**
|
533
422
|
* This method updates existing {return type}(s).
|
534
423
|
*
|
@@ -546,7 +435,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
546
435
|
* ```
|
547
436
|
*
|
548
437
|
*/
|
549
|
-
updateOrderItem(selector: Partial<
|
438
|
+
updateOrderItem(selector: Partial<FilterableOrderShippingMethodProps>, data: UpdateOrderItemDTO, sharedContext?: Context): Promise<OrderItemDTO[]>;
|
550
439
|
/**
|
551
440
|
* This method updates existing {return type}(s).
|
552
441
|
*
|
@@ -608,118 +497,12 @@ export interface IOrderModuleService extends IModuleService {
|
|
608
497
|
*
|
609
498
|
*/
|
610
499
|
listShippingMethods(filters: FilterableOrderShippingMethodProps, config: FindConfig<OrderShippingMethodDTO>, sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
* @example
|
618
|
-
* ```typescript
|
619
|
-
* const result = await orderModuleService.addShippingMethods({
|
620
|
-
* name: "Standard Shipping",
|
621
|
-
* shipping_method_id: "1",
|
622
|
-
* order_id: "123",
|
623
|
-
* amount: 1000
|
624
|
-
* });
|
625
|
-
* ```
|
626
|
-
*
|
627
|
-
*/
|
628
|
-
addShippingMethods(data: CreateOrderShippingMethodDTO): Promise<OrderShippingMethodDTO>;
|
629
|
-
/**
|
630
|
-
* This method Represents the completion of an asynchronous operation
|
631
|
-
*
|
632
|
-
* @param {CreateOrderShippingMethodDTO[]} data - The order shipping method to be created.
|
633
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} Represents the completion of an asynchronous operation
|
634
|
-
*
|
635
|
-
* @example
|
636
|
-
* ```typescript
|
637
|
-
* const shippingMethods: CreateOrderShippingMethodDTO[] = [
|
638
|
-
* {
|
639
|
-
* name: 'Standard Shipping',
|
640
|
-
* shipping_method_id: 'std_ship_001',
|
641
|
-
* order_id: 'order_12345',
|
642
|
-
* amount: 1000
|
643
|
-
* },
|
644
|
-
* {
|
645
|
-
* name: 'Express Shipping',
|
646
|
-
* shipping_method_id: 'exp_ship_002',
|
647
|
-
* order_id: 'order_12345',
|
648
|
-
* amount: 1000
|
649
|
-
* }
|
650
|
-
* ];
|
651
|
-
*
|
652
|
-
* const addedShippingMethods = await orderModuleService.addShippingMethods(shippingMethods);
|
653
|
-
* ```
|
654
|
-
*
|
655
|
-
*/
|
656
|
-
addShippingMethods(data: CreateOrderShippingMethodDTO[]): Promise<OrderShippingMethodDTO[]>;
|
657
|
-
/**
|
658
|
-
* This method Represents the completion of an asynchronous operation
|
659
|
-
*
|
660
|
-
* @param {string} orderId - The order's ID.
|
661
|
-
* @param {CreateOrderShippingMethodDTO[]} methods - The order shipping method to be created.
|
662
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
663
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} Represents the completion of an asynchronous operation
|
664
|
-
*
|
665
|
-
* @example
|
666
|
-
* ```typescript
|
667
|
-
* const createOrderShippingMethodDTOs: CreateOrderShippingMethodDTO[] = [{
|
668
|
-
* name: "Standard Shipping",
|
669
|
-
* shipping_method_id: "123",
|
670
|
-
* order_id: "abc",
|
671
|
-
* amount: 1000
|
672
|
-
* }];
|
673
|
-
*
|
674
|
-
* await orderModuleService.addShippingMethods("orderId123", createOrderShippingMethodDTOs);
|
675
|
-
* ```
|
676
|
-
*
|
677
|
-
*/
|
678
|
-
addShippingMethods(orderId: string, methods: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
679
|
-
/**
|
680
|
-
* This method Represents the completion of an asynchronous operation
|
681
|
-
*
|
682
|
-
* @param {string[]} methodIds - The list of {summary}
|
683
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
684
|
-
* @returns {Promise<void>} Resolves when {summary}
|
685
|
-
*
|
686
|
-
* @example
|
687
|
-
* ```typescript
|
688
|
-
* await orderModuleService.removeShippingMethods(['method1', 'method2']);
|
689
|
-
* ```
|
690
|
-
*
|
691
|
-
*/
|
692
|
-
removeShippingMethods(methodIds: string[], sharedContext?: Context): Promise<void>;
|
693
|
-
/**
|
694
|
-
* This method Represents the completion of an asynchronous operation
|
695
|
-
*
|
696
|
-
* @param {string} methodIds - {summary}
|
697
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
698
|
-
* @returns {Promise<void>} Resolves when {summary}
|
699
|
-
*
|
700
|
-
* @example
|
701
|
-
* ```typescript
|
702
|
-
* await orderModuleService.removeShippingMethods("methodId12345");
|
703
|
-
* ```
|
704
|
-
*
|
705
|
-
*/
|
706
|
-
removeShippingMethods(methodIds: string, sharedContext?: Context): Promise<void>;
|
707
|
-
/**
|
708
|
-
* This method Represents the completion of an asynchronous operation
|
709
|
-
*
|
710
|
-
* @param {Partial<OrderShippingMethodDTO>} selector - Make all properties in T optional
|
711
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
712
|
-
* @returns {Promise<void>} Resolves when {summary}
|
713
|
-
*
|
714
|
-
* @example
|
715
|
-
* ```typescript
|
716
|
-
* await orderModuleService.removeShippingMethods({
|
717
|
-
* id: "shipping-method-123",
|
718
|
-
* });
|
719
|
-
* ```
|
720
|
-
*
|
721
|
-
*/
|
722
|
-
removeShippingMethods(selector: Partial<OrderShippingMethodDTO>, sharedContext?: Context): Promise<void>;
|
500
|
+
createShippingMethods(data: CreateOrderShippingMethodDTO): Promise<OrderShippingMethodDTO>;
|
501
|
+
createShippingMethods(data: CreateOrderShippingMethodDTO[]): Promise<OrderShippingMethodDTO[]>;
|
502
|
+
createShippingMethods(orderId: string, methods: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
503
|
+
deleteShippingMethods(methodIds: string[], sharedContext?: Context): Promise<void>;
|
504
|
+
deleteShippingMethods(methodIds: string, sharedContext?: Context): Promise<void>;
|
505
|
+
deleteShippingMethods(selector: Partial<FilterableOrderShippingMethodProps>, sharedContext?: Context): Promise<void>;
|
723
506
|
/**
|
724
507
|
* This method retrieves a paginated list of {return type}(s) based on optional filters and configuration.
|
725
508
|
*
|
@@ -736,56 +519,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
736
519
|
*
|
737
520
|
*/
|
738
521
|
listLineItemAdjustments(filters: FilterableOrderLineItemAdjustmentProps, config?: FindConfig<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
* @param {CreateOrderAdjustmentDTO[]} data - The order adjustment to be created.
|
743
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} Represents the completion of an asynchronous operation
|
744
|
-
*
|
745
|
-
* @example
|
746
|
-
* ```typescript
|
747
|
-
* await orderModuleService.addLineItemAdjustments([
|
748
|
-
* {
|
749
|
-
* amount: 1000,
|
750
|
-
* }
|
751
|
-
* ]);
|
752
|
-
* ```
|
753
|
-
*
|
754
|
-
*/
|
755
|
-
addLineItemAdjustments(data: CreateOrderAdjustmentDTO[]): Promise<OrderLineItemAdjustmentDTO[]>;
|
756
|
-
/**
|
757
|
-
* This method Represents the completion of an asynchronous operation
|
758
|
-
*
|
759
|
-
* @param {CreateOrderAdjustmentDTO} data - The order adjustment to be created.
|
760
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} Represents the completion of an asynchronous operation
|
761
|
-
*
|
762
|
-
* @example
|
763
|
-
* ```typescript
|
764
|
-
* await orderModuleService.addLineItemAdjustments({
|
765
|
-
* amount: 1000,
|
766
|
-
* });
|
767
|
-
* ```
|
768
|
-
*
|
769
|
-
*/
|
770
|
-
addLineItemAdjustments(data: CreateOrderAdjustmentDTO): Promise<OrderLineItemAdjustmentDTO[]>;
|
771
|
-
/**
|
772
|
-
* This method Represents the completion of an asynchronous operation
|
773
|
-
*
|
774
|
-
* @param {string} orderId - The order's ID.
|
775
|
-
* @param {CreateOrderAdjustmentDTO[]} data - The order adjustment to be created.
|
776
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} Represents the completion of an asynchronous operation
|
777
|
-
*
|
778
|
-
* @example
|
779
|
-
* ```typescript
|
780
|
-
* await orderModuleService.addLineItemAdjustments("12345", [
|
781
|
-
* {
|
782
|
-
* amount: 1000,
|
783
|
-
* }
|
784
|
-
* ]);
|
785
|
-
* ```
|
786
|
-
*
|
787
|
-
*/
|
788
|
-
addLineItemAdjustments(orderId: string, data: CreateOrderAdjustmentDTO[]): Promise<OrderLineItemAdjustmentDTO[]>;
|
522
|
+
createLineItemAdjustments(data: CreateOrderAdjustmentDTO[]): Promise<OrderLineItemAdjustmentDTO[]>;
|
523
|
+
createLineItemAdjustments(data: CreateOrderAdjustmentDTO): Promise<OrderLineItemAdjustmentDTO[]>;
|
524
|
+
createLineItemAdjustments(orderId: string, data: CreateOrderAdjustmentDTO[]): Promise<OrderLineItemAdjustmentDTO[]>;
|
789
525
|
/**
|
790
526
|
* This method Represents the completion of an asynchronous operation
|
791
527
|
*
|
@@ -806,49 +542,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
806
542
|
*
|
807
543
|
*/
|
808
544
|
setLineItemAdjustments(orderId: string, data: UpsertOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
* @param {string[]} adjustmentIds - The list of {summary}
|
813
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
814
|
-
* @returns {Promise<void>} Resolves when {summary}
|
815
|
-
*
|
816
|
-
* @example
|
817
|
-
* ```typescript
|
818
|
-
* await orderModuleService.removeLineItemAdjustments(["adjustmentId1", "adjustmentId2"]);
|
819
|
-
*
|
820
|
-
*/
|
821
|
-
removeLineItemAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
822
|
-
/**
|
823
|
-
* This method Represents the completion of an asynchronous operation
|
824
|
-
*
|
825
|
-
* @param {string} adjustmentIds - {summary}
|
826
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
827
|
-
* @returns {Promise<void>} Resolves when {summary}
|
828
|
-
*
|
829
|
-
* @example
|
830
|
-
* ```typescript
|
831
|
-
* await orderModuleService.removeLineItemAdjustments("adjustmentId123");
|
832
|
-
* ```
|
833
|
-
*
|
834
|
-
*/
|
835
|
-
removeLineItemAdjustments(adjustmentIds: string, sharedContext?: Context): Promise<void>;
|
836
|
-
/**
|
837
|
-
* This method Represents the completion of an asynchronous operation
|
838
|
-
*
|
839
|
-
* @param {Partial<OrderLineItemAdjustmentDTO>} selector - Make all properties in T optional
|
840
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
841
|
-
* @returns {Promise<void>} Resolves when {summary}
|
842
|
-
*
|
843
|
-
* @example
|
844
|
-
* ```typescript
|
845
|
-
* await orderModuleService.removeLineItemAdjustments({
|
846
|
-
* item_id: "123"
|
847
|
-
* });
|
848
|
-
* ```
|
849
|
-
*
|
850
|
-
*/
|
851
|
-
removeLineItemAdjustments(selector: Partial<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
545
|
+
deleteLineItemAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
546
|
+
deleteLineItemAdjustments(adjustmentIds: string, sharedContext?: Context): Promise<void>;
|
547
|
+
deleteLineItemAdjustments(selector: Partial<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
852
548
|
/**
|
853
549
|
* This method retrieves a paginated list of {return type}(s) based on optional filters and configuration.
|
854
550
|
*
|
@@ -867,68 +563,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
867
563
|
*
|
868
564
|
*/
|
869
565
|
listShippingMethodAdjustments(filters: FilterableOrderShippingMethodAdjustmentProps, config?: FindConfig<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO[]} data - The order shipping method adjustment to be created.
|
874
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} Represents the completion of an asynchronous operation
|
875
|
-
*
|
876
|
-
* @example
|
877
|
-
* ```typescript
|
878
|
-
* const adjustmentsData: CreateOrderShippingMethodAdjustmentDTO[] = [{
|
879
|
-
* shipping_method_id: '123',
|
880
|
-
* code: "ADJUSTMENT_CODE",
|
881
|
-
* amount: 1000,
|
882
|
-
* description: 'Discount',
|
883
|
-
* promotion_id: 'promo-456'
|
884
|
-
* }];
|
885
|
-
*
|
886
|
-
* const result = await orderModuleService.addShippingMethodAdjustments(adjustmentsData);
|
887
|
-
* ```
|
888
|
-
*
|
889
|
-
*/
|
890
|
-
addShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO[]): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
891
|
-
/**
|
892
|
-
* This method Represents the completion of an asynchronous operation
|
893
|
-
*
|
894
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO} data - The order shipping method adjustment to be created.
|
895
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO>} Represents the completion of an asynchronous operation
|
896
|
-
*
|
897
|
-
* @example
|
898
|
-
* ```typescript
|
899
|
-
* // Example usage of addShippingMethodAdjustments method
|
900
|
-
* const adjustmentData: CreateOrderShippingMethodAdjustmentDTO = {
|
901
|
-
* shipping_method_id: "shipping_method_123",
|
902
|
-
* code: "ADJUSTMENT_CODE",
|
903
|
-
* amount: 1000
|
904
|
-
* };
|
905
|
-
*
|
906
|
-
* const result = await orderModuleService.addShippingMethodAdjustments(adjustmentData);
|
907
|
-
* ```
|
908
|
-
*
|
909
|
-
*/
|
910
|
-
addShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO): Promise<OrderShippingMethodAdjustmentDTO>;
|
911
|
-
/**
|
912
|
-
* This method Represents the completion of an asynchronous operation
|
913
|
-
*
|
914
|
-
* @param {string} orderId - The order's ID.
|
915
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO[]} data - The order shipping method adjustment to be created.
|
916
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
917
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} Represents the completion of an asynchronous operation
|
918
|
-
*
|
919
|
-
* @example
|
920
|
-
* ```typescript
|
921
|
-
* await orderModuleService.addShippingMethodAdjustments("orderId123", [
|
922
|
-
* {
|
923
|
-
* shipping_method_id: "shippingMethodId456",
|
924
|
-
* code: "CODE123",
|
925
|
-
* amount: 1000
|
926
|
-
* }
|
927
|
-
* ]);
|
928
|
-
* ```
|
929
|
-
*
|
930
|
-
*/
|
931
|
-
addShippingMethodAdjustments(orderId: string, data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
566
|
+
createShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO[]): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
567
|
+
createShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO): Promise<OrderShippingMethodAdjustmentDTO>;
|
568
|
+
createShippingMethodAdjustments(orderId: string, data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
932
569
|
/**
|
933
570
|
* This method Represents the completion of an asynchronous operation
|
934
571
|
*
|
@@ -950,48 +587,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
950
587
|
*
|
951
588
|
*/
|
952
589
|
setShippingMethodAdjustments(orderId: string, data: (CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
953
|
-
|
954
|
-
|
955
|
-
|
956
|
-
* @param {string[]} adjustmentIds - The list of {summary}
|
957
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
958
|
-
* @returns {Promise<void>} Resolves when {summary}
|
959
|
-
*
|
960
|
-
* @example
|
961
|
-
* ```typescript
|
962
|
-
* await orderModuleService.removeShippingMethodAdjustments(["adjustmentId1", "adjustmentId2"]);
|
963
|
-
* ```
|
964
|
-
*
|
965
|
-
*/
|
966
|
-
removeShippingMethodAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
967
|
-
/**
|
968
|
-
* This method Represents the completion of an asynchronous operation
|
969
|
-
*
|
970
|
-
* @param {string} adjustmentId - The adjustment's ID.
|
971
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
972
|
-
* @returns {Promise<void>} Resolves when {summary}
|
973
|
-
*
|
974
|
-
* @example
|
975
|
-
* ```typescript
|
976
|
-
* await orderModuleService.removeShippingMethodAdjustments("adjustmentId123");
|
977
|
-
* ```
|
978
|
-
*
|
979
|
-
*/
|
980
|
-
removeShippingMethodAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
981
|
-
/**
|
982
|
-
* This method Represents the completion of an asynchronous operation
|
983
|
-
*
|
984
|
-
* @param {Partial<OrderShippingMethodAdjustmentDTO>} selector - Make all properties in T optional
|
985
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
986
|
-
* @returns {Promise<void>} Resolves when {summary}
|
987
|
-
*
|
988
|
-
* @example
|
989
|
-
* ```typescript
|
990
|
-
* await orderModuleService.removeShippingMethodAdjustments({ id: "adjustment123" });
|
991
|
-
* ```
|
992
|
-
*
|
993
|
-
*/
|
994
|
-
removeShippingMethodAdjustments(selector: Partial<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
590
|
+
deleteShippingMethodAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
591
|
+
deleteShippingMethodAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
592
|
+
deleteShippingMethodAdjustments(selector: Partial<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
995
593
|
/**
|
996
594
|
* This method retrieves a paginated list of {return type}(s) based on optional filters and configuration.
|
997
595
|
*
|
@@ -1008,63 +606,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1008
606
|
*
|
1009
607
|
*/
|
1010
608
|
listLineItemTaxLines(filters: FilterableOrderLineItemTaxLineProps, config?: FindConfig<OrderLineItemTaxLineDTO>, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
* @param {CreateOrderLineItemTaxLineDTO[]} taxLines - The order line item tax line to be created.
|
1015
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} Represents the completion of an asynchronous operation
|
1016
|
-
*
|
1017
|
-
* @example
|
1018
|
-
* ```typescript
|
1019
|
-
* const taxLines: CreateOrderLineItemTaxLineDTO[] = [{
|
1020
|
-
* code: 'VAT',
|
1021
|
-
* rate: 20,
|
1022
|
-
* tax_rate_id: 'tax_rate_id_value'
|
1023
|
-
* }];
|
1024
|
-
*
|
1025
|
-
* const result = await orderModuleService.addLineItemTaxLines(taxLines);
|
1026
|
-
* ```
|
1027
|
-
*
|
1028
|
-
*/
|
1029
|
-
addLineItemTaxLines(taxLines: CreateOrderLineItemTaxLineDTO[]): Promise<OrderLineItemTaxLineDTO[]>;
|
1030
|
-
/**
|
1031
|
-
* This method Represents the completion of an asynchronous operation
|
1032
|
-
*
|
1033
|
-
* @param {CreateOrderLineItemTaxLineDTO} taxLine - The order line item tax line to be created.
|
1034
|
-
* @returns {Promise<OrderLineItemTaxLineDTO>} Represents the completion of an asynchronous operation
|
1035
|
-
*
|
1036
|
-
* @example
|
1037
|
-
* ```typescript
|
1038
|
-
* const taxLine: CreateOrderLineItemTaxLineDTO = {
|
1039
|
-
* code: 'TAX100',
|
1040
|
-
* rate: 10
|
1041
|
-
* };
|
1042
|
-
*
|
1043
|
-
* const response = await orderModuleService.addLineItemTaxLines(taxLine);
|
1044
|
-
* ```
|
1045
|
-
*
|
1046
|
-
*/
|
1047
|
-
addLineItemTaxLines(taxLine: CreateOrderLineItemTaxLineDTO): Promise<OrderLineItemTaxLineDTO>;
|
1048
|
-
/**
|
1049
|
-
* This method Represents the completion of an asynchronous operation
|
1050
|
-
*
|
1051
|
-
* @param {string} orderId - The order's ID.
|
1052
|
-
* @param {CreateOrderLineItemTaxLineDTO | CreateOrderLineItemTaxLineDTO[]} taxLines - The order line item tax line d t o | create order line item tax line to be created.
|
1053
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1054
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} Represents the completion of an asynchronous operation
|
1055
|
-
*
|
1056
|
-
* @example
|
1057
|
-
* ```typescript
|
1058
|
-
* await orderModuleService.addLineItemTaxLines("orderId123", [
|
1059
|
-
* {
|
1060
|
-
* code: "TAX1001",
|
1061
|
-
* rate: 70,
|
1062
|
-
* }
|
1063
|
-
* ]);
|
1064
|
-
* ```
|
1065
|
-
*
|
1066
|
-
*/
|
1067
|
-
addLineItemTaxLines(orderId: string, taxLines: CreateOrderLineItemTaxLineDTO[] | CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
609
|
+
createLineItemTaxLines(taxLines: CreateOrderLineItemTaxLineDTO[]): Promise<OrderLineItemTaxLineDTO[]>;
|
610
|
+
createLineItemTaxLines(taxLine: CreateOrderLineItemTaxLineDTO): Promise<OrderLineItemTaxLineDTO>;
|
611
|
+
createLineItemTaxLines(orderId: string, taxLines: CreateOrderLineItemTaxLineDTO[] | CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1068
612
|
/**
|
1069
613
|
* This method Represents the completion of an asynchronous operation
|
1070
614
|
*
|
@@ -1090,51 +634,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1090
634
|
*
|
1091
635
|
*/
|
1092
636
|
setLineItemTaxLines(orderId: string, taxLines: (CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
* @param {string[]} taxLineIds - The list of {summary}
|
1097
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1098
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1099
|
-
*
|
1100
|
-
* @example
|
1101
|
-
* ```typescript
|
1102
|
-
* // Example usage of removeLineItemTaxLines method from IOrderModuleService
|
1103
|
-
* await orderModuleService.removeLineItemTaxLines(["taxLineId1", "taxLineId2"]);
|
1104
|
-
* ```
|
1105
|
-
*
|
1106
|
-
*/
|
1107
|
-
removeLineItemTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
1108
|
-
/**
|
1109
|
-
* This method Represents the completion of an asynchronous operation
|
1110
|
-
*
|
1111
|
-
* @param {string} taxLineIds - {summary}
|
1112
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1113
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1114
|
-
*
|
1115
|
-
* @example
|
1116
|
-
* ```typescript
|
1117
|
-
* await orderModuleService.removeLineItemTaxLines("yourTaxLineId");
|
1118
|
-
* ```
|
1119
|
-
*
|
1120
|
-
*/
|
1121
|
-
removeLineItemTaxLines(taxLineIds: string, sharedContext?: Context): Promise<void>;
|
1122
|
-
/**
|
1123
|
-
* This method Represents the completion of an asynchronous operation
|
1124
|
-
*
|
1125
|
-
* @param {FilterableOrderLineItemTaxLineProps} selector - The filters to apply on the retrieved order line item tax line.
|
1126
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1127
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1128
|
-
*
|
1129
|
-
* @example
|
1130
|
-
* ```typescript
|
1131
|
-
* await orderModuleService.removeLineItemTaxLines({
|
1132
|
-
* id: "yourTaxLineId"
|
1133
|
-
* });
|
1134
|
-
* ```
|
1135
|
-
*
|
1136
|
-
*/
|
1137
|
-
removeLineItemTaxLines(selector: FilterableOrderLineItemTaxLineProps, sharedContext?: Context): Promise<void>;
|
637
|
+
deleteLineItemTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
638
|
+
deleteLineItemTaxLines(taxLineIds: string, sharedContext?: Context): Promise<void>;
|
639
|
+
deleteLineItemTaxLines(selector: FilterableOrderLineItemTaxLineProps, sharedContext?: Context): Promise<void>;
|
1138
640
|
/**
|
1139
641
|
* This method retrieves a paginated list of {return type}(s) based on optional filters and configuration.
|
1140
642
|
*
|
@@ -1155,67 +657,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1155
657
|
*
|
1156
658
|
*/
|
1157
659
|
listShippingMethodTaxLines(filters: FilterableOrderShippingMethodTaxLineProps, config?: FindConfig<OrderShippingMethodTaxLineDTO>, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1158
|
-
|
1159
|
-
|
1160
|
-
|
1161
|
-
* @param {CreateOrderShippingMethodTaxLineDTO[]} taxLines - The order shipping method tax line to be created.
|
1162
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} Represents the completion of an asynchronous operation
|
1163
|
-
*
|
1164
|
-
* @example
|
1165
|
-
* ```typescript
|
1166
|
-
* const result = await orderModuleService.addShippingMethodTaxLines([
|
1167
|
-
* {
|
1168
|
-
* code: "VAT20",
|
1169
|
-
* rate: 20,
|
1170
|
-
* }
|
1171
|
-
* ]);
|
1172
|
-
* ```
|
1173
|
-
*
|
1174
|
-
*/
|
1175
|
-
addShippingMethodTaxLines(taxLines: CreateOrderShippingMethodTaxLineDTO[]): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1176
|
-
/**
|
1177
|
-
* This method Represents the completion of an asynchronous operation
|
1178
|
-
*
|
1179
|
-
* @param {CreateOrderShippingMethodTaxLineDTO} taxLine - The order shipping method tax line to be created.
|
1180
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO>} Represents the completion of an asynchronous operation
|
1181
|
-
*
|
1182
|
-
* @example
|
1183
|
-
* ```typescript
|
1184
|
-
* const taxLine: CreateOrderShippingMethodTaxLineDTO = {
|
1185
|
-
* code: "VAT20",
|
1186
|
-
* rate: 20,
|
1187
|
-
* };
|
1188
|
-
*
|
1189
|
-
* orderModuleService.addShippingMethodTaxLines(taxLine).then((result) => {
|
1190
|
-
* console.log(result);
|
1191
|
-
* });
|
1192
|
-
* ```
|
1193
|
-
*
|
1194
|
-
*/
|
1195
|
-
addShippingMethodTaxLines(taxLine: CreateOrderShippingMethodTaxLineDTO): Promise<OrderShippingMethodTaxLineDTO>;
|
1196
|
-
/**
|
1197
|
-
* This method Represents the completion of an asynchronous operation
|
1198
|
-
*
|
1199
|
-
* @param {string} orderId - The order's ID.
|
1200
|
-
* @param {CreateOrderShippingMethodTaxLineDTO | CreateOrderShippingMethodTaxLineDTO[]} taxLines - The order shipping method tax line d t o | create order shipping method tax line to be created.
|
1201
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1202
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} Represents the completion of an asynchronous operation
|
1203
|
-
*
|
1204
|
-
* @example
|
1205
|
-
* ```typescript
|
1206
|
-
* const orderId = '123';
|
1207
|
-
* const taxLines = [
|
1208
|
-
* {
|
1209
|
-
* code: "VAT20",
|
1210
|
-
* rate: 20,
|
1211
|
-
* }
|
1212
|
-
* ];
|
1213
|
-
*
|
1214
|
-
* const addedTaxLines = await orderModuleService.addShippingMethodTaxLines(orderId, taxLines);
|
1215
|
-
* ```
|
1216
|
-
*
|
1217
|
-
*/
|
1218
|
-
addShippingMethodTaxLines(orderId: string, taxLines: CreateOrderShippingMethodTaxLineDTO[] | CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
660
|
+
createShippingMethodTaxLines(taxLines: CreateOrderShippingMethodTaxLineDTO[]): Promise<OrderShippingMethodTaxLineDTO[]>;
|
661
|
+
createShippingMethodTaxLines(taxLine: CreateOrderShippingMethodTaxLineDTO): Promise<OrderShippingMethodTaxLineDTO>;
|
662
|
+
createShippingMethodTaxLines(orderId: string, taxLines: CreateOrderShippingMethodTaxLineDTO[] | CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1219
663
|
/**
|
1220
664
|
* This method Represents the completion of an asynchronous operation
|
1221
665
|
*
|
@@ -1239,50 +683,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1239
683
|
*
|
1240
684
|
*/
|
1241
685
|
setShippingMethodTaxLines(orderId: string, taxLines: (CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
1245
|
-
* @param {string[]} taxLineIds - The list of {summary}
|
1246
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1247
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1248
|
-
*
|
1249
|
-
* @example
|
1250
|
-
* ```typescript
|
1251
|
-
* await orderModuleService.removeShippingMethodTaxLines(["taxLine1", "taxLine2"]);
|
1252
|
-
* ```
|
1253
|
-
*
|
1254
|
-
*/
|
1255
|
-
removeShippingMethodTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
1256
|
-
/**
|
1257
|
-
* This method Represents the completion of an asynchronous operation
|
1258
|
-
*
|
1259
|
-
* @param {string} taxLineIds - {summary}
|
1260
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1261
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1262
|
-
*
|
1263
|
-
* @example
|
1264
|
-
* ```typescript
|
1265
|
-
* await orderModuleService.removeShippingMethodTaxLines("12345");
|
1266
|
-
* ```
|
1267
|
-
*
|
1268
|
-
*/
|
1269
|
-
removeShippingMethodTaxLines(taxLineIds: string, sharedContext?: Context): Promise<void>;
|
1270
|
-
/**
|
1271
|
-
* This method Represents the completion of an asynchronous operation
|
1272
|
-
*
|
1273
|
-
* @param {FilterableOrderShippingMethodTaxLineProps} selector - The filters to apply on the retrieved order shipping method tax line.
|
1274
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
1275
|
-
* @returns {Promise<void>} Resolves when {summary}
|
1276
|
-
*
|
1277
|
-
* @example
|
1278
|
-
* ```typescript
|
1279
|
-
* await orderModuleService.removeShippingMethodTaxLines({
|
1280
|
-
* id: "shippingMethodTaxLineId"
|
1281
|
-
* });
|
1282
|
-
* ```
|
1283
|
-
*
|
1284
|
-
*/
|
1285
|
-
removeShippingMethodTaxLines(selector: FilterableOrderShippingMethodTaxLineProps, sharedContext?: Context): Promise<void>;
|
686
|
+
deleteShippingMethodTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
687
|
+
deleteShippingMethodTaxLines(taxLineIds: string, sharedContext?: Context): Promise<void>;
|
688
|
+
deleteShippingMethodTaxLines(selector: FilterableOrderShippingMethodTaxLineProps, sharedContext?: Context): Promise<void>;
|
1286
689
|
createOrderChange(data: CreateOrderChangeDTO, sharedContext?: Context): Promise<OrderChangeDTO>;
|
1287
690
|
/**
|
1288
691
|
* This method creates {return type}(s)
|
@@ -1520,26 +923,21 @@ export interface IOrderModuleService extends IModuleService {
|
|
1520
923
|
*
|
1521
924
|
*/
|
1522
925
|
applyPendingOrderActions(orderId: string | string[], sharedContext?: Context): any;
|
1523
|
-
|
1524
|
-
|
1525
|
-
|
1526
|
-
|
1527
|
-
|
1528
|
-
|
1529
|
-
|
1530
|
-
|
1531
|
-
|
1532
|
-
|
1533
|
-
|
1534
|
-
|
1535
|
-
|
1536
|
-
|
1537
|
-
|
1538
|
-
|
1539
|
-
* });
|
1540
|
-
* ```
|
1541
|
-
*
|
1542
|
-
*/
|
1543
|
-
addOrderAction(data: any, sharedContext?: Context): any;
|
926
|
+
addOrderAction(data: CreateOrderChangeActionDTO, sharedContext?: Context): Promise<OrderChangeActionDTO>;
|
927
|
+
addOrderAction(data: CreateOrderChangeActionDTO[], sharedContext?: Context): Promise<OrderChangeActionDTO[]>;
|
928
|
+
softDeleteAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
929
|
+
restoreAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
930
|
+
softDeleteLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
931
|
+
restoreLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
932
|
+
softDeleteShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
933
|
+
restoreShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
934
|
+
softDeleteLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
935
|
+
restoreLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
936
|
+
softDeleteShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
937
|
+
restoreShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
938
|
+
softDeleteLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
939
|
+
restoreLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
940
|
+
softDeleteShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
941
|
+
restoreShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
1544
942
|
}
|
1545
943
|
//# sourceMappingURL=service.d.ts.map
|