@medusajs/types 1.12.0-snapshot-20240827104434 → 1.12.0-snapshot-20240904063643
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/auth/provider.d.ts +5 -0
- package/dist/auth/provider.d.ts.map +1 -1
- package/dist/auth/providers/github.d.ts +7 -0
- package/dist/auth/providers/github.d.ts.map +1 -0
- package/dist/{http/api-key/admin/api-key.js → auth/providers/github.js} +1 -1
- package/dist/auth/providers/github.js.map +1 -0
- package/dist/auth/providers/google.d.ts +2 -2
- package/dist/auth/providers/index.d.ts +1 -0
- package/dist/auth/providers/index.d.ts.map +1 -1
- package/dist/auth/providers/index.js +1 -0
- package/dist/auth/providers/index.js.map +1 -1
- package/dist/auth/service.d.ts +1 -0
- package/dist/auth/service.d.ts.map +1 -1
- package/dist/cart/common.d.ts +4 -0
- package/dist/cart/common.d.ts.map +1 -1
- package/dist/cart/service.d.ts +1 -1
- package/dist/cart/service.d.ts.map +1 -1
- package/dist/customer/mutations.d.ts +4 -0
- package/dist/customer/mutations.d.ts.map +1 -1
- package/dist/http/address/entities.d.ts +18 -0
- package/dist/http/address/entities.d.ts.map +1 -0
- package/dist/http/address/entities.js +3 -0
- package/dist/http/address/entities.js.map +1 -0
- package/dist/http/address/index.d.ts +2 -0
- package/dist/http/address/index.d.ts.map +1 -0
- package/dist/http/address/index.js +18 -0
- package/dist/http/address/index.js.map +1 -0
- package/dist/http/api-key/admin/index.d.ts +3 -1
- package/dist/http/api-key/admin/index.d.ts.map +1 -1
- package/dist/http/api-key/admin/index.js +3 -1
- package/dist/http/api-key/admin/index.js.map +1 -1
- package/dist/http/api-key/admin/payloads.d.ts +12 -0
- package/dist/http/api-key/admin/payloads.d.ts.map +1 -0
- package/dist/http/api-key/admin/payloads.js +3 -0
- package/dist/http/api-key/admin/payloads.js.map +1 -0
- package/dist/http/api-key/admin/queries.d.ts +17 -0
- package/dist/http/api-key/admin/queries.d.ts.map +1 -0
- package/dist/http/api-key/admin/queries.js +3 -0
- package/dist/http/api-key/admin/queries.js.map +1 -0
- package/dist/http/api-key/admin/{api-key.d.ts → responses.d.ts} +6 -5
- package/dist/http/api-key/admin/responses.d.ts.map +1 -0
- package/dist/http/api-key/admin/responses.js +3 -0
- package/dist/http/api-key/admin/responses.js.map +1 -0
- package/dist/http/auth/index.d.ts +2 -0
- package/dist/http/auth/index.d.ts.map +1 -0
- package/dist/http/auth/index.js +18 -0
- package/dist/http/auth/index.js.map +1 -0
- package/dist/http/auth/payloads.d.ts +7 -0
- package/dist/http/auth/payloads.d.ts.map +1 -0
- package/dist/http/auth/payloads.js +3 -0
- package/dist/http/auth/payloads.js.map +1 -0
- package/dist/http/campaign/admin/index.d.ts +1 -0
- package/dist/http/campaign/admin/index.d.ts.map +1 -1
- package/dist/http/campaign/admin/index.js +1 -0
- package/dist/http/campaign/admin/index.js.map +1 -1
- package/dist/http/campaign/admin/queries.d.ts +14 -0
- package/dist/http/campaign/admin/queries.d.ts.map +1 -0
- package/dist/http/campaign/admin/queries.js +3 -0
- package/dist/http/campaign/admin/queries.js.map +1 -0
- package/dist/http/campaign/admin/responses.d.ts +5 -4
- package/dist/http/campaign/admin/responses.d.ts.map +1 -1
- package/dist/http/cart/store/responses.d.ts +2 -0
- package/dist/http/cart/store/responses.d.ts.map +1 -1
- package/dist/http/collection/store/queries.d.ts +3 -1
- package/dist/http/collection/store/queries.d.ts.map +1 -1
- package/dist/http/common/response.d.ts +3 -1
- package/dist/http/common/response.d.ts.map +1 -1
- package/dist/http/currency/store/index.d.ts +1 -0
- package/dist/http/currency/store/index.d.ts.map +1 -1
- package/dist/http/currency/store/index.js +1 -0
- package/dist/http/currency/store/index.js.map +1 -1
- package/dist/http/currency/store/queries.d.ts +7 -0
- package/dist/http/currency/store/queries.d.ts.map +1 -0
- package/dist/http/currency/store/queries.js +3 -0
- package/dist/http/currency/store/queries.js.map +1 -0
- package/dist/http/customer/admin/entities.d.ts +2 -3
- package/dist/http/customer/admin/entities.d.ts.map +1 -1
- package/dist/http/customer/admin/queries.d.ts +2 -1
- package/dist/http/customer/admin/queries.d.ts.map +1 -1
- package/dist/http/customer/admin/responses.d.ts +5 -8
- package/dist/http/customer/admin/responses.d.ts.map +1 -1
- package/dist/http/customer/common.d.ts +2 -1
- package/dist/http/customer/common.d.ts.map +1 -1
- package/dist/http/customer/store/responses.d.ts +2 -1
- package/dist/http/customer/store/responses.d.ts.map +1 -1
- package/dist/http/customer-group/admin/entities.d.ts +4 -0
- package/dist/http/customer-group/admin/entities.d.ts.map +1 -0
- package/dist/http/customer-group/admin/entities.js +3 -0
- package/dist/http/customer-group/admin/entities.js.map +1 -0
- package/dist/http/customer-group/admin/index.d.ts +5 -0
- package/dist/http/customer-group/admin/index.d.ts.map +1 -0
- package/dist/http/customer-group/admin/index.js +21 -0
- package/dist/http/customer-group/admin/index.js.map +1 -0
- package/dist/http/customer-group/admin/payloads.d.ts +9 -0
- package/dist/http/customer-group/admin/payloads.d.ts.map +1 -0
- package/dist/http/customer-group/admin/payloads.js +3 -0
- package/dist/http/customer-group/admin/payloads.js.map +1 -0
- package/dist/http/customer-group/admin/queries.d.ts +32 -0
- package/dist/http/customer-group/admin/queries.d.ts.map +1 -0
- package/dist/http/customer-group/admin/queries.js +3 -0
- package/dist/http/customer-group/admin/queries.js.map +1 -0
- package/dist/http/customer-group/admin/responses.d.ts +9 -0
- package/dist/http/customer-group/admin/responses.d.ts.map +1 -0
- package/dist/http/customer-group/admin/responses.js +3 -0
- package/dist/http/customer-group/admin/responses.js.map +1 -0
- package/dist/http/customer-group/common.d.ts +10 -0
- package/dist/http/customer-group/common.d.ts.map +1 -0
- package/dist/http/customer-group/common.js +3 -0
- package/dist/http/customer-group/common.js.map +1 -0
- package/dist/http/customer-group/index.d.ts +2 -0
- package/dist/http/customer-group/index.d.ts.map +1 -0
- package/dist/http/customer-group/index.js +18 -0
- package/dist/http/customer-group/index.js.map +1 -0
- package/dist/http/file/admin/responses.d.ts +2 -0
- package/dist/http/file/admin/responses.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/index.d.ts +1 -0
- package/dist/http/fulfillment/admin/index.d.ts.map +1 -1
- package/dist/http/fulfillment/admin/index.js +1 -0
- package/dist/http/fulfillment/admin/index.js.map +1 -1
- package/dist/http/fulfillment/admin/queries.d.ts +7 -0
- package/dist/http/fulfillment/admin/queries.d.ts.map +1 -0
- package/dist/http/fulfillment/admin/queries.js +3 -0
- package/dist/http/fulfillment/admin/queries.js.map +1 -0
- package/dist/http/fulfillment-set/admin/responses.d.ts +2 -2
- package/dist/http/fulfillment-set/admin/responses.d.ts.map +1 -1
- package/dist/http/index.d.ts +3 -0
- package/dist/http/index.d.ts.map +1 -1
- package/dist/http/index.js +3 -0
- package/dist/http/index.js.map +1 -1
- package/dist/http/inventory/admin/entities.d.ts +18 -0
- package/dist/http/inventory/admin/entities.d.ts.map +1 -1
- package/dist/http/inventory/admin/queries.d.ts +2 -2
- package/dist/http/inventory/admin/queries.d.ts.map +1 -1
- package/dist/http/inventory/admin/responses.d.ts +2 -1
- package/dist/http/inventory/admin/responses.d.ts.map +1 -1
- package/dist/http/invite/admin/index.d.ts +1 -0
- package/dist/http/invite/admin/index.d.ts.map +1 -1
- package/dist/http/invite/admin/index.js +1 -0
- package/dist/http/invite/admin/index.js.map +1 -1
- package/dist/http/invite/admin/queries.d.ts +11 -0
- package/dist/http/invite/admin/queries.d.ts.map +1 -0
- package/dist/http/invite/admin/queries.js +3 -0
- package/dist/http/invite/admin/queries.js.map +1 -0
- package/dist/http/invite/admin/responses.d.ts +2 -1
- package/dist/http/invite/admin/responses.d.ts.map +1 -1
- package/dist/http/order/admin/entities.d.ts +14 -0
- package/dist/http/order/admin/entities.d.ts.map +1 -1
- package/dist/http/order/admin/queries.d.ts +15 -1
- package/dist/http/order/admin/queries.d.ts.map +1 -1
- package/dist/http/order/admin/responses.d.ts +4 -0
- package/dist/http/order/admin/responses.d.ts.map +1 -1
- package/dist/http/order/common.d.ts +10 -4
- package/dist/http/order/common.d.ts.map +1 -1
- package/dist/http/order/store/queries.d.ts +5 -2
- package/dist/http/order/store/queries.d.ts.map +1 -1
- package/dist/http/order-edit/admin/responses.d.ts +2 -5
- package/dist/http/order-edit/admin/responses.d.ts.map +1 -1
- package/dist/http/payment/admin/queries.d.ts +18 -7
- package/dist/http/payment/admin/queries.d.ts.map +1 -1
- package/dist/http/payment/admin/responses.d.ts +1 -0
- package/dist/http/payment/admin/responses.d.ts.map +1 -1
- package/dist/http/payment/store/index.d.ts +1 -0
- package/dist/http/payment/store/index.d.ts.map +1 -1
- package/dist/http/payment/store/index.js +1 -0
- package/dist/http/payment/store/index.js.map +1 -1
- package/dist/http/payment/store/payloads.d.ts +4 -0
- package/dist/http/payment/store/payloads.d.ts.map +1 -0
- package/dist/http/payment/store/payloads.js +3 -0
- package/dist/http/payment/store/payloads.js.map +1 -0
- package/dist/http/payment/store/queries.d.ts +1 -0
- package/dist/http/payment/store/queries.d.ts.map +1 -1
- package/dist/http/pricing/admin/queries.d.ts +1 -0
- package/dist/http/pricing/admin/queries.d.ts.map +1 -1
- package/dist/http/product/admin/queries.d.ts +13 -4
- package/dist/http/product/admin/queries.d.ts.map +1 -1
- package/dist/http/product/admin/responses.d.ts +3 -3
- package/dist/http/product/admin/responses.d.ts.map +1 -1
- package/dist/http/product/store/queries.d.ts +1 -0
- package/dist/http/product/store/queries.d.ts.map +1 -1
- package/dist/http/product-category/common.d.ts +1 -0
- package/dist/http/product-category/common.d.ts.map +1 -1
- package/dist/http/promotion/admin/index.d.ts +2 -0
- package/dist/http/promotion/admin/index.d.ts.map +1 -1
- package/dist/http/promotion/admin/index.js +2 -0
- package/dist/http/promotion/admin/index.js.map +1 -1
- package/dist/http/promotion/admin/payloads.d.ts +69 -0
- package/dist/http/promotion/admin/payloads.d.ts.map +1 -0
- package/dist/http/promotion/admin/payloads.js +3 -0
- package/dist/http/promotion/admin/payloads.js.map +1 -0
- package/dist/http/promotion/admin/queries.d.ts +30 -0
- package/dist/http/promotion/admin/queries.d.ts.map +1 -0
- package/dist/http/promotion/admin/queries.js +3 -0
- package/dist/http/promotion/admin/queries.js.map +1 -0
- package/dist/http/promotion/admin/responses.d.ts +2 -1
- package/dist/http/promotion/admin/responses.d.ts.map +1 -1
- package/dist/http/promotion/common.d.ts +2 -2
- package/dist/http/promotion/common.d.ts.map +1 -1
- package/dist/http/region/admin/queries.d.ts +10 -1
- package/dist/http/region/admin/queries.d.ts.map +1 -1
- package/dist/http/region/admin/responses.d.ts +2 -1
- package/dist/http/region/admin/responses.d.ts.map +1 -1
- package/dist/http/region/common.d.ts +2 -3
- package/dist/http/region/common.d.ts.map +1 -1
- package/dist/http/reservation/admin/entities.d.ts +2 -2
- package/dist/http/reservation/admin/entities.d.ts.map +1 -1
- package/dist/http/reservation/admin/index.d.ts +2 -0
- package/dist/http/reservation/admin/index.d.ts.map +1 -1
- package/dist/http/reservation/admin/index.js +2 -0
- package/dist/http/reservation/admin/index.js.map +1 -1
- package/dist/http/reservation/admin/payloads.d.ts +15 -0
- package/dist/http/reservation/admin/payloads.d.ts.map +1 -0
- package/dist/http/reservation/admin/payloads.js +3 -0
- package/dist/http/reservation/admin/payloads.js.map +1 -0
- package/dist/http/reservation/admin/queries.d.ts +17 -0
- package/dist/http/reservation/admin/queries.d.ts.map +1 -0
- package/dist/http/reservation/admin/queries.js +3 -0
- package/dist/http/reservation/admin/queries.js.map +1 -0
- package/dist/http/reservation/admin/responses.d.ts +5 -4
- package/dist/http/reservation/admin/responses.d.ts.map +1 -1
- package/dist/http/return/admin/responses.d.ts +2 -1
- package/dist/http/return/admin/responses.d.ts.map +1 -1
- package/dist/http/return/common.d.ts +2 -0
- package/dist/http/return/common.d.ts.map +1 -1
- package/dist/http/return/store/index.d.ts +1 -0
- package/dist/http/return/store/index.d.ts.map +1 -1
- package/dist/http/return/store/index.js +1 -0
- package/dist/http/return/store/index.js.map +1 -1
- package/dist/http/return/store/payloads.d.ts +20 -0
- package/dist/http/return/store/payloads.d.ts.map +1 -0
- package/dist/http/return/store/payloads.js +3 -0
- package/dist/http/return/store/payloads.js.map +1 -0
- package/dist/http/shipping-option/admin/queries.d.ts +6 -4
- package/dist/http/shipping-option/admin/queries.d.ts.map +1 -1
- package/dist/http/shipping-option/store/index.d.ts +1 -0
- package/dist/http/shipping-option/store/index.d.ts.map +1 -1
- package/dist/http/shipping-option/store/index.js +1 -0
- package/dist/http/shipping-option/store/index.js.map +1 -1
- package/dist/http/shipping-option/store/queries.d.ts +6 -0
- package/dist/http/shipping-option/store/queries.d.ts.map +1 -0
- package/dist/http/shipping-option/store/queries.js +3 -0
- package/dist/http/shipping-option/store/queries.js.map +1 -0
- package/dist/http/stock-locations/admin/queries.d.ts +5 -1
- package/dist/http/stock-locations/admin/queries.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/queries.d.ts +6 -7
- package/dist/http/tax-rate/admin/queries.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/responses.d.ts +2 -1
- package/dist/http/tax-rate/admin/responses.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/entities.d.ts +54 -4
- package/dist/http/workflow-execution/admin/entities.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/index.d.ts +1 -0
- package/dist/http/workflow-execution/admin/index.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/index.js +1 -0
- package/dist/http/workflow-execution/admin/index.js.map +1 -1
- package/dist/http/workflow-execution/admin/queries.d.ts +6 -0
- package/dist/http/workflow-execution/admin/queries.d.ts.map +1 -0
- package/dist/http/workflow-execution/admin/queries.js +3 -0
- package/dist/http/workflow-execution/admin/queries.js.map +1 -0
- package/dist/http/workflow-execution/admin/responses.d.ts.map +1 -1
- package/dist/notification/common.d.ts +39 -0
- package/dist/notification/common.d.ts.map +1 -1
- package/dist/notification/provider.d.ts +9 -0
- package/dist/notification/provider.d.ts.map +1 -1
- package/dist/order/common.d.ts +8 -0
- package/dist/order/common.d.ts.map +1 -1
- package/dist/order/mutations.d.ts +3 -0
- package/dist/order/mutations.d.ts.map +1 -1
- package/dist/order/service.d.ts +175 -175
- package/dist/order/service.d.ts.map +1 -1
- package/dist/promotion/common/promotion.d.ts +1 -1
- package/dist/promotion/common/promotion.d.ts.map +1 -1
- package/dist/shared-context.d.ts +5 -0
- package/dist/shared-context.d.ts.map +1 -1
- package/dist/workflow/order/cancel-claim.d.ts +1 -0
- package/dist/workflow/order/cancel-claim.d.ts.map +1 -1
- package/dist/workflow/order/cancel-exchange.d.ts +1 -0
- package/dist/workflow/order/cancel-exchange.d.ts.map +1 -1
- package/dist/workflow/order/cancel-fulfillment.d.ts +1 -0
- package/dist/workflow/order/cancel-fulfillment.d.ts.map +1 -1
- package/dist/workflow/order/cancel-order.d.ts +1 -0
- package/dist/workflow/order/cancel-order.d.ts.map +1 -1
- package/dist/workflow/order/cancel-return.d.ts +1 -0
- package/dist/workflow/order/cancel-return.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/http/api-key/admin/api-key.d.ts.map +0 -1
- package/dist/http/api-key/admin/api-key.js.map +0 -1
package/dist/order/service.d.ts
CHANGED
@@ -635,7 +635,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
635
635
|
* To retrieve a list of addresses using their IDs:
|
636
636
|
*
|
637
637
|
* ```ts
|
638
|
-
* const addresses = await orderModuleService.
|
638
|
+
* const addresses = await orderModuleService.listOrderAddresses({
|
639
639
|
* id: ["123", "321"]
|
640
640
|
* })
|
641
641
|
* ```
|
@@ -643,7 +643,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
643
643
|
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
644
644
|
*
|
645
645
|
* ```ts
|
646
|
-
* const addresses = await orderModuleService.
|
646
|
+
* const addresses = await orderModuleService.listOrderAddresses({
|
647
647
|
* id: ["123", "321"]
|
648
648
|
* }, {
|
649
649
|
* take: 20,
|
@@ -651,7 +651,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
651
651
|
* })
|
652
652
|
* ```
|
653
653
|
*/
|
654
|
-
|
654
|
+
listOrderAddresses(filters?: FilterableOrderAddressProps, config?: FindConfig<OrderAddressDTO>, sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
655
655
|
/**
|
656
656
|
* This method creates addresses.
|
657
657
|
*
|
@@ -661,7 +661,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
661
661
|
*
|
662
662
|
* @example
|
663
663
|
* ```typescript
|
664
|
-
* const addresses = await orderModuleService.
|
664
|
+
* const addresses = await orderModuleService.createOrderAddresses([
|
665
665
|
* {
|
666
666
|
* first_name: "John",
|
667
667
|
* last_name: "Doe",
|
@@ -675,7 +675,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
675
675
|
* ```
|
676
676
|
*
|
677
677
|
*/
|
678
|
-
|
678
|
+
createOrderAddresses(data: CreateOrderAddressDTO[], sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
679
679
|
/**
|
680
680
|
* This method creates a return.
|
681
681
|
*
|
@@ -685,7 +685,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
685
685
|
*
|
686
686
|
* @example
|
687
687
|
* ```typescript
|
688
|
-
* const address = await orderModuleService.
|
688
|
+
* const address = await orderModuleService.createOrderAddresses({
|
689
689
|
* first_name: "John",
|
690
690
|
* last_name: "Doe",
|
691
691
|
* address_1: "123 Main St",
|
@@ -697,7 +697,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
697
697
|
* ```
|
698
698
|
*
|
699
699
|
*/
|
700
|
-
|
700
|
+
createOrderAddresses(data: CreateOrderAddressDTO, sharedContext?: Context): Promise<OrderAddressDTO>;
|
701
701
|
/**
|
702
702
|
* This method updates existing addresses. The address ID is specified in each address object.
|
703
703
|
*
|
@@ -707,14 +707,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
707
707
|
*
|
708
708
|
* @example
|
709
709
|
* ```typescript
|
710
|
-
* const addresses = await orderModuleService.
|
710
|
+
* const addresses = await orderModuleService.updateOrderAddresses([{
|
711
711
|
* id: "123",
|
712
712
|
* first_name: "John",
|
713
713
|
* }])
|
714
714
|
* ```
|
715
715
|
*
|
716
716
|
*/
|
717
|
-
|
717
|
+
updateOrderAddresses(data: UpdateOrderAddressDTO[], sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
718
718
|
/**
|
719
719
|
* This method updates an existing address.
|
720
720
|
*
|
@@ -724,14 +724,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
724
724
|
*
|
725
725
|
* @example
|
726
726
|
* ```typescript
|
727
|
-
* const address = await orderModuleService.
|
727
|
+
* const address = await orderModuleService.updateOrderAddresses({
|
728
728
|
* id: "123",
|
729
729
|
* first_name: "John",
|
730
730
|
* })
|
731
731
|
* ```
|
732
732
|
*
|
733
733
|
*/
|
734
|
-
|
734
|
+
updateOrderAddresses(data: UpdateOrderAddressDTO, sharedContext?: Context): Promise<OrderAddressDTO>;
|
735
735
|
/**
|
736
736
|
* This method deletes addresses by their IDs.
|
737
737
|
*
|
@@ -741,11 +741,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
741
741
|
*
|
742
742
|
* @example
|
743
743
|
* ```typescript
|
744
|
-
* await orderModuleService.
|
744
|
+
* await orderModuleService.deleteOrderAddresses(["123", "321"])
|
745
745
|
* ```
|
746
746
|
*
|
747
747
|
*/
|
748
|
-
|
748
|
+
deleteOrderAddresses(ids: string[], sharedContext?: Context): Promise<void>;
|
749
749
|
/**
|
750
750
|
* This method deletes an address by its ID.
|
751
751
|
*
|
@@ -755,11 +755,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
755
755
|
*
|
756
756
|
* @example
|
757
757
|
* ```typescript
|
758
|
-
* await orderModuleService.
|
758
|
+
* await orderModuleService.deleteOrderAddresses("123")
|
759
759
|
* ```
|
760
760
|
*
|
761
761
|
*/
|
762
|
-
|
762
|
+
deleteOrderAddresses(ids: string, sharedContext?: Context): Promise<void>;
|
763
763
|
/**
|
764
764
|
* This method retrieves a line item by its ID.
|
765
765
|
*
|
@@ -773,13 +773,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
773
773
|
* A simple example that retrieves an order change by its ID:
|
774
774
|
*
|
775
775
|
* ```ts
|
776
|
-
* const lineItem = await orderModuleService.
|
776
|
+
* const lineItem = await orderModuleService.retrieveOrderLineItem("123")
|
777
777
|
* ```
|
778
778
|
*
|
779
779
|
* To specify relations that should be retrieved:
|
780
780
|
*
|
781
781
|
* ```ts
|
782
|
-
* const lineItem = await orderModuleService.
|
782
|
+
* const lineItem = await orderModuleService.retrieveOrderLineItem(
|
783
783
|
* "123",
|
784
784
|
* {
|
785
785
|
* relations: ["order"]
|
@@ -788,7 +788,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
788
788
|
* ```
|
789
789
|
*
|
790
790
|
*/
|
791
|
-
|
791
|
+
retrieveOrderLineItem(itemId: string, config?: FindConfig<OrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO>;
|
792
792
|
/**
|
793
793
|
* This method retrieves a paginated list of line items based on optional filters and configuration.
|
794
794
|
*
|
@@ -802,7 +802,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
802
802
|
* To retrieve a list of line items using their IDs:
|
803
803
|
*
|
804
804
|
* ```ts
|
805
|
-
* const lineItems = await orderModuleService.
|
805
|
+
* const lineItems = await orderModuleService.listOrderLineItems({
|
806
806
|
* id: ["123", "321"]
|
807
807
|
* })
|
808
808
|
* ```
|
@@ -810,7 +810,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
810
810
|
* To specify relations that should be retrieved within the line item:
|
811
811
|
*
|
812
812
|
* ```ts
|
813
|
-
* const lineItems = await orderModuleService.
|
813
|
+
* const lineItems = await orderModuleService.listOrderLineItems({
|
814
814
|
* id: ["123", "321"]
|
815
815
|
* }, {
|
816
816
|
* relations: ["order"]
|
@@ -820,7 +820,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
820
820
|
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
821
821
|
*
|
822
822
|
* ```ts
|
823
|
-
* const lineItems = await orderModuleService.
|
823
|
+
* const lineItems = await orderModuleService.listOrderLineItems({
|
824
824
|
* id: ["123", "321"]
|
825
825
|
* }, {
|
826
826
|
* relations: ["order"],
|
@@ -830,7 +830,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
830
830
|
* ```
|
831
831
|
*
|
832
832
|
*/
|
833
|
-
|
833
|
+
listOrderLineItems(filters: FilterableOrderLineItemProps, config?: FindConfig<OrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
834
834
|
/**
|
835
835
|
* This method creates a line item.
|
836
836
|
*
|
@@ -839,13 +839,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
839
839
|
* @returns {Promise<OrderLineItemDTO[]>} The created line items.
|
840
840
|
*
|
841
841
|
* @example
|
842
|
-
* const lineItems = await orderModuleService.
|
842
|
+
* const lineItems = await orderModuleService.createOrderLineItems({
|
843
843
|
* title: "Shirt",
|
844
844
|
* quantity: 1,
|
845
845
|
* unit_price: 20
|
846
846
|
* })
|
847
847
|
*/
|
848
|
-
|
848
|
+
createOrderLineItems(data: CreateOrderLineItemDTO, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
849
849
|
/**
|
850
850
|
* This method creates line items.
|
851
851
|
*
|
@@ -854,13 +854,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
854
854
|
* @returns {Promise<OrderLineItemDTO[]>} The created line items.
|
855
855
|
*
|
856
856
|
* @example
|
857
|
-
* const lineItems = await orderModuleService.
|
857
|
+
* const lineItems = await orderModuleService.createOrderLineItems([{
|
858
858
|
* title: "Shirt",
|
859
859
|
* quantity: 1,
|
860
860
|
* unit_price: 20
|
861
861
|
* }])
|
862
862
|
*/
|
863
|
-
|
863
|
+
createOrderLineItems(data: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
864
864
|
/**
|
865
865
|
* This method creates orders.
|
866
866
|
*
|
@@ -870,7 +870,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
870
870
|
* @returns {Promise<OrderLineItemDTO[]>} The created orders.
|
871
871
|
*
|
872
872
|
* @example
|
873
|
-
* const lineItems = await orderModuleService.
|
873
|
+
* const lineItems = await orderModuleService.createOrderLineItems(
|
874
874
|
* "123",
|
875
875
|
* [{
|
876
876
|
* title: "Shirt",
|
@@ -879,7 +879,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
879
879
|
* }]
|
880
880
|
* )
|
881
881
|
*/
|
882
|
-
|
882
|
+
createOrderLineItems(orderId: string, items: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
883
883
|
/**
|
884
884
|
* This method updates existing line items. The line item to update is specified by the `selector` property of the first parameter.
|
885
885
|
*
|
@@ -888,7 +888,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
888
888
|
*
|
889
889
|
* @example
|
890
890
|
* ```typescript
|
891
|
-
* const lineItems = await orderModuleService.
|
891
|
+
* const lineItems = await orderModuleService.updateOrderLineItems([
|
892
892
|
* {
|
893
893
|
* selector: {
|
894
894
|
* id: "123"
|
@@ -901,7 +901,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
901
901
|
* ```
|
902
902
|
*
|
903
903
|
*/
|
904
|
-
|
904
|
+
updateOrderLineItems(data: UpdateOrderLineItemWithSelectorDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
905
905
|
/**
|
906
906
|
* This method updates existing line items matching the specified filters.
|
907
907
|
*
|
@@ -911,14 +911,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
911
911
|
* @returns {Promise<OrderLineItemDTO[]>} The updated line items.
|
912
912
|
*
|
913
913
|
* @example
|
914
|
-
* const lineItems = await orderModuleService.
|
914
|
+
* const lineItems = await orderModuleService.updateOrderLineItems({
|
915
915
|
* id: "123"
|
916
916
|
* }, {
|
917
917
|
* quantity: 2
|
918
918
|
* })
|
919
919
|
*
|
920
920
|
*/
|
921
|
-
|
921
|
+
updateOrderLineItems(selector: Partial<FilterableOrderLineItemProps>, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
922
922
|
/**
|
923
923
|
* This method updates an existing line item.
|
924
924
|
*
|
@@ -928,7 +928,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
928
928
|
* @returns {Promise<OrderLineItemDTO>} The updated line item.
|
929
929
|
*
|
930
930
|
* @example
|
931
|
-
* const lineItem = await orderModuleService.
|
931
|
+
* const lineItem = await orderModuleService.updateOrderLineItems(
|
932
932
|
* "123",
|
933
933
|
* {
|
934
934
|
* quantity: 2
|
@@ -936,7 +936,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
936
936
|
* )
|
937
937
|
*
|
938
938
|
*/
|
939
|
-
|
939
|
+
updateOrderLineItems(lineId: string, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO>;
|
940
940
|
/**
|
941
941
|
* This method deletes line items by their IDs.
|
942
942
|
*
|
@@ -945,11 +945,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
945
945
|
* @returns {Promise<void>} Resolves when the line items are deleted successfully.
|
946
946
|
*
|
947
947
|
* @example
|
948
|
-
* await orderModuleService.
|
948
|
+
* await orderModuleService.deleteOrderLineItems([
|
949
949
|
* "123", "321"
|
950
950
|
* ])
|
951
951
|
*/
|
952
|
-
|
952
|
+
deleteOrderLineItems(itemIds: string[], sharedContext?: Context): Promise<void>;
|
953
953
|
/**
|
954
954
|
* This method deletes a line item by its ID.
|
955
955
|
*
|
@@ -958,9 +958,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
958
958
|
* @returns {Promise<void>} Resolves when the line item is deleted successfully.
|
959
959
|
*
|
960
960
|
* @example
|
961
|
-
* await orderModuleService.
|
961
|
+
* await orderModuleService.deleteOrderLineItems("123")
|
962
962
|
*/
|
963
|
-
|
963
|
+
deleteOrderLineItems(itemId: string, sharedContext?: Context): Promise<void>;
|
964
964
|
/**
|
965
965
|
* This method deletes line items that match the specified filters.
|
966
966
|
*
|
@@ -969,11 +969,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
969
969
|
* @returns {Promise<void>} Resolves when the line items are deleted successfully.
|
970
970
|
*
|
971
971
|
* @example
|
972
|
-
* await orderModuleService.
|
972
|
+
* await orderModuleService.deleteOrderLineItems({
|
973
973
|
* id: ["123", "321"]
|
974
974
|
* })
|
975
975
|
*/
|
976
|
-
|
976
|
+
deleteOrderLineItems(selector: Partial<FilterableOrderLineItemProps>, sharedContext?: Context): Promise<void>;
|
977
977
|
/**
|
978
978
|
* This method updates existing order items matching the specified filters.
|
979
979
|
*
|
@@ -1041,7 +1041,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1041
1041
|
* To retrieve a list of shipping methods using their IDs:
|
1042
1042
|
*
|
1043
1043
|
* ```ts
|
1044
|
-
* const shippingMethods = await orderModuleService.
|
1044
|
+
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
1045
1045
|
* id: ["123", "321"]
|
1046
1046
|
* }, {})
|
1047
1047
|
* ```
|
@@ -1049,7 +1049,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1049
1049
|
* To specify relations that should be retrieved within the shipping method:
|
1050
1050
|
*
|
1051
1051
|
* ```ts
|
1052
|
-
* const shippingMethods = await orderModuleService.
|
1052
|
+
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
1053
1053
|
* id: ["123", "321"]
|
1054
1054
|
* }, {
|
1055
1055
|
* relations: ["adjustments"]
|
@@ -1059,7 +1059,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1059
1059
|
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
1060
1060
|
*
|
1061
1061
|
* ```ts
|
1062
|
-
* const shippingMethods = await orderModuleService.
|
1062
|
+
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
1063
1063
|
* id: ["123", "321"]
|
1064
1064
|
* }, {
|
1065
1065
|
* relations: ["adjustments"],
|
@@ -1069,7 +1069,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1069
1069
|
* ```
|
1070
1070
|
*
|
1071
1071
|
*/
|
1072
|
-
|
1072
|
+
listOrderShippingMethods(filters: FilterableOrderShippingMethodProps, config: FindConfig<OrderShippingMethodDTO>, sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
1073
1073
|
/**
|
1074
1074
|
* This method creates a shipping method.
|
1075
1075
|
*
|
@@ -1077,13 +1077,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
1077
1077
|
* @returns {Promise<OrderShippingMethodDTO>} The created shipping method.
|
1078
1078
|
*
|
1079
1079
|
* @example
|
1080
|
-
* const shippingMethod = await orderModuleService.
|
1080
|
+
* const shippingMethod = await orderModuleService.createOrderShippingMethods({
|
1081
1081
|
* name: "Express Shipping",
|
1082
1082
|
* order_id: "123",
|
1083
1083
|
* amount: 10
|
1084
1084
|
* })
|
1085
1085
|
*/
|
1086
|
-
|
1086
|
+
createOrderShippingMethods(data: CreateOrderShippingMethodDTO, sharedContext?: Context): Promise<OrderShippingMethodDTO>;
|
1087
1087
|
/**
|
1088
1088
|
* This method creates shipping methods.
|
1089
1089
|
*
|
@@ -1091,13 +1091,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
1091
1091
|
* @returns {Promise<OrderShippingMethodDTO[]>} The created orders.
|
1092
1092
|
*
|
1093
1093
|
* @example
|
1094
|
-
* const shippingMethods = await orderModuleService.
|
1094
|
+
* const shippingMethods = await orderModuleService.createOrderShippingMethods([{
|
1095
1095
|
* name: "Express Shipping",
|
1096
1096
|
* order_id: "123",
|
1097
1097
|
* amount: 10
|
1098
1098
|
* }])
|
1099
1099
|
*/
|
1100
|
-
|
1100
|
+
createOrderShippingMethods(data: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
1101
1101
|
/**
|
1102
1102
|
* This method creates shipping methods for an order.
|
1103
1103
|
*
|
@@ -1107,7 +1107,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1107
1107
|
* @returns {Promise<OrderShippingMethodDTO[]>} The created shipping methods.
|
1108
1108
|
*
|
1109
1109
|
* @example
|
1110
|
-
* const shippingMethods = await orderModuleService.
|
1110
|
+
* const shippingMethods = await orderModuleService.createOrderShippingMethods(
|
1111
1111
|
* "123",
|
1112
1112
|
* [
|
1113
1113
|
* {
|
@@ -1118,7 +1118,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1118
1118
|
* ]
|
1119
1119
|
* )
|
1120
1120
|
*/
|
1121
|
-
|
1121
|
+
createOrderShippingMethods(orderId: string, methods: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
1122
1122
|
/**
|
1123
1123
|
* This method updates existing shipping methods. The shipping method IDs are specified in each shipping method object.
|
1124
1124
|
*
|
@@ -1127,12 +1127,12 @@ export interface IOrderModuleService extends IModuleService {
|
|
1127
1127
|
* @returns {Promise<OrderShippingMethodDTO[]>} The updated shipping methods.
|
1128
1128
|
*
|
1129
1129
|
* @example
|
1130
|
-
* const shippingMethods = await orderModuleService.
|
1130
|
+
* const shippingMethods = await orderModuleService.updateOrderShippingMethods([{
|
1131
1131
|
* id: "123",
|
1132
1132
|
* name: "Express Shipping"
|
1133
1133
|
* }])
|
1134
1134
|
*/
|
1135
|
-
|
1135
|
+
updateOrderShippingMethods(data: UpdateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
1136
1136
|
/**
|
1137
1137
|
* This method updates an existing shipping method.
|
1138
1138
|
*
|
@@ -1141,12 +1141,12 @@ export interface IOrderModuleService extends IModuleService {
|
|
1141
1141
|
* @returns {Promise<OrderShippingMethodDTO>} The updated shipping method.
|
1142
1142
|
*
|
1143
1143
|
* @example
|
1144
|
-
* const shippingMethod = await orderModuleService.
|
1144
|
+
* const shippingMethod = await orderModuleService.updateOrderShippingMethods({
|
1145
1145
|
* id: "123",
|
1146
1146
|
* name: "Express Shipping"
|
1147
1147
|
* })
|
1148
1148
|
*/
|
1149
|
-
|
1149
|
+
updateOrderShippingMethods(data: UpdateOrderShippingMethodDTO, sharedContext?: Context): Promise<OrderShippingMethodDTO>;
|
1150
1150
|
/**
|
1151
1151
|
* This method deletes shipping methods by their IDs.
|
1152
1152
|
*
|
@@ -1155,11 +1155,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1155
1155
|
* @returns {Promise<void>} Resolves when the shipping methods are deleted successfully.
|
1156
1156
|
*
|
1157
1157
|
* @example
|
1158
|
-
* await orderModuleService.
|
1158
|
+
* await orderModuleService.deleteOrderShippingMethods([
|
1159
1159
|
* "123", "321"
|
1160
1160
|
* ])
|
1161
1161
|
*/
|
1162
|
-
|
1162
|
+
deleteOrderShippingMethods(methodIds: string[], sharedContext?: Context): Promise<void>;
|
1163
1163
|
/**
|
1164
1164
|
* This method deletes a shipping method by its ID.
|
1165
1165
|
*
|
@@ -1168,9 +1168,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1168
1168
|
* @returns {Promise<void>} Resolves when the shipping method is deleted successfully.
|
1169
1169
|
*
|
1170
1170
|
* @example
|
1171
|
-
* await orderModuleService.
|
1171
|
+
* await orderModuleService.deleteOrderShippingMethods("123")
|
1172
1172
|
*/
|
1173
|
-
|
1173
|
+
deleteOrderShippingMethods(methodId: string, sharedContext?: Context): Promise<void>;
|
1174
1174
|
/**
|
1175
1175
|
* This method deletes shipping methods matching the specified filters.
|
1176
1176
|
*
|
@@ -1179,11 +1179,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1179
1179
|
* @returns {Promise<void>} Resolves when the shipping methods are deleted successfully.
|
1180
1180
|
*
|
1181
1181
|
* @example
|
1182
|
-
* await orderModuleService.
|
1182
|
+
* await orderModuleService.deleteOrderShippingMethods({
|
1183
1183
|
* id: "123"
|
1184
1184
|
* })
|
1185
1185
|
*/
|
1186
|
-
|
1186
|
+
deleteOrderShippingMethods(selector: Partial<FilterableOrderShippingMethodProps>, sharedContext?: Context): Promise<void>;
|
1187
1187
|
/**
|
1188
1188
|
* This method retrieves a paginated list of line item adjustments based on optional filters and configuration.
|
1189
1189
|
*
|
@@ -1197,7 +1197,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1197
1197
|
* To retrieve a list of line item adjustments using their IDs:
|
1198
1198
|
*
|
1199
1199
|
* ```ts
|
1200
|
-
* const lineItemAdjustment = await orderModuleService.
|
1200
|
+
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
1201
1201
|
* id: ["123", "321"]
|
1202
1202
|
* })
|
1203
1203
|
* ```
|
@@ -1205,7 +1205,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1205
1205
|
* To specify relations that should be retrieved within the line item adjustment:
|
1206
1206
|
*
|
1207
1207
|
* ```ts
|
1208
|
-
* const lineItemAdjustment = await orderModuleService.
|
1208
|
+
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
1209
1209
|
* id: ["123", "321"]
|
1210
1210
|
* }, {
|
1211
1211
|
* relations: ["item"]
|
@@ -1215,7 +1215,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1215
1215
|
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
1216
1216
|
*
|
1217
1217
|
* ```ts
|
1218
|
-
* const lineItemAdjustment = await orderModuleService.
|
1218
|
+
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
1219
1219
|
* id: ["123", "321"]
|
1220
1220
|
* }, {
|
1221
1221
|
* relations: ["item"],
|
@@ -1225,7 +1225,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1225
1225
|
* ```
|
1226
1226
|
*
|
1227
1227
|
*/
|
1228
|
-
|
1228
|
+
listOrderLineItemAdjustments(filters: FilterableOrderLineItemAdjustmentProps, config?: FindConfig<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
1229
1229
|
/**
|
1230
1230
|
* This method creates line item adjustments.
|
1231
1231
|
*
|
@@ -1233,11 +1233,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1233
1233
|
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line item adjustments.
|
1234
1234
|
*
|
1235
1235
|
* @example
|
1236
|
-
* const lineItemAdjustments = await orderModuleService.
|
1236
|
+
* const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments([{
|
1237
1237
|
* amount: 5
|
1238
1238
|
* }])
|
1239
1239
|
*/
|
1240
|
-
|
1240
|
+
createOrderLineItemAdjustments(data: CreateOrderAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
1241
1241
|
/**
|
1242
1242
|
* This method creates a line item adjustment.
|
1243
1243
|
*
|
@@ -1245,11 +1245,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1245
1245
|
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line-item adjustment.
|
1246
1246
|
*
|
1247
1247
|
* @example
|
1248
|
-
* const lineItemAdjustment = await orderModuleService.
|
1248
|
+
* const lineItemAdjustment = await orderModuleService.createOrderLineItemAdjustments({
|
1249
1249
|
* amount: 5
|
1250
1250
|
* })
|
1251
1251
|
*/
|
1252
|
-
|
1252
|
+
createOrderLineItemAdjustments(data: CreateOrderAdjustmentDTO, sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
1253
1253
|
/**
|
1254
1254
|
* This method creates line item adjustments for an order.
|
1255
1255
|
*
|
@@ -1258,14 +1258,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
1258
1258
|
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line item adjustments.
|
1259
1259
|
*
|
1260
1260
|
* @example
|
1261
|
-
* const lineItemAdjustments = await orderModuleService.
|
1261
|
+
* const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments(
|
1262
1262
|
* "123",
|
1263
1263
|
* [{
|
1264
1264
|
* amount: 5
|
1265
1265
|
* }]
|
1266
1266
|
* )
|
1267
1267
|
*/
|
1268
|
-
|
1268
|
+
createOrderLineItemAdjustments(orderId: string, data: CreateOrderAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
1269
1269
|
/**
|
1270
1270
|
* This method sets the line item adjustments of an order.
|
1271
1271
|
*
|
@@ -1276,7 +1276,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1276
1276
|
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The order's line item adjustments.
|
1277
1277
|
*
|
1278
1278
|
* @example
|
1279
|
-
* const lineItemAdjustments = await orderModuleService.
|
1279
|
+
* const lineItemAdjustments = await orderModuleService.setOrderLineItemAdjustments(
|
1280
1280
|
* "123",
|
1281
1281
|
* [
|
1282
1282
|
* {
|
@@ -1292,7 +1292,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1292
1292
|
* )
|
1293
1293
|
*
|
1294
1294
|
*/
|
1295
|
-
|
1295
|
+
setOrderLineItemAdjustments(orderId: string, data: UpsertOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
1296
1296
|
/**
|
1297
1297
|
* This method deletes a line item adjustment by its ID.
|
1298
1298
|
*
|
@@ -1301,11 +1301,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1301
1301
|
* @returns {Promise<void>} Resolves when the line item adjustments are deleted successfully.
|
1302
1302
|
*
|
1303
1303
|
* @example
|
1304
|
-
* await orderModuleService.
|
1304
|
+
* await orderModuleService.deleteOrderLineItemAdjustments([
|
1305
1305
|
* "123", "321"
|
1306
1306
|
* ])
|
1307
1307
|
*/
|
1308
|
-
|
1308
|
+
deleteOrderLineItemAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
1309
1309
|
/**
|
1310
1310
|
* This method deletes a line item adjustment by its ID.
|
1311
1311
|
*
|
@@ -1314,9 +1314,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1314
1314
|
* @returns {Promise<void>} Resolves when the line item adjustment is deleted.
|
1315
1315
|
*
|
1316
1316
|
* @example
|
1317
|
-
* await orderModuleService.
|
1317
|
+
* await orderModuleService.deleteOrderLineItemAdjustments("123")
|
1318
1318
|
*/
|
1319
|
-
|
1319
|
+
deleteOrderLineItemAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
1320
1320
|
/**
|
1321
1321
|
* This method deletes line item adjustments matching the specified filters.
|
1322
1322
|
*
|
@@ -1325,11 +1325,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1325
1325
|
* @returns {Promise<void>} Resolves when the line item adjustments are deleted successfully.
|
1326
1326
|
*
|
1327
1327
|
* @example
|
1328
|
-
* await orderModuleService.
|
1328
|
+
* await orderModuleService.deleteOrderLineItemAdjustments({
|
1329
1329
|
* id: "123"
|
1330
1330
|
* })
|
1331
1331
|
*/
|
1332
|
-
|
1332
|
+
deleteOrderLineItemAdjustments(selector: Partial<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
1333
1333
|
/**
|
1334
1334
|
* This method retrieves a paginated list of shipping method adjustments based on optional filters and configuration.
|
1335
1335
|
*
|
@@ -1344,7 +1344,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1344
1344
|
*
|
1345
1345
|
* ```ts
|
1346
1346
|
* const shippingMethodAdjustments = await orderModuleService
|
1347
|
-
* .
|
1347
|
+
* .listOrderShippingMethodAdjustments({
|
1348
1348
|
* id: ["123", "321"]
|
1349
1349
|
* })
|
1350
1350
|
* ```
|
@@ -1353,7 +1353,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1353
1353
|
*
|
1354
1354
|
* ```ts
|
1355
1355
|
* const shippingMethodAdjustments = await orderModuleService
|
1356
|
-
* .
|
1356
|
+
* .listOrderShippingMethodAdjustments({
|
1357
1357
|
* id: ["123", "321"]
|
1358
1358
|
* }, {
|
1359
1359
|
* relations: ["shipping_method"]
|
@@ -1364,7 +1364,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1364
1364
|
*
|
1365
1365
|
* ```ts
|
1366
1366
|
* const shippingMethodAdjustments = await orderModuleService
|
1367
|
-
* .
|
1367
|
+
* .listOrderShippingMethodAdjustments({
|
1368
1368
|
* id: ["123", "321"]
|
1369
1369
|
* }, {
|
1370
1370
|
* relations: ["shipping_method"],
|
@@ -1374,7 +1374,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1374
1374
|
* ```
|
1375
1375
|
*
|
1376
1376
|
*/
|
1377
|
-
|
1377
|
+
listOrderShippingMethodAdjustments(filters: FilterableOrderShippingMethodAdjustmentProps, config?: FindConfig<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
1378
1378
|
/**
|
1379
1379
|
* This method creates shipping method adjustments.
|
1380
1380
|
*
|
@@ -1383,7 +1383,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1383
1383
|
*
|
1384
1384
|
* @example
|
1385
1385
|
* const shippingMethodAdjustments = await orderModuleService
|
1386
|
-
* .
|
1386
|
+
* .createOrderShippingMethodAdjustments([
|
1387
1387
|
* {
|
1388
1388
|
* shipping_method_id: "123",
|
1389
1389
|
* code: "50OFF",
|
@@ -1391,7 +1391,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1391
1391
|
* }
|
1392
1392
|
* ])
|
1393
1393
|
*/
|
1394
|
-
|
1394
|
+
createOrderShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
1395
1395
|
/**
|
1396
1396
|
* This method creates a shipping method adjustment.
|
1397
1397
|
*
|
@@ -1400,13 +1400,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
1400
1400
|
*
|
1401
1401
|
* @example
|
1402
1402
|
* const shippingMethodAdjustment = await orderModuleService
|
1403
|
-
* .
|
1403
|
+
* .createOrderShippingMethodAdjustments({
|
1404
1404
|
* shipping_method_id: "123",
|
1405
1405
|
* code: "50OFF",
|
1406
1406
|
* amount: 5
|
1407
1407
|
* })
|
1408
1408
|
*/
|
1409
|
-
|
1409
|
+
createOrderShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO, sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO>;
|
1410
1410
|
/**
|
1411
1411
|
* This method creates shipping method adjustments for an order.
|
1412
1412
|
*
|
@@ -1417,7 +1417,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1417
1417
|
*
|
1418
1418
|
* @example
|
1419
1419
|
* const shippingMethodAdjustments = await orderModuleService
|
1420
|
-
* .
|
1420
|
+
* .createOrderShippingMethodAdjustments(
|
1421
1421
|
* "123",
|
1422
1422
|
* [{
|
1423
1423
|
* shipping_method_id: "123",
|
@@ -1426,7 +1426,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1426
1426
|
* }]
|
1427
1427
|
* )
|
1428
1428
|
*/
|
1429
|
-
|
1429
|
+
createOrderShippingMethodAdjustments(orderId: string, data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
1430
1430
|
/**
|
1431
1431
|
* This method sets the shipping method adjustments of an order.
|
1432
1432
|
*
|
@@ -1438,7 +1438,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1438
1438
|
*
|
1439
1439
|
* @example
|
1440
1440
|
* const shippingMethodAdjustments = await orderModuleService
|
1441
|
-
* .
|
1441
|
+
* .setOrderShippingMethodAdjustments(
|
1442
1442
|
* "123",
|
1443
1443
|
* [
|
1444
1444
|
* {
|
@@ -1454,7 +1454,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1454
1454
|
* )
|
1455
1455
|
*
|
1456
1456
|
*/
|
1457
|
-
|
1457
|
+
setOrderShippingMethodAdjustments(orderId: string, data: (CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
1458
1458
|
/**
|
1459
1459
|
* This method deletes shipping method adjustments by their IDs.
|
1460
1460
|
*
|
@@ -1463,11 +1463,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1463
1463
|
* @returns {Promise<void>} Resolves when the shipping method adjustments are deleted successfully.
|
1464
1464
|
*
|
1465
1465
|
* @example
|
1466
|
-
* await orderModuleService.
|
1466
|
+
* await orderModuleService.deleteOrderShippingMethodAdjustments([
|
1467
1467
|
* "123", "321"
|
1468
1468
|
* ])
|
1469
1469
|
*/
|
1470
|
-
|
1470
|
+
deleteOrderShippingMethodAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
1471
1471
|
/**
|
1472
1472
|
* This method deletes a shipping method adjustment by its ID.
|
1473
1473
|
*
|
@@ -1476,9 +1476,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1476
1476
|
* @returns {Promise<void>} Resolves when the shipping method adjustment is deleted successfully
|
1477
1477
|
*
|
1478
1478
|
* @example
|
1479
|
-
* await orderModuleService.
|
1479
|
+
* await orderModuleService.deleteOrderShippingMethodAdjustments("123")
|
1480
1480
|
*/
|
1481
|
-
|
1481
|
+
deleteOrderShippingMethodAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
1482
1482
|
/**
|
1483
1483
|
* This method deletes shipping method adjustments matching the specified filters.
|
1484
1484
|
*
|
@@ -1487,11 +1487,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1487
1487
|
* @returns {Promise<void>} Resolves when the shipping method adjustments are deleted.
|
1488
1488
|
*
|
1489
1489
|
* @example
|
1490
|
-
* await orderModuleService.
|
1490
|
+
* await orderModuleService.deleteOrderShippingMethodAdjustments({
|
1491
1491
|
* id: "123"
|
1492
1492
|
* })
|
1493
1493
|
*/
|
1494
|
-
|
1494
|
+
deleteOrderShippingMethodAdjustments(selector: Partial<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
1495
1495
|
/**
|
1496
1496
|
* This method retrieves a paginated list of line item taxes based on optional filters and configuration.
|
1497
1497
|
*
|
@@ -1506,7 +1506,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1506
1506
|
*
|
1507
1507
|
* ```ts
|
1508
1508
|
* const lineItemTaxLines = await orderModuleService
|
1509
|
-
* .
|
1509
|
+
* .listOrderLineItemTaxLines({
|
1510
1510
|
* id: ["123", "321"]
|
1511
1511
|
* })
|
1512
1512
|
* ```
|
@@ -1515,7 +1515,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1515
1515
|
*
|
1516
1516
|
* ```ts
|
1517
1517
|
* const lineItemTaxLines = await orderModuleService
|
1518
|
-
* .
|
1518
|
+
* .listOrderLineItemTaxLines({
|
1519
1519
|
* id: ["123", "321"]
|
1520
1520
|
* }, {
|
1521
1521
|
* relations: ["item"]
|
@@ -1526,7 +1526,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1526
1526
|
*
|
1527
1527
|
* ```ts
|
1528
1528
|
* const lineItemTaxLines = await orderModuleService
|
1529
|
-
* .
|
1529
|
+
* .listOrderLineItemTaxLines({
|
1530
1530
|
* id: ["123", "321"]
|
1531
1531
|
* }, {
|
1532
1532
|
* relations: ["item"],
|
@@ -1536,7 +1536,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1536
1536
|
* ```
|
1537
1537
|
*
|
1538
1538
|
*/
|
1539
|
-
|
1539
|
+
listOrderLineItemTaxLines(filters: FilterableOrderLineItemTaxLineProps, config?: FindConfig<OrderLineItemTaxLineDTO>, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1540
1540
|
/**
|
1541
1541
|
* This method creates line item tax lines.
|
1542
1542
|
*
|
@@ -1545,14 +1545,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
1545
1545
|
*
|
1546
1546
|
* @example
|
1547
1547
|
* const lineItemTaxLines = await orderModuleService
|
1548
|
-
* .
|
1548
|
+
* .createOrderLineItemTaxLines([
|
1549
1549
|
* {
|
1550
1550
|
* code: "123",
|
1551
1551
|
* rate: 2
|
1552
1552
|
* }
|
1553
1553
|
* ])
|
1554
1554
|
*/
|
1555
|
-
|
1555
|
+
createOrderLineItemTaxLines(taxLines: CreateOrderLineItemTaxLineDTO[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1556
1556
|
/**
|
1557
1557
|
* This method creates a line item tax line.
|
1558
1558
|
*
|
@@ -1561,12 +1561,12 @@ export interface IOrderModuleService extends IModuleService {
|
|
1561
1561
|
*
|
1562
1562
|
* @example
|
1563
1563
|
* const lineItemTaxLines = await orderModuleService
|
1564
|
-
* .
|
1564
|
+
* .createOrderLineItemTaxLines({
|
1565
1565
|
* code: "123",
|
1566
1566
|
* rate: 2
|
1567
1567
|
* })
|
1568
1568
|
*/
|
1569
|
-
|
1569
|
+
createOrderLineItemTaxLines(taxLine: CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO>;
|
1570
1570
|
/**
|
1571
1571
|
* This method creates line item tax lines for an order.
|
1572
1572
|
*
|
@@ -1577,7 +1577,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1577
1577
|
*
|
1578
1578
|
* @example
|
1579
1579
|
* const lineItemTaxLines = await orderModuleService
|
1580
|
-
* .
|
1580
|
+
* .createOrderLineItemTaxLines(
|
1581
1581
|
* "123",
|
1582
1582
|
* [
|
1583
1583
|
* {
|
@@ -1587,7 +1587,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1587
1587
|
* ]
|
1588
1588
|
* )
|
1589
1589
|
*/
|
1590
|
-
|
1590
|
+
createOrderLineItemTaxLines(orderId: string, taxLines: CreateOrderLineItemTaxLineDTO[] | CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1591
1591
|
/**
|
1592
1592
|
* This method sets the line item tax lines of an order.
|
1593
1593
|
*
|
@@ -1599,7 +1599,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1599
1599
|
*
|
1600
1600
|
* @example
|
1601
1601
|
* const lineItemTaxLines = await orderModuleService
|
1602
|
-
* .
|
1602
|
+
* .setOrderLineItemTaxLines(
|
1603
1603
|
* "123",
|
1604
1604
|
* [
|
1605
1605
|
* {
|
@@ -1610,7 +1610,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1610
1610
|
* )
|
1611
1611
|
*
|
1612
1612
|
*/
|
1613
|
-
|
1613
|
+
setOrderLineItemTaxLines(orderId: string, taxLines: (CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
1614
1614
|
/**
|
1615
1615
|
* This method deletes line item tax lines by their IDs.
|
1616
1616
|
*
|
@@ -1619,11 +1619,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1619
1619
|
* @returns {Promise<void>} Resolves when the line item tax lines are deleted successfully.
|
1620
1620
|
*
|
1621
1621
|
* @example
|
1622
|
-
* await orderModuleService.
|
1622
|
+
* await orderModuleService.deleteOrderLineItemTaxLines([
|
1623
1623
|
* "123", "321"
|
1624
1624
|
* ])
|
1625
1625
|
*/
|
1626
|
-
|
1626
|
+
deleteOrderLineItemTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
1627
1627
|
/**
|
1628
1628
|
* This method deletes a line item tax line by its ID.
|
1629
1629
|
*
|
@@ -1632,9 +1632,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1632
1632
|
* @returns {Promise<void>} Resolves when the line item tax line is deleted successfully.
|
1633
1633
|
*
|
1634
1634
|
* @example
|
1635
|
-
* await orderModuleService.
|
1635
|
+
* await orderModuleService.deleteOrderLineItemTaxLines("123")
|
1636
1636
|
*/
|
1637
|
-
|
1637
|
+
deleteOrderLineItemTaxLines(taxLineId: string, sharedContext?: Context): Promise<void>;
|
1638
1638
|
/**
|
1639
1639
|
* This method deletes line item tax lines matching the specified filters.
|
1640
1640
|
*
|
@@ -1643,11 +1643,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1643
1643
|
* @returns {Promise<void>} Resolves when the line item tax lines are deleted successfully.
|
1644
1644
|
*
|
1645
1645
|
* @example
|
1646
|
-
* await orderModuleService.
|
1646
|
+
* await orderModuleService.deleteOrderLineItemTaxLines({
|
1647
1647
|
* id: ["123", "321"]
|
1648
1648
|
* })
|
1649
1649
|
*/
|
1650
|
-
|
1650
|
+
deleteOrderLineItemTaxLines(selector: FilterableOrderLineItemTaxLineProps, sharedContext?: Context): Promise<void>;
|
1651
1651
|
/**
|
1652
1652
|
* This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration.
|
1653
1653
|
*
|
@@ -1662,7 +1662,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1662
1662
|
*
|
1663
1663
|
* ```ts
|
1664
1664
|
* const shippingMethodTaxLines = await orderModuleService
|
1665
|
-
* .
|
1665
|
+
* .listOrderShippingMethodTaxLines({
|
1666
1666
|
* id: ["123", "321"]
|
1667
1667
|
* })
|
1668
1668
|
* ```
|
@@ -1671,7 +1671,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1671
1671
|
*
|
1672
1672
|
* ```ts
|
1673
1673
|
* const shippingMethodTaxLines = await orderModuleService
|
1674
|
-
* .
|
1674
|
+
* .listOrderShippingMethodTaxLines({
|
1675
1675
|
* id: ["123", "321"]
|
1676
1676
|
* }, {
|
1677
1677
|
* relations: ["shipping_method"]
|
@@ -1682,7 +1682,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1682
1682
|
*
|
1683
1683
|
* ```ts
|
1684
1684
|
* const shippingMethodTaxLines = await orderModuleService
|
1685
|
-
* .
|
1685
|
+
* .listOrderShippingMethodTaxLines({
|
1686
1686
|
* id: ["123", "321"]
|
1687
1687
|
* }, {
|
1688
1688
|
* relations: ["shipping_method"],
|
@@ -1692,7 +1692,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1692
1692
|
* ```
|
1693
1693
|
*
|
1694
1694
|
*/
|
1695
|
-
|
1695
|
+
listOrderShippingMethodTaxLines(filters: FilterableOrderShippingMethodTaxLineProps, config?: FindConfig<OrderShippingMethodTaxLineDTO>, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1696
1696
|
/**
|
1697
1697
|
* This method creates shipping method tax lines.
|
1698
1698
|
*
|
@@ -1701,14 +1701,14 @@ export interface IOrderModuleService extends IModuleService {
|
|
1701
1701
|
*
|
1702
1702
|
* @example
|
1703
1703
|
* const shippingMethodTaxLines = await orderModuleService
|
1704
|
-
* .
|
1704
|
+
* .createOrderShippingMethodTaxLines([
|
1705
1705
|
* {
|
1706
1706
|
* code: "123",
|
1707
1707
|
* rate: 2
|
1708
1708
|
* }
|
1709
1709
|
* ])
|
1710
1710
|
*/
|
1711
|
-
|
1711
|
+
createOrderShippingMethodTaxLines(taxLines: CreateOrderShippingMethodTaxLineDTO[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1712
1712
|
/**
|
1713
1713
|
* This method creates a shipping method tax line.
|
1714
1714
|
*
|
@@ -1717,12 +1717,12 @@ export interface IOrderModuleService extends IModuleService {
|
|
1717
1717
|
*
|
1718
1718
|
* @example
|
1719
1719
|
* const shippingMethodTaxLine = await orderModuleService
|
1720
|
-
* .
|
1720
|
+
* .createOrderShippingMethodTaxLines({
|
1721
1721
|
* code: "123",
|
1722
1722
|
* rate: 2
|
1723
1723
|
* })
|
1724
1724
|
*/
|
1725
|
-
|
1725
|
+
createOrderShippingMethodTaxLines(taxLine: CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO>;
|
1726
1726
|
/**
|
1727
1727
|
* This method creates shipping method tax lines for an order.
|
1728
1728
|
*
|
@@ -1733,7 +1733,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1733
1733
|
*
|
1734
1734
|
* @example
|
1735
1735
|
* const shippingMethodTaxLines = await orderModuleService
|
1736
|
-
* .
|
1736
|
+
* .createOrderShippingMethodTaxLines(
|
1737
1737
|
* "123",
|
1738
1738
|
* [{
|
1739
1739
|
* code: "123",
|
@@ -1741,7 +1741,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1741
1741
|
* }]
|
1742
1742
|
* )
|
1743
1743
|
*/
|
1744
|
-
|
1744
|
+
createOrderShippingMethodTaxLines(orderId: string, taxLines: CreateOrderShippingMethodTaxLineDTO[] | CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1745
1745
|
/**
|
1746
1746
|
* This method set the shipping method tax lines of an order.
|
1747
1747
|
*
|
@@ -1753,7 +1753,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1753
1753
|
*
|
1754
1754
|
* @example
|
1755
1755
|
* const shippingMethodTaxLines = await orderModuleService
|
1756
|
-
* .
|
1756
|
+
* .setOrderShippingMethodTaxLines(
|
1757
1757
|
* "123",
|
1758
1758
|
* [
|
1759
1759
|
* {
|
@@ -1768,7 +1768,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
1768
1768
|
* )
|
1769
1769
|
*
|
1770
1770
|
*/
|
1771
|
-
|
1771
|
+
setOrderShippingMethodTaxLines(orderId: string, taxLines: (CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
1772
1772
|
/**
|
1773
1773
|
* This method deletes shipping method tax lines by their IDs.
|
1774
1774
|
*
|
@@ -1777,11 +1777,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1777
1777
|
* @returns {Promise<void>} Resolves when the shipping method tax lines are deleted successfully.
|
1778
1778
|
*
|
1779
1779
|
* @example
|
1780
|
-
* await orderModuleService.
|
1780
|
+
* await orderModuleService.deleteOrderShippingMethodTaxLines([
|
1781
1781
|
* "123", "321"
|
1782
1782
|
* ])
|
1783
1783
|
*/
|
1784
|
-
|
1784
|
+
deleteOrderShippingMethodTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
1785
1785
|
/**
|
1786
1786
|
* This method deletes a shipping method tax line by its ID.
|
1787
1787
|
*
|
@@ -1790,9 +1790,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
1790
1790
|
* @returns {Promise<void>} Resolves when the shipping method tax line is deleted successfully.
|
1791
1791
|
*
|
1792
1792
|
* @example
|
1793
|
-
* await orderModuleService.
|
1793
|
+
* await orderModuleService.deleteOrderShippingMethodTaxLines("123")
|
1794
1794
|
*/
|
1795
|
-
|
1795
|
+
deleteOrderShippingMethodTaxLines(taxLineId: string, sharedContext?: Context): Promise<void>;
|
1796
1796
|
/**
|
1797
1797
|
* This method deletes shipping method tax line matching the specified filters.
|
1798
1798
|
*
|
@@ -1801,11 +1801,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
1801
1801
|
* @returns {Promise<void>} Resolves when the shipping method tax lines are deleted successfully.
|
1802
1802
|
*
|
1803
1803
|
* @example
|
1804
|
-
* await orderModuleService.
|
1804
|
+
* await orderModuleService.deleteOrderShippingMethodTaxLines({
|
1805
1805
|
* id: ["123", "321"]
|
1806
1806
|
* })
|
1807
1807
|
*/
|
1808
|
-
|
1808
|
+
deleteOrderShippingMethodTaxLines(selector: FilterableOrderShippingMethodTaxLineProps, sharedContext?: Context): Promise<void>;
|
1809
1809
|
/**
|
1810
1810
|
* This method retrieves a paginated list of order changes based on optional filters and configuration.
|
1811
1811
|
*
|
@@ -2443,11 +2443,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2443
2443
|
* If there are no related records, the promise resolves to `void`.
|
2444
2444
|
*
|
2445
2445
|
* @example
|
2446
|
-
* await orderModuleService.
|
2446
|
+
* await orderModuleService.softDeleteOrderAddresses([
|
2447
2447
|
* "123", "321"
|
2448
2448
|
* ])
|
2449
2449
|
*/
|
2450
|
-
|
2450
|
+
softDeleteOrderAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2451
2451
|
/**
|
2452
2452
|
* This method restores soft-deleted addresses by their IDs.
|
2453
2453
|
*
|
@@ -2462,11 +2462,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2462
2462
|
* If there are no related records restored, the promise resolves to `void`.
|
2463
2463
|
*
|
2464
2464
|
* @example
|
2465
|
-
* await orderModuleService.
|
2465
|
+
* await orderModuleService.restoreOrderAddresses([
|
2466
2466
|
* "123", "321"
|
2467
2467
|
* ])
|
2468
2468
|
*/
|
2469
|
-
|
2469
|
+
restoreOrderAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2470
2470
|
/**
|
2471
2471
|
* This method soft deletes line items by their IDs.
|
2472
2472
|
*
|
@@ -2480,11 +2480,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2480
2480
|
* If there are no related records, the promise resolves to `void`.
|
2481
2481
|
*
|
2482
2482
|
* @example
|
2483
|
-
* await orderModuleService.
|
2483
|
+
* await orderModuleService.softDeleteOrderLineItems([
|
2484
2484
|
* "123", "321"
|
2485
2485
|
* ])
|
2486
2486
|
*/
|
2487
|
-
|
2487
|
+
softDeleteOrderLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2488
2488
|
/**
|
2489
2489
|
* This method restores soft-deleted line item by their IDs.
|
2490
2490
|
*
|
@@ -2499,11 +2499,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2499
2499
|
* If there are no related records restored, the promise resolves to `void`.
|
2500
2500
|
*
|
2501
2501
|
* @example
|
2502
|
-
* await orderModuleService.
|
2502
|
+
* await orderModuleService.restoreOrderLineItems([
|
2503
2503
|
* "123", "321"
|
2504
2504
|
* ])
|
2505
2505
|
*/
|
2506
|
-
|
2506
|
+
restoreOrderLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2507
2507
|
/**
|
2508
2508
|
* This method soft-deletes shipping methods by their IDs.
|
2509
2509
|
*
|
@@ -2517,11 +2517,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2517
2517
|
* If there are no related records, the promise resolves to `void`.
|
2518
2518
|
*
|
2519
2519
|
* @example
|
2520
|
-
* await orderModuleService.
|
2520
|
+
* await orderModuleService.softDeleteOrderShippingMethods([
|
2521
2521
|
* "123", "321"
|
2522
2522
|
* ])
|
2523
2523
|
*/
|
2524
|
-
|
2524
|
+
softDeleteOrderShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2525
2525
|
/**
|
2526
2526
|
* This method restores soft-deleted shipping methods by their IDs.
|
2527
2527
|
*
|
@@ -2536,11 +2536,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2536
2536
|
* If there are no related records restored, the promise resolves to `void`.
|
2537
2537
|
*
|
2538
2538
|
* @example
|
2539
|
-
* await orderModuleService.
|
2539
|
+
* await orderModuleService.restoreOrderShippingMethods([
|
2540
2540
|
* "123", "321"
|
2541
2541
|
* ])
|
2542
2542
|
*/
|
2543
|
-
|
2543
|
+
restoreOrderShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2544
2544
|
/**
|
2545
2545
|
* This method soft-deletes line item adjustments by their IDs.
|
2546
2546
|
*
|
@@ -2554,11 +2554,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2554
2554
|
* If there are no related records, the promise resolves to `void`.
|
2555
2555
|
*
|
2556
2556
|
* @example
|
2557
|
-
* await orderModuleService.
|
2557
|
+
* await orderModuleService.softDeleteOrderLineItemAdjustments([
|
2558
2558
|
* "123", "321"
|
2559
2559
|
* ])
|
2560
2560
|
*/
|
2561
|
-
|
2561
|
+
softDeleteOrderLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2562
2562
|
/**
|
2563
2563
|
* This method restores soft-deleted line item adjustments by their IDs.
|
2564
2564
|
*
|
@@ -2573,11 +2573,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2573
2573
|
* If there are no related records restored, the promise resolves to `void`.
|
2574
2574
|
*
|
2575
2575
|
* @example
|
2576
|
-
* await orderModuleService.
|
2576
|
+
* await orderModuleService.restoreOrderLineItemAdjustments([
|
2577
2577
|
* "123", "321"
|
2578
2578
|
* ])
|
2579
2579
|
*/
|
2580
|
-
|
2580
|
+
restoreOrderLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2581
2581
|
/**
|
2582
2582
|
* This method soft-deletes shipping method adjustments by their IDs.
|
2583
2583
|
*
|
@@ -2591,11 +2591,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2591
2591
|
* If there are no related records, the promise resolves to `void`.
|
2592
2592
|
*
|
2593
2593
|
* @example
|
2594
|
-
* await orderModuleService.
|
2594
|
+
* await orderModuleService.softDeleteOrderShippingMethodAdjustments([
|
2595
2595
|
* "123", "321"
|
2596
2596
|
* ])
|
2597
2597
|
*/
|
2598
|
-
|
2598
|
+
softDeleteOrderShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2599
2599
|
/**
|
2600
2600
|
* This method restores soft-deleted shipping method adjustments by their IDs.
|
2601
2601
|
*
|
@@ -2610,11 +2610,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2610
2610
|
* If there are no related records restored, the promise resolves to `void`.
|
2611
2611
|
*
|
2612
2612
|
* @example
|
2613
|
-
* await orderModuleService.
|
2613
|
+
* await orderModuleService.restoreOrderShippingMethodAdjustments([
|
2614
2614
|
* "123", "321"
|
2615
2615
|
* ])
|
2616
2616
|
*/
|
2617
|
-
|
2617
|
+
restoreOrderShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2618
2618
|
/**
|
2619
2619
|
* This method soft-deletes line item tax lines by their IDs.
|
2620
2620
|
*
|
@@ -2628,11 +2628,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2628
2628
|
* If there are no related records, the promise resolves to `void`.
|
2629
2629
|
*
|
2630
2630
|
* @example
|
2631
|
-
* await orderModuleService.
|
2631
|
+
* await orderModuleService.softDeleteOrderLineItemTaxLines([
|
2632
2632
|
* "123", "321"
|
2633
2633
|
* ])
|
2634
2634
|
*/
|
2635
|
-
|
2635
|
+
softDeleteOrderLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2636
2636
|
/**
|
2637
2637
|
* This method restores soft-deleted line item tax lines by their IDs.
|
2638
2638
|
*
|
@@ -2647,11 +2647,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2647
2647
|
* If there are no related records restored, the promise resolves to `void`.
|
2648
2648
|
*
|
2649
2649
|
* @example
|
2650
|
-
* await orderModuleService.
|
2650
|
+
* await orderModuleService.restoreOrderLineItemTaxLines([
|
2651
2651
|
* "123", "321"
|
2652
2652
|
* ])
|
2653
2653
|
*/
|
2654
|
-
|
2654
|
+
restoreOrderLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2655
2655
|
/**
|
2656
2656
|
* This method soft deletes shipping method tax lines by their IDs.
|
2657
2657
|
*
|
@@ -2665,11 +2665,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2665
2665
|
* If there are no related records, the promise resolves to `void`.
|
2666
2666
|
*
|
2667
2667
|
* @example
|
2668
|
-
* await orderModuleService.
|
2668
|
+
* await orderModuleService.softDeleteOrderShippingMethodTaxLines([
|
2669
2669
|
* "123", "321"
|
2670
2670
|
* ])
|
2671
2671
|
*/
|
2672
|
-
|
2672
|
+
softDeleteOrderShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2673
2673
|
/**
|
2674
2674
|
* This method restores soft-deleted shipping method tax lines by their IDs.
|
2675
2675
|
*
|
@@ -2684,11 +2684,11 @@ export interface IOrderModuleService extends IModuleService {
|
|
2684
2684
|
* If there are no related records restored, the promise resolves to `void`.
|
2685
2685
|
*
|
2686
2686
|
* @example
|
2687
|
-
* await orderModuleService.
|
2687
|
+
* await orderModuleService.restoreOrderShippingMethodTaxLines([
|
2688
2688
|
* "123", "321"
|
2689
2689
|
* ])
|
2690
2690
|
*/
|
2691
|
-
|
2691
|
+
restoreOrderShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
2692
2692
|
/**
|
2693
2693
|
* This method reverts an order to its last version.
|
2694
2694
|
*
|
@@ -2713,7 +2713,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
2713
2713
|
* To retrieve a list of transactions using their IDs:
|
2714
2714
|
*
|
2715
2715
|
* ```ts
|
2716
|
-
* const transactions = await orderModuleService.
|
2716
|
+
* const transactions = await orderModuleService.listOrderTransactions({
|
2717
2717
|
* id: ["123", "321"]
|
2718
2718
|
* })
|
2719
2719
|
* ```
|
@@ -2721,7 +2721,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
2721
2721
|
* To specify relations that should be retrieved within the transaction:
|
2722
2722
|
*
|
2723
2723
|
* ```ts
|
2724
|
-
* const transactions = await orderModuleService.
|
2724
|
+
* const transactions = await orderModuleService.listOrderTransactions({
|
2725
2725
|
* id: ["123", "321"]
|
2726
2726
|
* }, {
|
2727
2727
|
* relations: ["order"]
|
@@ -2731,7 +2731,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
2731
2731
|
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
2732
2732
|
*
|
2733
2733
|
* ```ts
|
2734
|
-
* const transactions = await orderModuleService.
|
2734
|
+
* const transactions = await orderModuleService.listOrderTransactions({
|
2735
2735
|
* id: ["123", "321"]
|
2736
2736
|
* }, {
|
2737
2737
|
* relations: ["order"],
|
@@ -2740,7 +2740,7 @@ export interface IOrderModuleService extends IModuleService {
|
|
2740
2740
|
* })
|
2741
2741
|
* ```
|
2742
2742
|
*/
|
2743
|
-
|
2743
|
+
listOrderTransactions(filters?: FilterableOrderTransactionProps, config?: FindConfig<OrderTransactionDTO>, sharedContext?: Context): Promise<OrderTransactionDTO[]>;
|
2744
2744
|
/**
|
2745
2745
|
* This method adds a transaction to an order.
|
2746
2746
|
*
|
@@ -2749,13 +2749,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
2749
2749
|
* @returns {Promise<OrderTransactionDTO>} The created transaction.
|
2750
2750
|
*
|
2751
2751
|
* @example
|
2752
|
-
* const transaction = await orderModuleService.
|
2752
|
+
* const transaction = await orderModuleService.addOrderTransactions({
|
2753
2753
|
* order_id: "123",
|
2754
2754
|
* amount: 10,
|
2755
2755
|
* currency_code: "usd"
|
2756
2756
|
* })
|
2757
2757
|
*/
|
2758
|
-
|
2758
|
+
addOrderTransactions(data: CreateOrderTransactionDTO, sharedContext?: Context): Promise<OrderTransactionDTO>;
|
2759
2759
|
/**
|
2760
2760
|
* This method adds transactions to an order.
|
2761
2761
|
*
|
@@ -2764,13 +2764,13 @@ export interface IOrderModuleService extends IModuleService {
|
|
2764
2764
|
* @returns {Promise<OrderTransactionDTO[]>} The created order transactions.
|
2765
2765
|
*
|
2766
2766
|
* @example
|
2767
|
-
* const transactions = await orderModuleService.
|
2767
|
+
* const transactions = await orderModuleService.addOrderTransactions([{
|
2768
2768
|
* order_id: "123",
|
2769
2769
|
* amount: 10,
|
2770
2770
|
* currency_code: "usd"
|
2771
2771
|
* }])
|
2772
2772
|
*/
|
2773
|
-
|
2773
|
+
addOrderTransactions(data: CreateOrderTransactionDTO[], sharedContext?: Context): Promise<OrderTransactionDTO[]>;
|
2774
2774
|
/**
|
2775
2775
|
* This method deletes transactions by their IDs.
|
2776
2776
|
*
|
@@ -2782,16 +2782,16 @@ export interface IOrderModuleService extends IModuleService {
|
|
2782
2782
|
* To delete one transaction:
|
2783
2783
|
*
|
2784
2784
|
* ```ts
|
2785
|
-
* await orderModuleService.
|
2785
|
+
* await orderModuleService.deleteOrderTransactions("123")
|
2786
2786
|
* ```
|
2787
2787
|
*
|
2788
2788
|
* To delete multiple transactions:
|
2789
2789
|
*
|
2790
2790
|
* ```ts
|
2791
|
-
* await orderModuleService.
|
2791
|
+
* await orderModuleService.deleteOrderTransactions(["123", "321"])
|
2792
2792
|
* ```
|
2793
2793
|
*/
|
2794
|
-
|
2794
|
+
deleteOrderTransactions(transactionIds: string | object | string[] | object[], sharedContext?: Context): Promise<void>;
|
2795
2795
|
/**
|
2796
2796
|
* This method soft deletes transactions by their IDs.
|
2797
2797
|
*
|
@@ -2805,9 +2805,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
2805
2805
|
* If there are no related records, the promise resolves to `void`.
|
2806
2806
|
*
|
2807
2807
|
* @example
|
2808
|
-
* await orderModuleService.
|
2808
|
+
* await orderModuleService.softDeleteOrderTransactions(["123", "321"])
|
2809
2809
|
*/
|
2810
|
-
|
2810
|
+
softDeleteOrderTransactions<TReturnableLinkableKeys extends string = string>(transactionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
2811
2811
|
/**
|
2812
2812
|
* This method restores soft-deleted transactions by their IDs.
|
2813
2813
|
*
|
@@ -2822,9 +2822,9 @@ export interface IOrderModuleService extends IModuleService {
|
|
2822
2822
|
* If there are no related records restored, the promise resolves to `void`.
|
2823
2823
|
*
|
2824
2824
|
* @example
|
2825
|
-
* await orderModuleService.
|
2825
|
+
* await orderModuleService.restoreOrderTransactions(["123", "321"])
|
2826
2826
|
*/
|
2827
|
-
|
2827
|
+
restoreOrderTransactions<TReturnableLinkableKeys extends string = string>(transactionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
2828
2828
|
/**
|
2829
2829
|
* This method retrieves a return reason by its ID.
|
2830
2830
|
*
|