@acmekit/types 2.13.2 → 2.13.3
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/bundles.d.ts +0 -12
- package/dist/bundles.d.ts.map +1 -1
- package/dist/bundles.js +1 -13
- package/dist/bundles.js.map +1 -1
- package/dist/http/index.d.ts +0 -34
- package/dist/http/index.d.ts.map +1 -1
- package/dist/http/index.js +0 -34
- package/dist/http/index.js.map +1 -1
- package/dist/http/store/admin/entities.d.ts +0 -5
- package/dist/http/store/admin/entities.d.ts.map +1 -1
- package/dist/index.d.ts +1 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -15
- package/dist/index.js.map +1 -1
- package/dist/totals/big-number.d.ts +19 -12
- package/dist/totals/big-number.d.ts.map +1 -1
- package/dist/totals/index.d.ts +0 -24
- package/dist/totals/index.d.ts.map +1 -1
- package/dist/totals/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/workflow/index.d.ts +0 -10
- package/dist/workflow/index.d.ts.map +1 -1
- package/dist/workflow/index.js +1 -11
- package/dist/workflow/index.js.map +1 -1
- package/dist/workflows/index.d.ts +1 -2
- package/dist/workflows/index.d.ts.map +1 -1
- package/dist/workflows/index.js +0 -16
- package/dist/workflows/index.js.map +1 -1
- package/package.json +2 -2
- package/dist/cart/common.d.ts +0 -1133
- package/dist/cart/common.d.ts.map +0 -1
- package/dist/cart/common.js +0 -3
- package/dist/cart/common.js.map +0 -1
- package/dist/cart/index.d.ts +0 -5
- package/dist/cart/index.d.ts.map +0 -1
- package/dist/cart/index.js +0 -21
- package/dist/cart/index.js.map +0 -1
- package/dist/cart/mutations.d.ts +0 -742
- package/dist/cart/mutations.d.ts.map +0 -1
- package/dist/cart/mutations.js +0 -4
- package/dist/cart/mutations.js.map +0 -1
- package/dist/cart/service.d.ts +0 -1888
- package/dist/cart/service.d.ts.map +0 -1
- package/dist/cart/service.js +0 -3
- package/dist/cart/service.js.map +0 -1
- package/dist/cart/workflows.d.ts +0 -498
- package/dist/cart/workflows.d.ts.map +0 -1
- package/dist/cart/workflows.js +0 -3
- package/dist/cart/workflows.js.map +0 -1
- package/dist/currency/common/currency.d.ts +0 -52
- package/dist/currency/common/currency.d.ts.map +0 -1
- package/dist/currency/common/currency.js +0 -3
- package/dist/currency/common/currency.js.map +0 -1
- package/dist/currency/common/index.d.ts +0 -2
- package/dist/currency/common/index.d.ts.map +0 -1
- package/dist/currency/common/index.js +0 -18
- package/dist/currency/common/index.js.map +0 -1
- package/dist/currency/index.d.ts +0 -3
- package/dist/currency/index.d.ts.map +0 -1
- package/dist/currency/index.js +0 -19
- package/dist/currency/index.js.map +0 -1
- package/dist/currency/service.d.ts +0 -96
- package/dist/currency/service.d.ts.map +0 -1
- package/dist/currency/service.js +0 -3
- package/dist/currency/service.js.map +0 -1
- package/dist/fulfillment/common/address.d.ts +0 -70
- package/dist/fulfillment/common/address.d.ts.map +0 -1
- package/dist/fulfillment/common/address.js +0 -3
- package/dist/fulfillment/common/address.js.map +0 -1
- package/dist/fulfillment/common/cart.d.ts +0 -89
- package/dist/fulfillment/common/cart.d.ts.map +0 -1
- package/dist/fulfillment/common/cart.js +0 -3
- package/dist/fulfillment/common/cart.js.map +0 -1
- package/dist/fulfillment/common/fulfillment-item.d.ts +0 -55
- package/dist/fulfillment/common/fulfillment-item.d.ts.map +0 -1
- package/dist/fulfillment/common/fulfillment-item.js +0 -3
- package/dist/fulfillment/common/fulfillment-item.js.map +0 -1
- package/dist/fulfillment/common/fulfillment-label.d.ts +0 -43
- package/dist/fulfillment/common/fulfillment-label.d.ts.map +0 -1
- package/dist/fulfillment/common/fulfillment-label.js +0 -3
- package/dist/fulfillment/common/fulfillment-label.js.map +0 -1
- package/dist/fulfillment/common/fulfillment-provider.d.ts +0 -45
- package/dist/fulfillment/common/fulfillment-provider.d.ts.map +0 -1
- package/dist/fulfillment/common/fulfillment-provider.js +0 -3
- package/dist/fulfillment/common/fulfillment-provider.js.map +0 -1
- package/dist/fulfillment/common/fulfillment-set.d.ts +0 -61
- package/dist/fulfillment/common/fulfillment-set.d.ts.map +0 -1
- package/dist/fulfillment/common/fulfillment-set.js +0 -3
- package/dist/fulfillment/common/fulfillment-set.js.map +0 -1
- package/dist/fulfillment/common/fulfillment.d.ts +0 -142
- package/dist/fulfillment/common/fulfillment.d.ts.map +0 -1
- package/dist/fulfillment/common/fulfillment.js +0 -3
- package/dist/fulfillment/common/fulfillment.js.map +0 -1
- package/dist/fulfillment/common/geo-zone.d.ts +0 -76
- package/dist/fulfillment/common/geo-zone.d.ts.map +0 -1
- package/dist/fulfillment/common/geo-zone.js +0 -3
- package/dist/fulfillment/common/geo-zone.js.map +0 -1
- package/dist/fulfillment/common/index.d.ts +0 -15
- package/dist/fulfillment/common/index.d.ts.map +0 -1
- package/dist/fulfillment/common/index.js +0 -31
- package/dist/fulfillment/common/index.js.map +0 -1
- package/dist/fulfillment/common/order.d.ts +0 -899
- package/dist/fulfillment/common/order.d.ts.map +0 -1
- package/dist/fulfillment/common/order.js +0 -3
- package/dist/fulfillment/common/order.js.map +0 -1
- package/dist/fulfillment/common/service-zone.d.ts +0 -79
- package/dist/fulfillment/common/service-zone.d.ts.map +0 -1
- package/dist/fulfillment/common/service-zone.js +0 -3
- package/dist/fulfillment/common/service-zone.js.map +0 -1
- package/dist/fulfillment/common/shipping-option-rule.d.ts +0 -73
- package/dist/fulfillment/common/shipping-option-rule.d.ts.map +0 -1
- package/dist/fulfillment/common/shipping-option-rule.js +0 -3
- package/dist/fulfillment/common/shipping-option-rule.js.map +0 -1
- package/dist/fulfillment/common/shipping-option-type.d.ts +0 -65
- package/dist/fulfillment/common/shipping-option-type.d.ts.map +0 -1
- package/dist/fulfillment/common/shipping-option-type.js +0 -3
- package/dist/fulfillment/common/shipping-option-type.js.map +0 -1
- package/dist/fulfillment/common/shipping-option.d.ts +0 -171
- package/dist/fulfillment/common/shipping-option.d.ts.map +0 -1
- package/dist/fulfillment/common/shipping-option.js +0 -3
- package/dist/fulfillment/common/shipping-option.js.map +0 -1
- package/dist/fulfillment/common/shipping-profile.d.ts +0 -61
- package/dist/fulfillment/common/shipping-profile.d.ts.map +0 -1
- package/dist/fulfillment/common/shipping-profile.js +0 -3
- package/dist/fulfillment/common/shipping-profile.js.map +0 -1
- package/dist/fulfillment/index.d.ts +0 -6
- package/dist/fulfillment/index.d.ts.map +0 -1
- package/dist/fulfillment/index.js +0 -22
- package/dist/fulfillment/index.js.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-address.d.ts +0 -54
- package/dist/fulfillment/mutations/fulfillment-address.d.ts.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-address.js +0 -3
- package/dist/fulfillment/mutations/fulfillment-address.js.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-item.d.ts +0 -34
- package/dist/fulfillment/mutations/fulfillment-item.d.ts.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-item.js +0 -3
- package/dist/fulfillment/mutations/fulfillment-item.js.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-label.d.ts +0 -22
- package/dist/fulfillment/mutations/fulfillment-label.d.ts.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-label.js +0 -3
- package/dist/fulfillment/mutations/fulfillment-label.js.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-set.d.ts +0 -45
- package/dist/fulfillment/mutations/fulfillment-set.d.ts.map +0 -1
- package/dist/fulfillment/mutations/fulfillment-set.js +0 -3
- package/dist/fulfillment/mutations/fulfillment-set.js.map +0 -1
- package/dist/fulfillment/mutations/fulfillment.d.ts +0 -110
- package/dist/fulfillment/mutations/fulfillment.d.ts.map +0 -1
- package/dist/fulfillment/mutations/fulfillment.js +0 -3
- package/dist/fulfillment/mutations/fulfillment.js.map +0 -1
- package/dist/fulfillment/mutations/geo-zone.d.ts +0 -169
- package/dist/fulfillment/mutations/geo-zone.d.ts.map +0 -1
- package/dist/fulfillment/mutations/geo-zone.js +0 -3
- package/dist/fulfillment/mutations/geo-zone.js.map +0 -1
- package/dist/fulfillment/mutations/index.d.ts +0 -12
- package/dist/fulfillment/mutations/index.d.ts.map +0 -1
- package/dist/fulfillment/mutations/index.js +0 -28
- package/dist/fulfillment/mutations/index.js.map +0 -1
- package/dist/fulfillment/mutations/service-zone.d.ts +0 -46
- package/dist/fulfillment/mutations/service-zone.d.ts.map +0 -1
- package/dist/fulfillment/mutations/service-zone.js +0 -3
- package/dist/fulfillment/mutations/service-zone.js.map +0 -1
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts +0 -32
- package/dist/fulfillment/mutations/shipping-option-rule.d.ts.map +0 -1
- package/dist/fulfillment/mutations/shipping-option-rule.js +0 -3
- package/dist/fulfillment/mutations/shipping-option-rule.js.map +0 -1
- package/dist/fulfillment/mutations/shipping-option-type.d.ts +0 -32
- package/dist/fulfillment/mutations/shipping-option-type.d.ts.map +0 -1
- package/dist/fulfillment/mutations/shipping-option-type.js +0 -3
- package/dist/fulfillment/mutations/shipping-option-type.js.map +0 -1
- package/dist/fulfillment/mutations/shipping-option.d.ts +0 -183
- package/dist/fulfillment/mutations/shipping-option.d.ts.map +0 -1
- package/dist/fulfillment/mutations/shipping-option.js +0 -3
- package/dist/fulfillment/mutations/shipping-option.js.map +0 -1
- package/dist/fulfillment/mutations/shipping-profile.d.ts +0 -41
- package/dist/fulfillment/mutations/shipping-profile.d.ts.map +0 -1
- package/dist/fulfillment/mutations/shipping-profile.js +0 -3
- package/dist/fulfillment/mutations/shipping-profile.js.map +0 -1
- package/dist/fulfillment/provider.d.ts +0 -131
- package/dist/fulfillment/provider.d.ts.map +0 -1
- package/dist/fulfillment/provider.js +0 -3
- package/dist/fulfillment/provider.js.map +0 -1
- package/dist/fulfillment/service.d.ts +0 -2632
- package/dist/fulfillment/service.d.ts.map +0 -1
- package/dist/fulfillment/service.js +0 -3
- package/dist/fulfillment/service.js.map +0 -1
- package/dist/fulfillment/workflows.d.ts +0 -243
- package/dist/fulfillment/workflows.d.ts.map +0 -1
- package/dist/fulfillment/workflows.js +0 -3
- package/dist/fulfillment/workflows.js.map +0 -1
- package/dist/http/campaign/admin/index.d.ts +0 -4
- package/dist/http/campaign/admin/index.d.ts.map +0 -1
- package/dist/http/campaign/admin/index.js +0 -20
- package/dist/http/campaign/admin/index.js.map +0 -1
- package/dist/http/campaign/admin/payloads.d.ts +0 -87
- package/dist/http/campaign/admin/payloads.d.ts.map +0 -1
- package/dist/http/campaign/admin/payloads.js +0 -3
- package/dist/http/campaign/admin/payloads.js.map +0 -1
- package/dist/http/campaign/admin/queries.d.ts +0 -14
- package/dist/http/campaign/admin/queries.d.ts.map +0 -1
- package/dist/http/campaign/admin/queries.js +0 -3
- package/dist/http/campaign/admin/queries.js.map +0 -1
- package/dist/http/campaign/admin/responses.d.ts +0 -90
- package/dist/http/campaign/admin/responses.d.ts.map +0 -1
- package/dist/http/campaign/admin/responses.js +0 -3
- package/dist/http/campaign/admin/responses.js.map +0 -1
- package/dist/http/campaign/index.d.ts +0 -2
- package/dist/http/campaign/index.d.ts.map +0 -1
- package/dist/http/campaign/index.js +0 -18
- package/dist/http/campaign/index.js.map +0 -1
- package/dist/http/cart/common.d.ts +0 -704
- package/dist/http/cart/common.d.ts.map +0 -1
- package/dist/http/cart/common.js +0 -3
- package/dist/http/cart/common.js.map +0 -1
- package/dist/http/cart/index.d.ts +0 -2
- package/dist/http/cart/index.d.ts.map +0 -1
- package/dist/http/cart/index.js +0 -18
- package/dist/http/cart/index.js.map +0 -1
- package/dist/http/cart/store/entities.d.ts +0 -112
- package/dist/http/cart/store/entities.d.ts.map +0 -1
- package/dist/http/cart/store/entities.js +0 -3
- package/dist/http/cart/store/entities.js.map +0 -1
- package/dist/http/cart/store/index.d.ts +0 -4
- package/dist/http/cart/store/index.d.ts.map +0 -1
- package/dist/http/cart/store/index.js +0 -20
- package/dist/http/cart/store/index.js.map +0 -1
- package/dist/http/cart/store/payloads.d.ts +0 -191
- package/dist/http/cart/store/payloads.d.ts.map +0 -1
- package/dist/http/cart/store/payloads.js +0 -3
- package/dist/http/cart/store/payloads.js.map +0 -1
- package/dist/http/cart/store/responses.d.ts +0 -48
- package/dist/http/cart/store/responses.d.ts.map +0 -1
- package/dist/http/cart/store/responses.js +0 -3
- package/dist/http/cart/store/responses.js.map +0 -1
- package/dist/http/claim/admin/entities.d.ts +0 -18
- package/dist/http/claim/admin/entities.d.ts.map +0 -1
- package/dist/http/claim/admin/entities.js +0 -3
- package/dist/http/claim/admin/entities.js.map +0 -1
- package/dist/http/claim/admin/index.d.ts +0 -5
- package/dist/http/claim/admin/index.d.ts.map +0 -1
- package/dist/http/claim/admin/index.js +0 -21
- package/dist/http/claim/admin/index.js.map +0 -1
- package/dist/http/claim/admin/payloads.d.ts +0 -142
- package/dist/http/claim/admin/payloads.d.ts.map +0 -1
- package/dist/http/claim/admin/payloads.js +0 -10
- package/dist/http/claim/admin/payloads.js.map +0 -1
- package/dist/http/claim/admin/queries.d.ts +0 -50
- package/dist/http/claim/admin/queries.d.ts.map +0 -1
- package/dist/http/claim/admin/queries.js +0 -3
- package/dist/http/claim/admin/queries.js.map +0 -1
- package/dist/http/claim/admin/responses.d.ts +0 -54
- package/dist/http/claim/admin/responses.d.ts.map +0 -1
- package/dist/http/claim/admin/responses.js +0 -3
- package/dist/http/claim/admin/responses.js.map +0 -1
- package/dist/http/claim/common.d.ts +0 -131
- package/dist/http/claim/common.d.ts.map +0 -1
- package/dist/http/claim/common.js +0 -3
- package/dist/http/claim/common.js.map +0 -1
- package/dist/http/claim/index.d.ts +0 -2
- package/dist/http/claim/index.d.ts.map +0 -1
- package/dist/http/claim/index.js +0 -18
- package/dist/http/claim/index.js.map +0 -1
- package/dist/http/collection/admin/entities.d.ts +0 -9
- package/dist/http/collection/admin/entities.d.ts.map +0 -1
- package/dist/http/collection/admin/entities.js +0 -3
- package/dist/http/collection/admin/entities.js.map +0 -1
- package/dist/http/collection/admin/index.d.ts +0 -5
- package/dist/http/collection/admin/index.d.ts.map +0 -1
- package/dist/http/collection/admin/index.js +0 -21
- package/dist/http/collection/admin/index.js.map +0 -1
- package/dist/http/collection/admin/payloads.d.ts +0 -39
- package/dist/http/collection/admin/payloads.d.ts.map +0 -1
- package/dist/http/collection/admin/payloads.js +0 -3
- package/dist/http/collection/admin/payloads.js.map +0 -1
- package/dist/http/collection/admin/queries.d.ts +0 -11
- package/dist/http/collection/admin/queries.d.ts.map +0 -1
- package/dist/http/collection/admin/queries.js +0 -3
- package/dist/http/collection/admin/queries.js.map +0 -1
- package/dist/http/collection/admin/responses.d.ts +0 -18
- package/dist/http/collection/admin/responses.d.ts.map +0 -1
- package/dist/http/collection/admin/responses.js +0 -3
- package/dist/http/collection/admin/responses.js.map +0 -1
- package/dist/http/collection/common.d.ts +0 -66
- package/dist/http/collection/common.d.ts.map +0 -1
- package/dist/http/collection/common.js +0 -3
- package/dist/http/collection/common.js.map +0 -1
- package/dist/http/collection/index.d.ts +0 -3
- package/dist/http/collection/index.d.ts.map +0 -1
- package/dist/http/collection/index.js +0 -19
- package/dist/http/collection/index.js.map +0 -1
- package/dist/http/collection/store/entities.d.ts +0 -9
- package/dist/http/collection/store/entities.d.ts.map +0 -1
- package/dist/http/collection/store/entities.js +0 -3
- package/dist/http/collection/store/entities.js.map +0 -1
- package/dist/http/collection/store/index.d.ts +0 -4
- package/dist/http/collection/store/index.d.ts.map +0 -1
- package/dist/http/collection/store/index.js +0 -20
- package/dist/http/collection/store/index.js.map +0 -1
- package/dist/http/collection/store/queries.d.ts +0 -6
- package/dist/http/collection/store/queries.d.ts.map +0 -1
- package/dist/http/collection/store/queries.js +0 -3
- package/dist/http/collection/store/queries.js.map +0 -1
- package/dist/http/collection/store/responses.d.ts +0 -15
- package/dist/http/collection/store/responses.d.ts.map +0 -1
- package/dist/http/collection/store/responses.js +0 -3
- package/dist/http/collection/store/responses.js.map +0 -1
- package/dist/http/currency/admin/entities.d.ts +0 -4
- package/dist/http/currency/admin/entities.d.ts.map +0 -1
- package/dist/http/currency/admin/entities.js +0 -3
- package/dist/http/currency/admin/entities.js.map +0 -1
- package/dist/http/currency/admin/index.d.ts +0 -4
- package/dist/http/currency/admin/index.d.ts.map +0 -1
- package/dist/http/currency/admin/index.js +0 -20
- package/dist/http/currency/admin/index.js.map +0 -1
- package/dist/http/currency/admin/queries.d.ts +0 -15
- package/dist/http/currency/admin/queries.d.ts.map +0 -1
- package/dist/http/currency/admin/queries.js +0 -3
- package/dist/http/currency/admin/queries.js.map +0 -1
- package/dist/http/currency/admin/responses.d.ts +0 -16
- package/dist/http/currency/admin/responses.d.ts.map +0 -1
- package/dist/http/currency/admin/responses.js +0 -3
- package/dist/http/currency/admin/responses.js.map +0 -1
- package/dist/http/currency/common.d.ts +0 -48
- package/dist/http/currency/common.d.ts.map +0 -1
- package/dist/http/currency/common.js +0 -3
- package/dist/http/currency/common.js.map +0 -1
- package/dist/http/currency/index.d.ts +0 -4
- package/dist/http/currency/index.d.ts.map +0 -1
- package/dist/http/currency/index.js +0 -20
- package/dist/http/currency/index.js.map +0 -1
- package/dist/http/currency/store/entities.d.ts +0 -4
- package/dist/http/currency/store/entities.d.ts.map +0 -1
- package/dist/http/currency/store/entities.js +0 -3
- package/dist/http/currency/store/entities.js.map +0 -1
- package/dist/http/currency/store/index.d.ts +0 -4
- package/dist/http/currency/store/index.d.ts.map +0 -1
- package/dist/http/currency/store/index.js +0 -20
- package/dist/http/currency/store/index.js.map +0 -1
- package/dist/http/currency/store/queries.d.ts +0 -7
- package/dist/http/currency/store/queries.d.ts.map +0 -1
- package/dist/http/currency/store/queries.js +0 -3
- package/dist/http/currency/store/queries.js.map +0 -1
- package/dist/http/currency/store/responses.d.ts +0 -10
- package/dist/http/currency/store/responses.d.ts.map +0 -1
- package/dist/http/currency/store/responses.js +0 -3
- package/dist/http/currency/store/responses.js.map +0 -1
- package/dist/http/draft-order/admin/entities.d.ts +0 -6
- package/dist/http/draft-order/admin/entities.d.ts.map +0 -1
- package/dist/http/draft-order/admin/entities.js +0 -3
- package/dist/http/draft-order/admin/entities.js.map +0 -1
- package/dist/http/draft-order/admin/index.d.ts +0 -5
- package/dist/http/draft-order/admin/index.d.ts.map +0 -1
- package/dist/http/draft-order/admin/index.js +0 -21
- package/dist/http/draft-order/admin/index.js.map +0 -1
- package/dist/http/draft-order/admin/payloads.d.ts +0 -252
- package/dist/http/draft-order/admin/payloads.d.ts.map +0 -1
- package/dist/http/draft-order/admin/payloads.js +0 -3
- package/dist/http/draft-order/admin/payloads.js.map +0 -1
- package/dist/http/draft-order/admin/queries.d.ts +0 -35
- package/dist/http/draft-order/admin/queries.d.ts.map +0 -1
- package/dist/http/draft-order/admin/queries.js +0 -3
- package/dist/http/draft-order/admin/queries.js.map +0 -1
- package/dist/http/draft-order/admin/responses.d.ts +0 -22
- package/dist/http/draft-order/admin/responses.d.ts.map +0 -1
- package/dist/http/draft-order/admin/responses.js +0 -3
- package/dist/http/draft-order/admin/responses.js.map +0 -1
- package/dist/http/draft-order/index.d.ts +0 -2
- package/dist/http/draft-order/index.d.ts.map +0 -1
- package/dist/http/draft-order/index.js +0 -18
- package/dist/http/draft-order/index.js.map +0 -1
- package/dist/http/exchange/admin/entities.d.ts +0 -4
- package/dist/http/exchange/admin/entities.d.ts.map +0 -1
- package/dist/http/exchange/admin/entities.js +0 -3
- package/dist/http/exchange/admin/entities.js.map +0 -1
- package/dist/http/exchange/admin/index.d.ts +0 -5
- package/dist/http/exchange/admin/index.d.ts.map +0 -1
- package/dist/http/exchange/admin/index.js +0 -21
- package/dist/http/exchange/admin/index.js.map +0 -1
- package/dist/http/exchange/admin/payloads.d.ts +0 -162
- package/dist/http/exchange/admin/payloads.d.ts.map +0 -1
- package/dist/http/exchange/admin/payloads.js +0 -3
- package/dist/http/exchange/admin/payloads.js.map +0 -1
- package/dist/http/exchange/admin/queries.d.ts +0 -51
- package/dist/http/exchange/admin/queries.d.ts.map +0 -1
- package/dist/http/exchange/admin/queries.js +0 -3
- package/dist/http/exchange/admin/queries.js.map +0 -1
- package/dist/http/exchange/admin/responses.d.ts +0 -50
- package/dist/http/exchange/admin/responses.d.ts.map +0 -1
- package/dist/http/exchange/admin/responses.js +0 -3
- package/dist/http/exchange/admin/responses.js.map +0 -1
- package/dist/http/exchange/common.d.ts +0 -155
- package/dist/http/exchange/common.d.ts.map +0 -1
- package/dist/http/exchange/common.js +0 -3
- package/dist/http/exchange/common.js.map +0 -1
- package/dist/http/exchange/index.d.ts +0 -2
- package/dist/http/exchange/index.d.ts.map +0 -1
- package/dist/http/exchange/index.js +0 -18
- package/dist/http/exchange/index.js.map +0 -1
- package/dist/http/fulfillment/admin/entitites.d.ts +0 -201
- package/dist/http/fulfillment/admin/entitites.d.ts.map +0 -1
- package/dist/http/fulfillment/admin/entitites.js +0 -3
- package/dist/http/fulfillment/admin/entitites.js.map +0 -1
- package/dist/http/fulfillment/admin/index.d.ts +0 -4
- package/dist/http/fulfillment/admin/index.d.ts.map +0 -1
- package/dist/http/fulfillment/admin/index.js +0 -20
- package/dist/http/fulfillment/admin/index.js.map +0 -1
- package/dist/http/fulfillment/admin/payloads.d.ts +0 -153
- package/dist/http/fulfillment/admin/payloads.d.ts.map +0 -1
- package/dist/http/fulfillment/admin/payloads.js +0 -3
- package/dist/http/fulfillment/admin/payloads.js.map +0 -1
- package/dist/http/fulfillment/admin/responses.d.ts +0 -8
- package/dist/http/fulfillment/admin/responses.d.ts.map +0 -1
- package/dist/http/fulfillment/admin/responses.js +0 -3
- package/dist/http/fulfillment/admin/responses.js.map +0 -1
- package/dist/http/fulfillment/index.d.ts +0 -3
- package/dist/http/fulfillment/index.d.ts.map +0 -1
- package/dist/http/fulfillment/index.js +0 -19
- package/dist/http/fulfillment/index.js.map +0 -1
- package/dist/http/fulfillment/store/index.d.ts +0 -186
- package/dist/http/fulfillment/store/index.d.ts.map +0 -1
- package/dist/http/fulfillment/store/index.js +0 -3
- package/dist/http/fulfillment/store/index.js.map +0 -1
- package/dist/http/fulfillment-provider/admin/entities.d.ts +0 -6
- package/dist/http/fulfillment-provider/admin/entities.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/admin/entities.js +0 -3
- package/dist/http/fulfillment-provider/admin/entities.js.map +0 -1
- package/dist/http/fulfillment-provider/admin/index.d.ts +0 -4
- package/dist/http/fulfillment-provider/admin/index.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/admin/index.js +0 -20
- package/dist/http/fulfillment-provider/admin/index.js.map +0 -1
- package/dist/http/fulfillment-provider/admin/queries.d.ts +0 -21
- package/dist/http/fulfillment-provider/admin/queries.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/admin/queries.js +0 -3
- package/dist/http/fulfillment-provider/admin/queries.js.map +0 -1
- package/dist/http/fulfillment-provider/admin/responses.d.ts +0 -17
- package/dist/http/fulfillment-provider/admin/responses.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/admin/responses.js +0 -3
- package/dist/http/fulfillment-provider/admin/responses.js.map +0 -1
- package/dist/http/fulfillment-provider/common.d.ts +0 -21
- package/dist/http/fulfillment-provider/common.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/common.js +0 -3
- package/dist/http/fulfillment-provider/common.js.map +0 -1
- package/dist/http/fulfillment-provider/index.d.ts +0 -2
- package/dist/http/fulfillment-provider/index.d.ts.map +0 -1
- package/dist/http/fulfillment-provider/index.js +0 -18
- package/dist/http/fulfillment-provider/index.js.map +0 -1
- package/dist/http/fulfillment-set/admin/entities.d.ts +0 -120
- package/dist/http/fulfillment-set/admin/entities.d.ts.map +0 -1
- package/dist/http/fulfillment-set/admin/entities.js +0 -3
- package/dist/http/fulfillment-set/admin/entities.js.map +0 -1
- package/dist/http/fulfillment-set/admin/index.d.ts +0 -5
- package/dist/http/fulfillment-set/admin/index.d.ts.map +0 -1
- package/dist/http/fulfillment-set/admin/index.js +0 -21
- package/dist/http/fulfillment-set/admin/index.js.map +0 -1
- package/dist/http/fulfillment-set/admin/payloads.d.ts +0 -122
- package/dist/http/fulfillment-set/admin/payloads.d.ts.map +0 -1
- package/dist/http/fulfillment-set/admin/payloads.js +0 -3
- package/dist/http/fulfillment-set/admin/payloads.js.map +0 -1
- package/dist/http/fulfillment-set/admin/queries.d.ts +0 -12
- package/dist/http/fulfillment-set/admin/queries.d.ts.map +0 -1
- package/dist/http/fulfillment-set/admin/queries.js +0 -3
- package/dist/http/fulfillment-set/admin/queries.js.map +0 -1
- package/dist/http/fulfillment-set/admin/responses.d.ts +0 -19
- package/dist/http/fulfillment-set/admin/responses.d.ts.map +0 -1
- package/dist/http/fulfillment-set/admin/responses.js +0 -3
- package/dist/http/fulfillment-set/admin/responses.js.map +0 -1
- package/dist/http/fulfillment-set/index.d.ts +0 -2
- package/dist/http/fulfillment-set/index.d.ts.map +0 -1
- package/dist/http/fulfillment-set/index.js +0 -18
- package/dist/http/fulfillment-set/index.js.map +0 -1
- package/dist/http/inventory/admin/entities.d.ts +0 -117
- package/dist/http/inventory/admin/entities.d.ts.map +0 -1
- package/dist/http/inventory/admin/entities.js +0 -3
- package/dist/http/inventory/admin/entities.js.map +0 -1
- package/dist/http/inventory/admin/index.d.ts +0 -5
- package/dist/http/inventory/admin/index.d.ts.map +0 -1
- package/dist/http/inventory/admin/index.js +0 -21
- package/dist/http/inventory/admin/index.js.map +0 -1
- package/dist/http/inventory/admin/payloads.d.ts +0 -61
- package/dist/http/inventory/admin/payloads.d.ts.map +0 -1
- package/dist/http/inventory/admin/payloads.js +0 -3
- package/dist/http/inventory/admin/payloads.js.map +0 -1
- package/dist/http/inventory/admin/queries.d.ts +0 -58
- package/dist/http/inventory/admin/queries.d.ts.map +0 -1
- package/dist/http/inventory/admin/queries.js +0 -3
- package/dist/http/inventory/admin/queries.js.map +0 -1
- package/dist/http/inventory/admin/responses.d.ts +0 -17
- package/dist/http/inventory/admin/responses.d.ts.map +0 -1
- package/dist/http/inventory/admin/responses.js +0 -3
- package/dist/http/inventory/admin/responses.js.map +0 -1
- package/dist/http/inventory/index.d.ts +0 -2
- package/dist/http/inventory/index.d.ts.map +0 -1
- package/dist/http/inventory/index.js +0 -18
- package/dist/http/inventory/index.js.map +0 -1
- package/dist/http/inventory-level/admin/entities.d.ts +0 -39
- package/dist/http/inventory-level/admin/entities.d.ts.map +0 -1
- package/dist/http/inventory-level/admin/entities.js +0 -3
- package/dist/http/inventory-level/admin/entities.js.map +0 -1
- package/dist/http/inventory-level/admin/index.d.ts +0 -5
- package/dist/http/inventory-level/admin/index.d.ts.map +0 -1
- package/dist/http/inventory-level/admin/index.js +0 -21
- package/dist/http/inventory-level/admin/index.js.map +0 -1
- package/dist/http/inventory-level/admin/payloads.d.ts +0 -104
- package/dist/http/inventory-level/admin/payloads.d.ts.map +0 -1
- package/dist/http/inventory-level/admin/payloads.js +0 -3
- package/dist/http/inventory-level/admin/payloads.js.map +0 -1
- package/dist/http/inventory-level/admin/queries.d.ts +0 -9
- package/dist/http/inventory-level/admin/queries.d.ts.map +0 -1
- package/dist/http/inventory-level/admin/queries.js +0 -3
- package/dist/http/inventory-level/admin/queries.js.map +0 -1
- package/dist/http/inventory-level/admin/responses.d.ts +0 -37
- package/dist/http/inventory-level/admin/responses.d.ts.map +0 -1
- package/dist/http/inventory-level/admin/responses.js +0 -3
- package/dist/http/inventory-level/admin/responses.js.map +0 -1
- package/dist/http/inventory-level/index.d.ts +0 -2
- package/dist/http/inventory-level/index.d.ts.map +0 -1
- package/dist/http/inventory-level/index.js +0 -18
- package/dist/http/inventory-level/index.js.map +0 -1
- package/dist/http/order/admin/entities.d.ts +0 -163
- package/dist/http/order/admin/entities.d.ts.map +0 -1
- package/dist/http/order/admin/entities.js +0 -3
- package/dist/http/order/admin/entities.js.map +0 -1
- package/dist/http/order/admin/index.d.ts +0 -5
- package/dist/http/order/admin/index.d.ts.map +0 -1
- package/dist/http/order/admin/index.js +0 -21
- package/dist/http/order/admin/index.js.map +0 -1
- package/dist/http/order/admin/payload.d.ts +0 -190
- package/dist/http/order/admin/payload.d.ts.map +0 -1
- package/dist/http/order/admin/payload.js +0 -3
- package/dist/http/order/admin/payload.js.map +0 -1
- package/dist/http/order/admin/queries.d.ts +0 -72
- package/dist/http/order/admin/queries.d.ts.map +0 -1
- package/dist/http/order/admin/queries.js +0 -3
- package/dist/http/order/admin/queries.js.map +0 -1
- package/dist/http/order/admin/responses.d.ts +0 -45
- package/dist/http/order/admin/responses.d.ts.map +0 -1
- package/dist/http/order/admin/responses.js +0 -3
- package/dist/http/order/admin/responses.js.map +0 -1
- package/dist/http/order/common.d.ts +0 -1082
- package/dist/http/order/common.d.ts.map +0 -1
- package/dist/http/order/common.js +0 -3
- package/dist/http/order/common.js.map +0 -1
- package/dist/http/order/index.d.ts +0 -3
- package/dist/http/order/index.d.ts.map +0 -1
- package/dist/http/order/index.js +0 -19
- package/dist/http/order/index.js.map +0 -1
- package/dist/http/order/store/entities.d.ts +0 -83
- package/dist/http/order/store/entities.d.ts.map +0 -1
- package/dist/http/order/store/entities.js +0 -3
- package/dist/http/order/store/entities.js.map +0 -1
- package/dist/http/order/store/index.d.ts +0 -5
- package/dist/http/order/store/index.d.ts.map +0 -1
- package/dist/http/order/store/index.js +0 -21
- package/dist/http/order/store/index.js.map +0 -1
- package/dist/http/order/store/payloads.d.ts +0 -13
- package/dist/http/order/store/payloads.d.ts.map +0 -1
- package/dist/http/order/store/payloads.js +0 -3
- package/dist/http/order/store/payloads.js.map +0 -1
- package/dist/http/order/store/queries.d.ts +0 -14
- package/dist/http/order/store/queries.d.ts.map +0 -1
- package/dist/http/order/store/queries.js +0 -3
- package/dist/http/order/store/queries.js.map +0 -1
- package/dist/http/order/store/responses.d.ts +0 -15
- package/dist/http/order/store/responses.d.ts.map +0 -1
- package/dist/http/order/store/responses.js +0 -3
- package/dist/http/order/store/responses.js.map +0 -1
- package/dist/http/order-edit/admin/index.d.ts +0 -3
- package/dist/http/order-edit/admin/index.d.ts.map +0 -1
- package/dist/http/order-edit/admin/index.js +0 -19
- package/dist/http/order-edit/admin/index.js.map +0 -1
- package/dist/http/order-edit/admin/payloads.d.ts +0 -60
- package/dist/http/order-edit/admin/payloads.d.ts.map +0 -1
- package/dist/http/order-edit/admin/payloads.js +0 -3
- package/dist/http/order-edit/admin/payloads.js.map +0 -1
- package/dist/http/order-edit/admin/responses.d.ts +0 -16
- package/dist/http/order-edit/admin/responses.d.ts.map +0 -1
- package/dist/http/order-edit/admin/responses.js +0 -3
- package/dist/http/order-edit/admin/responses.js.map +0 -1
- package/dist/http/order-edit/common.d.ts +0 -10
- package/dist/http/order-edit/common.d.ts.map +0 -1
- package/dist/http/order-edit/common.js +0 -3
- package/dist/http/order-edit/common.js.map +0 -1
- package/dist/http/order-edit/index.d.ts +0 -3
- package/dist/http/order-edit/index.d.ts.map +0 -1
- package/dist/http/order-edit/index.js +0 -19
- package/dist/http/order-edit/index.js.map +0 -1
- package/dist/http/payment/admin/entities.d.ts +0 -44
- package/dist/http/payment/admin/entities.d.ts.map +0 -1
- package/dist/http/payment/admin/entities.js +0 -3
- package/dist/http/payment/admin/entities.js.map +0 -1
- package/dist/http/payment/admin/index.d.ts +0 -5
- package/dist/http/payment/admin/index.d.ts.map +0 -1
- package/dist/http/payment/admin/index.js +0 -21
- package/dist/http/payment/admin/index.js.map +0 -1
- package/dist/http/payment/admin/payloads.d.ts +0 -36
- package/dist/http/payment/admin/payloads.d.ts.map +0 -1
- package/dist/http/payment/admin/payloads.js +0 -3
- package/dist/http/payment/admin/payloads.js.map +0 -1
- package/dist/http/payment/admin/queries.d.ts +0 -55
- package/dist/http/payment/admin/queries.d.ts.map +0 -1
- package/dist/http/payment/admin/queries.js +0 -3
- package/dist/http/payment/admin/queries.js.map +0 -1
- package/dist/http/payment/admin/responses.d.ts +0 -48
- package/dist/http/payment/admin/responses.d.ts.map +0 -1
- package/dist/http/payment/admin/responses.js +0 -3
- package/dist/http/payment/admin/responses.js.map +0 -1
- package/dist/http/payment/common.d.ts +0 -344
- package/dist/http/payment/common.d.ts.map +0 -1
- package/dist/http/payment/common.js +0 -3
- package/dist/http/payment/common.js.map +0 -1
- package/dist/http/payment/index.d.ts +0 -3
- package/dist/http/payment/index.d.ts.map +0 -1
- package/dist/http/payment/index.js +0 -19
- package/dist/http/payment/index.js.map +0 -1
- package/dist/http/payment/store/entities.d.ts +0 -20
- package/dist/http/payment/store/entities.d.ts.map +0 -1
- package/dist/http/payment/store/entities.js +0 -3
- package/dist/http/payment/store/entities.js.map +0 -1
- package/dist/http/payment/store/index.d.ts +0 -5
- package/dist/http/payment/store/index.d.ts.map +0 -1
- package/dist/http/payment/store/index.js +0 -21
- package/dist/http/payment/store/index.js.map +0 -1
- package/dist/http/payment/store/payloads.d.ts +0 -17
- package/dist/http/payment/store/payloads.d.ts.map +0 -1
- package/dist/http/payment/store/payloads.js +0 -3
- package/dist/http/payment/store/payloads.js.map +0 -1
- package/dist/http/payment/store/queries.d.ts +0 -13
- package/dist/http/payment/store/queries.d.ts.map +0 -1
- package/dist/http/payment/store/queries.js +0 -3
- package/dist/http/payment/store/queries.js.map +0 -1
- package/dist/http/payment/store/responses.d.ts +0 -15
- package/dist/http/payment/store/responses.d.ts.map +0 -1
- package/dist/http/payment/store/responses.js +0 -3
- package/dist/http/payment/store/responses.js.map +0 -1
- package/dist/http/price-list/admin/entities.d.ts +0 -63
- package/dist/http/price-list/admin/entities.d.ts.map +0 -1
- package/dist/http/price-list/admin/entities.js +0 -3
- package/dist/http/price-list/admin/entities.js.map +0 -1
- package/dist/http/price-list/admin/index.d.ts +0 -5
- package/dist/http/price-list/admin/index.d.ts.map +0 -1
- package/dist/http/price-list/admin/index.js +0 -21
- package/dist/http/price-list/admin/index.js.map +0 -1
- package/dist/http/price-list/admin/payloads.d.ts +0 -148
- package/dist/http/price-list/admin/payloads.d.ts.map +0 -1
- package/dist/http/price-list/admin/payloads.js +0 -3
- package/dist/http/price-list/admin/payloads.js.map +0 -1
- package/dist/http/price-list/admin/queries.d.ts +0 -34
- package/dist/http/price-list/admin/queries.d.ts.map +0 -1
- package/dist/http/price-list/admin/queries.js +0 -3
- package/dist/http/price-list/admin/queries.js.map +0 -1
- package/dist/http/price-list/admin/responses.d.ts +0 -41
- package/dist/http/price-list/admin/responses.d.ts.map +0 -1
- package/dist/http/price-list/admin/responses.js +0 -3
- package/dist/http/price-list/admin/responses.js.map +0 -1
- package/dist/http/price-list/index.d.ts +0 -2
- package/dist/http/price-list/index.d.ts.map +0 -1
- package/dist/http/price-list/index.js +0 -18
- package/dist/http/price-list/index.js.map +0 -1
- package/dist/http/pricing/admin/entities.d.ts +0 -104
- package/dist/http/pricing/admin/entities.d.ts.map +0 -1
- package/dist/http/pricing/admin/entities.js +0 -3
- package/dist/http/pricing/admin/entities.js.map +0 -1
- package/dist/http/pricing/admin/index.d.ts +0 -5
- package/dist/http/pricing/admin/index.d.ts.map +0 -1
- package/dist/http/pricing/admin/index.js +0 -21
- package/dist/http/pricing/admin/index.js.map +0 -1
- package/dist/http/pricing/admin/payloads.d.ts +0 -39
- package/dist/http/pricing/admin/payloads.d.ts.map +0 -1
- package/dist/http/pricing/admin/payloads.js +0 -3
- package/dist/http/pricing/admin/payloads.js.map +0 -1
- package/dist/http/pricing/admin/queries.d.ts +0 -23
- package/dist/http/pricing/admin/queries.d.ts.map +0 -1
- package/dist/http/pricing/admin/queries.js +0 -3
- package/dist/http/pricing/admin/queries.js.map +0 -1
- package/dist/http/pricing/admin/responses.d.ts +0 -18
- package/dist/http/pricing/admin/responses.d.ts.map +0 -1
- package/dist/http/pricing/admin/responses.js +0 -3
- package/dist/http/pricing/admin/responses.js.map +0 -1
- package/dist/http/pricing/common.d.ts +0 -103
- package/dist/http/pricing/common.d.ts.map +0 -1
- package/dist/http/pricing/common.js +0 -3
- package/dist/http/pricing/common.js.map +0 -1
- package/dist/http/pricing/index.d.ts +0 -3
- package/dist/http/pricing/index.d.ts.map +0 -1
- package/dist/http/pricing/index.js +0 -19
- package/dist/http/pricing/index.js.map +0 -1
- package/dist/http/pricing/store/entities.d.ts +0 -52
- package/dist/http/pricing/store/entities.d.ts.map +0 -1
- package/dist/http/pricing/store/entities.js +0 -3
- package/dist/http/pricing/store/entities.js.map +0 -1
- package/dist/http/pricing/store/index.d.ts +0 -2
- package/dist/http/pricing/store/index.d.ts.map +0 -1
- package/dist/http/pricing/store/index.js +0 -18
- package/dist/http/pricing/store/index.js.map +0 -1
- package/dist/http/product/admin/entitites.d.ts +0 -136
- package/dist/http/product/admin/entitites.d.ts.map +0 -1
- package/dist/http/product/admin/entitites.js +0 -3
- package/dist/http/product/admin/entitites.js.map +0 -1
- package/dist/http/product/admin/index.d.ts +0 -5
- package/dist/http/product/admin/index.d.ts.map +0 -1
- package/dist/http/product/admin/index.js +0 -21
- package/dist/http/product/admin/index.js.map +0 -1
- package/dist/http/product/admin/payloads.d.ts +0 -619
- package/dist/http/product/admin/payloads.d.ts.map +0 -1
- package/dist/http/product/admin/payloads.js +0 -3
- package/dist/http/product/admin/payloads.js.map +0 -1
- package/dist/http/product/admin/queries.d.ts +0 -71
- package/dist/http/product/admin/queries.d.ts.map +0 -1
- package/dist/http/product/admin/queries.js +0 -3
- package/dist/http/product/admin/queries.js.map +0 -1
- package/dist/http/product/admin/responses.d.ts +0 -109
- package/dist/http/product/admin/responses.d.ts.map +0 -1
- package/dist/http/product/admin/responses.js +0 -3
- package/dist/http/product/admin/responses.js.map +0 -1
- package/dist/http/product/common.d.ts +0 -436
- package/dist/http/product/common.d.ts.map +0 -1
- package/dist/http/product/common.js +0 -3
- package/dist/http/product/common.js.map +0 -1
- package/dist/http/product/index.d.ts +0 -3
- package/dist/http/product/index.d.ts.map +0 -1
- package/dist/http/product/index.js +0 -19
- package/dist/http/product/index.js.map +0 -1
- package/dist/http/product/store/entitites.d.ts +0 -65
- package/dist/http/product/store/entitites.d.ts.map +0 -1
- package/dist/http/product/store/entitites.js +0 -3
- package/dist/http/product/store/entitites.js.map +0 -1
- package/dist/http/product/store/index.d.ts +0 -4
- package/dist/http/product/store/index.d.ts.map +0 -1
- package/dist/http/product/store/index.js +0 -20
- package/dist/http/product/store/index.js.map +0 -1
- package/dist/http/product/store/queries.d.ts +0 -57
- package/dist/http/product/store/queries.d.ts.map +0 -1
- package/dist/http/product/store/queries.js +0 -3
- package/dist/http/product/store/queries.js.map +0 -1
- package/dist/http/product/store/responses.d.ts +0 -27
- package/dist/http/product/store/responses.d.ts.map +0 -1
- package/dist/http/product/store/responses.js +0 -3
- package/dist/http/product/store/responses.js.map +0 -1
- package/dist/http/product-category/admin/entities.d.ts +0 -22
- package/dist/http/product-category/admin/entities.d.ts.map +0 -1
- package/dist/http/product-category/admin/entities.js +0 -3
- package/dist/http/product-category/admin/entities.js.map +0 -1
- package/dist/http/product-category/admin/index.d.ts +0 -5
- package/dist/http/product-category/admin/index.d.ts.map +0 -1
- package/dist/http/product-category/admin/index.js +0 -21
- package/dist/http/product-category/admin/index.js.map +0 -1
- package/dist/http/product-category/admin/payloads.d.ts +0 -85
- package/dist/http/product-category/admin/payloads.d.ts.map +0 -1
- package/dist/http/product-category/admin/payloads.js +0 -3
- package/dist/http/product-category/admin/payloads.js.map +0 -1
- package/dist/http/product-category/admin/queries.d.ts +0 -14
- package/dist/http/product-category/admin/queries.d.ts.map +0 -1
- package/dist/http/product-category/admin/queries.js +0 -3
- package/dist/http/product-category/admin/queries.js.map +0 -1
- package/dist/http/product-category/admin/responses.d.ts +0 -18
- package/dist/http/product-category/admin/responses.d.ts.map +0 -1
- package/dist/http/product-category/admin/responses.js +0 -3
- package/dist/http/product-category/admin/responses.js.map +0 -1
- package/dist/http/product-category/common.d.ts +0 -135
- package/dist/http/product-category/common.d.ts.map +0 -1
- package/dist/http/product-category/common.js +0 -3
- package/dist/http/product-category/common.js.map +0 -1
- package/dist/http/product-category/index.d.ts +0 -3
- package/dist/http/product-category/index.d.ts.map +0 -1
- package/dist/http/product-category/index.js +0 -19
- package/dist/http/product-category/index.js.map +0 -1
- package/dist/http/product-category/store/entities.d.ts +0 -17
- package/dist/http/product-category/store/entities.d.ts.map +0 -1
- package/dist/http/product-category/store/entities.js +0 -3
- package/dist/http/product-category/store/entities.js.map +0 -1
- package/dist/http/product-category/store/index.d.ts +0 -4
- package/dist/http/product-category/store/index.d.ts.map +0 -1
- package/dist/http/product-category/store/index.js +0 -20
- package/dist/http/product-category/store/index.js.map +0 -1
- package/dist/http/product-category/store/queries.d.ts +0 -6
- package/dist/http/product-category/store/queries.d.ts.map +0 -1
- package/dist/http/product-category/store/queries.js +0 -3
- package/dist/http/product-category/store/queries.js.map +0 -1
- package/dist/http/product-category/store/responses.d.ts +0 -16
- package/dist/http/product-category/store/responses.d.ts.map +0 -1
- package/dist/http/product-category/store/responses.js +0 -3
- package/dist/http/product-category/store/responses.js.map +0 -1
- package/dist/http/product-tag/admin/entities.d.ts +0 -9
- package/dist/http/product-tag/admin/entities.d.ts.map +0 -1
- package/dist/http/product-tag/admin/entities.js +0 -3
- package/dist/http/product-tag/admin/entities.js.map +0 -1
- package/dist/http/product-tag/admin/index.d.ts +0 -5
- package/dist/http/product-tag/admin/index.d.ts.map +0 -1
- package/dist/http/product-tag/admin/index.js +0 -21
- package/dist/http/product-tag/admin/index.js.map +0 -1
- package/dist/http/product-tag/admin/payloads.d.ts +0 -21
- package/dist/http/product-tag/admin/payloads.d.ts.map +0 -1
- package/dist/http/product-tag/admin/payloads.js +0 -3
- package/dist/http/product-tag/admin/payloads.js.map +0 -1
- package/dist/http/product-tag/admin/queries.d.ts +0 -12
- package/dist/http/product-tag/admin/queries.d.ts.map +0 -1
- package/dist/http/product-tag/admin/queries.js +0 -3
- package/dist/http/product-tag/admin/queries.js.map +0 -1
- package/dist/http/product-tag/admin/responses.d.ts +0 -18
- package/dist/http/product-tag/admin/responses.d.ts.map +0 -1
- package/dist/http/product-tag/admin/responses.js +0 -3
- package/dist/http/product-tag/admin/responses.js.map +0 -1
- package/dist/http/product-tag/common.d.ts +0 -51
- package/dist/http/product-tag/common.d.ts.map +0 -1
- package/dist/http/product-tag/common.js +0 -3
- package/dist/http/product-tag/common.js.map +0 -1
- package/dist/http/product-tag/index.d.ts +0 -3
- package/dist/http/product-tag/index.d.ts.map +0 -1
- package/dist/http/product-tag/index.js +0 -19
- package/dist/http/product-tag/index.js.map +0 -1
- package/dist/http/product-tag/store/entities.d.ts +0 -4
- package/dist/http/product-tag/store/entities.d.ts.map +0 -1
- package/dist/http/product-tag/store/entities.js +0 -3
- package/dist/http/product-tag/store/entities.js.map +0 -1
- package/dist/http/product-tag/store/index.d.ts +0 -4
- package/dist/http/product-tag/store/index.d.ts.map +0 -1
- package/dist/http/product-tag/store/index.js +0 -20
- package/dist/http/product-tag/store/index.js.map +0 -1
- package/dist/http/product-tag/store/queries.d.ts +0 -8
- package/dist/http/product-tag/store/queries.d.ts.map +0 -1
- package/dist/http/product-tag/store/queries.js +0 -3
- package/dist/http/product-tag/store/queries.js.map +0 -1
- package/dist/http/product-tag/store/responses.d.ts +0 -16
- package/dist/http/product-tag/store/responses.d.ts.map +0 -1
- package/dist/http/product-tag/store/responses.js +0 -3
- package/dist/http/product-tag/store/responses.js.map +0 -1
- package/dist/http/product-type/admin/entities.d.ts +0 -9
- package/dist/http/product-type/admin/entities.d.ts.map +0 -1
- package/dist/http/product-type/admin/entities.js +0 -3
- package/dist/http/product-type/admin/entities.js.map +0 -1
- package/dist/http/product-type/admin/index.d.ts +0 -5
- package/dist/http/product-type/admin/index.d.ts.map +0 -1
- package/dist/http/product-type/admin/index.js +0 -21
- package/dist/http/product-type/admin/index.js.map +0 -1
- package/dist/http/product-type/admin/payloads.d.ts +0 -21
- package/dist/http/product-type/admin/payloads.d.ts.map +0 -1
- package/dist/http/product-type/admin/payloads.js +0 -3
- package/dist/http/product-type/admin/payloads.js.map +0 -1
- package/dist/http/product-type/admin/queries.d.ts +0 -31
- package/dist/http/product-type/admin/queries.d.ts.map +0 -1
- package/dist/http/product-type/admin/queries.js +0 -3
- package/dist/http/product-type/admin/queries.js.map +0 -1
- package/dist/http/product-type/admin/responses.d.ts +0 -18
- package/dist/http/product-type/admin/responses.d.ts.map +0 -1
- package/dist/http/product-type/admin/responses.js +0 -3
- package/dist/http/product-type/admin/responses.js.map +0 -1
- package/dist/http/product-type/common.d.ts +0 -51
- package/dist/http/product-type/common.d.ts.map +0 -1
- package/dist/http/product-type/common.js +0 -3
- package/dist/http/product-type/common.js.map +0 -1
- package/dist/http/product-type/index.d.ts +0 -3
- package/dist/http/product-type/index.d.ts.map +0 -1
- package/dist/http/product-type/index.js +0 -19
- package/dist/http/product-type/index.js.map +0 -1
- package/dist/http/product-type/store/entities.d.ts +0 -4
- package/dist/http/product-type/store/entities.d.ts.map +0 -1
- package/dist/http/product-type/store/entities.js +0 -3
- package/dist/http/product-type/store/entities.js.map +0 -1
- package/dist/http/product-type/store/index.d.ts +0 -4
- package/dist/http/product-type/store/index.d.ts.map +0 -1
- package/dist/http/product-type/store/index.js +0 -20
- package/dist/http/product-type/store/index.js.map +0 -1
- package/dist/http/product-type/store/queries.d.ts +0 -8
- package/dist/http/product-type/store/queries.d.ts.map +0 -1
- package/dist/http/product-type/store/queries.js +0 -3
- package/dist/http/product-type/store/queries.js.map +0 -1
- package/dist/http/product-type/store/responses.d.ts +0 -16
- package/dist/http/product-type/store/responses.d.ts.map +0 -1
- package/dist/http/product-type/store/responses.js +0 -3
- package/dist/http/product-type/store/responses.js.map +0 -1
- package/dist/http/promotion/admin/entities.d.ts +0 -39
- package/dist/http/promotion/admin/entities.d.ts.map +0 -1
- package/dist/http/promotion/admin/entities.js +0 -3
- package/dist/http/promotion/admin/entities.js.map +0 -1
- package/dist/http/promotion/admin/index.d.ts +0 -5
- package/dist/http/promotion/admin/index.d.ts.map +0 -1
- package/dist/http/promotion/admin/index.js +0 -21
- package/dist/http/promotion/admin/index.js.map +0 -1
- package/dist/http/promotion/admin/payloads.d.ts +0 -242
- package/dist/http/promotion/admin/payloads.d.ts.map +0 -1
- package/dist/http/promotion/admin/payloads.js +0 -3
- package/dist/http/promotion/admin/payloads.js.map +0 -1
- package/dist/http/promotion/admin/queries.d.ts +0 -103
- package/dist/http/promotion/admin/queries.d.ts.map +0 -1
- package/dist/http/promotion/admin/queries.js +0 -3
- package/dist/http/promotion/admin/queries.js.map +0 -1
- package/dist/http/promotion/admin/responses.d.ts +0 -56
- package/dist/http/promotion/admin/responses.d.ts.map +0 -1
- package/dist/http/promotion/admin/responses.js +0 -3
- package/dist/http/promotion/admin/responses.js.map +0 -1
- package/dist/http/promotion/common.d.ts +0 -129
- package/dist/http/promotion/common.d.ts.map +0 -1
- package/dist/http/promotion/common.js +0 -3
- package/dist/http/promotion/common.js.map +0 -1
- package/dist/http/promotion/index.d.ts +0 -3
- package/dist/http/promotion/index.d.ts.map +0 -1
- package/dist/http/promotion/index.js +0 -19
- package/dist/http/promotion/index.js.map +0 -1
- package/dist/http/promotion/store.d.ts +0 -4
- package/dist/http/promotion/store.d.ts.map +0 -1
- package/dist/http/promotion/store.js +0 -3
- package/dist/http/promotion/store.js.map +0 -1
- package/dist/http/refund-reason/admin/entities.d.ts +0 -4
- package/dist/http/refund-reason/admin/entities.d.ts.map +0 -1
- package/dist/http/refund-reason/admin/entities.js +0 -3
- package/dist/http/refund-reason/admin/entities.js.map +0 -1
- package/dist/http/refund-reason/admin/index.d.ts +0 -5
- package/dist/http/refund-reason/admin/index.d.ts.map +0 -1
- package/dist/http/refund-reason/admin/index.js +0 -21
- package/dist/http/refund-reason/admin/index.js.map +0 -1
- package/dist/http/refund-reason/admin/payloads.d.ts +0 -30
- package/dist/http/refund-reason/admin/payloads.d.ts.map +0 -1
- package/dist/http/refund-reason/admin/payloads.js +0 -3
- package/dist/http/refund-reason/admin/payloads.js.map +0 -1
- package/dist/http/refund-reason/admin/queries.d.ts +0 -8
- package/dist/http/refund-reason/admin/queries.d.ts.map +0 -1
- package/dist/http/refund-reason/admin/queries.js +0 -3
- package/dist/http/refund-reason/admin/queries.js.map +0 -1
- package/dist/http/refund-reason/admin/responses.d.ts +0 -18
- package/dist/http/refund-reason/admin/responses.d.ts.map +0 -1
- package/dist/http/refund-reason/admin/responses.js +0 -3
- package/dist/http/refund-reason/admin/responses.js.map +0 -1
- package/dist/http/refund-reason/common.d.ts +0 -65
- package/dist/http/refund-reason/common.d.ts.map +0 -1
- package/dist/http/refund-reason/common.js +0 -3
- package/dist/http/refund-reason/common.js.map +0 -1
- package/dist/http/refund-reason/index.d.ts +0 -2
- package/dist/http/refund-reason/index.d.ts.map +0 -1
- package/dist/http/refund-reason/index.js +0 -18
- package/dist/http/refund-reason/index.js.map +0 -1
- package/dist/http/region/admin/entities.d.ts +0 -10
- package/dist/http/region/admin/entities.d.ts.map +0 -1
- package/dist/http/region/admin/entities.js +0 -3
- package/dist/http/region/admin/entities.js.map +0 -1
- package/dist/http/region/admin/index.d.ts +0 -5
- package/dist/http/region/admin/index.d.ts.map +0 -1
- package/dist/http/region/admin/index.js +0 -21
- package/dist/http/region/admin/index.js.map +0 -1
- package/dist/http/region/admin/payloads.d.ts +0 -87
- package/dist/http/region/admin/payloads.d.ts.map +0 -1
- package/dist/http/region/admin/payloads.js +0 -3
- package/dist/http/region/admin/payloads.js.map +0 -1
- package/dist/http/region/admin/queries.d.ts +0 -36
- package/dist/http/region/admin/queries.d.ts.map +0 -1
- package/dist/http/region/admin/queries.js +0 -3
- package/dist/http/region/admin/queries.js.map +0 -1
- package/dist/http/region/admin/responses.d.ts +0 -16
- package/dist/http/region/admin/responses.d.ts.map +0 -1
- package/dist/http/region/admin/responses.js +0 -3
- package/dist/http/region/admin/responses.js.map +0 -1
- package/dist/http/region/common.d.ts +0 -107
- package/dist/http/region/common.d.ts.map +0 -1
- package/dist/http/region/common.js +0 -3
- package/dist/http/region/common.js.map +0 -1
- package/dist/http/region/index.d.ts +0 -3
- package/dist/http/region/index.d.ts.map +0 -1
- package/dist/http/region/index.js +0 -19
- package/dist/http/region/index.js.map +0 -1
- package/dist/http/region/store/entities.d.ts +0 -6
- package/dist/http/region/store/entities.d.ts.map +0 -1
- package/dist/http/region/store/entities.js +0 -3
- package/dist/http/region/store/entities.js.map +0 -1
- package/dist/http/region/store/index.d.ts +0 -4
- package/dist/http/region/store/index.d.ts.map +0 -1
- package/dist/http/region/store/index.js +0 -20
- package/dist/http/region/store/index.js.map +0 -1
- package/dist/http/region/store/queries.d.ts +0 -7
- package/dist/http/region/store/queries.d.ts.map +0 -1
- package/dist/http/region/store/queries.js +0 -3
- package/dist/http/region/store/queries.js.map +0 -1
- package/dist/http/region/store/responses.d.ts +0 -15
- package/dist/http/region/store/responses.d.ts.map +0 -1
- package/dist/http/region/store/responses.js +0 -3
- package/dist/http/region/store/responses.js.map +0 -1
- package/dist/http/reservation/admin/entities.d.ts +0 -56
- package/dist/http/reservation/admin/entities.d.ts.map +0 -1
- package/dist/http/reservation/admin/entities.js +0 -3
- package/dist/http/reservation/admin/entities.js.map +0 -1
- package/dist/http/reservation/admin/index.d.ts +0 -5
- package/dist/http/reservation/admin/index.d.ts.map +0 -1
- package/dist/http/reservation/admin/index.js +0 -21
- package/dist/http/reservation/admin/index.js.map +0 -1
- package/dist/http/reservation/admin/payloads.d.ts +0 -47
- package/dist/http/reservation/admin/payloads.d.ts.map +0 -1
- package/dist/http/reservation/admin/payloads.js +0 -3
- package/dist/http/reservation/admin/payloads.js.map +0 -1
- package/dist/http/reservation/admin/queries.d.ts +0 -51
- package/dist/http/reservation/admin/queries.d.ts.map +0 -1
- package/dist/http/reservation/admin/queries.js +0 -3
- package/dist/http/reservation/admin/queries.js.map +0 -1
- package/dist/http/reservation/admin/responses.d.ts +0 -16
- package/dist/http/reservation/admin/responses.d.ts.map +0 -1
- package/dist/http/reservation/admin/responses.js +0 -3
- package/dist/http/reservation/admin/responses.js.map +0 -1
- package/dist/http/reservation/index.d.ts +0 -2
- package/dist/http/reservation/index.d.ts.map +0 -1
- package/dist/http/reservation/index.js +0 -18
- package/dist/http/reservation/index.js.map +0 -1
- package/dist/http/return/admin/entities.d.ts +0 -10
- package/dist/http/return/admin/entities.d.ts.map +0 -1
- package/dist/http/return/admin/entities.js +0 -3
- package/dist/http/return/admin/entities.js.map +0 -1
- package/dist/http/return/admin/index.d.ts +0 -5
- package/dist/http/return/admin/index.d.ts.map +0 -1
- package/dist/http/return/admin/index.js +0 -21
- package/dist/http/return/admin/index.js.map +0 -1
- package/dist/http/return/admin/payloads.d.ts +0 -252
- package/dist/http/return/admin/payloads.d.ts.map +0 -1
- package/dist/http/return/admin/payloads.js +0 -3
- package/dist/http/return/admin/payloads.js.map +0 -1
- package/dist/http/return/admin/queries.d.ts +0 -25
- package/dist/http/return/admin/queries.d.ts.map +0 -1
- package/dist/http/return/admin/queries.js +0 -3
- package/dist/http/return/admin/queries.js.map +0 -1
- package/dist/http/return/admin/responses.d.ts +0 -26
- package/dist/http/return/admin/responses.d.ts.map +0 -1
- package/dist/http/return/admin/responses.js +0 -3
- package/dist/http/return/admin/responses.js.map +0 -1
- package/dist/http/return/common.d.ts +0 -102
- package/dist/http/return/common.d.ts.map +0 -1
- package/dist/http/return/common.js +0 -3
- package/dist/http/return/common.js.map +0 -1
- package/dist/http/return/index.d.ts +0 -3
- package/dist/http/return/index.d.ts.map +0 -1
- package/dist/http/return/index.js +0 -19
- package/dist/http/return/index.js.map +0 -1
- package/dist/http/return/store/entities.d.ts +0 -7
- package/dist/http/return/store/entities.d.ts.map +0 -1
- package/dist/http/return/store/entities.js +0 -3
- package/dist/http/return/store/entities.js.map +0 -1
- package/dist/http/return/store/index.d.ts +0 -4
- package/dist/http/return/store/index.d.ts.map +0 -1
- package/dist/http/return/store/index.js +0 -20
- package/dist/http/return/store/index.js.map +0 -1
- package/dist/http/return/store/payloads.d.ts +0 -20
- package/dist/http/return/store/payloads.d.ts.map +0 -1
- package/dist/http/return/store/payloads.js +0 -3
- package/dist/http/return/store/payloads.js.map +0 -1
- package/dist/http/return/store/responses.d.ts +0 -5
- package/dist/http/return/store/responses.d.ts.map +0 -1
- package/dist/http/return/store/responses.js +0 -3
- package/dist/http/return/store/responses.js.map +0 -1
- package/dist/http/return-reason/admin/entities.d.ts +0 -4
- package/dist/http/return-reason/admin/entities.d.ts.map +0 -1
- package/dist/http/return-reason/admin/entities.js +0 -3
- package/dist/http/return-reason/admin/entities.js.map +0 -1
- package/dist/http/return-reason/admin/index.d.ts +0 -5
- package/dist/http/return-reason/admin/index.d.ts.map +0 -1
- package/dist/http/return-reason/admin/index.js +0 -21
- package/dist/http/return-reason/admin/index.js.map +0 -1
- package/dist/http/return-reason/admin/payloads.d.ts +0 -34
- package/dist/http/return-reason/admin/payloads.d.ts.map +0 -1
- package/dist/http/return-reason/admin/payloads.js +0 -3
- package/dist/http/return-reason/admin/payloads.js.map +0 -1
- package/dist/http/return-reason/admin/queries.d.ts +0 -12
- package/dist/http/return-reason/admin/queries.d.ts.map +0 -1
- package/dist/http/return-reason/admin/queries.js +0 -3
- package/dist/http/return-reason/admin/queries.js.map +0 -1
- package/dist/http/return-reason/admin/responses.d.ts +0 -18
- package/dist/http/return-reason/admin/responses.d.ts.map +0 -1
- package/dist/http/return-reason/admin/responses.js +0 -3
- package/dist/http/return-reason/admin/responses.js.map +0 -1
- package/dist/http/return-reason/common.d.ts +0 -49
- package/dist/http/return-reason/common.d.ts.map +0 -1
- package/dist/http/return-reason/common.js +0 -3
- package/dist/http/return-reason/common.js.map +0 -1
- package/dist/http/return-reason/index.d.ts +0 -3
- package/dist/http/return-reason/index.d.ts.map +0 -1
- package/dist/http/return-reason/index.js +0 -19
- package/dist/http/return-reason/index.js.map +0 -1
- package/dist/http/return-reason/store/entities.d.ts +0 -4
- package/dist/http/return-reason/store/entities.d.ts.map +0 -1
- package/dist/http/return-reason/store/entities.js +0 -3
- package/dist/http/return-reason/store/entities.js.map +0 -1
- package/dist/http/return-reason/store/index.d.ts +0 -3
- package/dist/http/return-reason/store/index.d.ts.map +0 -1
- package/dist/http/return-reason/store/index.js +0 -19
- package/dist/http/return-reason/store/index.js.map +0 -1
- package/dist/http/return-reason/store/responses.d.ts +0 -9
- package/dist/http/return-reason/store/responses.d.ts.map +0 -1
- package/dist/http/return-reason/store/responses.js +0 -3
- package/dist/http/return-reason/store/responses.js.map +0 -1
- package/dist/http/sales-channel/admin/entities.d.ts +0 -35
- package/dist/http/sales-channel/admin/entities.d.ts.map +0 -1
- package/dist/http/sales-channel/admin/entities.js +0 -3
- package/dist/http/sales-channel/admin/entities.js.map +0 -1
- package/dist/http/sales-channel/admin/index.d.ts +0 -5
- package/dist/http/sales-channel/admin/index.d.ts.map +0 -1
- package/dist/http/sales-channel/admin/index.js +0 -21
- package/dist/http/sales-channel/admin/index.js.map +0 -1
- package/dist/http/sales-channel/admin/payloads.d.ts +0 -49
- package/dist/http/sales-channel/admin/payloads.d.ts.map +0 -1
- package/dist/http/sales-channel/admin/payloads.js +0 -3
- package/dist/http/sales-channel/admin/payloads.js.map +0 -1
- package/dist/http/sales-channel/admin/queries.d.ts +0 -47
- package/dist/http/sales-channel/admin/queries.d.ts.map +0 -1
- package/dist/http/sales-channel/admin/queries.js +0 -3
- package/dist/http/sales-channel/admin/queries.js.map +0 -1
- package/dist/http/sales-channel/admin/responses.d.ts +0 -17
- package/dist/http/sales-channel/admin/responses.d.ts.map +0 -1
- package/dist/http/sales-channel/admin/responses.js +0 -3
- package/dist/http/sales-channel/admin/responses.js.map +0 -1
- package/dist/http/sales-channel/index.d.ts +0 -2
- package/dist/http/sales-channel/index.d.ts.map +0 -1
- package/dist/http/sales-channel/index.js +0 -18
- package/dist/http/sales-channel/index.js.map +0 -1
- package/dist/http/shipping-option/admin/entities.d.ts +0 -249
- package/dist/http/shipping-option/admin/entities.d.ts.map +0 -1
- package/dist/http/shipping-option/admin/entities.js +0 -3
- package/dist/http/shipping-option/admin/entities.js.map +0 -1
- package/dist/http/shipping-option/admin/index.d.ts +0 -5
- package/dist/http/shipping-option/admin/index.d.ts.map +0 -1
- package/dist/http/shipping-option/admin/index.js +0 -21
- package/dist/http/shipping-option/admin/index.js.map +0 -1
- package/dist/http/shipping-option/admin/payloads.d.ts +0 -281
- package/dist/http/shipping-option/admin/payloads.d.ts.map +0 -1
- package/dist/http/shipping-option/admin/payloads.js +0 -3
- package/dist/http/shipping-option/admin/payloads.js.map +0 -1
- package/dist/http/shipping-option/admin/queries.d.ts +0 -83
- package/dist/http/shipping-option/admin/queries.d.ts.map +0 -1
- package/dist/http/shipping-option/admin/queries.js +0 -3
- package/dist/http/shipping-option/admin/queries.js.map +0 -1
- package/dist/http/shipping-option/admin/responses.d.ts +0 -33
- package/dist/http/shipping-option/admin/responses.d.ts.map +0 -1
- package/dist/http/shipping-option/admin/responses.js +0 -3
- package/dist/http/shipping-option/admin/responses.js.map +0 -1
- package/dist/http/shipping-option/index.d.ts +0 -3
- package/dist/http/shipping-option/index.d.ts.map +0 -1
- package/dist/http/shipping-option/index.js +0 -19
- package/dist/http/shipping-option/index.js.map +0 -1
- package/dist/http/shipping-option/store/entities.d.ts +0 -28
- package/dist/http/shipping-option/store/entities.d.ts.map +0 -1
- package/dist/http/shipping-option/store/entities.js +0 -3
- package/dist/http/shipping-option/store/entities.js.map +0 -1
- package/dist/http/shipping-option/store/index.d.ts +0 -5
- package/dist/http/shipping-option/store/index.d.ts.map +0 -1
- package/dist/http/shipping-option/store/index.js +0 -21
- package/dist/http/shipping-option/store/index.js.map +0 -1
- package/dist/http/shipping-option/store/payloads.d.ts +0 -17
- package/dist/http/shipping-option/store/payloads.d.ts.map +0 -1
- package/dist/http/shipping-option/store/payloads.js +0 -3
- package/dist/http/shipping-option/store/payloads.js.map +0 -1
- package/dist/http/shipping-option/store/queries.d.ts +0 -14
- package/dist/http/shipping-option/store/queries.d.ts.map +0 -1
- package/dist/http/shipping-option/store/queries.js +0 -3
- package/dist/http/shipping-option/store/queries.js.map +0 -1
- package/dist/http/shipping-option/store/responses.d.ts +0 -20
- package/dist/http/shipping-option/store/responses.d.ts.map +0 -1
- package/dist/http/shipping-option/store/responses.js +0 -3
- package/dist/http/shipping-option/store/responses.js.map +0 -1
- package/dist/http/shipping-profile/admin/entities.d.ts +0 -31
- package/dist/http/shipping-profile/admin/entities.d.ts.map +0 -1
- package/dist/http/shipping-profile/admin/entities.js +0 -3
- package/dist/http/shipping-profile/admin/entities.js.map +0 -1
- package/dist/http/shipping-profile/admin/index.d.ts +0 -5
- package/dist/http/shipping-profile/admin/index.d.ts.map +0 -1
- package/dist/http/shipping-profile/admin/index.js +0 -21
- package/dist/http/shipping-profile/admin/index.js.map +0 -1
- package/dist/http/shipping-profile/admin/payloads.d.ts +0 -29
- package/dist/http/shipping-profile/admin/payloads.d.ts.map +0 -1
- package/dist/http/shipping-profile/admin/payloads.js +0 -3
- package/dist/http/shipping-profile/admin/payloads.js.map +0 -1
- package/dist/http/shipping-profile/admin/queries.d.ts +0 -41
- package/dist/http/shipping-profile/admin/queries.d.ts.map +0 -1
- package/dist/http/shipping-profile/admin/queries.js +0 -3
- package/dist/http/shipping-profile/admin/queries.js.map +0 -1
- package/dist/http/shipping-profile/admin/responses.d.ts +0 -17
- package/dist/http/shipping-profile/admin/responses.d.ts.map +0 -1
- package/dist/http/shipping-profile/admin/responses.js +0 -3
- package/dist/http/shipping-profile/admin/responses.js.map +0 -1
- package/dist/http/shipping-profile/index.d.ts +0 -2
- package/dist/http/shipping-profile/index.d.ts.map +0 -1
- package/dist/http/shipping-profile/index.js +0 -18
- package/dist/http/shipping-profile/index.js.map +0 -1
- package/dist/http/stock-locations/admin/entities.d.ts +0 -45
- package/dist/http/stock-locations/admin/entities.d.ts.map +0 -1
- package/dist/http/stock-locations/admin/entities.js +0 -3
- package/dist/http/stock-locations/admin/entities.js.map +0 -1
- package/dist/http/stock-locations/admin/index.d.ts +0 -5
- package/dist/http/stock-locations/admin/index.d.ts.map +0 -1
- package/dist/http/stock-locations/admin/index.js +0 -21
- package/dist/http/stock-locations/admin/index.js.map +0 -1
- package/dist/http/stock-locations/admin/payloads.d.ts +0 -101
- package/dist/http/stock-locations/admin/payloads.d.ts.map +0 -1
- package/dist/http/stock-locations/admin/payloads.js +0 -3
- package/dist/http/stock-locations/admin/payloads.js.map +0 -1
- package/dist/http/stock-locations/admin/queries.d.ts +0 -37
- package/dist/http/stock-locations/admin/queries.d.ts.map +0 -1
- package/dist/http/stock-locations/admin/queries.js +0 -3
- package/dist/http/stock-locations/admin/queries.js.map +0 -1
- package/dist/http/stock-locations/admin/responses.d.ts +0 -18
- package/dist/http/stock-locations/admin/responses.d.ts.map +0 -1
- package/dist/http/stock-locations/admin/responses.js +0 -3
- package/dist/http/stock-locations/admin/responses.js.map +0 -1
- package/dist/http/stock-locations/index.d.ts +0 -2
- package/dist/http/stock-locations/index.d.ts.map +0 -1
- package/dist/http/stock-locations/index.js +0 -18
- package/dist/http/stock-locations/index.js.map +0 -1
- package/dist/http/tax-provider/admin/entities.d.ts +0 -11
- package/dist/http/tax-provider/admin/entities.d.ts.map +0 -1
- package/dist/http/tax-provider/admin/entities.js +0 -3
- package/dist/http/tax-provider/admin/entities.js.map +0 -1
- package/dist/http/tax-provider/admin/index.d.ts +0 -4
- package/dist/http/tax-provider/admin/index.d.ts.map +0 -1
- package/dist/http/tax-provider/admin/index.js +0 -20
- package/dist/http/tax-provider/admin/index.js.map +0 -1
- package/dist/http/tax-provider/admin/queries.d.ts +0 -13
- package/dist/http/tax-provider/admin/queries.d.ts.map +0 -1
- package/dist/http/tax-provider/admin/queries.js +0 -3
- package/dist/http/tax-provider/admin/queries.js.map +0 -1
- package/dist/http/tax-provider/admin/responses.d.ts +0 -9
- package/dist/http/tax-provider/admin/responses.d.ts.map +0 -1
- package/dist/http/tax-provider/admin/responses.js +0 -3
- package/dist/http/tax-provider/admin/responses.js.map +0 -1
- package/dist/http/tax-provider/index.d.ts +0 -2
- package/dist/http/tax-provider/index.d.ts.map +0 -1
- package/dist/http/tax-provider/index.js +0 -18
- package/dist/http/tax-provider/index.js.map +0 -1
- package/dist/http/tax-rate/admin/entities.d.ts +0 -76
- package/dist/http/tax-rate/admin/entities.d.ts.map +0 -1
- package/dist/http/tax-rate/admin/entities.js +0 -3
- package/dist/http/tax-rate/admin/entities.js.map +0 -1
- package/dist/http/tax-rate/admin/index.d.ts +0 -5
- package/dist/http/tax-rate/admin/index.d.ts.map +0 -1
- package/dist/http/tax-rate/admin/index.js +0 -21
- package/dist/http/tax-rate/admin/index.js.map +0 -1
- package/dist/http/tax-rate/admin/payloads.d.ts +0 -81
- package/dist/http/tax-rate/admin/payloads.d.ts.map +0 -1
- package/dist/http/tax-rate/admin/payloads.js +0 -3
- package/dist/http/tax-rate/admin/payloads.js.map +0 -1
- package/dist/http/tax-rate/admin/queries.d.ts +0 -45
- package/dist/http/tax-rate/admin/queries.d.ts.map +0 -1
- package/dist/http/tax-rate/admin/queries.js +0 -3
- package/dist/http/tax-rate/admin/queries.js.map +0 -1
- package/dist/http/tax-rate/admin/responses.d.ts +0 -18
- package/dist/http/tax-rate/admin/responses.d.ts.map +0 -1
- package/dist/http/tax-rate/admin/responses.js +0 -3
- package/dist/http/tax-rate/admin/responses.js.map +0 -1
- package/dist/http/tax-rate/index.d.ts +0 -2
- package/dist/http/tax-rate/index.d.ts.map +0 -1
- package/dist/http/tax-rate/index.js +0 -18
- package/dist/http/tax-rate/index.js.map +0 -1
- package/dist/http/tax-region/admin/entities.d.ts +0 -62
- package/dist/http/tax-region/admin/entities.d.ts.map +0 -1
- package/dist/http/tax-region/admin/entities.js +0 -3
- package/dist/http/tax-region/admin/entities.js.map +0 -1
- package/dist/http/tax-region/admin/index.d.ts +0 -5
- package/dist/http/tax-region/admin/index.d.ts.map +0 -1
- package/dist/http/tax-region/admin/index.js +0 -21
- package/dist/http/tax-region/admin/index.js.map +0 -1
- package/dist/http/tax-region/admin/payloads.d.ts +0 -65
- package/dist/http/tax-region/admin/payloads.d.ts.map +0 -1
- package/dist/http/tax-region/admin/payloads.js +0 -3
- package/dist/http/tax-region/admin/payloads.js.map +0 -1
- package/dist/http/tax-region/admin/queries.d.ts +0 -44
- package/dist/http/tax-region/admin/queries.d.ts.map +0 -1
- package/dist/http/tax-region/admin/queries.js +0 -3
- package/dist/http/tax-region/admin/queries.js.map +0 -1
- package/dist/http/tax-region/admin/responses.d.ts +0 -17
- package/dist/http/tax-region/admin/responses.d.ts.map +0 -1
- package/dist/http/tax-region/admin/responses.js +0 -3
- package/dist/http/tax-region/admin/responses.js.map +0 -1
- package/dist/http/tax-region/index.d.ts +0 -2
- package/dist/http/tax-region/index.d.ts.map +0 -1
- package/dist/http/tax-region/index.js +0 -18
- package/dist/http/tax-region/index.js.map +0 -1
- package/dist/inventory/common/index.d.ts +0 -4
- package/dist/inventory/common/index.d.ts.map +0 -1
- package/dist/inventory/common/index.js +0 -20
- package/dist/inventory/common/index.js.map +0 -1
- package/dist/inventory/common/inventory-item.d.ts +0 -114
- package/dist/inventory/common/inventory-item.d.ts.map +0 -1
- package/dist/inventory/common/inventory-item.js +0 -3
- package/dist/inventory/common/inventory-item.js.map +0 -1
- package/dist/inventory/common/inventory-level.d.ts +0 -80
- package/dist/inventory/common/inventory-level.d.ts.map +0 -1
- package/dist/inventory/common/inventory-level.js +0 -3
- package/dist/inventory/common/inventory-level.js.map +0 -1
- package/dist/inventory/common/reservation-item.d.ts +0 -98
- package/dist/inventory/common/reservation-item.d.ts.map +0 -1
- package/dist/inventory/common/reservation-item.js +0 -3
- package/dist/inventory/common/reservation-item.js.map +0 -1
- package/dist/inventory/index.d.ts +0 -4
- package/dist/inventory/index.d.ts.map +0 -1
- package/dist/inventory/index.js +0 -20
- package/dist/inventory/index.js.map +0 -1
- package/dist/inventory/mutations/index.d.ts +0 -4
- package/dist/inventory/mutations/index.d.ts.map +0 -1
- package/dist/inventory/mutations/index.js +0 -20
- package/dist/inventory/mutations/index.js.map +0 -1
- package/dist/inventory/mutations/inventory-item.d.ts +0 -73
- package/dist/inventory/mutations/inventory-item.d.ts.map +0 -1
- package/dist/inventory/mutations/inventory-item.js +0 -3
- package/dist/inventory/mutations/inventory-item.js.map +0 -1
- package/dist/inventory/mutations/inventory-level.d.ts +0 -63
- package/dist/inventory/mutations/inventory-level.d.ts.map +0 -1
- package/dist/inventory/mutations/inventory-level.js +0 -3
- package/dist/inventory/mutations/inventory-level.js.map +0 -1
- package/dist/inventory/mutations/reservation-item.d.ts +0 -81
- package/dist/inventory/mutations/reservation-item.d.ts.map +0 -1
- package/dist/inventory/mutations/reservation-item.js +0 -3
- package/dist/inventory/mutations/reservation-item.js.map +0 -1
- package/dist/inventory/service.d.ts +0 -1034
- package/dist/inventory/service.d.ts.map +0 -1
- package/dist/inventory/service.js +0 -3
- package/dist/inventory/service.js.map +0 -1
- package/dist/order/common.d.ts +0 -2515
- package/dist/order/common.d.ts.map +0 -1
- package/dist/order/common.js +0 -3
- package/dist/order/common.js.map +0 -1
- package/dist/order/index.d.ts +0 -5
- package/dist/order/index.d.ts.map +0 -1
- package/dist/order/index.js +0 -21
- package/dist/order/index.js.map +0 -1
- package/dist/order/mutations.d.ts +0 -1933
- package/dist/order/mutations.d.ts.map +0 -1
- package/dist/order/mutations.js +0 -3
- package/dist/order/mutations.js.map +0 -1
- package/dist/order/service.d.ts +0 -4130
- package/dist/order/service.d.ts.map +0 -1
- package/dist/order/service.js +0 -3
- package/dist/order/service.js.map +0 -1
- package/dist/order/workflows.d.ts +0 -8
- package/dist/order/workflows.d.ts.map +0 -1
- package/dist/order/workflows.js +0 -3
- package/dist/order/workflows.js.map +0 -1
- package/dist/payment/common.d.ts +0 -585
- package/dist/payment/common.d.ts.map +0 -1
- package/dist/payment/common.js +0 -3
- package/dist/payment/common.js.map +0 -1
- package/dist/payment/index.d.ts +0 -5
- package/dist/payment/index.d.ts.map +0 -1
- package/dist/payment/index.js +0 -21
- package/dist/payment/index.js.map +0 -1
- package/dist/payment/mutations.d.ts +0 -353
- package/dist/payment/mutations.d.ts.map +0 -1
- package/dist/payment/mutations.js +0 -3
- package/dist/payment/mutations.js.map +0 -1
- package/dist/payment/provider.d.ts +0 -617
- package/dist/payment/provider.d.ts.map +0 -1
- package/dist/payment/provider.js +0 -3
- package/dist/payment/provider.js.map +0 -1
- package/dist/payment/service.d.ts +0 -1234
- package/dist/payment/service.d.ts.map +0 -1
- package/dist/payment/service.js +0 -3
- package/dist/payment/service.js.map +0 -1
- package/dist/pricing/common/index.d.ts +0 -8
- package/dist/pricing/common/index.d.ts.map +0 -1
- package/dist/pricing/common/index.js +0 -24
- package/dist/pricing/common/index.js.map +0 -1
- package/dist/pricing/common/money-amount.d.ts +0 -120
- package/dist/pricing/common/money-amount.d.ts.map +0 -1
- package/dist/pricing/common/money-amount.js +0 -3
- package/dist/pricing/common/money-amount.js.map +0 -1
- package/dist/pricing/common/price-list.d.ts +0 -345
- package/dist/pricing/common/price-list.d.ts.map +0 -1
- package/dist/pricing/common/price-list.js +0 -3
- package/dist/pricing/common/price-list.js.map +0 -1
- package/dist/pricing/common/price-preference.d.ts +0 -90
- package/dist/pricing/common/price-preference.d.ts.map +0 -1
- package/dist/pricing/common/price-preference.js +0 -3
- package/dist/pricing/common/price-preference.js.map +0 -1
- package/dist/pricing/common/price-rule.d.ts +0 -165
- package/dist/pricing/common/price-rule.d.ts.map +0 -1
- package/dist/pricing/common/price-rule.js +0 -3
- package/dist/pricing/common/price-rule.js.map +0 -1
- package/dist/pricing/common/price-set.d.ts +0 -289
- package/dist/pricing/common/price-set.d.ts.map +0 -1
- package/dist/pricing/common/price-set.js +0 -3
- package/dist/pricing/common/price-set.js.map +0 -1
- package/dist/pricing/common/price.d.ts +0 -138
- package/dist/pricing/common/price.d.ts.map +0 -1
- package/dist/pricing/common/price.js +0 -3
- package/dist/pricing/common/price.js.map +0 -1
- package/dist/pricing/common/pricing-context.d.ts +0 -11
- package/dist/pricing/common/pricing-context.d.ts.map +0 -1
- package/dist/pricing/common/pricing-context.js +0 -3
- package/dist/pricing/common/pricing-context.js.map +0 -1
- package/dist/pricing/index.d.ts +0 -4
- package/dist/pricing/index.d.ts.map +0 -1
- package/dist/pricing/index.js +0 -20
- package/dist/pricing/index.js.map +0 -1
- package/dist/pricing/service.d.ts +0 -1601
- package/dist/pricing/service.d.ts.map +0 -1
- package/dist/pricing/service.js +0 -3
- package/dist/pricing/service.js.map +0 -1
- package/dist/pricing/workflows.d.ts +0 -242
- package/dist/pricing/workflows.d.ts.map +0 -1
- package/dist/pricing/workflows.js +0 -3
- package/dist/pricing/workflows.js.map +0 -1
- package/dist/product/common.d.ts +0 -1643
- package/dist/product/common.d.ts.map +0 -1
- package/dist/product/common.js +0 -3
- package/dist/product/common.js.map +0 -1
- package/dist/product/index.d.ts +0 -3
- package/dist/product/index.d.ts.map +0 -1
- package/dist/product/index.js +0 -19
- package/dist/product/index.js.map +0 -1
- package/dist/product/service.d.ts +0 -2429
- package/dist/product/service.d.ts.map +0 -1
- package/dist/product/service.js +0 -3
- package/dist/product/service.js.map +0 -1
- package/dist/product-category/index.d.ts +0 -2
- package/dist/product-category/index.d.ts.map +0 -1
- package/dist/product-category/index.js +0 -18
- package/dist/product-category/index.js.map +0 -1
- package/dist/product-category/repository.d.ts +0 -6
- package/dist/product-category/repository.d.ts.map +0 -1
- package/dist/product-category/repository.js +0 -3
- package/dist/product-category/repository.js.map +0 -1
- package/dist/promotion/common/application-method.d.ts +0 -208
- package/dist/promotion/common/application-method.d.ts.map +0 -1
- package/dist/promotion/common/application-method.js +0 -3
- package/dist/promotion/common/application-method.js.map +0 -1
- package/dist/promotion/common/campaign-budget.d.ts +0 -73
- package/dist/promotion/common/campaign-budget.d.ts.map +0 -1
- package/dist/promotion/common/campaign-budget.js +0 -3
- package/dist/promotion/common/campaign-budget.js.map +0 -1
- package/dist/promotion/common/campaign.d.ts +0 -58
- package/dist/promotion/common/campaign.d.ts.map +0 -1
- package/dist/promotion/common/campaign.js +0 -3
- package/dist/promotion/common/campaign.js.map +0 -1
- package/dist/promotion/common/campaing-budget-usage.d.ts +0 -58
- package/dist/promotion/common/campaing-budget-usage.d.ts.map +0 -1
- package/dist/promotion/common/campaing-budget-usage.js +0 -3
- package/dist/promotion/common/campaing-budget-usage.js.map +0 -1
- package/dist/promotion/common/compute-actions.d.ts +0 -296
- package/dist/promotion/common/compute-actions.d.ts.map +0 -1
- package/dist/promotion/common/compute-actions.js +0 -3
- package/dist/promotion/common/compute-actions.js.map +0 -1
- package/dist/promotion/common/index.d.ts +0 -9
- package/dist/promotion/common/index.d.ts.map +0 -1
- package/dist/promotion/common/index.js +0 -25
- package/dist/promotion/common/index.js.map +0 -1
- package/dist/promotion/common/promotion-rule-value.d.ts +0 -47
- package/dist/promotion/common/promotion-rule-value.d.ts.map +0 -1
- package/dist/promotion/common/promotion-rule-value.js +0 -3
- package/dist/promotion/common/promotion-rule-value.js.map +0 -1
- package/dist/promotion/common/promotion-rule.d.ts +0 -106
- package/dist/promotion/common/promotion-rule.d.ts.map +0 -1
- package/dist/promotion/common/promotion-rule.js +0 -3
- package/dist/promotion/common/promotion-rule.js.map +0 -1
- package/dist/promotion/common/promotion.d.ts +0 -214
- package/dist/promotion/common/promotion.d.ts.map +0 -1
- package/dist/promotion/common/promotion.js +0 -3
- package/dist/promotion/common/promotion.js.map +0 -1
- package/dist/promotion/http.d.ts +0 -16
- package/dist/promotion/http.d.ts.map +0 -1
- package/dist/promotion/http.js +0 -3
- package/dist/promotion/http.js.map +0 -1
- package/dist/promotion/index.d.ts +0 -6
- package/dist/promotion/index.d.ts.map +0 -1
- package/dist/promotion/index.js +0 -22
- package/dist/promotion/index.js.map +0 -1
- package/dist/promotion/mutations.d.ts +0 -140
- package/dist/promotion/mutations.d.ts.map +0 -1
- package/dist/promotion/mutations.js +0 -3
- package/dist/promotion/mutations.js.map +0 -1
- package/dist/promotion/service.d.ts +0 -905
- package/dist/promotion/service.d.ts.map +0 -1
- package/dist/promotion/service.js +0 -3
- package/dist/promotion/service.js.map +0 -1
- package/dist/promotion/workflows.d.ts +0 -55
- package/dist/promotion/workflows.d.ts.map +0 -1
- package/dist/promotion/workflows.js +0 -3
- package/dist/promotion/workflows.js.map +0 -1
- package/dist/region/common.d.ts +0 -135
- package/dist/region/common.d.ts.map +0 -1
- package/dist/region/common.js +0 -3
- package/dist/region/common.js.map +0 -1
- package/dist/region/index.d.ts +0 -4
- package/dist/region/index.d.ts.map +0 -1
- package/dist/region/index.js +0 -20
- package/dist/region/index.js.map +0 -1
- package/dist/region/mutations.d.ts +0 -87
- package/dist/region/mutations.d.ts.map +0 -1
- package/dist/region/mutations.js +0 -3
- package/dist/region/mutations.js.map +0 -1
- package/dist/region/service.d.ts +0 -466
- package/dist/region/service.d.ts.map +0 -1
- package/dist/region/service.js +0 -3
- package/dist/region/service.js.map +0 -1
- package/dist/sales-channel/common.d.ts +0 -69
- package/dist/sales-channel/common.d.ts.map +0 -1
- package/dist/sales-channel/common.js +0 -3
- package/dist/sales-channel/common.js.map +0 -1
- package/dist/sales-channel/index.d.ts +0 -4
- package/dist/sales-channel/index.d.ts.map +0 -1
- package/dist/sales-channel/index.js +0 -20
- package/dist/sales-channel/index.js.map +0 -1
- package/dist/sales-channel/mutations.d.ts +0 -66
- package/dist/sales-channel/mutations.d.ts.map +0 -1
- package/dist/sales-channel/mutations.js +0 -3
- package/dist/sales-channel/mutations.js.map +0 -1
- package/dist/sales-channel/service.d.ts +0 -239
- package/dist/sales-channel/service.d.ts.map +0 -1
- package/dist/sales-channel/service.js +0 -3
- package/dist/sales-channel/service.js.map +0 -1
- package/dist/stock-location/common.d.ts +0 -430
- package/dist/stock-location/common.d.ts.map +0 -1
- package/dist/stock-location/common.js +0 -3
- package/dist/stock-location/common.js.map +0 -1
- package/dist/stock-location/index.d.ts +0 -3
- package/dist/stock-location/index.d.ts.map +0 -1
- package/dist/stock-location/index.js +0 -19
- package/dist/stock-location/index.js.map +0 -1
- package/dist/stock-location/service.d.ts +0 -326
- package/dist/stock-location/service.d.ts.map +0 -1
- package/dist/stock-location/service.js +0 -3
- package/dist/stock-location/service.js.map +0 -1
- package/dist/tax/common.d.ts +0 -475
- package/dist/tax/common.d.ts.map +0 -1
- package/dist/tax/common.js +0 -3
- package/dist/tax/common.js.map +0 -1
- package/dist/tax/index.d.ts +0 -5
- package/dist/tax/index.d.ts.map +0 -1
- package/dist/tax/index.js +0 -21
- package/dist/tax/index.js.map +0 -1
- package/dist/tax/mutations.d.ts +0 -262
- package/dist/tax/mutations.d.ts.map +0 -1
- package/dist/tax/mutations.js +0 -3
- package/dist/tax/mutations.js.map +0 -1
- package/dist/tax/provider.d.ts +0 -168
- package/dist/tax/provider.d.ts.map +0 -1
- package/dist/tax/provider.js +0 -3
- package/dist/tax/provider.js.map +0 -1
- package/dist/tax/service.d.ts +0 -775
- package/dist/tax/service.d.ts.map +0 -1
- package/dist/tax/service.js +0 -3
- package/dist/tax/service.js.map +0 -1
- package/dist/workflow/cart/create-cart.d.ts +0 -19
- package/dist/workflow/cart/create-cart.d.ts.map +0 -1
- package/dist/workflow/cart/create-cart.js +0 -3
- package/dist/workflow/cart/create-cart.js.map +0 -1
- package/dist/workflow/cart/index.d.ts +0 -2
- package/dist/workflow/cart/index.d.ts.map +0 -1
- package/dist/workflow/cart/index.js +0 -18
- package/dist/workflow/cart/index.js.map +0 -1
- package/dist/workflow/fulfillment/calculate-shipping-options-prices.d.ts +0 -31
- package/dist/workflow/fulfillment/calculate-shipping-options-prices.d.ts.map +0 -1
- package/dist/workflow/fulfillment/calculate-shipping-options-prices.js +0 -3
- package/dist/workflow/fulfillment/calculate-shipping-options-prices.js.map +0 -1
- package/dist/workflow/fulfillment/create-fulfillment.d.ts +0 -158
- package/dist/workflow/fulfillment/create-fulfillment.d.ts.map +0 -1
- package/dist/workflow/fulfillment/create-fulfillment.js +0 -3
- package/dist/workflow/fulfillment/create-fulfillment.js.map +0 -1
- package/dist/workflow/fulfillment/create-shipment.d.ts +0 -19
- package/dist/workflow/fulfillment/create-shipment.d.ts.map +0 -1
- package/dist/workflow/fulfillment/create-shipment.js +0 -3
- package/dist/workflow/fulfillment/create-shipment.js.map +0 -1
- package/dist/workflow/fulfillment/create-shipping-options.d.ts +0 -116
- package/dist/workflow/fulfillment/create-shipping-options.d.ts.map +0 -1
- package/dist/workflow/fulfillment/create-shipping-options.js +0 -3
- package/dist/workflow/fulfillment/create-shipping-options.js.map +0 -1
- package/dist/workflow/fulfillment/delete-shipping-options.d.ts +0 -10
- package/dist/workflow/fulfillment/delete-shipping-options.d.ts.map +0 -1
- package/dist/workflow/fulfillment/delete-shipping-options.js +0 -3
- package/dist/workflow/fulfillment/delete-shipping-options.js.map +0 -1
- package/dist/workflow/fulfillment/index.d.ts +0 -10
- package/dist/workflow/fulfillment/index.d.ts.map +0 -1
- package/dist/workflow/fulfillment/index.js +0 -26
- package/dist/workflow/fulfillment/index.js.map +0 -1
- package/dist/workflow/fulfillment/service-zones.d.ts +0 -60
- package/dist/workflow/fulfillment/service-zones.d.ts.map +0 -1
- package/dist/workflow/fulfillment/service-zones.js +0 -3
- package/dist/workflow/fulfillment/service-zones.js.map +0 -1
- package/dist/workflow/fulfillment/shipping-profiles.d.ts +0 -46
- package/dist/workflow/fulfillment/shipping-profiles.d.ts.map +0 -1
- package/dist/workflow/fulfillment/shipping-profiles.js +0 -3
- package/dist/workflow/fulfillment/shipping-profiles.js.map +0 -1
- package/dist/workflow/fulfillment/update-fulfillment.d.ts +0 -42
- package/dist/workflow/fulfillment/update-fulfillment.d.ts.map +0 -1
- package/dist/workflow/fulfillment/update-fulfillment.js +0 -3
- package/dist/workflow/fulfillment/update-fulfillment.js.map +0 -1
- package/dist/workflow/fulfillment/update-shipping-options.d.ts +0 -154
- package/dist/workflow/fulfillment/update-shipping-options.d.ts.map +0 -1
- package/dist/workflow/fulfillment/update-shipping-options.js +0 -3
- package/dist/workflow/fulfillment/update-shipping-options.js.map +0 -1
- package/dist/workflow/inventory/create-inventory-items.d.ts +0 -19
- package/dist/workflow/inventory/create-inventory-items.d.ts.map +0 -1
- package/dist/workflow/inventory/create-inventory-items.js +0 -3
- package/dist/workflow/inventory/create-inventory-items.js.map +0 -1
- package/dist/workflow/inventory/index.d.ts +0 -2
- package/dist/workflow/inventory/index.d.ts.map +0 -1
- package/dist/workflow/inventory/index.js +0 -18
- package/dist/workflow/inventory/index.js.map +0 -1
- package/dist/workflow/order/accept-transfer.d.ts +0 -14
- package/dist/workflow/order/accept-transfer.d.ts.map +0 -1
- package/dist/workflow/order/accept-transfer.js +0 -3
- package/dist/workflow/order/accept-transfer.js.map +0 -1
- package/dist/workflow/order/begin-claim-order.d.ts +0 -31
- package/dist/workflow/order/begin-claim-order.d.ts.map +0 -1
- package/dist/workflow/order/begin-claim-order.js +0 -3
- package/dist/workflow/order/begin-claim-order.js.map +0 -1
- package/dist/workflow/order/begin-exchange-order.d.ts +0 -26
- package/dist/workflow/order/begin-exchange-order.d.ts.map +0 -1
- package/dist/workflow/order/begin-exchange-order.js +0 -3
- package/dist/workflow/order/begin-exchange-order.js.map +0 -1
- package/dist/workflow/order/begin-order-edit.d.ts +0 -29
- package/dist/workflow/order/begin-order-edit.d.ts.map +0 -1
- package/dist/workflow/order/begin-order-edit.js +0 -3
- package/dist/workflow/order/begin-order-edit.js.map +0 -1
- package/dist/workflow/order/begin-return-order.d.ts +0 -30
- package/dist/workflow/order/begin-return-order.d.ts.map +0 -1
- package/dist/workflow/order/begin-return-order.js +0 -3
- package/dist/workflow/order/begin-return-order.js.map +0 -1
- package/dist/workflow/order/cancel-claim.d.ts +0 -18
- package/dist/workflow/order/cancel-claim.d.ts.map +0 -1
- package/dist/workflow/order/cancel-claim.js +0 -3
- package/dist/workflow/order/cancel-claim.js.map +0 -1
- package/dist/workflow/order/cancel-exchange.d.ts +0 -18
- package/dist/workflow/order/cancel-exchange.d.ts.map +0 -1
- package/dist/workflow/order/cancel-exchange.js +0 -3
- package/dist/workflow/order/cancel-exchange.js.map +0 -1
- package/dist/workflow/order/cancel-fulfillment.d.ts +0 -19
- package/dist/workflow/order/cancel-fulfillment.d.ts.map +0 -1
- package/dist/workflow/order/cancel-fulfillment.js +0 -3
- package/dist/workflow/order/cancel-fulfillment.js.map +0 -1
- package/dist/workflow/order/cancel-order.d.ts +0 -18
- package/dist/workflow/order/cancel-order.d.ts.map +0 -1
- package/dist/workflow/order/cancel-order.js +0 -3
- package/dist/workflow/order/cancel-order.js.map +0 -1
- package/dist/workflow/order/cancel-return.d.ts +0 -18
- package/dist/workflow/order/cancel-return.d.ts.map +0 -1
- package/dist/workflow/order/cancel-return.js +0 -3
- package/dist/workflow/order/cancel-return.js.map +0 -1
- package/dist/workflow/order/cancel-transfer.d.ts +0 -18
- package/dist/workflow/order/cancel-transfer.d.ts.map +0 -1
- package/dist/workflow/order/cancel-transfer.js +0 -3
- package/dist/workflow/order/cancel-transfer.js.map +0 -1
- package/dist/workflow/order/create-fulfillment.d.ts +0 -65
- package/dist/workflow/order/create-fulfillment.d.ts.map +0 -1
- package/dist/workflow/order/create-fulfillment.js +0 -3
- package/dist/workflow/order/create-fulfillment.js.map +0 -1
- package/dist/workflow/order/create-return-order.d.ts +0 -85
- package/dist/workflow/order/create-return-order.d.ts.map +0 -1
- package/dist/workflow/order/create-return-order.js +0 -3
- package/dist/workflow/order/create-return-order.js.map +0 -1
- package/dist/workflow/order/create-shipment.d.ts +0 -51
- package/dist/workflow/order/create-shipment.d.ts.map +0 -1
- package/dist/workflow/order/create-shipment.js +0 -3
- package/dist/workflow/order/create-shipment.js.map +0 -1
- package/dist/workflow/order/decline-transfer.d.ts +0 -14
- package/dist/workflow/order/decline-transfer.d.ts.map +0 -1
- package/dist/workflow/order/decline-transfer.js +0 -3
- package/dist/workflow/order/decline-transfer.js.map +0 -1
- package/dist/workflow/order/index.d.ts +0 -23
- package/dist/workflow/order/index.d.ts.map +0 -1
- package/dist/workflow/order/index.js +0 -39
- package/dist/workflow/order/index.js.map +0 -1
- package/dist/workflow/order/items.d.ts +0 -323
- package/dist/workflow/order/items.d.ts.map +0 -1
- package/dist/workflow/order/items.js +0 -3
- package/dist/workflow/order/items.js.map +0 -1
- package/dist/workflow/order/receive-return.d.ts +0 -120
- package/dist/workflow/order/receive-return.d.ts.map +0 -1
- package/dist/workflow/order/receive-return.js +0 -3
- package/dist/workflow/order/receive-return.js.map +0 -1
- package/dist/workflow/order/request-item-return.d.ts +0 -140
- package/dist/workflow/order/request-item-return.d.ts.map +0 -1
- package/dist/workflow/order/request-item-return.js +0 -3
- package/dist/workflow/order/request-item-return.js.map +0 -1
- package/dist/workflow/order/request-transfer.d.ts +0 -24
- package/dist/workflow/order/request-transfer.d.ts.map +0 -1
- package/dist/workflow/order/request-transfer.js +0 -3
- package/dist/workflow/order/request-transfer.js.map +0 -1
- package/dist/workflow/order/shipping-method.d.ts +0 -198
- package/dist/workflow/order/shipping-method.d.ts.map +0 -1
- package/dist/workflow/order/shipping-method.js +0 -3
- package/dist/workflow/order/shipping-method.js.map +0 -1
- package/dist/workflow/order/update-order.d.ts +0 -44
- package/dist/workflow/order/update-order.d.ts.map +0 -1
- package/dist/workflow/order/update-order.js +0 -3
- package/dist/workflow/order/update-order.js.map +0 -1
- package/dist/workflow/order/update-return.d.ts +0 -22
- package/dist/workflow/order/update-return.d.ts.map +0 -1
- package/dist/workflow/order/update-return.js +0 -3
- package/dist/workflow/order/update-return.js.map +0 -1
- package/dist/workflow/price-list/create-price-list.d.ts +0 -66
- package/dist/workflow/price-list/create-price-list.d.ts.map +0 -1
- package/dist/workflow/price-list/create-price-list.js +0 -3
- package/dist/workflow/price-list/create-price-list.js.map +0 -1
- package/dist/workflow/price-list/index.d.ts +0 -3
- package/dist/workflow/price-list/index.d.ts.map +0 -1
- package/dist/workflow/price-list/index.js +0 -19
- package/dist/workflow/price-list/index.js.map +0 -1
- package/dist/workflow/price-list/remove-price-list.d.ts +0 -4
- package/dist/workflow/price-list/remove-price-list.d.ts.map +0 -1
- package/dist/workflow/price-list/remove-price-list.js +0 -3
- package/dist/workflow/price-list/remove-price-list.js.map +0 -1
- package/dist/workflow/pricing/index.d.ts +0 -31
- package/dist/workflow/pricing/index.d.ts.map +0 -1
- package/dist/workflow/pricing/index.js +0 -3
- package/dist/workflow/pricing/index.js.map +0 -1
- package/dist/workflow/product/create-product-variants.d.ts +0 -26
- package/dist/workflow/product/create-product-variants.d.ts.map +0 -1
- package/dist/workflow/product/create-product-variants.js +0 -3
- package/dist/workflow/product/create-product-variants.js.map +0 -1
- package/dist/workflow/product/create-products.d.ts +0 -82
- package/dist/workflow/product/create-products.d.ts.map +0 -1
- package/dist/workflow/product/create-products.js +0 -3
- package/dist/workflow/product/create-products.js.map +0 -1
- package/dist/workflow/product/export-products.d.ts +0 -21
- package/dist/workflow/product/export-products.d.ts.map +0 -1
- package/dist/workflow/product/export-products.js +0 -3
- package/dist/workflow/product/export-products.js.map +0 -1
- package/dist/workflow/product/import-products.d.ts +0 -18
- package/dist/workflow/product/import-products.d.ts.map +0 -1
- package/dist/workflow/product/import-products.js +0 -3
- package/dist/workflow/product/import-products.js.map +0 -1
- package/dist/workflow/product/index.d.ts +0 -7
- package/dist/workflow/product/index.d.ts.map +0 -1
- package/dist/workflow/product/index.js +0 -23
- package/dist/workflow/product/index.js.map +0 -1
- package/dist/workflow/product/update-product-variants.d.ts +0 -37
- package/dist/workflow/product/update-product-variants.d.ts.map +0 -1
- package/dist/workflow/product/update-product-variants.js +0 -3
- package/dist/workflow/product/update-product-variants.js.map +0 -1
- package/dist/workflow/product/update-products.d.ts +0 -78
- package/dist/workflow/product/update-products.d.ts.map +0 -1
- package/dist/workflow/product/update-products.js +0 -3
- package/dist/workflow/product/update-products.js.map +0 -1
- package/dist/workflow/product-category/index.d.ts +0 -31
- package/dist/workflow/product-category/index.d.ts.map +0 -1
- package/dist/workflow/product-category/index.js +0 -3
- package/dist/workflow/product-category/index.js.map +0 -1
- package/dist/workflow/region/create-regions.d.ts +0 -26
- package/dist/workflow/region/create-regions.d.ts.map +0 -1
- package/dist/workflow/region/create-regions.js +0 -3
- package/dist/workflow/region/create-regions.js.map +0 -1
- package/dist/workflow/region/index.d.ts +0 -3
- package/dist/workflow/region/index.d.ts.map +0 -1
- package/dist/workflow/region/index.js +0 -19
- package/dist/workflow/region/index.js.map +0 -1
- package/dist/workflow/region/update-regions.d.ts +0 -10
- package/dist/workflow/region/update-regions.d.ts.map +0 -1
- package/dist/workflow/region/update-regions.js +0 -3
- package/dist/workflow/region/update-regions.js.map +0 -1
- package/dist/workflow/reservation/create-reservations.d.ts +0 -15
- package/dist/workflow/reservation/create-reservations.d.ts.map +0 -1
- package/dist/workflow/reservation/create-reservations.js +0 -3
- package/dist/workflow/reservation/create-reservations.js.map +0 -1
- package/dist/workflow/reservation/index.d.ts +0 -3
- package/dist/workflow/reservation/index.d.ts.map +0 -1
- package/dist/workflow/reservation/index.js +0 -19
- package/dist/workflow/reservation/index.js.map +0 -1
- package/dist/workflow/reservation/update-reservations.d.ts +0 -15
- package/dist/workflow/reservation/update-reservations.d.ts.map +0 -1
- package/dist/workflow/reservation/update-reservations.js +0 -3
- package/dist/workflow/reservation/update-reservations.js.map +0 -1
- package/dist/workflows/products/index.d.ts +0 -2
- package/dist/workflows/products/index.d.ts.map +0 -1
- package/dist/workflows/products/index.js +0 -18
- package/dist/workflows/products/index.js.map +0 -1
- package/dist/workflows/products/mutations.d.ts +0 -45
- package/dist/workflows/products/mutations.d.ts.map +0 -1
- package/dist/workflows/products/mutations.js +0 -3
- package/dist/workflows/products/mutations.js.map +0 -1
- package/dist/workflows/stock-locations/index.d.ts +0 -2
- package/dist/workflows/stock-locations/index.d.ts.map +0 -1
- package/dist/workflows/stock-locations/index.js +0 -18
- package/dist/workflows/stock-locations/index.js.map +0 -1
- package/dist/workflows/stock-locations/mutations.d.ts +0 -23
- package/dist/workflows/stock-locations/mutations.d.ts.map +0 -1
- package/dist/workflows/stock-locations/mutations.js +0 -3
- package/dist/workflows/stock-locations/mutations.js.map +0 -1
package/dist/order/service.d.ts
DELETED
|
@@ -1,4130 +0,0 @@
|
|
|
1
|
-
import { FindConfig } from "../common";
|
|
2
|
-
import { RestoreReturn, SoftDeleteReturn } from "../dal";
|
|
3
|
-
import { IModuleService } from "../modules-sdk";
|
|
4
|
-
import { Context } from "../shared-context";
|
|
5
|
-
import { FilterableOrderAddressProps, FilterableOrderChangeActionProps, FilterableOrderChangeProps, FilterableOrderClaimProps, FilterableOrderExchangeProps, FilterableOrderLineItemAdjustmentProps, FilterableOrderLineItemProps, FilterableOrderLineItemTaxLineProps, FilterableOrderProps, FilterableOrderReturnReasonProps, FilterableOrderShippingMethodAdjustmentProps, FilterableOrderShippingMethodProps, FilterableOrderShippingMethodTaxLineProps, FilterableOrderTransactionProps, FilterableReturnProps, OrderAddressDTO, OrderChangeActionDTO, OrderChangeDTO, OrderChangeReturn, OrderClaimDTO, OrderClaimItemDTO, OrderCreditLineDTO, OrderDTO, OrderExchangeDTO, OrderExchangeItemDTO, OrderItemDTO, OrderLineItemAdjustmentDTO, OrderLineItemDTO, OrderLineItemTaxLineDTO, OrderPreviewDTO, OrderReturnItemDTO, OrderReturnReasonDTO, OrderShippingMethodAdjustmentDTO, OrderShippingMethodDTO, OrderShippingMethodTaxLineDTO, OrderTransactionDTO, ReturnDTO } from "./common";
|
|
6
|
-
import { CancelOrderChangeDTO, CancelOrderClaimDTO, CancelOrderExchangeDTO, CancelOrderFulfillmentDTO, CancelOrderReturnDTO, ConfirmOrderChangeDTO, CreateOrderAddressDTO, CreateOrderChangeActionDTO, CreateOrderChangeDTO, CreateOrderClaimDTO, CreateOrderClaimItemDTO, CreateOrderCreditLineDTO, CreateOrderDTO, CreateOrderExchangeDTO, CreateOrderExchangeItemDTO, CreateOrderLineItemAdjustmentDTO, CreateOrderLineItemDTO, CreateOrderLineItemTaxLineDTO, CreateOrderReturnDTO, CreateOrderReturnItemDTO, CreateOrderReturnReasonDTO, CreateOrderShippingMethodAdjustmentDTO, CreateOrderShippingMethodDTO, CreateOrderShippingMethodTaxLineDTO, CreateOrderTransactionDTO, DeclineOrderChangeDTO, ReceiveOrderReturnDTO, RegisterOrderChangeDTO, RegisterOrderDeliveryDTO, RegisterOrderFulfillmentDTO, RegisterOrderShipmentDTO, UpdateOrderAddressDTO, UpdateOrderChangeActionDTO, UpdateOrderChangeDTO, UpdateOrderClaimDTO, UpdateOrderClaimWithSelectorDTO, UpdateOrderDTO, UpdateOrderExchangeDTO, UpdateOrderExchangeWithSelectorDTO, UpdateOrderItemDTO, UpdateOrderItemWithSelectorDTO, UpdateOrderLineItemDTO, UpdateOrderLineItemTaxLineDTO, UpdateOrderLineItemWithSelectorDTO, UpdateOrderReturnReasonDTO, UpdateOrderReturnWithSelectorDTO, UpdateOrderShippingMethodAdjustmentDTO, UpdateOrderShippingMethodDTO, UpdateOrderShippingMethodTaxLineDTO, UpdateReturnDTO, UpsertOrderLineItemAdjustmentDTO } from "./mutations";
|
|
7
|
-
/**
|
|
8
|
-
* The main service interface for the Order Module.
|
|
9
|
-
*/
|
|
10
|
-
export interface IOrderModuleService extends IModuleService {
|
|
11
|
-
/**
|
|
12
|
-
* This method retrieves an order by its ID.
|
|
13
|
-
*
|
|
14
|
-
* @param {string} orderId - The order's ID.
|
|
15
|
-
* @param {FindConfig<OrderDTO>} config - The configurations determining how the order is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
16
|
-
* attributes or relations associated with a order.
|
|
17
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
18
|
-
* @returns {Promise<OrderDTO>} The retrieved order.
|
|
19
|
-
*
|
|
20
|
-
* @example
|
|
21
|
-
* A simple example that retrieves an order change by its ID:
|
|
22
|
-
*
|
|
23
|
-
* ```ts
|
|
24
|
-
* const order = await orderModuleService.retrieveOrder(
|
|
25
|
-
* "123"
|
|
26
|
-
* )
|
|
27
|
-
* ```
|
|
28
|
-
*
|
|
29
|
-
* To specify relations that should be retrieved:
|
|
30
|
-
*
|
|
31
|
-
* :::note
|
|
32
|
-
*
|
|
33
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
34
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
35
|
-
*
|
|
36
|
-
* :::
|
|
37
|
-
*
|
|
38
|
-
* ```ts
|
|
39
|
-
* const order = await orderModuleService.retrieveOrder(
|
|
40
|
-
* "123",
|
|
41
|
-
* {
|
|
42
|
-
* relations: ["items"]
|
|
43
|
-
* }
|
|
44
|
-
* )
|
|
45
|
-
* ```
|
|
46
|
-
*
|
|
47
|
-
*/
|
|
48
|
-
retrieveOrder(orderId: string, config?: FindConfig<OrderDTO>, sharedContext?: Context): Promise<OrderDTO>;
|
|
49
|
-
/**
|
|
50
|
-
* This method retrieves a paginated list of orders based on optional filters and configuration.
|
|
51
|
-
*
|
|
52
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved order.
|
|
53
|
-
* @param {FindConfig<OrderDTO>} config - The configurations determining how the order is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
54
|
-
* attributes or relations associated with a order.
|
|
55
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
56
|
-
* @returns {Promise<OrderDTO[]>} The list of orders.
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* To retrieve a list of orders using their IDs:
|
|
60
|
-
*
|
|
61
|
-
* ```ts
|
|
62
|
-
* const orders = await orderModuleService.listOrders({
|
|
63
|
-
* id: ["123", "321"]
|
|
64
|
-
* })
|
|
65
|
-
* ```
|
|
66
|
-
*
|
|
67
|
-
* To specify relations that should be retrieved within the order:
|
|
68
|
-
*
|
|
69
|
-
* :::note
|
|
70
|
-
*
|
|
71
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
72
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
73
|
-
*
|
|
74
|
-
* :::
|
|
75
|
-
*
|
|
76
|
-
* ```ts
|
|
77
|
-
* const orders = await orderModuleService.listOrders({
|
|
78
|
-
* id: ["123", "321"]
|
|
79
|
-
* }, {
|
|
80
|
-
* relations: ["items"]
|
|
81
|
-
* })
|
|
82
|
-
* ```
|
|
83
|
-
*
|
|
84
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
85
|
-
*
|
|
86
|
-
* ```ts
|
|
87
|
-
* const orders = await orderModuleService.listOrders({
|
|
88
|
-
* id: ["123", "321"]
|
|
89
|
-
* }, {
|
|
90
|
-
* relations: ["items"],
|
|
91
|
-
* take: 20,
|
|
92
|
-
* skip: 2
|
|
93
|
-
* })
|
|
94
|
-
* ```
|
|
95
|
-
*
|
|
96
|
-
*/
|
|
97
|
-
listOrders(filters?: FilterableOrderProps, config?: FindConfig<OrderDTO>, sharedContext?: Context): Promise<OrderDTO[]>;
|
|
98
|
-
/**
|
|
99
|
-
* This method retrieves a paginated list of orders along with the total count of available orders satisfying the provided filters.
|
|
100
|
-
*
|
|
101
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved order.
|
|
102
|
-
* @param {FindConfig<OrderDTO>} config - The configurations determining how the order is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
103
|
-
* attributes or relations associated with a order.
|
|
104
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
105
|
-
* @returns {Promise<[OrderDTO[], number]>} The list of orders along with their total count.
|
|
106
|
-
*
|
|
107
|
-
* @example
|
|
108
|
-
* To retrieve a list of orders using their IDs:
|
|
109
|
-
*
|
|
110
|
-
* ```ts
|
|
111
|
-
* const [orders, count] = await orderModuleService.listAndCountOrders({
|
|
112
|
-
* id: ["123", "321"]
|
|
113
|
-
* })
|
|
114
|
-
* ```
|
|
115
|
-
*
|
|
116
|
-
* To specify relations that should be retrieved within the order:
|
|
117
|
-
*
|
|
118
|
-
* :::note
|
|
119
|
-
*
|
|
120
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
121
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
122
|
-
*
|
|
123
|
-
* :::
|
|
124
|
-
*
|
|
125
|
-
* ```ts
|
|
126
|
-
* const [orders, count] = await orderModuleService.listAndCountOrders({
|
|
127
|
-
* id: ["123", "321"]
|
|
128
|
-
* }, {
|
|
129
|
-
* relations: ["items"],
|
|
130
|
-
* })
|
|
131
|
-
* ```
|
|
132
|
-
*
|
|
133
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
134
|
-
*
|
|
135
|
-
* ```ts
|
|
136
|
-
* const [orders, count] = await orderModuleService.listAndCountOrders({
|
|
137
|
-
* id: ["123", "321"]
|
|
138
|
-
* }, {
|
|
139
|
-
* relations: ["items"],
|
|
140
|
-
* take: 20,
|
|
141
|
-
* skip: 2
|
|
142
|
-
* })
|
|
143
|
-
* ```
|
|
144
|
-
*
|
|
145
|
-
*/
|
|
146
|
-
listAndCountOrders(filters?: FilterableOrderProps, config?: FindConfig<OrderDTO>, sharedContext?: Context): Promise<[OrderDTO[], number]>;
|
|
147
|
-
/**
|
|
148
|
-
* This method retrieves a return by its ID.
|
|
149
|
-
*
|
|
150
|
-
* @param {string} returnId - The return's ID.
|
|
151
|
-
* @param {FindConfig<ReturnDTO>} config - The configurations determining how the return is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
152
|
-
* attributes or relations associated with a return.
|
|
153
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
154
|
-
* @returns {Promise<ReturnDTO>} The retrieved return.
|
|
155
|
-
*
|
|
156
|
-
* @example
|
|
157
|
-
* A simple example that retrieves an order change by its ID:
|
|
158
|
-
*
|
|
159
|
-
* ```ts
|
|
160
|
-
* const orderReturn = await orderModuleService.retrieveReturn(
|
|
161
|
-
* "123"
|
|
162
|
-
* )
|
|
163
|
-
* ```
|
|
164
|
-
*
|
|
165
|
-
* To specify relations that should be retrieved:
|
|
166
|
-
*
|
|
167
|
-
* :::note
|
|
168
|
-
*
|
|
169
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
170
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
171
|
-
*
|
|
172
|
-
* :::
|
|
173
|
-
*
|
|
174
|
-
* ```ts
|
|
175
|
-
* const orderReturn = await orderModuleService.retrieveReturn(
|
|
176
|
-
* "123",
|
|
177
|
-
* {
|
|
178
|
-
* relations: ["order"]
|
|
179
|
-
* }
|
|
180
|
-
* )
|
|
181
|
-
* ```
|
|
182
|
-
*/
|
|
183
|
-
retrieveReturn(returnId: string, config?: FindConfig<ReturnDTO>, sharedContext?: Context): Promise<ReturnDTO>;
|
|
184
|
-
/**
|
|
185
|
-
* This method retrieves a paginated list of returns based on optional filters and configuration.
|
|
186
|
-
*
|
|
187
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved returns.
|
|
188
|
-
* @param {FindConfig<ReturnDTO>} config - The configurations determining how the return is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
189
|
-
* attributes or relations associated with a return.
|
|
190
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
191
|
-
* @returns {Promise<ReturnDTO[]>} The list of returns.
|
|
192
|
-
*
|
|
193
|
-
* @example
|
|
194
|
-
* To retrieve a list of returns using their IDs:
|
|
195
|
-
*
|
|
196
|
-
* ```ts
|
|
197
|
-
* const returns = await orderModuleService.listReturns({
|
|
198
|
-
* id: ["123", "321"]
|
|
199
|
-
* })
|
|
200
|
-
* ```
|
|
201
|
-
*
|
|
202
|
-
* To specify relations that should be retrieved within the return:
|
|
203
|
-
*
|
|
204
|
-
* :::note
|
|
205
|
-
*
|
|
206
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
207
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
208
|
-
*
|
|
209
|
-
* :::
|
|
210
|
-
*
|
|
211
|
-
* ```ts
|
|
212
|
-
* const returns = await orderModuleService.listReturns({
|
|
213
|
-
* id: ["123", "321"]
|
|
214
|
-
* }, {
|
|
215
|
-
* relations: ["order"]
|
|
216
|
-
* })
|
|
217
|
-
* ```
|
|
218
|
-
*
|
|
219
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
220
|
-
*
|
|
221
|
-
* ```ts
|
|
222
|
-
* const returns = await orderModuleService.listReturns({
|
|
223
|
-
* id: ["123", "321"]
|
|
224
|
-
* }, {
|
|
225
|
-
* relations: ["order"],
|
|
226
|
-
* take: 20,
|
|
227
|
-
* skip: 2
|
|
228
|
-
* })
|
|
229
|
-
* ```
|
|
230
|
-
*/
|
|
231
|
-
listReturns(filters?: FilterableOrderProps, config?: FindConfig<ReturnDTO>, sharedContext?: Context): Promise<ReturnDTO[]>;
|
|
232
|
-
/**
|
|
233
|
-
* This method retrieves a paginated list of returns along with the total count of available returns satisfying the provided filters.
|
|
234
|
-
*
|
|
235
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved returns.
|
|
236
|
-
* @param {FindConfig<ReturnDTO>} config - The configurations determining how the return is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
237
|
-
* attributes or relations associated with a return.
|
|
238
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
239
|
-
* @returns {Promise<[ReturnDTO[], number]>} The list of returns along with their total count.
|
|
240
|
-
*
|
|
241
|
-
* @example
|
|
242
|
-
* To retrieve a list of returns using their IDs:
|
|
243
|
-
*
|
|
244
|
-
* ```ts
|
|
245
|
-
* const [returns, count] = await orderModuleService.listAndCountReturns({
|
|
246
|
-
* id: ["123", "321"]
|
|
247
|
-
* })
|
|
248
|
-
* ```
|
|
249
|
-
*
|
|
250
|
-
* To specify relations that should be retrieved within the return:
|
|
251
|
-
*
|
|
252
|
-
* :::note
|
|
253
|
-
*
|
|
254
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
255
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
256
|
-
*
|
|
257
|
-
* :::
|
|
258
|
-
*
|
|
259
|
-
* ```ts
|
|
260
|
-
* const [returns, count] = await orderModuleService.listAndCountReturns({
|
|
261
|
-
* id: ["123", "321"]
|
|
262
|
-
* }, {
|
|
263
|
-
* relations: ["order"],
|
|
264
|
-
* })
|
|
265
|
-
* ```
|
|
266
|
-
*
|
|
267
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
268
|
-
*
|
|
269
|
-
* ```ts
|
|
270
|
-
* const [returns, count] = await orderModuleService.listAndCountReturns({
|
|
271
|
-
* id: ["123", "321"]
|
|
272
|
-
* }, {
|
|
273
|
-
* relations: ["order"],
|
|
274
|
-
* take: 20,
|
|
275
|
-
* skip: 2
|
|
276
|
-
* })
|
|
277
|
-
* ```
|
|
278
|
-
*/
|
|
279
|
-
listAndCountReturns(filters?: FilterableOrderProps, config?: FindConfig<ReturnDTO>, sharedContext?: Context): Promise<[ReturnDTO[], number]>;
|
|
280
|
-
/**
|
|
281
|
-
* This method retrieves an order claim by its ID.
|
|
282
|
-
*
|
|
283
|
-
* @param {string} claimId - The claim's ID.
|
|
284
|
-
* @param {FindConfig<OrderClaimDTO>} config - The configurations determining how the order claim is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
285
|
-
* attributes or relations associated with a order claim.
|
|
286
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
287
|
-
* @returns {Promise<OrderClaimDTO>} The retrieved order claim.
|
|
288
|
-
*
|
|
289
|
-
* @example
|
|
290
|
-
* A simple example that retrieves an order change by its ID:
|
|
291
|
-
*
|
|
292
|
-
* ```ts
|
|
293
|
-
* const claim = await orderModuleService.retrieveOrderClaim(
|
|
294
|
-
* "123"
|
|
295
|
-
* )
|
|
296
|
-
* ```
|
|
297
|
-
*
|
|
298
|
-
* To specify relations that should be retrieved:
|
|
299
|
-
*
|
|
300
|
-
* :::note
|
|
301
|
-
*
|
|
302
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
303
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
304
|
-
*
|
|
305
|
-
* :::
|
|
306
|
-
*
|
|
307
|
-
* ```ts
|
|
308
|
-
* const claim = await orderModuleService.retrieveOrderClaim(
|
|
309
|
-
* "123",
|
|
310
|
-
* {
|
|
311
|
-
* relations: ["order"]
|
|
312
|
-
* }
|
|
313
|
-
* )
|
|
314
|
-
* ```
|
|
315
|
-
*/
|
|
316
|
-
retrieveOrderClaim(claimId: string, config?: FindConfig<OrderClaimDTO>, sharedContext?: Context): Promise<OrderClaimDTO>;
|
|
317
|
-
/**
|
|
318
|
-
* This method retrieves a paginated list of order claims based on optional filters and configuration.
|
|
319
|
-
*
|
|
320
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved order claims.
|
|
321
|
-
* @param {FindConfig<OrderClaimDTO>} config - The configurations determining how the order claim is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
322
|
-
* attributes or relations associated with a order claim.
|
|
323
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
324
|
-
* @returns {Promise<OrderClaimDTO[]>} The list of order claims.
|
|
325
|
-
*
|
|
326
|
-
* @example
|
|
327
|
-
* To retrieve a list of order claims using their IDs:
|
|
328
|
-
*
|
|
329
|
-
* ```ts
|
|
330
|
-
* const claims = await orderModuleService.listOrderClaims({
|
|
331
|
-
* id: ["123", "321"]
|
|
332
|
-
* })
|
|
333
|
-
* ```
|
|
334
|
-
*
|
|
335
|
-
* To specify relations that should be retrieved within the claim:
|
|
336
|
-
*
|
|
337
|
-
* :::note
|
|
338
|
-
*
|
|
339
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
340
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
341
|
-
*
|
|
342
|
-
* :::
|
|
343
|
-
*
|
|
344
|
-
* ```ts
|
|
345
|
-
* const claims = await orderModuleService.listOrderClaims({
|
|
346
|
-
* id: ["123", "321"]
|
|
347
|
-
* }, {
|
|
348
|
-
* relations: ["order"]
|
|
349
|
-
* })
|
|
350
|
-
* ```
|
|
351
|
-
*
|
|
352
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
353
|
-
*
|
|
354
|
-
* ```ts
|
|
355
|
-
* const claims = await orderModuleService.listOrderClaims({
|
|
356
|
-
* id: ["123", "321"]
|
|
357
|
-
* }, {
|
|
358
|
-
* relations: ["order"],
|
|
359
|
-
* take: 20,
|
|
360
|
-
* skip: 2
|
|
361
|
-
* })
|
|
362
|
-
* ```
|
|
363
|
-
*/
|
|
364
|
-
listOrderClaims(filters?: FilterableOrderProps, config?: FindConfig<OrderClaimDTO>, sharedContext?: Context): Promise<OrderClaimDTO[]>;
|
|
365
|
-
/**
|
|
366
|
-
* This method retrieves a paginated list of order claims along with the total count of available claims satisfying the provided filters.
|
|
367
|
-
*
|
|
368
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved order claims.
|
|
369
|
-
* @param {FindConfig<OrderClaimDTO>} config - The configurations determining how the order claim is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
370
|
-
* attributes or relations associated with a order claim.
|
|
371
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
372
|
-
* @returns {Promise<[OrderClaimDTO[], number]>} The list of order claims along with their total count.
|
|
373
|
-
*
|
|
374
|
-
* @example
|
|
375
|
-
* To retrieve a list of order claims using their IDs:
|
|
376
|
-
*
|
|
377
|
-
* ```ts
|
|
378
|
-
* const [claims, count] = await orderModuleService.listAndCountOrderClaims({
|
|
379
|
-
* id: ["123", "321"]
|
|
380
|
-
* })
|
|
381
|
-
* ```
|
|
382
|
-
*
|
|
383
|
-
* To specify relations that should be retrieved within the claim:
|
|
384
|
-
*
|
|
385
|
-
* :::note
|
|
386
|
-
*
|
|
387
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
388
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
389
|
-
*
|
|
390
|
-
* :::
|
|
391
|
-
*
|
|
392
|
-
* ```ts
|
|
393
|
-
* const [claims, count] = await orderModuleService.listAndCountOrderClaims({
|
|
394
|
-
* id: ["123", "321"]
|
|
395
|
-
* }, {
|
|
396
|
-
* relations: ["order"],
|
|
397
|
-
* })
|
|
398
|
-
* ```
|
|
399
|
-
*
|
|
400
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
401
|
-
*
|
|
402
|
-
* ```ts
|
|
403
|
-
* const [claims, count] = await orderModuleService.listAndCountOrderClaims({
|
|
404
|
-
* id: ["123", "321"]
|
|
405
|
-
* }, {
|
|
406
|
-
* relations: ["order"],
|
|
407
|
-
* take: 20,
|
|
408
|
-
* skip: 2
|
|
409
|
-
* })
|
|
410
|
-
* ```
|
|
411
|
-
*/
|
|
412
|
-
listAndCountOrderClaims(filters?: FilterableOrderProps, config?: FindConfig<OrderClaimDTO>, sharedContext?: Context): Promise<[OrderClaimDTO[], number]>;
|
|
413
|
-
/**
|
|
414
|
-
* This method retrieves an order exchange by its ID.
|
|
415
|
-
*
|
|
416
|
-
* @param {string} exchangeId - The exchange's ID.
|
|
417
|
-
* @param {FindConfig<OrderExchangeDTO>} config - The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
418
|
-
* attributes or relations associated with a order exchange.
|
|
419
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
420
|
-
* @returns {Promise<OrderExchangeDTO>} The retrieved order exchange.
|
|
421
|
-
*
|
|
422
|
-
* @example
|
|
423
|
-
* A simple example that retrieves an order change by its ID:
|
|
424
|
-
*
|
|
425
|
-
* ```ts
|
|
426
|
-
* const exchange = await orderModuleService.retrieveOrderExchange(
|
|
427
|
-
* "123"
|
|
428
|
-
* )
|
|
429
|
-
* ```
|
|
430
|
-
*
|
|
431
|
-
* To specify relations that should be retrieved:
|
|
432
|
-
*
|
|
433
|
-
* :::note
|
|
434
|
-
*
|
|
435
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
436
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
437
|
-
*
|
|
438
|
-
* :::
|
|
439
|
-
*
|
|
440
|
-
* ```ts
|
|
441
|
-
* const exchange = await orderModuleService.retrieveOrderExchange(
|
|
442
|
-
* "123",
|
|
443
|
-
* {
|
|
444
|
-
* relations: ["order"]
|
|
445
|
-
* }
|
|
446
|
-
* )
|
|
447
|
-
* ```
|
|
448
|
-
*/
|
|
449
|
-
retrieveOrderExchange(exchangeId: string, config?: FindConfig<OrderExchangeDTO>, sharedContext?: Context): Promise<OrderExchangeDTO>;
|
|
450
|
-
/**
|
|
451
|
-
* This method retrieves a paginated list of order exchanges based on optional filters and configuration.
|
|
452
|
-
*
|
|
453
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved exchanges.
|
|
454
|
-
* @param {FindConfig<OrderExchangeDTO>} config - The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
455
|
-
* attributes or relations associated with a order exchange.
|
|
456
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
457
|
-
* @returns {Promise<OrderExchangeDTO[]>} The list of exchanges.
|
|
458
|
-
*
|
|
459
|
-
* @example
|
|
460
|
-
* To retrieve a list of exchanges using their IDs:
|
|
461
|
-
*
|
|
462
|
-
* ```ts
|
|
463
|
-
* const exchanges = await orderModuleService.listOrderExchanges({
|
|
464
|
-
* id: ["123", "321"]
|
|
465
|
-
* })
|
|
466
|
-
* ```
|
|
467
|
-
*
|
|
468
|
-
* To specify relations that should be retrieved within the exchange:
|
|
469
|
-
*
|
|
470
|
-
* :::note
|
|
471
|
-
*
|
|
472
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
473
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
474
|
-
*
|
|
475
|
-
* :::
|
|
476
|
-
*
|
|
477
|
-
* ```ts
|
|
478
|
-
* const exchanges = await orderModuleService.listOrderExchanges({
|
|
479
|
-
* id: ["123", "321"]
|
|
480
|
-
* }, {
|
|
481
|
-
* relations: ["order"]
|
|
482
|
-
* })
|
|
483
|
-
* ```
|
|
484
|
-
*
|
|
485
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
486
|
-
*
|
|
487
|
-
* ```ts
|
|
488
|
-
* const exchanges = await orderModuleService.listOrderExchanges({
|
|
489
|
-
* id: ["123", "321"]
|
|
490
|
-
* }, {
|
|
491
|
-
* relations: ["order"],
|
|
492
|
-
* take: 20,
|
|
493
|
-
* skip: 2
|
|
494
|
-
* })
|
|
495
|
-
* ```
|
|
496
|
-
*/
|
|
497
|
-
listOrderExchanges(filters?: FilterableOrderProps, config?: FindConfig<OrderExchangeDTO>, sharedContext?: Context): Promise<OrderExchangeDTO[]>;
|
|
498
|
-
/**
|
|
499
|
-
* This method retrieves a paginated list of exchanges along with the total count of available exchanges satisfying the provided filters.
|
|
500
|
-
*
|
|
501
|
-
* @param {FilterableOrderProps} filters - The filters to apply on the retrieved exchanges.
|
|
502
|
-
* @param {FindConfig<OrderExchangeDTO>} config - The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
503
|
-
* attributes or relations associated with a order exchange.
|
|
504
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
505
|
-
* @returns {Promise<[OrderExchangeDTO[], number]>} The list of exchanges along with their total count.
|
|
506
|
-
*
|
|
507
|
-
* @example
|
|
508
|
-
* To retrieve a list of exchanges using their IDs:
|
|
509
|
-
*
|
|
510
|
-
* ```ts
|
|
511
|
-
* const [exchanges, count] = await orderModuleService.listOrderExchanges({
|
|
512
|
-
* id: ["123", "321"]
|
|
513
|
-
* })
|
|
514
|
-
* ```
|
|
515
|
-
*
|
|
516
|
-
* To specify relations that should be retrieved within the exchange:
|
|
517
|
-
*
|
|
518
|
-
* :::note
|
|
519
|
-
*
|
|
520
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
521
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
522
|
-
*
|
|
523
|
-
* :::
|
|
524
|
-
*
|
|
525
|
-
* ```ts
|
|
526
|
-
* const [exchanges, count] = await orderModuleService.listOrderExchanges({
|
|
527
|
-
* id: ["123", "321"]
|
|
528
|
-
* }, {
|
|
529
|
-
* relations: ["order"],
|
|
530
|
-
* })
|
|
531
|
-
* ```
|
|
532
|
-
*
|
|
533
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
534
|
-
*
|
|
535
|
-
* ```ts
|
|
536
|
-
* const [exchanges, count] = await orderModuleService.listOrderExchanges({
|
|
537
|
-
* id: ["123", "321"]
|
|
538
|
-
* }, {
|
|
539
|
-
* relations: ["order"],
|
|
540
|
-
* take: 20,
|
|
541
|
-
* skip: 2
|
|
542
|
-
* })
|
|
543
|
-
* ```
|
|
544
|
-
*/
|
|
545
|
-
listAndCountOrderExchanges(filters?: FilterableOrderProps, config?: FindConfig<OrderExchangeDTO>, sharedContext?: Context): Promise<[OrderExchangeDTO[], number]>;
|
|
546
|
-
/**
|
|
547
|
-
* This method creates orders
|
|
548
|
-
*
|
|
549
|
-
* @param {CreateOrderDTO[]} data - The order to be created.
|
|
550
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
551
|
-
* @returns {Promise<OrderDTO[]>} The created orders.
|
|
552
|
-
*
|
|
553
|
-
* @example
|
|
554
|
-
* ```ts
|
|
555
|
-
* const orders = await orderModuleService.createOrders([{
|
|
556
|
-
* currency_code: "usd",
|
|
557
|
-
* items: [
|
|
558
|
-
* {
|
|
559
|
-
* title: "Product Name",
|
|
560
|
-
* quantity: 1,
|
|
561
|
-
* unit_price: 20
|
|
562
|
-
* }
|
|
563
|
-
* ]
|
|
564
|
-
* }])
|
|
565
|
-
* ```
|
|
566
|
-
*
|
|
567
|
-
*/
|
|
568
|
-
createOrders(data: CreateOrderDTO[], sharedContext?: Context): Promise<OrderDTO[]>;
|
|
569
|
-
/**
|
|
570
|
-
* This method creates orders
|
|
571
|
-
*
|
|
572
|
-
* @param {CreateOrderDTO} data - The order to be created.
|
|
573
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
574
|
-
* @returns {Promise<OrderDTO>} The created orders.
|
|
575
|
-
*
|
|
576
|
-
* @example
|
|
577
|
-
* ```ts
|
|
578
|
-
* const order = await orderModuleService.createOrders({
|
|
579
|
-
* currency_code: "usd",
|
|
580
|
-
* items: [
|
|
581
|
-
* {
|
|
582
|
-
* title: "Product Name",
|
|
583
|
-
* quantity: 1,
|
|
584
|
-
* unit_price: 20
|
|
585
|
-
* }
|
|
586
|
-
* ]
|
|
587
|
-
* })
|
|
588
|
-
* ```
|
|
589
|
-
*
|
|
590
|
-
*/
|
|
591
|
-
createOrders(data: CreateOrderDTO, sharedContext?: Context): Promise<OrderDTO>;
|
|
592
|
-
/**
|
|
593
|
-
* This method updates existing orders. The order IDs are specified in each order object.
|
|
594
|
-
*
|
|
595
|
-
* @param {UpdateOrderDTO[]} data - The attributes to update in the order.
|
|
596
|
-
* @returns {Promise<OrderDTO[]>} The updated orders.
|
|
597
|
-
*
|
|
598
|
-
* @example
|
|
599
|
-
* ```typescript
|
|
600
|
-
* const orders = await orderModuleService.updateOrders([{
|
|
601
|
-
* id: "123",
|
|
602
|
-
* email: "example@gmail.com"
|
|
603
|
-
* }])
|
|
604
|
-
* ```
|
|
605
|
-
*
|
|
606
|
-
*/
|
|
607
|
-
updateOrders(data: UpdateOrderDTO[], sharedContext?: Context): Promise<OrderDTO[]>;
|
|
608
|
-
/**
|
|
609
|
-
* This method updates existing orders.
|
|
610
|
-
*
|
|
611
|
-
* @param {string} orderId - The ID of the order to update.
|
|
612
|
-
* @param {UpdateOrderDTO} data - The attributes to update in the order.
|
|
613
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
614
|
-
* @returns {Promise<OrderDTO>} The updated orders.
|
|
615
|
-
*
|
|
616
|
-
* @example
|
|
617
|
-
* ```typescript
|
|
618
|
-
* const order = await orderModuleService.updateOrders(
|
|
619
|
-
* "123",
|
|
620
|
-
* {
|
|
621
|
-
* email: "example@gmail.com"
|
|
622
|
-
* }
|
|
623
|
-
* )
|
|
624
|
-
* ```
|
|
625
|
-
*
|
|
626
|
-
*/
|
|
627
|
-
updateOrders(orderId: string, data: UpdateOrderDTO, sharedContext?: Context): Promise<OrderDTO>;
|
|
628
|
-
/**
|
|
629
|
-
* This method updates existing orders matching the specified filters.
|
|
630
|
-
*
|
|
631
|
-
* @param {Partial<OrderDTO>} selector - The filters specifying which orders to update.
|
|
632
|
-
* @param {UpdateOrderDTO} data - The attributes to update in the orders.
|
|
633
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
634
|
-
* @returns {Promise<OrderDTO[]>} The updated orders.
|
|
635
|
-
*
|
|
636
|
-
* @example
|
|
637
|
-
* ```typescript
|
|
638
|
-
* const orders = await orderModuleService.updateOrders({
|
|
639
|
-
* id: ["123", "321"]
|
|
640
|
-
* }, {
|
|
641
|
-
* email: "example@gmail.com"
|
|
642
|
-
* })
|
|
643
|
-
* ```
|
|
644
|
-
*
|
|
645
|
-
*/
|
|
646
|
-
updateOrders(selector: Partial<FilterableOrderProps>, data: UpdateOrderDTO, sharedContext?: Context): Promise<OrderDTO[]>;
|
|
647
|
-
/**
|
|
648
|
-
* This method deletes orders by its ID.
|
|
649
|
-
*
|
|
650
|
-
* @param {string[]} orderIds - The IDs of orders to delete.
|
|
651
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
652
|
-
* @returns {Promise<void>} Resolves when the orders are deleted successfully.
|
|
653
|
-
*
|
|
654
|
-
* @example
|
|
655
|
-
* ```typescript
|
|
656
|
-
* await orderModuleService.deleteOrders(["123", "321"])
|
|
657
|
-
* ```
|
|
658
|
-
*
|
|
659
|
-
*/
|
|
660
|
-
deleteOrders(orderIds: string[], sharedContext?: Context): Promise<void>;
|
|
661
|
-
/**
|
|
662
|
-
* This method deletes an order by its ID.
|
|
663
|
-
*
|
|
664
|
-
* @param {string} orderId - The order's ID.
|
|
665
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
666
|
-
* @returns {Promise<void>} Resolves when the order is deleted successfully.
|
|
667
|
-
*
|
|
668
|
-
* @example
|
|
669
|
-
* ```typescript
|
|
670
|
-
* await orderModuleService.deleteOrders("123");
|
|
671
|
-
* ```
|
|
672
|
-
*
|
|
673
|
-
*/
|
|
674
|
-
deleteOrders(orderId: string, sharedContext?: Context): Promise<void>;
|
|
675
|
-
/**
|
|
676
|
-
* This method soft deletes orders by their IDs.
|
|
677
|
-
*
|
|
678
|
-
* @param {string[]} orderIds - The list of order IDs.
|
|
679
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
680
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
681
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated items.
|
|
682
|
-
* The object's keys are the ID attribute names of the order entity's relations, such as `item_id`, and its value is an array of strings, each being the ID of a record associated
|
|
683
|
-
* with the order through this relation, such as the IDs of associated item.
|
|
684
|
-
*
|
|
685
|
-
* If there are no related records, the promise resolves to `void`.
|
|
686
|
-
*
|
|
687
|
-
* @example
|
|
688
|
-
* await orderModuleService.softDeleteOrders(["123", "321"])
|
|
689
|
-
*/
|
|
690
|
-
softDeleteOrders<TReturnableLinkableKeys extends string = string>(orderIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
691
|
-
/**
|
|
692
|
-
* This method restores soft deleted orders by their IDs.
|
|
693
|
-
*
|
|
694
|
-
* @param {string[]} orderIds - The list of order IDs.
|
|
695
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the orders. You can pass to its `returnLinkableKeys`
|
|
696
|
-
* property any of the order's relation attribute names, such as `items`.
|
|
697
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
698
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the IDs of associated items.
|
|
699
|
-
* The object's keys are the ID attribute names of the order entity's relations, such as `item_id`,
|
|
700
|
-
* and its value is an array of strings, each being the ID of the record associated with the order through this relation,
|
|
701
|
-
* such as the IDs of associated items.
|
|
702
|
-
*
|
|
703
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
704
|
-
*
|
|
705
|
-
* @example
|
|
706
|
-
* await orderModuleService.restoreOrders(["123", "321"])
|
|
707
|
-
*/
|
|
708
|
-
restoreOrders<TReturnableLinkableKeys extends string = string>(orderIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
709
|
-
/**
|
|
710
|
-
* This method retrieves a paginated list of addresses based on optional filters and configuration.
|
|
711
|
-
*
|
|
712
|
-
* @param {FilterableOrderAddressProps} filters - The filters to apply on the retrieved order addresss.
|
|
713
|
-
* @param {FindConfig<OrderAddressDTO>} config - The configurations determining how the order address is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
714
|
-
* attributes or relations associated with a order address.
|
|
715
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
716
|
-
* @returns {Promise<OrderAddressDTO[]>} The list of addresses.
|
|
717
|
-
*
|
|
718
|
-
* @example
|
|
719
|
-
* To retrieve a list of addresses using their IDs:
|
|
720
|
-
*
|
|
721
|
-
* ```ts
|
|
722
|
-
* const addresses = await orderModuleService.listOrderAddresses({
|
|
723
|
-
* id: ["123", "321"]
|
|
724
|
-
* })
|
|
725
|
-
* ```
|
|
726
|
-
*
|
|
727
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
728
|
-
*
|
|
729
|
-
* ```ts
|
|
730
|
-
* const addresses = await orderModuleService.listOrderAddresses({
|
|
731
|
-
* id: ["123", "321"]
|
|
732
|
-
* }, {
|
|
733
|
-
* take: 20,
|
|
734
|
-
* skip: 2
|
|
735
|
-
* })
|
|
736
|
-
* ```
|
|
737
|
-
*/
|
|
738
|
-
listOrderAddresses(filters?: FilterableOrderAddressProps, config?: FindConfig<OrderAddressDTO>, sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
|
739
|
-
/**
|
|
740
|
-
* This method creates addresses.
|
|
741
|
-
*
|
|
742
|
-
* @param {CreateOrderAddressDTO[]} data - The addresses to be created.
|
|
743
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
744
|
-
* @returns {Promise<OrderAddressDTO[]>} The created addresses.
|
|
745
|
-
*
|
|
746
|
-
* @example
|
|
747
|
-
* ```typescript
|
|
748
|
-
* const addresses = await orderModuleService.createOrderAddresses([
|
|
749
|
-
* {
|
|
750
|
-
* first_name: "John",
|
|
751
|
-
* last_name: "Doe",
|
|
752
|
-
* address_1: "123 Main St",
|
|
753
|
-
* city: "Anytown",
|
|
754
|
-
* country_code: "us",
|
|
755
|
-
* province: "us-ca",
|
|
756
|
-
* postal_code: "12345"
|
|
757
|
-
* }
|
|
758
|
-
* ])
|
|
759
|
-
* ```
|
|
760
|
-
*
|
|
761
|
-
*/
|
|
762
|
-
createOrderAddresses(data: CreateOrderAddressDTO[], sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
|
763
|
-
/**
|
|
764
|
-
* This method creates a return.
|
|
765
|
-
*
|
|
766
|
-
* @param {CreateOrderAddressDTO} data - The address to be created.
|
|
767
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
768
|
-
* @returns {Promise<OrderAddressDTO>} The created return.
|
|
769
|
-
*
|
|
770
|
-
* @example
|
|
771
|
-
* ```typescript
|
|
772
|
-
* const address = await orderModuleService.createOrderAddresses({
|
|
773
|
-
* first_name: "John",
|
|
774
|
-
* last_name: "Doe",
|
|
775
|
-
* address_1: "123 Main St",
|
|
776
|
-
* city: "Anytown",
|
|
777
|
-
* country_code: "us",
|
|
778
|
-
* province: "us-ca",
|
|
779
|
-
* postal_code: "12345"
|
|
780
|
-
* })
|
|
781
|
-
* ```
|
|
782
|
-
*
|
|
783
|
-
*/
|
|
784
|
-
createOrderAddresses(data: CreateOrderAddressDTO, sharedContext?: Context): Promise<OrderAddressDTO>;
|
|
785
|
-
/**
|
|
786
|
-
* This method updates existing addresses. The address ID is specified in each address object.
|
|
787
|
-
*
|
|
788
|
-
* @param {UpdateOrderAddressDTO[]} data - The attributes to update in the address.
|
|
789
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
790
|
-
* @returns {Promise<OrderAddressDTO[]>} The updated addresses.
|
|
791
|
-
*
|
|
792
|
-
* @example
|
|
793
|
-
* ```typescript
|
|
794
|
-
* const addresses = await orderModuleService.updateOrderAddresses([{
|
|
795
|
-
* id: "123",
|
|
796
|
-
* first_name: "John",
|
|
797
|
-
* }])
|
|
798
|
-
* ```
|
|
799
|
-
*
|
|
800
|
-
*/
|
|
801
|
-
updateOrderAddresses(data: UpdateOrderAddressDTO[], sharedContext?: Context): Promise<OrderAddressDTO[]>;
|
|
802
|
-
/**
|
|
803
|
-
* This method updates an existing address.
|
|
804
|
-
*
|
|
805
|
-
* @param {UpdateOrderAddressDTO} data - The attributes to update in the address.
|
|
806
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
807
|
-
* @returns {Promise<OrderAddressDTO>} The updated address.
|
|
808
|
-
*
|
|
809
|
-
* @example
|
|
810
|
-
* ```typescript
|
|
811
|
-
* const address = await orderModuleService.updateOrderAddresses({
|
|
812
|
-
* id: "123",
|
|
813
|
-
* first_name: "John",
|
|
814
|
-
* })
|
|
815
|
-
* ```
|
|
816
|
-
*
|
|
817
|
-
*/
|
|
818
|
-
updateOrderAddresses(data: UpdateOrderAddressDTO, sharedContext?: Context): Promise<OrderAddressDTO>;
|
|
819
|
-
/**
|
|
820
|
-
* This method deletes addresses by their IDs.
|
|
821
|
-
*
|
|
822
|
-
* @param {string[]} ids - The list of address IDs.
|
|
823
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
824
|
-
* @returns {Promise<void>} Resolves when the addresses are deleted.
|
|
825
|
-
*
|
|
826
|
-
* @example
|
|
827
|
-
* ```typescript
|
|
828
|
-
* await orderModuleService.deleteOrderAddresses(["123", "321"])
|
|
829
|
-
* ```
|
|
830
|
-
*
|
|
831
|
-
*/
|
|
832
|
-
deleteOrderAddresses(ids: string[], sharedContext?: Context): Promise<void>;
|
|
833
|
-
/**
|
|
834
|
-
* This method deletes an address by its ID.
|
|
835
|
-
*
|
|
836
|
-
* @param {string} ids - The ID of the address.
|
|
837
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
838
|
-
* @returns {Promise<void>} Resolves when the address is deleted.
|
|
839
|
-
*
|
|
840
|
-
* @example
|
|
841
|
-
* ```typescript
|
|
842
|
-
* await orderModuleService.deleteOrderAddresses("123")
|
|
843
|
-
* ```
|
|
844
|
-
*
|
|
845
|
-
*/
|
|
846
|
-
deleteOrderAddresses(ids: string, sharedContext?: Context): Promise<void>;
|
|
847
|
-
/**
|
|
848
|
-
* This method retrieves a line item by its ID.
|
|
849
|
-
*
|
|
850
|
-
* @param {string} itemId - The item's ID.
|
|
851
|
-
* @param {FindConfig<OrderLineItemDTO>} config - The configurations determining how the line item is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
852
|
-
* attributes or relations associated with a line item.
|
|
853
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
854
|
-
* @returns {Promise<OrderLineItemDTO>} The retrieved line item.
|
|
855
|
-
*
|
|
856
|
-
* @example
|
|
857
|
-
* A simple example that retrieves an order change by its ID:
|
|
858
|
-
*
|
|
859
|
-
* ```ts
|
|
860
|
-
* const lineItem = await orderModuleService.retrieveOrderLineItem("123")
|
|
861
|
-
* ```
|
|
862
|
-
*
|
|
863
|
-
* To specify relations that should be retrieved:
|
|
864
|
-
*
|
|
865
|
-
* :::note
|
|
866
|
-
*
|
|
867
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
868
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
869
|
-
*
|
|
870
|
-
* :::
|
|
871
|
-
*
|
|
872
|
-
* ```ts
|
|
873
|
-
* const lineItem = await orderModuleService.retrieveOrderLineItem(
|
|
874
|
-
* "123",
|
|
875
|
-
* {
|
|
876
|
-
* relations: ["order"]
|
|
877
|
-
* }
|
|
878
|
-
* )
|
|
879
|
-
* ```
|
|
880
|
-
*
|
|
881
|
-
*/
|
|
882
|
-
retrieveOrderLineItem(itemId: string, config?: FindConfig<OrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO>;
|
|
883
|
-
/**
|
|
884
|
-
* This method retrieves a paginated list of line items based on optional filters and configuration.
|
|
885
|
-
*
|
|
886
|
-
* @param {FilterableOrderLineItemProps} filters - The filters to apply on the retrieved line item.
|
|
887
|
-
* @param {FindConfig<OrderLineItemDTO>} config - The configurations determining how the line item is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
888
|
-
* attributes or relations associated with a line item.
|
|
889
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
890
|
-
* @returns {Promise<OrderLineItemDTO[]>} The list of line items.
|
|
891
|
-
*
|
|
892
|
-
* @example
|
|
893
|
-
* To retrieve a list of line items using their IDs:
|
|
894
|
-
*
|
|
895
|
-
* ```ts
|
|
896
|
-
* const lineItems = await orderModuleService.listOrderLineItems({
|
|
897
|
-
* id: ["123", "321"]
|
|
898
|
-
* })
|
|
899
|
-
* ```
|
|
900
|
-
*
|
|
901
|
-
* To specify relations that should be retrieved within the line item:
|
|
902
|
-
*
|
|
903
|
-
* :::note
|
|
904
|
-
*
|
|
905
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
906
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
907
|
-
*
|
|
908
|
-
* :::
|
|
909
|
-
*
|
|
910
|
-
* ```ts
|
|
911
|
-
* const lineItems = await orderModuleService.listOrderLineItems({
|
|
912
|
-
* id: ["123", "321"]
|
|
913
|
-
* }, {
|
|
914
|
-
* relations: ["order"]
|
|
915
|
-
* })
|
|
916
|
-
* ```
|
|
917
|
-
*
|
|
918
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
919
|
-
*
|
|
920
|
-
* ```ts
|
|
921
|
-
* const lineItems = await orderModuleService.listOrderLineItems({
|
|
922
|
-
* id: ["123", "321"]
|
|
923
|
-
* }, {
|
|
924
|
-
* relations: ["order"],
|
|
925
|
-
* take: 20,
|
|
926
|
-
* skip: 2
|
|
927
|
-
* })
|
|
928
|
-
* ```
|
|
929
|
-
*
|
|
930
|
-
*/
|
|
931
|
-
listOrderLineItems(filters: FilterableOrderLineItemProps, config?: FindConfig<OrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
932
|
-
/**
|
|
933
|
-
* This method creates a line item.
|
|
934
|
-
*
|
|
935
|
-
* @param {CreateOrderLineItemDTO} data - The line item to be created.
|
|
936
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
937
|
-
* @returns {Promise<OrderLineItemDTO[]>} The created line items.
|
|
938
|
-
*
|
|
939
|
-
* @example
|
|
940
|
-
* const lineItems = await orderModuleService.createOrderLineItems({
|
|
941
|
-
* title: "Shirt",
|
|
942
|
-
* quantity: 1,
|
|
943
|
-
* unit_price: 20
|
|
944
|
-
* })
|
|
945
|
-
*/
|
|
946
|
-
createOrderLineItems(data: CreateOrderLineItemDTO, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
947
|
-
/**
|
|
948
|
-
* This method creates line items.
|
|
949
|
-
*
|
|
950
|
-
* @param {CreateOrderLineItemDTO[]} data - The line items to be created.
|
|
951
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
952
|
-
* @returns {Promise<OrderLineItemDTO[]>} The created line items.
|
|
953
|
-
*
|
|
954
|
-
* @example
|
|
955
|
-
* const lineItems = await orderModuleService.createOrderLineItems([{
|
|
956
|
-
* title: "Shirt",
|
|
957
|
-
* quantity: 1,
|
|
958
|
-
* unit_price: 20
|
|
959
|
-
* }])
|
|
960
|
-
*/
|
|
961
|
-
createOrderLineItems(data: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
962
|
-
/**
|
|
963
|
-
* This method creates orders.
|
|
964
|
-
*
|
|
965
|
-
* @param {string} orderId - The order's ID.
|
|
966
|
-
* @param {CreateOrderLineItemDTO[]} items - The order line items to be created.
|
|
967
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
968
|
-
* @returns {Promise<OrderLineItemDTO[]>} The created orders.
|
|
969
|
-
*
|
|
970
|
-
* @example
|
|
971
|
-
* const lineItems = await orderModuleService.createOrderLineItems(
|
|
972
|
-
* "123",
|
|
973
|
-
* [{
|
|
974
|
-
* title: "Shirt",
|
|
975
|
-
* quantity: 1,
|
|
976
|
-
* unit_price: 20
|
|
977
|
-
* }]
|
|
978
|
-
* )
|
|
979
|
-
*/
|
|
980
|
-
createOrderLineItems(orderId: string, items: CreateOrderLineItemDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
981
|
-
/**
|
|
982
|
-
* This method updates existing line items. The line item to update is specified by the `selector` property of the first parameter.
|
|
983
|
-
*
|
|
984
|
-
* @param {UpdateOrderLineItemWithSelectorDTO[]} data - The attributes to update in the order line item with selector.
|
|
985
|
-
* @returns {Promise<OrderLineItemDTO[]>} The updated line items.
|
|
986
|
-
*
|
|
987
|
-
* @example
|
|
988
|
-
* ```typescript
|
|
989
|
-
* const lineItems = await orderModuleService.updateOrderLineItems([
|
|
990
|
-
* {
|
|
991
|
-
* selector: {
|
|
992
|
-
* id: "123"
|
|
993
|
-
* },
|
|
994
|
-
* data: {
|
|
995
|
-
* quantity: 2
|
|
996
|
-
* }
|
|
997
|
-
* }
|
|
998
|
-
* ])
|
|
999
|
-
* ```
|
|
1000
|
-
*
|
|
1001
|
-
*/
|
|
1002
|
-
updateOrderLineItems(data: UpdateOrderLineItemWithSelectorDTO[], sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
1003
|
-
/**
|
|
1004
|
-
* This method updates existing line items matching the specified filters.
|
|
1005
|
-
*
|
|
1006
|
-
* @param {Partial<OrderLineItemDTO>} selector - The filters specifying which line items to update.
|
|
1007
|
-
* @param {Partial<UpdateOrderLineItemDTO>} data - The data to update in the line items.
|
|
1008
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1009
|
-
* @returns {Promise<OrderLineItemDTO[]>} The updated line items.
|
|
1010
|
-
*
|
|
1011
|
-
* @example
|
|
1012
|
-
* const lineItems = await orderModuleService.updateOrderLineItems({
|
|
1013
|
-
* id: "123"
|
|
1014
|
-
* }, {
|
|
1015
|
-
* quantity: 2
|
|
1016
|
-
* })
|
|
1017
|
-
*
|
|
1018
|
-
*/
|
|
1019
|
-
updateOrderLineItems(selector: Partial<FilterableOrderLineItemProps>, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO[]>;
|
|
1020
|
-
/**
|
|
1021
|
-
* This method updates an existing line item.
|
|
1022
|
-
*
|
|
1023
|
-
* @param {string} lineId - The line items's ID.
|
|
1024
|
-
* @param {Partial<UpdateOrderLineItemDTO>} data - The data to update in the line item.
|
|
1025
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1026
|
-
* @returns {Promise<OrderLineItemDTO>} The updated line item.
|
|
1027
|
-
*
|
|
1028
|
-
* @example
|
|
1029
|
-
* const lineItem = await orderModuleService.updateOrderLineItems(
|
|
1030
|
-
* "123",
|
|
1031
|
-
* {
|
|
1032
|
-
* quantity: 2
|
|
1033
|
-
* }
|
|
1034
|
-
* )
|
|
1035
|
-
*
|
|
1036
|
-
*/
|
|
1037
|
-
updateOrderLineItems(lineId: string, data: Partial<UpdateOrderLineItemDTO>, sharedContext?: Context): Promise<OrderLineItemDTO>;
|
|
1038
|
-
/**
|
|
1039
|
-
* This method deletes line items by their IDs.
|
|
1040
|
-
*
|
|
1041
|
-
* @param {string[]} itemIds - The IDs of the line items to delete.
|
|
1042
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1043
|
-
* @returns {Promise<void>} Resolves when the line items are deleted successfully.
|
|
1044
|
-
*
|
|
1045
|
-
* @example
|
|
1046
|
-
* await orderModuleService.deleteOrderLineItems([
|
|
1047
|
-
* "123", "321"
|
|
1048
|
-
* ])
|
|
1049
|
-
*/
|
|
1050
|
-
deleteOrderLineItems(itemIds: string[], sharedContext?: Context): Promise<void>;
|
|
1051
|
-
/**
|
|
1052
|
-
* This method deletes a line item by its ID.
|
|
1053
|
-
*
|
|
1054
|
-
* @param {string} itemId - The line item's ID.
|
|
1055
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1056
|
-
* @returns {Promise<void>} Resolves when the line item is deleted successfully.
|
|
1057
|
-
*
|
|
1058
|
-
* @example
|
|
1059
|
-
* await orderModuleService.deleteOrderLineItems("123")
|
|
1060
|
-
*/
|
|
1061
|
-
deleteOrderLineItems(itemId: string, sharedContext?: Context): Promise<void>;
|
|
1062
|
-
/**
|
|
1063
|
-
* This method deletes line items that match the specified filters.
|
|
1064
|
-
*
|
|
1065
|
-
* @param {Partial<FilterableOrderLineItemProps>} selector - The filters specifying which line items to delete.
|
|
1066
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1067
|
-
* @returns {Promise<void>} Resolves when the line items are deleted successfully.
|
|
1068
|
-
*
|
|
1069
|
-
* @example
|
|
1070
|
-
* await orderModuleService.deleteOrderLineItems({
|
|
1071
|
-
* id: ["123", "321"]
|
|
1072
|
-
* })
|
|
1073
|
-
*/
|
|
1074
|
-
deleteOrderLineItems(selector: Partial<FilterableOrderLineItemProps>, sharedContext?: Context): Promise<void>;
|
|
1075
|
-
/**
|
|
1076
|
-
* This method updates existing order items matching the specified filters.
|
|
1077
|
-
*
|
|
1078
|
-
* @param {Partial<OrderItemDTO>} selector - The filters specifying which order items to update.
|
|
1079
|
-
* @param {UpdateOrderItemDTO} data - The attributes to update in the order item.
|
|
1080
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1081
|
-
* @returns {Promise<OrderItemDTO[]>} The updated order items.
|
|
1082
|
-
*
|
|
1083
|
-
* @example
|
|
1084
|
-
* const orderItems = await orderModuleService.updateOrderItem({
|
|
1085
|
-
* id: "123"
|
|
1086
|
-
* }, {
|
|
1087
|
-
* quantity: 2
|
|
1088
|
-
* })
|
|
1089
|
-
*
|
|
1090
|
-
*/
|
|
1091
|
-
updateOrderItem(selector: Partial<FilterableOrderShippingMethodProps>, data: UpdateOrderItemDTO, sharedContext?: Context): Promise<OrderItemDTO[]>;
|
|
1092
|
-
/**
|
|
1093
|
-
* This method updates an existing order item.
|
|
1094
|
-
*
|
|
1095
|
-
* @param {string} orderItemId - The order item's ID.
|
|
1096
|
-
* @param {Partial<UpdateOrderItemDTO>} data - The data to update in the order item.
|
|
1097
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1098
|
-
* @returns {Promise<OrderItemDTO>} The updated order item.
|
|
1099
|
-
*
|
|
1100
|
-
* @example
|
|
1101
|
-
* const orderItem = await orderModuleService.updateOrderItem(
|
|
1102
|
-
* "123",
|
|
1103
|
-
* {
|
|
1104
|
-
* quantity: 2
|
|
1105
|
-
* }
|
|
1106
|
-
* )
|
|
1107
|
-
*
|
|
1108
|
-
*/
|
|
1109
|
-
updateOrderItem(orderItemId: string, data: Partial<UpdateOrderItemDTO>, sharedContext?: Context): Promise<OrderItemDTO>;
|
|
1110
|
-
/**
|
|
1111
|
-
* This method updates existing order items. The items are identified either by their ID or the specified filters.
|
|
1112
|
-
*
|
|
1113
|
-
* @param {string | Partial<OrderItemDTO> | UpdateOrderItemWithSelectorDTO[]} orderItemIdOrDataOrSelector - Either the ID of an order item, or the
|
|
1114
|
-
* filters specifying which order items to update.
|
|
1115
|
-
* @param {UpdateOrderItemDTO | Partial<UpdateOrderItemDTO>} data - The data to update.
|
|
1116
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1117
|
-
* @returns {Promise<OrderItemDTO | OrderItemDTO[]>} The updated order items.
|
|
1118
|
-
*
|
|
1119
|
-
* @example
|
|
1120
|
-
* const orderItem = await orderModuleService.updateOrderItem(
|
|
1121
|
-
* "123",
|
|
1122
|
-
* {
|
|
1123
|
-
* quantity: 2
|
|
1124
|
-
* }
|
|
1125
|
-
* )
|
|
1126
|
-
*
|
|
1127
|
-
*/
|
|
1128
|
-
updateOrderItem(orderItemIdOrDataOrSelector: string | UpdateOrderItemWithSelectorDTO[] | Partial<OrderItemDTO>, data?: UpdateOrderItemDTO | Partial<UpdateOrderItemDTO>, sharedContext?: Context): Promise<OrderItemDTO[] | OrderItemDTO>;
|
|
1129
|
-
/**
|
|
1130
|
-
* This method retrieves a paginated list of shipping methods based on optional filters and configuration.
|
|
1131
|
-
*
|
|
1132
|
-
* @param {FilterableOrderShippingMethodProps} filters - The filters to apply on the retrieved shipping method.
|
|
1133
|
-
* @param {FindConfig<OrderShippingMethodDTO>} config - The configurations determining how the shipping method is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
1134
|
-
* attributes or relations associated with a shipping method.
|
|
1135
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1136
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} The list of shipping methods.
|
|
1137
|
-
*
|
|
1138
|
-
* @example
|
|
1139
|
-
* To retrieve a list of shipping methods using their IDs:
|
|
1140
|
-
*
|
|
1141
|
-
* ```ts
|
|
1142
|
-
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
|
1143
|
-
* id: ["123", "321"]
|
|
1144
|
-
* }, {})
|
|
1145
|
-
* ```
|
|
1146
|
-
*
|
|
1147
|
-
* To specify relations that should be retrieved within the shipping method:
|
|
1148
|
-
*
|
|
1149
|
-
* :::note
|
|
1150
|
-
*
|
|
1151
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
1152
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
1153
|
-
*
|
|
1154
|
-
* :::
|
|
1155
|
-
*
|
|
1156
|
-
* ```ts
|
|
1157
|
-
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
|
1158
|
-
* id: ["123", "321"]
|
|
1159
|
-
* }, {
|
|
1160
|
-
* relations: ["adjustments"]
|
|
1161
|
-
* })
|
|
1162
|
-
* ```
|
|
1163
|
-
*
|
|
1164
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
1165
|
-
*
|
|
1166
|
-
* ```ts
|
|
1167
|
-
* const shippingMethods = await orderModuleService.listOrderShippingMethods({
|
|
1168
|
-
* id: ["123", "321"]
|
|
1169
|
-
* }, {
|
|
1170
|
-
* relations: ["adjustments"],
|
|
1171
|
-
* take: 20,
|
|
1172
|
-
* skip: 2
|
|
1173
|
-
* })
|
|
1174
|
-
* ```
|
|
1175
|
-
*
|
|
1176
|
-
*/
|
|
1177
|
-
listOrderShippingMethods(filters: FilterableOrderShippingMethodProps, config: FindConfig<OrderShippingMethodDTO>, sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
|
1178
|
-
/**
|
|
1179
|
-
* This method creates a shipping method.
|
|
1180
|
-
*
|
|
1181
|
-
* @param {CreateOrderShippingMethodDTO} data - The shipping method to be created.
|
|
1182
|
-
* @returns {Promise<OrderShippingMethodDTO>} The created shipping method.
|
|
1183
|
-
*
|
|
1184
|
-
* @example
|
|
1185
|
-
* const shippingMethod = await orderModuleService.createOrderShippingMethods({
|
|
1186
|
-
* name: "Express Shipping",
|
|
1187
|
-
* order_id: "123",
|
|
1188
|
-
* amount: 10
|
|
1189
|
-
* })
|
|
1190
|
-
*/
|
|
1191
|
-
createOrderShippingMethods(data: CreateOrderShippingMethodDTO, sharedContext?: Context): Promise<OrderShippingMethodDTO>;
|
|
1192
|
-
/**
|
|
1193
|
-
* This method creates shipping methods.
|
|
1194
|
-
*
|
|
1195
|
-
* @param {CreateOrderShippingMethodDTO[]} data - The order shipping methods to be created.
|
|
1196
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} The created orders.
|
|
1197
|
-
*
|
|
1198
|
-
* @example
|
|
1199
|
-
* const shippingMethods = await orderModuleService.createOrderShippingMethods([{
|
|
1200
|
-
* name: "Express Shipping",
|
|
1201
|
-
* order_id: "123",
|
|
1202
|
-
* amount: 10
|
|
1203
|
-
* }])
|
|
1204
|
-
*/
|
|
1205
|
-
createOrderShippingMethods(data: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
|
1206
|
-
/**
|
|
1207
|
-
* This method creates shipping methods for an order.
|
|
1208
|
-
*
|
|
1209
|
-
* @param {string} orderId - The order's ID.
|
|
1210
|
-
* @param {CreateOrderShippingMethodDTO[]} methods - The shipping methods to be created.
|
|
1211
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1212
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} The created shipping methods.
|
|
1213
|
-
*
|
|
1214
|
-
* @example
|
|
1215
|
-
* const shippingMethods = await orderModuleService.createOrderShippingMethods(
|
|
1216
|
-
* "123",
|
|
1217
|
-
* [
|
|
1218
|
-
* {
|
|
1219
|
-
* name: "Express Shipping",
|
|
1220
|
-
* order_id: "123",
|
|
1221
|
-
* amount: 10
|
|
1222
|
-
* }
|
|
1223
|
-
* ]
|
|
1224
|
-
* )
|
|
1225
|
-
*/
|
|
1226
|
-
createOrderShippingMethods(orderId: string, methods: CreateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
|
1227
|
-
/**
|
|
1228
|
-
* This method updates existing shipping methods. The shipping method IDs are specified in each shipping method object.
|
|
1229
|
-
*
|
|
1230
|
-
* @param {UpdateOrderShippingMethodDTO[]} data - The attributes to update in the shipping methods.
|
|
1231
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1232
|
-
* @returns {Promise<OrderShippingMethodDTO[]>} The updated shipping methods.
|
|
1233
|
-
*
|
|
1234
|
-
* @example
|
|
1235
|
-
* const shippingMethods = await orderModuleService.updateOrderShippingMethods([{
|
|
1236
|
-
* id: "123",
|
|
1237
|
-
* name: "Express Shipping"
|
|
1238
|
-
* }])
|
|
1239
|
-
*/
|
|
1240
|
-
updateOrderShippingMethods(data: UpdateOrderShippingMethodDTO[], sharedContext?: Context): Promise<OrderShippingMethodDTO[]>;
|
|
1241
|
-
/**
|
|
1242
|
-
* This method updates an existing shipping method.
|
|
1243
|
-
*
|
|
1244
|
-
* @param {UpdateOrderShippingMethodDTO} data - The attributes to update in the shipping method.
|
|
1245
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1246
|
-
* @returns {Promise<OrderShippingMethodDTO>} The updated shipping method.
|
|
1247
|
-
*
|
|
1248
|
-
* @example
|
|
1249
|
-
* const shippingMethod = await orderModuleService.updateOrderShippingMethods({
|
|
1250
|
-
* id: "123",
|
|
1251
|
-
* name: "Express Shipping"
|
|
1252
|
-
* })
|
|
1253
|
-
*/
|
|
1254
|
-
updateOrderShippingMethods(data: UpdateOrderShippingMethodDTO, sharedContext?: Context): Promise<OrderShippingMethodDTO>;
|
|
1255
|
-
/**
|
|
1256
|
-
* This method deletes shipping methods by their IDs.
|
|
1257
|
-
*
|
|
1258
|
-
* @param {string[]} methodIds - The list of shipping methods.
|
|
1259
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1260
|
-
* @returns {Promise<void>} Resolves when the shipping methods are deleted successfully.
|
|
1261
|
-
*
|
|
1262
|
-
* @example
|
|
1263
|
-
* await orderModuleService.deleteOrderShippingMethods([
|
|
1264
|
-
* "123", "321"
|
|
1265
|
-
* ])
|
|
1266
|
-
*/
|
|
1267
|
-
deleteOrderShippingMethods(methodIds: string[], sharedContext?: Context): Promise<void>;
|
|
1268
|
-
/**
|
|
1269
|
-
* This method deletes a shipping method by its ID.
|
|
1270
|
-
*
|
|
1271
|
-
* @param {string} methodId - The shipping method's ID.
|
|
1272
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1273
|
-
* @returns {Promise<void>} Resolves when the shipping method is deleted successfully.
|
|
1274
|
-
*
|
|
1275
|
-
* @example
|
|
1276
|
-
* await orderModuleService.deleteOrderShippingMethods("123")
|
|
1277
|
-
*/
|
|
1278
|
-
deleteOrderShippingMethods(methodId: string, sharedContext?: Context): Promise<void>;
|
|
1279
|
-
/**
|
|
1280
|
-
* This method deletes shipping methods matching the specified filters.
|
|
1281
|
-
*
|
|
1282
|
-
* @param {Partial<FilterableOrderShippingMethodProps>} selector - The filters specifying the shipping methods to delete.
|
|
1283
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1284
|
-
* @returns {Promise<void>} Resolves when the shipping methods are deleted successfully.
|
|
1285
|
-
*
|
|
1286
|
-
* @example
|
|
1287
|
-
* await orderModuleService.deleteOrderShippingMethods({
|
|
1288
|
-
* id: "123"
|
|
1289
|
-
* })
|
|
1290
|
-
*/
|
|
1291
|
-
deleteOrderShippingMethods(selector: Partial<FilterableOrderShippingMethodProps>, sharedContext?: Context): Promise<void>;
|
|
1292
|
-
/**
|
|
1293
|
-
* This method retrieves a paginated list of line item adjustments based on optional filters and configuration.
|
|
1294
|
-
*
|
|
1295
|
-
* @param {FilterableOrderLineItemAdjustmentProps} filters - The filters to apply on the retrieved line item adjustment.
|
|
1296
|
-
* @param {FindConfig<OrderLineItemAdjustmentDTO>} config - The configurations determining how the line item adjustment is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
1297
|
-
* attributes or relations associated with a line item adjustment.
|
|
1298
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1299
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The list of line item adjustments.
|
|
1300
|
-
*
|
|
1301
|
-
* @example
|
|
1302
|
-
* To retrieve a list of line item adjustments using their IDs:
|
|
1303
|
-
*
|
|
1304
|
-
* ```ts
|
|
1305
|
-
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
|
1306
|
-
* id: ["123", "321"]
|
|
1307
|
-
* })
|
|
1308
|
-
* ```
|
|
1309
|
-
*
|
|
1310
|
-
* To specify relations that should be retrieved within the line item adjustment:
|
|
1311
|
-
*
|
|
1312
|
-
* :::note
|
|
1313
|
-
*
|
|
1314
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
1315
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
1316
|
-
*
|
|
1317
|
-
* :::
|
|
1318
|
-
*
|
|
1319
|
-
* ```ts
|
|
1320
|
-
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
|
1321
|
-
* id: ["123", "321"]
|
|
1322
|
-
* }, {
|
|
1323
|
-
* relations: ["item"]
|
|
1324
|
-
* })
|
|
1325
|
-
* ```
|
|
1326
|
-
*
|
|
1327
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
1328
|
-
*
|
|
1329
|
-
* ```ts
|
|
1330
|
-
* const lineItemAdjustment = await orderModuleService.listOrderLineItemAdjustments({
|
|
1331
|
-
* id: ["123", "321"]
|
|
1332
|
-
* }, {
|
|
1333
|
-
* relations: ["item"],
|
|
1334
|
-
* take: 20,
|
|
1335
|
-
* skip: 2
|
|
1336
|
-
* })
|
|
1337
|
-
* ```
|
|
1338
|
-
*
|
|
1339
|
-
*/
|
|
1340
|
-
listOrderLineItemAdjustments(filters: FilterableOrderLineItemAdjustmentProps, config?: FindConfig<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1341
|
-
/**
|
|
1342
|
-
* This method creates line item adjustments.
|
|
1343
|
-
*
|
|
1344
|
-
* @param {CreateOrderLineItemAdjustmentDTO[]} data - The line item adjustments to be created.
|
|
1345
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line item adjustments.
|
|
1346
|
-
*
|
|
1347
|
-
* @example
|
|
1348
|
-
* const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments([{
|
|
1349
|
-
* amount: 5
|
|
1350
|
-
* }])
|
|
1351
|
-
*/
|
|
1352
|
-
createOrderLineItemAdjustments(data: CreateOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1353
|
-
/**
|
|
1354
|
-
* This method creates a line item adjustment.
|
|
1355
|
-
*
|
|
1356
|
-
* @param {CreateOrderLineItemAdjustmentDTO} data - The line-item adjustment to be created.
|
|
1357
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line-item adjustment.
|
|
1358
|
-
*
|
|
1359
|
-
* @example
|
|
1360
|
-
* const lineItemAdjustment = await orderModuleService.createOrderLineItemAdjustments({
|
|
1361
|
-
* amount: 5
|
|
1362
|
-
* })
|
|
1363
|
-
*/
|
|
1364
|
-
createOrderLineItemAdjustments(data: CreateOrderLineItemAdjustmentDTO, sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1365
|
-
/**
|
|
1366
|
-
* This method creates line item adjustments for an order.
|
|
1367
|
-
*
|
|
1368
|
-
* @param {string} orderId - The order's ID.
|
|
1369
|
-
* @param {CreateOrderLineItemAdjustmentDTO[]} data - The line-item adjustments to be created.
|
|
1370
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The created line item adjustments.
|
|
1371
|
-
*
|
|
1372
|
-
* @example
|
|
1373
|
-
* const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments(
|
|
1374
|
-
* "123",
|
|
1375
|
-
* [{
|
|
1376
|
-
* amount: 5
|
|
1377
|
-
* }]
|
|
1378
|
-
* )
|
|
1379
|
-
*/
|
|
1380
|
-
createOrderLineItemAdjustments(orderId: string, data: CreateOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1381
|
-
/**
|
|
1382
|
-
* This method upserts line item adjustments.
|
|
1383
|
-
*
|
|
1384
|
-
* @param {UpsertOrderLineItemAdjustmentDTO[]} data - The line item adjustments to create or update. If the `id` property is provided
|
|
1385
|
-
* in an object, it means an existing line item adjustment will be updated. Otherwise, a new one is created.
|
|
1386
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1387
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The line item adjustments.
|
|
1388
|
-
*
|
|
1389
|
-
* @example
|
|
1390
|
-
* const lineItemAdjustments = await orderModuleService.upsertOrderLineItemAdjustments(
|
|
1391
|
-
* [
|
|
1392
|
-
* {
|
|
1393
|
-
* item_id: "1234",
|
|
1394
|
-
* amount: 10
|
|
1395
|
-
* },
|
|
1396
|
-
* {
|
|
1397
|
-
* id: "123",
|
|
1398
|
-
* item_id: "4321",
|
|
1399
|
-
* amount: 20
|
|
1400
|
-
* }
|
|
1401
|
-
* ]
|
|
1402
|
-
* )
|
|
1403
|
-
*
|
|
1404
|
-
*/
|
|
1405
|
-
upsertOrderLineItemAdjustments(data: UpsertOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1406
|
-
/**
|
|
1407
|
-
* This method sets the line item adjustments of an order.
|
|
1408
|
-
*
|
|
1409
|
-
* @param {string} orderId - The order's ID.
|
|
1410
|
-
* @param {UpsertOrderLineItemAdjustmentDTO[]} data - The line item adjustments to create or update. If the `id` property is provided
|
|
1411
|
-
* in an object, it means an existing line item adjustment will be updated. Otherwise, a new one is created.
|
|
1412
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1413
|
-
* @returns {Promise<OrderLineItemAdjustmentDTO[]>} The order's line item adjustments.
|
|
1414
|
-
*
|
|
1415
|
-
* @example
|
|
1416
|
-
* const lineItemAdjustments = await orderModuleService.setOrderLineItemAdjustments(
|
|
1417
|
-
* "123",
|
|
1418
|
-
* [
|
|
1419
|
-
* {
|
|
1420
|
-
* item_id: "1234",
|
|
1421
|
-
* amount: 10
|
|
1422
|
-
* },
|
|
1423
|
-
* {
|
|
1424
|
-
* id: "123",
|
|
1425
|
-
* item_id: "4321",
|
|
1426
|
-
* amount: 20
|
|
1427
|
-
* }
|
|
1428
|
-
* ]
|
|
1429
|
-
* )
|
|
1430
|
-
*
|
|
1431
|
-
*/
|
|
1432
|
-
setOrderLineItemAdjustments(orderId: string, data: UpsertOrderLineItemAdjustmentDTO[], sharedContext?: Context): Promise<OrderLineItemAdjustmentDTO[]>;
|
|
1433
|
-
/**
|
|
1434
|
-
* This method deletes a line item adjustment by its ID.
|
|
1435
|
-
*
|
|
1436
|
-
* @param {string[]} adjustmentIds - The IDs of line item adjustments.
|
|
1437
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1438
|
-
* @returns {Promise<void>} Resolves when the line item adjustments are deleted successfully.
|
|
1439
|
-
*
|
|
1440
|
-
* @example
|
|
1441
|
-
* await orderModuleService.deleteOrderLineItemAdjustments([
|
|
1442
|
-
* "123", "321"
|
|
1443
|
-
* ])
|
|
1444
|
-
*/
|
|
1445
|
-
deleteOrderLineItemAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
|
1446
|
-
/**
|
|
1447
|
-
* This method deletes a line item adjustment by its ID.
|
|
1448
|
-
*
|
|
1449
|
-
* @param {string} adjustmentId - The ID of the line item adjustment.
|
|
1450
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1451
|
-
* @returns {Promise<void>} Resolves when the line item adjustment is deleted.
|
|
1452
|
-
*
|
|
1453
|
-
* @example
|
|
1454
|
-
* await orderModuleService.deleteOrderLineItemAdjustments("123")
|
|
1455
|
-
*/
|
|
1456
|
-
deleteOrderLineItemAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
|
1457
|
-
/**
|
|
1458
|
-
* This method deletes line item adjustments matching the specified filters.
|
|
1459
|
-
*
|
|
1460
|
-
* @param {Partial<OrderLineItemAdjustmentDTO>} selector - The filters specifying which line item adjustments to delete.
|
|
1461
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1462
|
-
* @returns {Promise<void>} Resolves when the line item adjustments are deleted successfully.
|
|
1463
|
-
*
|
|
1464
|
-
* @example
|
|
1465
|
-
* await orderModuleService.deleteOrderLineItemAdjustments({
|
|
1466
|
-
* id: "123"
|
|
1467
|
-
* })
|
|
1468
|
-
*/
|
|
1469
|
-
deleteOrderLineItemAdjustments(selector: Partial<OrderLineItemAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
|
1470
|
-
/**
|
|
1471
|
-
* This method retrieves a paginated list of shipping method adjustments based on optional filters and configuration.
|
|
1472
|
-
*
|
|
1473
|
-
* @param {FilterableOrderShippingMethodAdjustmentProps} filters - The filters to apply on the retrieved shipping method adjustment.
|
|
1474
|
-
* @param {FindConfig<OrderShippingMethodAdjustmentDTO>} config - The configurations determining how the shipping method adjustment is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
1475
|
-
* attributes or relations associated with a shipping method adjustment.
|
|
1476
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1477
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} The list of shipping method adjustments.
|
|
1478
|
-
*
|
|
1479
|
-
* @example
|
|
1480
|
-
* To retrieve a list of shipping method adjustments using their IDs:
|
|
1481
|
-
*
|
|
1482
|
-
* ```ts
|
|
1483
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1484
|
-
* .listOrderShippingMethodAdjustments({
|
|
1485
|
-
* id: ["123", "321"]
|
|
1486
|
-
* })
|
|
1487
|
-
* ```
|
|
1488
|
-
*
|
|
1489
|
-
* To specify relations that should be retrieved within the shipping method adjustment:
|
|
1490
|
-
*
|
|
1491
|
-
* :::note
|
|
1492
|
-
*
|
|
1493
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
1494
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
1495
|
-
*
|
|
1496
|
-
* :::
|
|
1497
|
-
*
|
|
1498
|
-
* ```ts
|
|
1499
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1500
|
-
* .listOrderShippingMethodAdjustments({
|
|
1501
|
-
* id: ["123", "321"]
|
|
1502
|
-
* }, {
|
|
1503
|
-
* relations: ["shipping_method"]
|
|
1504
|
-
* })
|
|
1505
|
-
* ```
|
|
1506
|
-
*
|
|
1507
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
1508
|
-
*
|
|
1509
|
-
* ```ts
|
|
1510
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1511
|
-
* .listOrderShippingMethodAdjustments({
|
|
1512
|
-
* id: ["123", "321"]
|
|
1513
|
-
* }, {
|
|
1514
|
-
* relations: ["shipping_method"],
|
|
1515
|
-
* take: 20,
|
|
1516
|
-
* skip: 2
|
|
1517
|
-
* })
|
|
1518
|
-
* ```
|
|
1519
|
-
*
|
|
1520
|
-
*/
|
|
1521
|
-
listOrderShippingMethodAdjustments(filters: FilterableOrderShippingMethodAdjustmentProps, config?: FindConfig<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
|
1522
|
-
/**
|
|
1523
|
-
* This method creates shipping method adjustments.
|
|
1524
|
-
*
|
|
1525
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO[]} data - The order shipping method adjustments to be created.
|
|
1526
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} The created shipping method adjustments.
|
|
1527
|
-
*
|
|
1528
|
-
* @example
|
|
1529
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1530
|
-
* .createOrderShippingMethodAdjustments([
|
|
1531
|
-
* {
|
|
1532
|
-
* shipping_method_id: "123",
|
|
1533
|
-
* code: "50OFF",
|
|
1534
|
-
* amount: 5
|
|
1535
|
-
* }
|
|
1536
|
-
* ])
|
|
1537
|
-
*/
|
|
1538
|
-
createOrderShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
|
1539
|
-
/**
|
|
1540
|
-
* This method creates a shipping method adjustment.
|
|
1541
|
-
*
|
|
1542
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO} data - The shipping method adjustment to be created.
|
|
1543
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO>} The created shipping method adjustment.
|
|
1544
|
-
*
|
|
1545
|
-
* @example
|
|
1546
|
-
* const shippingMethodAdjustment = await orderModuleService
|
|
1547
|
-
* .createOrderShippingMethodAdjustments({
|
|
1548
|
-
* shipping_method_id: "123",
|
|
1549
|
-
* code: "50OFF",
|
|
1550
|
-
* amount: 5
|
|
1551
|
-
* })
|
|
1552
|
-
*/
|
|
1553
|
-
createOrderShippingMethodAdjustments(data: CreateOrderShippingMethodAdjustmentDTO, sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO>;
|
|
1554
|
-
/**
|
|
1555
|
-
* This method creates shipping method adjustments for an order.
|
|
1556
|
-
*
|
|
1557
|
-
* @param {string} orderId - The order's ID.
|
|
1558
|
-
* @param {CreateOrderShippingMethodAdjustmentDTO[]} data - The order shipping method adjustments to be created.
|
|
1559
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1560
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} The created shipping method adjustments.
|
|
1561
|
-
*
|
|
1562
|
-
* @example
|
|
1563
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1564
|
-
* .createOrderShippingMethodAdjustments(
|
|
1565
|
-
* "123",
|
|
1566
|
-
* [{
|
|
1567
|
-
* shipping_method_id: "123",
|
|
1568
|
-
* code: "50OFF",
|
|
1569
|
-
* amount: 5
|
|
1570
|
-
* }]
|
|
1571
|
-
* )
|
|
1572
|
-
*/
|
|
1573
|
-
createOrderShippingMethodAdjustments(orderId: string, data: CreateOrderShippingMethodAdjustmentDTO[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
|
1574
|
-
/**
|
|
1575
|
-
* This method upserts shipping method adjustments.
|
|
1576
|
-
*
|
|
1577
|
-
* @param {(CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[]} data - The shipping method adjustments to be created
|
|
1578
|
-
* or updated. If an adjustment object has an `id` property, it's updated. Otherwise, a new adjustment is created.
|
|
1579
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1580
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} The shipping method adjustments.
|
|
1581
|
-
*
|
|
1582
|
-
* @example
|
|
1583
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1584
|
-
* .upsertOrderShippingMethodAdjustments(
|
|
1585
|
-
* [
|
|
1586
|
-
* {
|
|
1587
|
-
* shipping_method_id: "123",
|
|
1588
|
-
* code: "50OFF",
|
|
1589
|
-
* amount: 5
|
|
1590
|
-
* },
|
|
1591
|
-
* {
|
|
1592
|
-
* id: "321",
|
|
1593
|
-
* amount: 5
|
|
1594
|
-
* }
|
|
1595
|
-
* ]
|
|
1596
|
-
* )
|
|
1597
|
-
*
|
|
1598
|
-
*/
|
|
1599
|
-
upsertOrderShippingMethodAdjustments(data: (CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
|
1600
|
-
/**
|
|
1601
|
-
* This method sets the shipping method adjustments of an order.
|
|
1602
|
-
*
|
|
1603
|
-
* @param {string} orderId - The order's ID.
|
|
1604
|
-
* @param {(CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[]} data - The shipping method adjustments to be created
|
|
1605
|
-
* or updated. If an adjustment object has an `id` property, it's updated. Otherwise, a new adjustment is created.
|
|
1606
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1607
|
-
* @returns {Promise<OrderShippingMethodAdjustmentDTO[]>} The order's shipping method adjustments.
|
|
1608
|
-
*
|
|
1609
|
-
* @example
|
|
1610
|
-
* const shippingMethodAdjustments = await orderModuleService
|
|
1611
|
-
* .setOrderShippingMethodAdjustments(
|
|
1612
|
-
* "123",
|
|
1613
|
-
* [
|
|
1614
|
-
* {
|
|
1615
|
-
* shipping_method_id: "123",
|
|
1616
|
-
* code: "50OFF",
|
|
1617
|
-
* amount: 5
|
|
1618
|
-
* },
|
|
1619
|
-
* {
|
|
1620
|
-
* id: "321",
|
|
1621
|
-
* amount: 5
|
|
1622
|
-
* }
|
|
1623
|
-
* ]
|
|
1624
|
-
* )
|
|
1625
|
-
*
|
|
1626
|
-
*/
|
|
1627
|
-
setOrderShippingMethodAdjustments(orderId: string, data: (CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[], sharedContext?: Context): Promise<OrderShippingMethodAdjustmentDTO[]>;
|
|
1628
|
-
/**
|
|
1629
|
-
* This method deletes shipping method adjustments by their IDs.
|
|
1630
|
-
*
|
|
1631
|
-
* @param {string[]} adjustmentIds - The IDs of shipping method adjustments.
|
|
1632
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1633
|
-
* @returns {Promise<void>} Resolves when the shipping method adjustments are deleted successfully.
|
|
1634
|
-
*
|
|
1635
|
-
* @example
|
|
1636
|
-
* await orderModuleService.deleteOrderShippingMethodAdjustments([
|
|
1637
|
-
* "123", "321"
|
|
1638
|
-
* ])
|
|
1639
|
-
*/
|
|
1640
|
-
deleteOrderShippingMethodAdjustments(adjustmentIds: string[], sharedContext?: Context): Promise<void>;
|
|
1641
|
-
/**
|
|
1642
|
-
* This method deletes a shipping method adjustment by its ID.
|
|
1643
|
-
*
|
|
1644
|
-
* @param {string} adjustmentId - The adjustment's ID.
|
|
1645
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1646
|
-
* @returns {Promise<void>} Resolves when the shipping method adjustment is deleted successfully
|
|
1647
|
-
*
|
|
1648
|
-
* @example
|
|
1649
|
-
* await orderModuleService.deleteOrderShippingMethodAdjustments("123")
|
|
1650
|
-
*/
|
|
1651
|
-
deleteOrderShippingMethodAdjustments(adjustmentId: string, sharedContext?: Context): Promise<void>;
|
|
1652
|
-
/**
|
|
1653
|
-
* This method deletes shipping method adjustments matching the specified filters.
|
|
1654
|
-
*
|
|
1655
|
-
* @param {Partial<OrderShippingMethodAdjustmentDTO>} selector - The filters specifying which shipping method adjustments to delete.
|
|
1656
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1657
|
-
* @returns {Promise<void>} Resolves when the shipping method adjustments are deleted.
|
|
1658
|
-
*
|
|
1659
|
-
* @example
|
|
1660
|
-
* await orderModuleService.deleteOrderShippingMethodAdjustments({
|
|
1661
|
-
* id: "123"
|
|
1662
|
-
* })
|
|
1663
|
-
*/
|
|
1664
|
-
deleteOrderShippingMethodAdjustments(selector: Partial<OrderShippingMethodAdjustmentDTO>, sharedContext?: Context): Promise<void>;
|
|
1665
|
-
/**
|
|
1666
|
-
* This method retrieves a paginated list of line item taxes based on optional filters and configuration.
|
|
1667
|
-
*
|
|
1668
|
-
* @param {FilterableOrderLineItemTaxLineProps} filters - The filters to apply on the retrieved line item tax line.
|
|
1669
|
-
* @param {FindConfig<OrderLineItemTaxLineDTO>} config - The configurations determining how the line item tax line is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
1670
|
-
* attributes or relations associated with a line item tax line.
|
|
1671
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1672
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} The list of line item taxes.
|
|
1673
|
-
*
|
|
1674
|
-
* @example
|
|
1675
|
-
* To retrieve a list of line item tax lines using their IDs:
|
|
1676
|
-
*
|
|
1677
|
-
* ```ts
|
|
1678
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1679
|
-
* .listOrderLineItemTaxLines({
|
|
1680
|
-
* id: ["123", "321"]
|
|
1681
|
-
* })
|
|
1682
|
-
* ```
|
|
1683
|
-
*
|
|
1684
|
-
* To specify relations that should be retrieved within the line item tax line:
|
|
1685
|
-
*
|
|
1686
|
-
* :::note
|
|
1687
|
-
*
|
|
1688
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
1689
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
1690
|
-
*
|
|
1691
|
-
* :::
|
|
1692
|
-
*
|
|
1693
|
-
* ```ts
|
|
1694
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1695
|
-
* .listOrderLineItemTaxLines({
|
|
1696
|
-
* id: ["123", "321"]
|
|
1697
|
-
* }, {
|
|
1698
|
-
* relations: ["item"]
|
|
1699
|
-
* })
|
|
1700
|
-
* ```
|
|
1701
|
-
*
|
|
1702
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
1703
|
-
*
|
|
1704
|
-
* ```ts
|
|
1705
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1706
|
-
* .listOrderLineItemTaxLines({
|
|
1707
|
-
* id: ["123", "321"]
|
|
1708
|
-
* }, {
|
|
1709
|
-
* relations: ["item"],
|
|
1710
|
-
* take: 20,
|
|
1711
|
-
* skip: 2
|
|
1712
|
-
* })
|
|
1713
|
-
* ```
|
|
1714
|
-
*
|
|
1715
|
-
*/
|
|
1716
|
-
listOrderLineItemTaxLines(filters: FilterableOrderLineItemTaxLineProps, config?: FindConfig<OrderLineItemTaxLineDTO>, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
|
1717
|
-
/**
|
|
1718
|
-
* This method creates line item tax lines.
|
|
1719
|
-
*
|
|
1720
|
-
* @param {CreateOrderLineItemTaxLineDTO[]} taxLines - The line item tax lines to be created.
|
|
1721
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} The created line item tax lines.
|
|
1722
|
-
*
|
|
1723
|
-
* @example
|
|
1724
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1725
|
-
* .createOrderLineItemTaxLines([
|
|
1726
|
-
* {
|
|
1727
|
-
* code: "123",
|
|
1728
|
-
* rate: 2
|
|
1729
|
-
* }
|
|
1730
|
-
* ])
|
|
1731
|
-
*/
|
|
1732
|
-
createOrderLineItemTaxLines(taxLines: CreateOrderLineItemTaxLineDTO[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
|
1733
|
-
/**
|
|
1734
|
-
* This method creates a line item tax line.
|
|
1735
|
-
*
|
|
1736
|
-
* @param {CreateOrderLineItemTaxLineDTO} taxLine - The line item tax line to be created.
|
|
1737
|
-
* @returns {Promise<OrderLineItemTaxLineDTO>} The created line item tax line.
|
|
1738
|
-
*
|
|
1739
|
-
* @example
|
|
1740
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1741
|
-
* .createOrderLineItemTaxLines({
|
|
1742
|
-
* code: "123",
|
|
1743
|
-
* rate: 2
|
|
1744
|
-
* })
|
|
1745
|
-
*/
|
|
1746
|
-
createOrderLineItemTaxLines(taxLine: CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO>;
|
|
1747
|
-
/**
|
|
1748
|
-
* This method creates line item tax lines for an order.
|
|
1749
|
-
*
|
|
1750
|
-
* @param {string} orderId - The order's ID.
|
|
1751
|
-
* @param {CreateOrderLineItemTaxLineDTO | CreateOrderLineItemTaxLineDTO[]} taxLines - The line item tax lines to be created.
|
|
1752
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1753
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} The created line item tax line.
|
|
1754
|
-
*
|
|
1755
|
-
* @example
|
|
1756
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1757
|
-
* .createOrderLineItemTaxLines(
|
|
1758
|
-
* "123",
|
|
1759
|
-
* [
|
|
1760
|
-
* {
|
|
1761
|
-
* code: "123",
|
|
1762
|
-
* rate: 2
|
|
1763
|
-
* }
|
|
1764
|
-
* ]
|
|
1765
|
-
* )
|
|
1766
|
-
*/
|
|
1767
|
-
createOrderLineItemTaxLines(orderId: string, taxLines: CreateOrderLineItemTaxLineDTO[] | CreateOrderLineItemTaxLineDTO, sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
|
1768
|
-
/**
|
|
1769
|
-
* This method upserts line item tax lines.
|
|
1770
|
-
*
|
|
1771
|
-
* @param {(CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[]} taxLines - The line item tax lines to create or update. If the
|
|
1772
|
-
* tax line object has an `id` property, it'll be updated. Otherwise, a tax line is created.
|
|
1773
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1774
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} The line item tax lines.
|
|
1775
|
-
*
|
|
1776
|
-
* @example
|
|
1777
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1778
|
-
* .upsertOrderLineItemTaxLines(
|
|
1779
|
-
* [
|
|
1780
|
-
* {
|
|
1781
|
-
* code: "123",
|
|
1782
|
-
* rate: 2
|
|
1783
|
-
* }
|
|
1784
|
-
* ]
|
|
1785
|
-
* )
|
|
1786
|
-
*
|
|
1787
|
-
*/
|
|
1788
|
-
upsertOrderLineItemTaxLines(taxLines: (CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
|
1789
|
-
/**
|
|
1790
|
-
* This method sets the line item tax lines of an order.
|
|
1791
|
-
*
|
|
1792
|
-
* @param {string} orderId - The order's ID.
|
|
1793
|
-
* @param {(CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[]} taxLines - The line item tax lines to create or update. If the
|
|
1794
|
-
* tax line object has an `id` property, it'll be updated. Otherwise, a tax line is created.
|
|
1795
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1796
|
-
* @returns {Promise<OrderLineItemTaxLineDTO[]>} The order's line item tax lines.
|
|
1797
|
-
*
|
|
1798
|
-
* @example
|
|
1799
|
-
* const lineItemTaxLines = await orderModuleService
|
|
1800
|
-
* .setOrderLineItemTaxLines(
|
|
1801
|
-
* "123",
|
|
1802
|
-
* [
|
|
1803
|
-
* {
|
|
1804
|
-
* code: "123",
|
|
1805
|
-
* rate: 2
|
|
1806
|
-
* }
|
|
1807
|
-
* ]
|
|
1808
|
-
* )
|
|
1809
|
-
*
|
|
1810
|
-
*/
|
|
1811
|
-
setOrderLineItemTaxLines(orderId: string, taxLines: (CreateOrderLineItemTaxLineDTO | UpdateOrderLineItemTaxLineDTO)[], sharedContext?: Context): Promise<OrderLineItemTaxLineDTO[]>;
|
|
1812
|
-
/**
|
|
1813
|
-
* This method deletes line item tax lines by their IDs.
|
|
1814
|
-
*
|
|
1815
|
-
* @param {string[]} taxLineIds - The IDs of the line item tax lines.
|
|
1816
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1817
|
-
* @returns {Promise<void>} Resolves when the line item tax lines are deleted successfully.
|
|
1818
|
-
*
|
|
1819
|
-
* @example
|
|
1820
|
-
* await orderModuleService.deleteOrderLineItemTaxLines([
|
|
1821
|
-
* "123", "321"
|
|
1822
|
-
* ])
|
|
1823
|
-
*/
|
|
1824
|
-
deleteOrderLineItemTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
|
1825
|
-
/**
|
|
1826
|
-
* This method deletes a line item tax line by its ID.
|
|
1827
|
-
*
|
|
1828
|
-
* @param {string} taxLineId - The ID of the line item tax line.
|
|
1829
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1830
|
-
* @returns {Promise<void>} Resolves when the line item tax line is deleted successfully.
|
|
1831
|
-
*
|
|
1832
|
-
* @example
|
|
1833
|
-
* await orderModuleService.deleteOrderLineItemTaxLines("123")
|
|
1834
|
-
*/
|
|
1835
|
-
deleteOrderLineItemTaxLines(taxLineId: string, sharedContext?: Context): Promise<void>;
|
|
1836
|
-
/**
|
|
1837
|
-
* This method deletes line item tax lines matching the specified filters.
|
|
1838
|
-
*
|
|
1839
|
-
* @param {FilterableOrderLineItemTaxLineProps} selector - The filters specifying which line item tax lines to update.
|
|
1840
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1841
|
-
* @returns {Promise<void>} Resolves when the line item tax lines are deleted successfully.
|
|
1842
|
-
*
|
|
1843
|
-
* @example
|
|
1844
|
-
* await orderModuleService.deleteOrderLineItemTaxLines({
|
|
1845
|
-
* id: ["123", "321"]
|
|
1846
|
-
* })
|
|
1847
|
-
*/
|
|
1848
|
-
deleteOrderLineItemTaxLines(selector: FilterableOrderLineItemTaxLineProps, sharedContext?: Context): Promise<void>;
|
|
1849
|
-
/**
|
|
1850
|
-
* This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration.
|
|
1851
|
-
*
|
|
1852
|
-
* @param {FilterableOrderShippingMethodTaxLineProps} filters - The filters to apply on the retrieved shipping method tax line.
|
|
1853
|
-
* @param {FindConfig<OrderShippingMethodTaxLineDTO>} config - The configurations determining how the shipping method tax line is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
1854
|
-
* attributes or relations associated with a shipping method tax line.
|
|
1855
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1856
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} The list of shipping method tax lines.
|
|
1857
|
-
*
|
|
1858
|
-
* @example
|
|
1859
|
-
* To retrieve a list of shipping method tax lines using their IDs:
|
|
1860
|
-
*
|
|
1861
|
-
* ```ts
|
|
1862
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1863
|
-
* .listOrderShippingMethodTaxLines({
|
|
1864
|
-
* id: ["123", "321"]
|
|
1865
|
-
* })
|
|
1866
|
-
* ```
|
|
1867
|
-
*
|
|
1868
|
-
* To specify relations that should be retrieved within the shipping method tax line:
|
|
1869
|
-
*
|
|
1870
|
-
* :::note
|
|
1871
|
-
*
|
|
1872
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
1873
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
1874
|
-
*
|
|
1875
|
-
* :::
|
|
1876
|
-
*
|
|
1877
|
-
* ```ts
|
|
1878
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1879
|
-
* .listOrderShippingMethodTaxLines({
|
|
1880
|
-
* id: ["123", "321"]
|
|
1881
|
-
* }, {
|
|
1882
|
-
* relations: ["shipping_method"]
|
|
1883
|
-
* })
|
|
1884
|
-
* ```
|
|
1885
|
-
*
|
|
1886
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
1887
|
-
*
|
|
1888
|
-
* ```ts
|
|
1889
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1890
|
-
* .listOrderShippingMethodTaxLines({
|
|
1891
|
-
* id: ["123", "321"]
|
|
1892
|
-
* }, {
|
|
1893
|
-
* relations: ["shipping_method"],
|
|
1894
|
-
* take: 20,
|
|
1895
|
-
* skip: 2
|
|
1896
|
-
* })
|
|
1897
|
-
* ```
|
|
1898
|
-
*
|
|
1899
|
-
*/
|
|
1900
|
-
listOrderShippingMethodTaxLines(filters: FilterableOrderShippingMethodTaxLineProps, config?: FindConfig<OrderShippingMethodTaxLineDTO>, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
|
1901
|
-
/**
|
|
1902
|
-
* This method creates shipping method tax lines.
|
|
1903
|
-
*
|
|
1904
|
-
* @param {CreateOrderShippingMethodTaxLineDTO[]} taxLines - The shipping method tax lines to be created.
|
|
1905
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} The created shipping method tax lines.
|
|
1906
|
-
*
|
|
1907
|
-
* @example
|
|
1908
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1909
|
-
* .createOrderShippingMethodTaxLines([
|
|
1910
|
-
* {
|
|
1911
|
-
* code: "123",
|
|
1912
|
-
* rate: 2
|
|
1913
|
-
* }
|
|
1914
|
-
* ])
|
|
1915
|
-
*/
|
|
1916
|
-
createOrderShippingMethodTaxLines(taxLines: CreateOrderShippingMethodTaxLineDTO[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
|
1917
|
-
/**
|
|
1918
|
-
* This method creates a shipping method tax line.
|
|
1919
|
-
*
|
|
1920
|
-
* @param {CreateOrderShippingMethodTaxLineDTO} taxLine - The shipping method tax line to be created.
|
|
1921
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO>} The created shipping method tax line.
|
|
1922
|
-
*
|
|
1923
|
-
* @example
|
|
1924
|
-
* const shippingMethodTaxLine = await orderModuleService
|
|
1925
|
-
* .createOrderShippingMethodTaxLines({
|
|
1926
|
-
* code: "123",
|
|
1927
|
-
* rate: 2
|
|
1928
|
-
* })
|
|
1929
|
-
*/
|
|
1930
|
-
createOrderShippingMethodTaxLines(taxLine: CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO>;
|
|
1931
|
-
/**
|
|
1932
|
-
* This method creates shipping method tax lines for an order.
|
|
1933
|
-
*
|
|
1934
|
-
* @param {string} orderId - The order's ID.
|
|
1935
|
-
* @param {CreateOrderShippingMethodTaxLineDTO | CreateOrderShippingMethodTaxLineDTO[]} taxLines - The shipping method tax lines to be created.
|
|
1936
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1937
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} The created shipping method tax lines.
|
|
1938
|
-
*
|
|
1939
|
-
* @example
|
|
1940
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1941
|
-
* .createOrderShippingMethodTaxLines(
|
|
1942
|
-
* "123",
|
|
1943
|
-
* [{
|
|
1944
|
-
* code: "123",
|
|
1945
|
-
* rate: 2
|
|
1946
|
-
* }]
|
|
1947
|
-
* )
|
|
1948
|
-
*/
|
|
1949
|
-
createOrderShippingMethodTaxLines(orderId: string, taxLines: CreateOrderShippingMethodTaxLineDTO[] | CreateOrderShippingMethodTaxLineDTO, sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
|
1950
|
-
/**
|
|
1951
|
-
* This method upsert shipping method tax lines.
|
|
1952
|
-
*
|
|
1953
|
-
* @param {(CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[]} taxLines - The shipping method tax lines to create or update.
|
|
1954
|
-
* If a tax line object has an `id` property, it's updated. Otherwise, a tax line is created.
|
|
1955
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1956
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} The shipping method tax lines.
|
|
1957
|
-
*
|
|
1958
|
-
* @example
|
|
1959
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1960
|
-
* .upsertOrderShippingMethodTaxLines(
|
|
1961
|
-
* [
|
|
1962
|
-
* {
|
|
1963
|
-
* code: "123",
|
|
1964
|
-
* rate: 2
|
|
1965
|
-
* },
|
|
1966
|
-
* {
|
|
1967
|
-
* id: "321",
|
|
1968
|
-
* rate: 2
|
|
1969
|
-
* }
|
|
1970
|
-
* ]
|
|
1971
|
-
* )
|
|
1972
|
-
*
|
|
1973
|
-
*/
|
|
1974
|
-
upsertOrderShippingMethodTaxLines(taxLines: (CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
|
1975
|
-
/**
|
|
1976
|
-
* This method set the shipping method tax lines of an order.
|
|
1977
|
-
*
|
|
1978
|
-
* @param {string} orderId - The order's ID.
|
|
1979
|
-
* @param {(CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[]} taxLines - The shipping method tax lines to create or update.
|
|
1980
|
-
* If a tax line object has an `id` property, it's updated. Otherwise, a tax line is created.
|
|
1981
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
1982
|
-
* @returns {Promise<OrderShippingMethodTaxLineDTO[]>} The order's shipping method tax lines.
|
|
1983
|
-
*
|
|
1984
|
-
* @example
|
|
1985
|
-
* const shippingMethodTaxLines = await orderModuleService
|
|
1986
|
-
* .setOrderShippingMethodTaxLines(
|
|
1987
|
-
* "123",
|
|
1988
|
-
* [
|
|
1989
|
-
* {
|
|
1990
|
-
* code: "123",
|
|
1991
|
-
* rate: 2
|
|
1992
|
-
* },
|
|
1993
|
-
* {
|
|
1994
|
-
* id: "321",
|
|
1995
|
-
* rate: 2
|
|
1996
|
-
* }
|
|
1997
|
-
* ]
|
|
1998
|
-
* )
|
|
1999
|
-
*
|
|
2000
|
-
*/
|
|
2001
|
-
setOrderShippingMethodTaxLines(orderId: string, taxLines: (CreateOrderShippingMethodTaxLineDTO | UpdateOrderShippingMethodTaxLineDTO)[], sharedContext?: Context): Promise<OrderShippingMethodTaxLineDTO[]>;
|
|
2002
|
-
/**
|
|
2003
|
-
* This method deletes shipping method tax lines by their IDs.
|
|
2004
|
-
*
|
|
2005
|
-
* @param {string[]} taxLineIds - The list of shipping method tax lines.
|
|
2006
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2007
|
-
* @returns {Promise<void>} Resolves when the shipping method tax lines are deleted successfully.
|
|
2008
|
-
*
|
|
2009
|
-
* @example
|
|
2010
|
-
* await orderModuleService.deleteOrderShippingMethodTaxLines([
|
|
2011
|
-
* "123", "321"
|
|
2012
|
-
* ])
|
|
2013
|
-
*/
|
|
2014
|
-
deleteOrderShippingMethodTaxLines(taxLineIds: string[], sharedContext?: Context): Promise<void>;
|
|
2015
|
-
/**
|
|
2016
|
-
* This method deletes a shipping method tax line by its ID.
|
|
2017
|
-
*
|
|
2018
|
-
* @param {string} taxLineId - The ID of the shipping method tax line
|
|
2019
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2020
|
-
* @returns {Promise<void>} Resolves when the shipping method tax line is deleted successfully.
|
|
2021
|
-
*
|
|
2022
|
-
* @example
|
|
2023
|
-
* await orderModuleService.deleteOrderShippingMethodTaxLines("123")
|
|
2024
|
-
*/
|
|
2025
|
-
deleteOrderShippingMethodTaxLines(taxLineId: string, sharedContext?: Context): Promise<void>;
|
|
2026
|
-
/**
|
|
2027
|
-
* This method deletes shipping method tax line matching the specified filters.
|
|
2028
|
-
*
|
|
2029
|
-
* @param {FilterableOrderShippingMethodTaxLineProps} selector - The filters specifying which shipping method tax lines to delete.
|
|
2030
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2031
|
-
* @returns {Promise<void>} Resolves when the shipping method tax lines are deleted successfully.
|
|
2032
|
-
*
|
|
2033
|
-
* @example
|
|
2034
|
-
* await orderModuleService.deleteOrderShippingMethodTaxLines({
|
|
2035
|
-
* id: ["123", "321"]
|
|
2036
|
-
* })
|
|
2037
|
-
*/
|
|
2038
|
-
deleteOrderShippingMethodTaxLines(selector: FilterableOrderShippingMethodTaxLineProps, sharedContext?: Context): Promise<void>;
|
|
2039
|
-
/**
|
|
2040
|
-
* This method retrieves a paginated list of order changes based on optional filters and configuration.
|
|
2041
|
-
*
|
|
2042
|
-
* @param {FilterableOrderChangeProps} filters - The filters to apply on the retrieved order changes.
|
|
2043
|
-
* @param {FindConfig<OrderChangeDTO>} config - The configurations determining how the order exchange is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
2044
|
-
* attributes or relations associated with a order exchange.
|
|
2045
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2046
|
-
* @returns {Promise<OrderChangeDTO[]>} The list of order changes.
|
|
2047
|
-
*
|
|
2048
|
-
* @example
|
|
2049
|
-
* To retrieve a list of order changes using their IDs:
|
|
2050
|
-
*
|
|
2051
|
-
* ```ts
|
|
2052
|
-
* const orderChanges = await orderModuleService.listOrderChanges({
|
|
2053
|
-
* id: ["123", "321"]
|
|
2054
|
-
* })
|
|
2055
|
-
* ```
|
|
2056
|
-
*
|
|
2057
|
-
* To specify relations that should be retrieved within the exchange:
|
|
2058
|
-
*
|
|
2059
|
-
* :::note
|
|
2060
|
-
*
|
|
2061
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
2062
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
2063
|
-
*
|
|
2064
|
-
* :::
|
|
2065
|
-
*
|
|
2066
|
-
* ```ts
|
|
2067
|
-
* const orderChanges = await orderModuleService.listOrderChanges({
|
|
2068
|
-
* id: ["123", "321"]
|
|
2069
|
-
* }, {
|
|
2070
|
-
* relations: ["actions"]
|
|
2071
|
-
* })
|
|
2072
|
-
* ```
|
|
2073
|
-
*
|
|
2074
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
2075
|
-
*
|
|
2076
|
-
* ```ts
|
|
2077
|
-
* const orderChanges = await orderModuleService.listOrderChanges({
|
|
2078
|
-
* id: ["123", "321"]
|
|
2079
|
-
* }, {
|
|
2080
|
-
* relations: ["actions"],
|
|
2081
|
-
* take: 20,
|
|
2082
|
-
* skip: 2
|
|
2083
|
-
* })
|
|
2084
|
-
* ```
|
|
2085
|
-
*/
|
|
2086
|
-
listOrderChanges(filters?: FilterableOrderChangeProps, config?: FindConfig<OrderChangeDTO>, sharedContext?: Context): Promise<OrderChangeDTO[]>;
|
|
2087
|
-
/**
|
|
2088
|
-
* This method retrieves an order change by its ID.
|
|
2089
|
-
*
|
|
2090
|
-
* @param {string} orderChangeId - The order change ID.
|
|
2091
|
-
* @param {FindConfig<OrderChangeDTO>} config - The configurations determining how the order change is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
2092
|
-
* attributes or relations associated with a order change.
|
|
2093
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2094
|
-
* @returns {Promise<OrderChangeDTO>} The retrieved order change.
|
|
2095
|
-
*
|
|
2096
|
-
* @example
|
|
2097
|
-
* A simple example that retrieves an order change by its ID:
|
|
2098
|
-
*
|
|
2099
|
-
* ```ts
|
|
2100
|
-
* const orderChange = await orderModuleService.retrieveOrderChange(
|
|
2101
|
-
* "123"
|
|
2102
|
-
* )
|
|
2103
|
-
* ```
|
|
2104
|
-
*
|
|
2105
|
-
* To specify relations that should be retrieved:
|
|
2106
|
-
*
|
|
2107
|
-
* :::note
|
|
2108
|
-
*
|
|
2109
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
2110
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
2111
|
-
*
|
|
2112
|
-
* :::
|
|
2113
|
-
*
|
|
2114
|
-
* ```ts
|
|
2115
|
-
* const orderChange = await orderModuleService.retrieveOrderChange(
|
|
2116
|
-
* "123",
|
|
2117
|
-
* {
|
|
2118
|
-
* relations: ["order"]
|
|
2119
|
-
* }
|
|
2120
|
-
* )
|
|
2121
|
-
* ```
|
|
2122
|
-
*
|
|
2123
|
-
*/
|
|
2124
|
-
retrieveOrderChange(orderChangeId: string, config?: FindConfig<OrderChangeDTO>, sharedContext?: Context): Promise<OrderChangeDTO>;
|
|
2125
|
-
/**
|
|
2126
|
-
* This method creates an order change.
|
|
2127
|
-
*
|
|
2128
|
-
* @param {CreateOrderChangeDTO} data - The order change to be created.
|
|
2129
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2130
|
-
* @returns {Promise<OrderChangeDTO>} The created order change.
|
|
2131
|
-
*
|
|
2132
|
-
* @example
|
|
2133
|
-
* const orderChange = await orderModuleService.createOrderChange({
|
|
2134
|
-
* order_id: "123",
|
|
2135
|
-
* })
|
|
2136
|
-
*/
|
|
2137
|
-
createOrderChange(data: CreateOrderChangeDTO, sharedContext?: Context): Promise<OrderChangeDTO>;
|
|
2138
|
-
/**
|
|
2139
|
-
* This method creates order changes.
|
|
2140
|
-
*
|
|
2141
|
-
* @param {CreateOrderChangeDTO[]} data - The order changes to be created.
|
|
2142
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2143
|
-
* @returns {Promise<OrderChangeDTO[]>} The created order changes.
|
|
2144
|
-
*
|
|
2145
|
-
* @example
|
|
2146
|
-
* const orderChanges = await orderModuleService.createOrderChange([
|
|
2147
|
-
* {
|
|
2148
|
-
* order_id: "123",
|
|
2149
|
-
* }
|
|
2150
|
-
* ])
|
|
2151
|
-
*
|
|
2152
|
-
*/
|
|
2153
|
-
createOrderChange(data: CreateOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeDTO[]>;
|
|
2154
|
-
/**
|
|
2155
|
-
* This method creates order changes.
|
|
2156
|
-
*
|
|
2157
|
-
* @param {CreateOrderChangeDTO | CreateOrderChangeDTO[]} data - The order changes to be created.
|
|
2158
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2159
|
-
* @returns {Promise<OrderChangeDTO | OrderChangeDTO[]>} The created order changes.
|
|
2160
|
-
*
|
|
2161
|
-
* @example
|
|
2162
|
-
* const orderChanges = await orderModuleService.createOrderChange([
|
|
2163
|
-
* {
|
|
2164
|
-
* order_id: "123",
|
|
2165
|
-
* }
|
|
2166
|
-
* ])
|
|
2167
|
-
*
|
|
2168
|
-
*/
|
|
2169
|
-
createOrderChange(data: CreateOrderChangeDTO | CreateOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeDTO | OrderChangeDTO[]>;
|
|
2170
|
-
/**
|
|
2171
|
-
* This method updates an existing order change.
|
|
2172
|
-
*
|
|
2173
|
-
* @param {UpdateOrderChangeDTO} data - The attributes to update in the order change.
|
|
2174
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2175
|
-
* @returns {Promise<OrderChangeDTO>} The updated order change.
|
|
2176
|
-
*
|
|
2177
|
-
* @example
|
|
2178
|
-
* const orderChange = await orderModuleService.updateOrderChanges({
|
|
2179
|
-
* id: "123"
|
|
2180
|
-
* })
|
|
2181
|
-
*/
|
|
2182
|
-
updateOrderChanges(data: UpdateOrderChangeDTO, sharedContext?: Context): Promise<OrderChangeDTO>;
|
|
2183
|
-
/**
|
|
2184
|
-
* This method updates order changes. The order changes are identified by the `id` property of each order change object.
|
|
2185
|
-
*
|
|
2186
|
-
* @param {UpdateOrderChangeDTO[]} data - The order changes to be updated.
|
|
2187
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2188
|
-
* @returns {Promise<OrderChangeDTO[]>} The updated order changes.
|
|
2189
|
-
*
|
|
2190
|
-
* @example
|
|
2191
|
-
* const orderChanges = await orderModuleService.updateOrderChanges([{
|
|
2192
|
-
* id: "123"
|
|
2193
|
-
* }])
|
|
2194
|
-
*
|
|
2195
|
-
*/
|
|
2196
|
-
updateOrderChanges(data: UpdateOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeDTO[]>;
|
|
2197
|
-
/**
|
|
2198
|
-
* This method updates order changes. The order changes are identified by the `id` property of each order change object.
|
|
2199
|
-
*
|
|
2200
|
-
* @param {UpdateOrderChangeDTO | UpdateOrderChangeDTO[]} data - The data to update in each order change.
|
|
2201
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2202
|
-
* @returns {Promise<OrderChangeDTO | OrderChangeDTO[]>} The updated order changes.
|
|
2203
|
-
*
|
|
2204
|
-
* @example
|
|
2205
|
-
* const orderChanges = await orderModuleService.updateOrderChanges([{
|
|
2206
|
-
* id: "123"
|
|
2207
|
-
* }])
|
|
2208
|
-
*
|
|
2209
|
-
*/
|
|
2210
|
-
updateOrderChanges(data: UpdateOrderChangeDTO | UpdateOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeDTO | OrderChangeDTO[]>;
|
|
2211
|
-
/**
|
|
2212
|
-
* This method deletes order changes by their IDs.
|
|
2213
|
-
*
|
|
2214
|
-
* @param {string[]} orderChangeId - The IDs of order changes.
|
|
2215
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2216
|
-
* @returns {Promise<void>} Resolves when the order changes are deleted successfully.
|
|
2217
|
-
*
|
|
2218
|
-
* @example
|
|
2219
|
-
* await orderModuleService.deleteOrderChanges(["123", "321"])
|
|
2220
|
-
*
|
|
2221
|
-
*/
|
|
2222
|
-
deleteOrderChanges(orderChangeId: string[], sharedContext?: Context): Promise<void>;
|
|
2223
|
-
/**
|
|
2224
|
-
* This method deletes an order change by its ID.
|
|
2225
|
-
*
|
|
2226
|
-
* @param {string} orderChangeId - The order change's ID.
|
|
2227
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2228
|
-
* @returns {Promise<void>} Resolves when the order change is deleted successfully.
|
|
2229
|
-
*
|
|
2230
|
-
* @example
|
|
2231
|
-
* await orderModuleService.deleteOrderChanges("123")
|
|
2232
|
-
*
|
|
2233
|
-
*/
|
|
2234
|
-
deleteOrderChanges(orderChangeId: string, sharedContext?: Context): Promise<void>;
|
|
2235
|
-
/**
|
|
2236
|
-
* This method cancels an order's change.
|
|
2237
|
-
*
|
|
2238
|
-
* @param {string} orderId - The order's ID.
|
|
2239
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2240
|
-
* @returns {Promise<void>} Resolves when the order's change is canceled successfully.
|
|
2241
|
-
*
|
|
2242
|
-
* @example
|
|
2243
|
-
* await orderModuleService.cancelOrderChange("123")
|
|
2244
|
-
*
|
|
2245
|
-
*/
|
|
2246
|
-
cancelOrderChange(orderId: string, sharedContext?: Context): Promise<void>;
|
|
2247
|
-
/**
|
|
2248
|
-
* This method cancels orders' changes.
|
|
2249
|
-
*
|
|
2250
|
-
* @param {string[]} orderId - The orders IDs.
|
|
2251
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2252
|
-
* @returns {Promise<void>} Resolves when the orders' changes are canceled successfully.
|
|
2253
|
-
*
|
|
2254
|
-
* @example
|
|
2255
|
-
* await orderModuleService.cancelOrderChange(["123", "321"])
|
|
2256
|
-
*
|
|
2257
|
-
*/
|
|
2258
|
-
cancelOrderChange(orderId: string[], sharedContext?: Context): Promise<void>;
|
|
2259
|
-
/**
|
|
2260
|
-
* This method retrieves a preview of an order if its change was confirmed and applied on it.
|
|
2261
|
-
*
|
|
2262
|
-
* @param {string} orderId - The order's ID.
|
|
2263
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2264
|
-
* @returns {Promise<OrderDTO>} The preview of the order.
|
|
2265
|
-
*
|
|
2266
|
-
* @example
|
|
2267
|
-
* const orderPreview = await orderModuleService.previewOrderChange(
|
|
2268
|
-
* "123"
|
|
2269
|
-
* )
|
|
2270
|
-
*/
|
|
2271
|
-
previewOrderChange(orderId: string, sharedContext?: Context): Promise<OrderPreviewDTO>;
|
|
2272
|
-
/**
|
|
2273
|
-
* This method cancels an order's change, providing cancelation details.
|
|
2274
|
-
*
|
|
2275
|
-
* @param {CancelOrderChangeDTO} data - The cancelation details of the order's change.
|
|
2276
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2277
|
-
* @returns {Promise<void>} Resolves when the order's change is canceled successfully.
|
|
2278
|
-
*
|
|
2279
|
-
* @example
|
|
2280
|
-
* await orderModuleService.cancelOrderChange({
|
|
2281
|
-
* id: "123",
|
|
2282
|
-
* canceled_by: "user_123"
|
|
2283
|
-
* })
|
|
2284
|
-
*
|
|
2285
|
-
*/
|
|
2286
|
-
cancelOrderChange(data: CancelOrderChangeDTO, sharedContext?: Context): Promise<void>;
|
|
2287
|
-
/**
|
|
2288
|
-
* This method cancels orders' changes, providing cancelation details.
|
|
2289
|
-
*
|
|
2290
|
-
* @param {CancelOrderChangeDTO[]} data - The cancelation details of the orders' changes.
|
|
2291
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2292
|
-
* @returns {Promise<void>} Resolves when the orders' changes are canceled successfully.
|
|
2293
|
-
*
|
|
2294
|
-
* @example
|
|
2295
|
-
* await orderModuleService.cancelOrderChange([{
|
|
2296
|
-
* id: "123",
|
|
2297
|
-
* canceled_by: "user_123"
|
|
2298
|
-
* }])
|
|
2299
|
-
*
|
|
2300
|
-
*/
|
|
2301
|
-
cancelOrderChange(data: CancelOrderChangeDTO[], sharedContext?: Context): Promise<void>;
|
|
2302
|
-
/**
|
|
2303
|
-
* This method confirms an order change, applying these changes on the associated order.
|
|
2304
|
-
*
|
|
2305
|
-
* @param {string} orderChangeId - The order change's ID.
|
|
2306
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2307
|
-
* @returns {Promise<OrderChangeReturn>} The item and shipping method changes made on the order.
|
|
2308
|
-
*
|
|
2309
|
-
* @example
|
|
2310
|
-
* const {
|
|
2311
|
-
* items,
|
|
2312
|
-
* shippingMethods
|
|
2313
|
-
* } = await orderModuleService.confirmOrderChange("123")
|
|
2314
|
-
*
|
|
2315
|
-
*/
|
|
2316
|
-
confirmOrderChange(orderChangeId: string, sharedContext?: Context): Promise<OrderChangeReturn>;
|
|
2317
|
-
/**
|
|
2318
|
-
* This method confirms order changes, applying these changes on the associated orders.
|
|
2319
|
-
*
|
|
2320
|
-
* @param {string[]} orderChangeId - The order changes' IDs.
|
|
2321
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2322
|
-
* @returns {Promise<void>} The item and shipping method changes made on the order.
|
|
2323
|
-
*
|
|
2324
|
-
* @example
|
|
2325
|
-
* await orderModuleService.confirmOrderChange(["123"])
|
|
2326
|
-
*
|
|
2327
|
-
*/
|
|
2328
|
-
confirmOrderChange(orderChangeId: string[], sharedContext?: Context): Promise<OrderChangeReturn>;
|
|
2329
|
-
/**
|
|
2330
|
-
* This method confirms an order change, specifying confirmation details.
|
|
2331
|
-
*
|
|
2332
|
-
* @param {ConfirmOrderChangeDTO} data - The confirmation's details of the order change.
|
|
2333
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2334
|
-
* @returns {Promise<void>} The item and shipping method changes made on the order.
|
|
2335
|
-
*
|
|
2336
|
-
* @example
|
|
2337
|
-
* await orderModuleService.confirmOrderChange({
|
|
2338
|
-
* id: "123",
|
|
2339
|
-
* confirmed_by: "user_123"
|
|
2340
|
-
* })
|
|
2341
|
-
*
|
|
2342
|
-
*/
|
|
2343
|
-
confirmOrderChange(data: ConfirmOrderChangeDTO, sharedContext?: Context): Promise<OrderChangeReturn>;
|
|
2344
|
-
/**
|
|
2345
|
-
* This method confirms order changes, specifying confirmation details.
|
|
2346
|
-
*
|
|
2347
|
-
* @param {ConfirmOrderChangeDTO[]} data - The confirm order changes details.
|
|
2348
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2349
|
-
* @returns {Promise<void>} The item and shipping method changes made on all the orders.
|
|
2350
|
-
*
|
|
2351
|
-
* @example
|
|
2352
|
-
* await orderModuleService.confirmOrderChange([{
|
|
2353
|
-
* id: "123",
|
|
2354
|
-
* confirmed_by: "user_123"
|
|
2355
|
-
* }])
|
|
2356
|
-
*
|
|
2357
|
-
*/
|
|
2358
|
-
confirmOrderChange(data: ConfirmOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeReturn>;
|
|
2359
|
-
/**
|
|
2360
|
-
* This method declines an order change.
|
|
2361
|
-
*
|
|
2362
|
-
* @param {string} orderChangeId - The order change's ID.
|
|
2363
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2364
|
-
* @returns {Promise<void>} Resolves when the order change is declined successfully.
|
|
2365
|
-
*
|
|
2366
|
-
* @example
|
|
2367
|
-
* await orderModuleService.declineOrderChange("123")
|
|
2368
|
-
*
|
|
2369
|
-
*/
|
|
2370
|
-
declineOrderChange(orderChangeId: string, sharedContext?: Context): Promise<void>;
|
|
2371
|
-
/**
|
|
2372
|
-
* This method declines order changes.
|
|
2373
|
-
*
|
|
2374
|
-
* @param {string[]} orderChangeId - The order changes' IDs.
|
|
2375
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2376
|
-
* @returns {Promise<void>} Resolves when the order changes are declined successfully.
|
|
2377
|
-
*
|
|
2378
|
-
* @example
|
|
2379
|
-
* await orderModuleService.declineOrderChange(["123", "321"])
|
|
2380
|
-
*
|
|
2381
|
-
*/
|
|
2382
|
-
declineOrderChange(orderChangeId: string[], sharedContext?: Context): Promise<void>;
|
|
2383
|
-
/**
|
|
2384
|
-
* This method declines an order change, providing additional details.
|
|
2385
|
-
*
|
|
2386
|
-
* @param {DeclineOrderChangeDTO} data - The details of the order change decline.
|
|
2387
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2388
|
-
* @returns {Promise<void>} Resolves when the order change is declined successfully.
|
|
2389
|
-
*
|
|
2390
|
-
* @example
|
|
2391
|
-
* await orderModuleService.declineOrderChange({
|
|
2392
|
-
* id: "123",
|
|
2393
|
-
* declined_by: "user_123"
|
|
2394
|
-
* })
|
|
2395
|
-
*
|
|
2396
|
-
*/
|
|
2397
|
-
declineOrderChange(data: DeclineOrderChangeDTO, sharedContext?: Context): Promise<void>;
|
|
2398
|
-
/**
|
|
2399
|
-
* This method declines order changes, providing additional details for each.
|
|
2400
|
-
*
|
|
2401
|
-
* @param {DeclineOrderChangeDTO[]} data - The details of the order change declines.
|
|
2402
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2403
|
-
* @returns {Promise<void>} Resolves when the order changes are declined successfully.
|
|
2404
|
-
*
|
|
2405
|
-
* @example
|
|
2406
|
-
* await orderModuleService.declineOrderChange([
|
|
2407
|
-
* {
|
|
2408
|
-
* id: "123",
|
|
2409
|
-
* declined_by: "user_123"
|
|
2410
|
-
* }
|
|
2411
|
-
* ])
|
|
2412
|
-
*
|
|
2413
|
-
*/
|
|
2414
|
-
declineOrderChange(data: DeclineOrderChangeDTO[], sharedContext?: Context): Promise<void>;
|
|
2415
|
-
/**
|
|
2416
|
-
* This method registers an order change.
|
|
2417
|
-
*
|
|
2418
|
-
* @param {RegisterOrderChangeDTO} data - The register order change details.
|
|
2419
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2420
|
-
* @returns {Promise<OrderChangeReturn>} The item and shipping method changes made on the order.
|
|
2421
|
-
*
|
|
2422
|
-
* @example
|
|
2423
|
-
* await orderModuleService.registerOrderChange({
|
|
2424
|
-
* order_id: "123",
|
|
2425
|
-
* details: Record<string, unknown>
|
|
2426
|
-
* })
|
|
2427
|
-
*
|
|
2428
|
-
*/
|
|
2429
|
-
registerOrderChange(data: RegisterOrderChangeDTO, sharedContext?: Context): Promise<OrderChangeDTO>;
|
|
2430
|
-
/**
|
|
2431
|
-
* This method registers order changes.
|
|
2432
|
-
*
|
|
2433
|
-
* @param {RegisterOrderChangeDTO[]} data - The register order changes details.
|
|
2434
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2435
|
-
* @returns {Promise<OrderChangeReturn[]>} The item and shipping method changes made on the orders.
|
|
2436
|
-
*
|
|
2437
|
-
* @example
|
|
2438
|
-
* await orderModuleService.registerOrderChange({
|
|
2439
|
-
* order_id: "123",
|
|
2440
|
-
* details: Record<string, unknown>
|
|
2441
|
-
* })
|
|
2442
|
-
*
|
|
2443
|
-
*/
|
|
2444
|
-
registerOrderChange(data: RegisterOrderChangeDTO[], sharedContext?: Context): Promise<OrderChangeDTO[]>;
|
|
2445
|
-
/**
|
|
2446
|
-
* This method soft deletes order changes by their IDs.
|
|
2447
|
-
*
|
|
2448
|
-
* @param {string | string[]} orderChangeId - The IDs of order changes.
|
|
2449
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2450
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2451
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2452
|
-
* The object's keys are the ID attribute names of the order change entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2453
|
-
* with the order through this relation.
|
|
2454
|
-
*
|
|
2455
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2456
|
-
*
|
|
2457
|
-
* @example
|
|
2458
|
-
* await orderModuleService.softDeleteOrderChanges([
|
|
2459
|
-
* "123", "321"
|
|
2460
|
-
* ])
|
|
2461
|
-
*/
|
|
2462
|
-
softDeleteOrderChanges<TReturnableLinkableKeys extends string = string>(orderChangeId: string | string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
2463
|
-
/**
|
|
2464
|
-
* This method restores soft deleted order changes by their IDs.
|
|
2465
|
-
*
|
|
2466
|
-
* @param {string | string[]} orderChangeId - The IDs of order changes.
|
|
2467
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the order. You can pass to its `returnLinkableKeys`
|
|
2468
|
-
* property any of the order change's relation attribute names.
|
|
2469
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2470
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2471
|
-
* The object's keys are the ID attribute names of the order change entity's relations,
|
|
2472
|
-
* and its value is an array of strings, each being the ID of the record associated with the order change through this relation.
|
|
2473
|
-
*
|
|
2474
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2475
|
-
*
|
|
2476
|
-
* @example
|
|
2477
|
-
* await orderModuleService.restoreOrderChanges([
|
|
2478
|
-
* "123", "321"
|
|
2479
|
-
* ])
|
|
2480
|
-
*/
|
|
2481
|
-
restoreOrderChanges<TReturnableLinkableKeys extends string = string>(orderChangeId: string | string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
2482
|
-
/**
|
|
2483
|
-
* This method applies orders' actions who are still pending on the order.
|
|
2484
|
-
*
|
|
2485
|
-
* @param {string | string[]} orderId - The order's ID.
|
|
2486
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2487
|
-
* @returns {Promise<OrderChangeReturn>} The changes made by applying the actions on the orders.
|
|
2488
|
-
*
|
|
2489
|
-
* @example
|
|
2490
|
-
* const {
|
|
2491
|
-
* items,
|
|
2492
|
-
* shipping_methods
|
|
2493
|
-
* } = await orderModuleService.applyPendingOrderActions([
|
|
2494
|
-
* "123", "321"
|
|
2495
|
-
* ])
|
|
2496
|
-
*
|
|
2497
|
-
*/
|
|
2498
|
-
applyPendingOrderActions(orderId: string | string[], sharedContext?: Context): Promise<OrderChangeReturn>;
|
|
2499
|
-
/**
|
|
2500
|
-
* This method retrieves a paginated list of order change actions based on optional filters and configuration.
|
|
2501
|
-
*
|
|
2502
|
-
* @param {FilterableOrderChangeActionProps} filters - The filters to apply on the retrieved order change action.
|
|
2503
|
-
* @param {FindConfig<OrderChangeActionDTO>} config - The configurations determining how the order change action is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
2504
|
-
* attributes or relations associated with an order change action.
|
|
2505
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2506
|
-
* @returns {Promise<OrderChangeActionDTO[]>} The list of order change actions.
|
|
2507
|
-
*
|
|
2508
|
-
* @example
|
|
2509
|
-
* To retrieve a list of shipping method tax lines using their IDs:
|
|
2510
|
-
*
|
|
2511
|
-
* ```ts
|
|
2512
|
-
* const orderChangeActions = await orderModuleService.listOrderChangeActions({
|
|
2513
|
-
* id: ["123", "321"]
|
|
2514
|
-
* })
|
|
2515
|
-
* ```
|
|
2516
|
-
*
|
|
2517
|
-
* To specify relations that should be retrieved within the shipping method tax line:
|
|
2518
|
-
*
|
|
2519
|
-
* :::note
|
|
2520
|
-
*
|
|
2521
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
2522
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
2523
|
-
*
|
|
2524
|
-
* :::
|
|
2525
|
-
*
|
|
2526
|
-
* ```ts
|
|
2527
|
-
* const orderChangeActions = await orderModuleService.listOrderChangeActions({
|
|
2528
|
-
* id: ["123", "321"]
|
|
2529
|
-
* }, {
|
|
2530
|
-
* relations: ["order"]
|
|
2531
|
-
* })
|
|
2532
|
-
* ```
|
|
2533
|
-
*
|
|
2534
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
2535
|
-
*
|
|
2536
|
-
* ```ts
|
|
2537
|
-
* const orderChangeActions = await orderModuleService.listOrderChangeActions({
|
|
2538
|
-
* id: ["123", "321"]
|
|
2539
|
-
* }, {
|
|
2540
|
-
* relations: ["order"],
|
|
2541
|
-
* take: 20,
|
|
2542
|
-
* skip: 2
|
|
2543
|
-
* })
|
|
2544
|
-
* ```
|
|
2545
|
-
*
|
|
2546
|
-
*/
|
|
2547
|
-
listOrderChangeActions(filters?: FilterableOrderChangeActionProps, config?: FindConfig<OrderChangeActionDTO>, sharedContext?: Context): Promise<OrderChangeActionDTO[]>;
|
|
2548
|
-
/**
|
|
2549
|
-
* This method retrieves an orde rchange action by its ID.
|
|
2550
|
-
*
|
|
2551
|
-
* @param {string} actionId - The order change action's ID.
|
|
2552
|
-
* @param {FindConfig<OrderChangeActionDTO>} config - The configurations determining how the order change action is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
2553
|
-
* attributes or relations associated with an order change action.
|
|
2554
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2555
|
-
* @returns {Promise<OrderChangeActionDTO>} The retrieved order change action.
|
|
2556
|
-
*
|
|
2557
|
-
* @example
|
|
2558
|
-
* A simple example that retrieves an order change by its ID:
|
|
2559
|
-
*
|
|
2560
|
-
* ```ts
|
|
2561
|
-
* const orderChangeAction = await orderModuleService.retrieveOrderChangeAction(
|
|
2562
|
-
* "123"
|
|
2563
|
-
* )
|
|
2564
|
-
* ```
|
|
2565
|
-
*
|
|
2566
|
-
* To specify relations that should be retrieved:
|
|
2567
|
-
*
|
|
2568
|
-
* :::note
|
|
2569
|
-
*
|
|
2570
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
2571
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
2572
|
-
*
|
|
2573
|
-
* :::
|
|
2574
|
-
*
|
|
2575
|
-
* ```ts
|
|
2576
|
-
* const orderChangeAction = await orderModuleService.retrieveOrderChangeAction(
|
|
2577
|
-
* "123",
|
|
2578
|
-
* {
|
|
2579
|
-
* relations: ["order"]
|
|
2580
|
-
* }
|
|
2581
|
-
* )
|
|
2582
|
-
* ```
|
|
2583
|
-
*
|
|
2584
|
-
*/
|
|
2585
|
-
retrieveOrderChangeAction(actionId: string, config?: FindConfig<OrderChangeActionDTO>, sharedContext?: Context): Promise<OrderChangeActionDTO>;
|
|
2586
|
-
/**
|
|
2587
|
-
* This method updates an existing order change action.
|
|
2588
|
-
*
|
|
2589
|
-
* @param {UpdateOrderChangeActionDTO} data - The attributes to update in the order change action.
|
|
2590
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2591
|
-
* @returns {Promise<OrderChangeActionDTO>} The updated order change action.
|
|
2592
|
-
*
|
|
2593
|
-
* @example
|
|
2594
|
-
* const orderChangeAction = await orderModuleService.updateOrderChangeActions({
|
|
2595
|
-
* id: "123",
|
|
2596
|
-
* internal_note: "Changing an item"
|
|
2597
|
-
* })
|
|
2598
|
-
*/
|
|
2599
|
-
updateOrderChangeActions(data: UpdateOrderChangeActionDTO, sharedContext?: Context): Promise<OrderChangeActionDTO>;
|
|
2600
|
-
/**
|
|
2601
|
-
* This method updates order change actions.
|
|
2602
|
-
*
|
|
2603
|
-
* @param {UpdateOrderChangeActionDTO[]} data - The order change actions to be updated.
|
|
2604
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2605
|
-
* @returns {Promise<OrderChangeActionDTO[]>} The updated order change actions.
|
|
2606
|
-
*
|
|
2607
|
-
* @example
|
|
2608
|
-
* const orderChangeActions = await orderModuleService.updateOrderChangeActions([{
|
|
2609
|
-
* id: "123",
|
|
2610
|
-
* internal_note: "Changing an item"
|
|
2611
|
-
* }])
|
|
2612
|
-
*
|
|
2613
|
-
*/
|
|
2614
|
-
updateOrderChangeActions(data: UpdateOrderChangeActionDTO[], sharedContext?: Context): Promise<OrderChangeActionDTO[]>;
|
|
2615
|
-
/**
|
|
2616
|
-
* This method updates order change actions.
|
|
2617
|
-
*
|
|
2618
|
-
* @param {UpdateOrderChangeActionDTO | UpdateOrderChangeActionDTO[]} data - The order change actions to be updated.
|
|
2619
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2620
|
-
* @returns {Promise<OrderChangeActionDTO | OrderChangeActionDTO[]>} The updated order change actions.
|
|
2621
|
-
*
|
|
2622
|
-
* @example
|
|
2623
|
-
* const orderChangeActions = await orderModuleService.updateOrderChangeActions([{
|
|
2624
|
-
* id: "123",
|
|
2625
|
-
* internal_note: "Changing an item"
|
|
2626
|
-
* }])
|
|
2627
|
-
*
|
|
2628
|
-
*/
|
|
2629
|
-
updateOrderChangeActions(data: UpdateOrderChangeActionDTO | UpdateOrderChangeActionDTO[], sharedContext?: Context): Promise<OrderChangeActionDTO | OrderChangeActionDTO[]>;
|
|
2630
|
-
/**
|
|
2631
|
-
* This method creates and adds an action to an order and its change.
|
|
2632
|
-
*
|
|
2633
|
-
* @param {CreateOrderChangeActionDTO} data - The action to be added to an order.
|
|
2634
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2635
|
-
* @returns {Promise<OrderChangeActionDTO>} The order change action added.
|
|
2636
|
-
*
|
|
2637
|
-
* @example
|
|
2638
|
-
* const orderChangeAction = await orderModuleService.addOrderAction({
|
|
2639
|
-
* order_id: "123",
|
|
2640
|
-
* order_change_id: "321",
|
|
2641
|
-
* action: "ITEM_ADD"
|
|
2642
|
-
* })
|
|
2643
|
-
*/
|
|
2644
|
-
addOrderAction(data: CreateOrderChangeActionDTO, sharedContext?: Context): Promise<OrderChangeActionDTO>;
|
|
2645
|
-
/**
|
|
2646
|
-
* This method creates and adds actions to orders and their changes.
|
|
2647
|
-
*
|
|
2648
|
-
* @param {CreateOrderChangeActionDTO[]} data - The order change actions to be created.
|
|
2649
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2650
|
-
* @returns {Promise<OrderChangeActionDTO[]>} The created order change actions.
|
|
2651
|
-
*
|
|
2652
|
-
* @example
|
|
2653
|
-
* const orderChangeActions = await orderModuleService.addOrderAction([{
|
|
2654
|
-
* order_id: "123",
|
|
2655
|
-
* order_change_id: "321",
|
|
2656
|
-
* action: "ITEM_ADD"
|
|
2657
|
-
* }])
|
|
2658
|
-
*/
|
|
2659
|
-
addOrderAction(data: CreateOrderChangeActionDTO[], sharedContext?: Context): Promise<OrderChangeActionDTO[]>;
|
|
2660
|
-
/**
|
|
2661
|
-
* This method deletes order change actions by their IDs.
|
|
2662
|
-
*
|
|
2663
|
-
* @param {string[]} actionId - The IDs of order change actions.
|
|
2664
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2665
|
-
* @returns {Promise<void>} Resolves when the order change actions are deleted successfully.
|
|
2666
|
-
*
|
|
2667
|
-
* @example
|
|
2668
|
-
* await orderModuleService.deleteOrderChangeActions([
|
|
2669
|
-
* "123", "321"
|
|
2670
|
-
* ])
|
|
2671
|
-
*
|
|
2672
|
-
*/
|
|
2673
|
-
deleteOrderChangeActions(actionId: string[], sharedContext?: Context): Promise<void>;
|
|
2674
|
-
/**
|
|
2675
|
-
* This method deletes an order change action by its ID.
|
|
2676
|
-
*
|
|
2677
|
-
* @param {string} actionId - The order change action's ID.
|
|
2678
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2679
|
-
* @returns {Promise<void>} Resolves when the order change action is deleted successfully.
|
|
2680
|
-
*
|
|
2681
|
-
* @example
|
|
2682
|
-
* ```typescript
|
|
2683
|
-
* await orderModuleService.deleteOrderActions("123")
|
|
2684
|
-
* ```
|
|
2685
|
-
*
|
|
2686
|
-
*/
|
|
2687
|
-
deleteOrderChangeActions(actionId: string, sharedContext?: Context): Promise<void>;
|
|
2688
|
-
/**
|
|
2689
|
-
* This method soft-deletes order change actions by their IDs.
|
|
2690
|
-
*
|
|
2691
|
-
* @param {string} actionIds - The order change action's ID.
|
|
2692
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2693
|
-
* @returns {Promise<void>} Resolves when the order change action is soft-deleted successfully.
|
|
2694
|
-
*
|
|
2695
|
-
* @example
|
|
2696
|
-
* await orderModuleService.softDeleteOrderChangeActions([
|
|
2697
|
-
* "123", "321"
|
|
2698
|
-
* ])
|
|
2699
|
-
*
|
|
2700
|
-
*/
|
|
2701
|
-
softDeleteOrderChangeActions<TReturnableLinkableKeys extends string = string>(actionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2702
|
-
/**
|
|
2703
|
-
* This method restores soft-deleted order change actions by their IDs.
|
|
2704
|
-
*
|
|
2705
|
-
* @param {string | string[]} actionId - The IDs of order change actions.
|
|
2706
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the order change action. You can pass to its `returnLinkableKeys`
|
|
2707
|
-
* property any of the order's relation attribute names.
|
|
2708
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2709
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2710
|
-
* The object's keys are the ID attribute names of the order change action entity's relations,
|
|
2711
|
-
* and its value is an array of strings, each being the ID of the record associated with the order through this relation.
|
|
2712
|
-
*
|
|
2713
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2714
|
-
*
|
|
2715
|
-
* @example
|
|
2716
|
-
* await orderModuleService.restoreOrderChangeActions([
|
|
2717
|
-
* "123", "321"
|
|
2718
|
-
* ])
|
|
2719
|
-
*/
|
|
2720
|
-
restoreOrderChangeActions<TReturnableLinkableKeys extends string = string>(actionId: string | string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
2721
|
-
/**
|
|
2722
|
-
* This method soft deletes addresses by their IDs.
|
|
2723
|
-
*
|
|
2724
|
-
* @param {string[]} ids - The IDs of the addresses.
|
|
2725
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2726
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2727
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2728
|
-
* The object's keys are the ID attribute names of the address entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2729
|
-
* with the order through this relation.
|
|
2730
|
-
*
|
|
2731
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2732
|
-
*
|
|
2733
|
-
* @example
|
|
2734
|
-
* await orderModuleService.softDeleteOrderAddresses([
|
|
2735
|
-
* "123", "321"
|
|
2736
|
-
* ])
|
|
2737
|
-
*/
|
|
2738
|
-
softDeleteOrderAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2739
|
-
/**
|
|
2740
|
-
* This method restores soft-deleted addresses by their IDs.
|
|
2741
|
-
*
|
|
2742
|
-
* @param {string[]} ids - The IDs of the addresses.
|
|
2743
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the addresses. You can pass to its `returnLinkableKeys`
|
|
2744
|
-
* property any of the address's relation attribute names.
|
|
2745
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2746
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2747
|
-
* The object's keys are the ID attribute names of the address entity's relations,
|
|
2748
|
-
* and its value is an array of strings, each being the ID of the record associated with the address through this relation.
|
|
2749
|
-
*
|
|
2750
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2751
|
-
*
|
|
2752
|
-
* @example
|
|
2753
|
-
* await orderModuleService.restoreOrderAddresses([
|
|
2754
|
-
* "123", "321"
|
|
2755
|
-
* ])
|
|
2756
|
-
*/
|
|
2757
|
-
restoreOrderAddresses<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2758
|
-
/**
|
|
2759
|
-
* This method soft deletes line items by their IDs.
|
|
2760
|
-
*
|
|
2761
|
-
* @param {string[]} ids - The IDs of the line items.
|
|
2762
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2763
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2764
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2765
|
-
* The object's keys are the ID attribute names of the line item entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2766
|
-
* with the line item through this relation.
|
|
2767
|
-
*
|
|
2768
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2769
|
-
*
|
|
2770
|
-
* @example
|
|
2771
|
-
* await orderModuleService.softDeleteOrderLineItems([
|
|
2772
|
-
* "123", "321"
|
|
2773
|
-
* ])
|
|
2774
|
-
*/
|
|
2775
|
-
softDeleteOrderLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2776
|
-
/**
|
|
2777
|
-
* This method restores soft-deleted line item by their IDs.
|
|
2778
|
-
*
|
|
2779
|
-
* @param {string[]} ids - The IDs of the line items.
|
|
2780
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the order. You can pass to its `returnLinkableKeys`
|
|
2781
|
-
* property any of the line item's relation attribute names.
|
|
2782
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2783
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2784
|
-
* The object's keys are the ID attribute names of the line item entity's relations,
|
|
2785
|
-
* and its value is an array of strings, each being the ID of the record associated with the line item through this relation.
|
|
2786
|
-
*
|
|
2787
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2788
|
-
*
|
|
2789
|
-
* @example
|
|
2790
|
-
* await orderModuleService.restoreOrderLineItems([
|
|
2791
|
-
* "123", "321"
|
|
2792
|
-
* ])
|
|
2793
|
-
*/
|
|
2794
|
-
restoreOrderLineItems<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2795
|
-
/**
|
|
2796
|
-
* This method soft-deletes shipping methods by their IDs.
|
|
2797
|
-
*
|
|
2798
|
-
* @param {string[]} ids - The IDs of the shipping methods.
|
|
2799
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2800
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2801
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2802
|
-
* The object's keys are the ID attribute names of the shipping method entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2803
|
-
* with the shipping method through this relation.
|
|
2804
|
-
*
|
|
2805
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2806
|
-
*
|
|
2807
|
-
* @example
|
|
2808
|
-
* await orderModuleService.softDeleteOrderShippingMethods([
|
|
2809
|
-
* "123", "321"
|
|
2810
|
-
* ])
|
|
2811
|
-
*/
|
|
2812
|
-
softDeleteOrderShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2813
|
-
/**
|
|
2814
|
-
* This method restores soft-deleted shipping methods by their IDs.
|
|
2815
|
-
*
|
|
2816
|
-
* @param {string[]} ids - The IDs of the shipping methods.
|
|
2817
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the shipping methods. You can pass to its `returnLinkableKeys`
|
|
2818
|
-
* property any of the shipping method's relation attribute names.
|
|
2819
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2820
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2821
|
-
* The object's keys are the ID attribute names of the shipping method entity's relations,
|
|
2822
|
-
* and its value is an array of strings, each being the ID of the record associated with the shipping method through this relation.
|
|
2823
|
-
*
|
|
2824
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2825
|
-
*
|
|
2826
|
-
* @example
|
|
2827
|
-
* await orderModuleService.restoreOrderShippingMethods([
|
|
2828
|
-
* "123", "321"
|
|
2829
|
-
* ])
|
|
2830
|
-
*/
|
|
2831
|
-
restoreOrderShippingMethods<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2832
|
-
/**
|
|
2833
|
-
* This method soft-deletes line item adjustments by their IDs.
|
|
2834
|
-
*
|
|
2835
|
-
* @param {string[]} ids - The IDs of the line item adjustments.
|
|
2836
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2837
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2838
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2839
|
-
* The object's keys are the ID attribute names of the line item adjustment entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2840
|
-
* with the line item adjustment through this relation.
|
|
2841
|
-
*
|
|
2842
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2843
|
-
*
|
|
2844
|
-
* @example
|
|
2845
|
-
* await orderModuleService.softDeleteOrderLineItemAdjustments([
|
|
2846
|
-
* "123", "321"
|
|
2847
|
-
* ])
|
|
2848
|
-
*/
|
|
2849
|
-
softDeleteOrderLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2850
|
-
/**
|
|
2851
|
-
* This method restores soft-deleted line item adjustments by their IDs.
|
|
2852
|
-
*
|
|
2853
|
-
* @param {string[]} ids - The IDs of the line item adjustments.
|
|
2854
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the line item adjustment. You can pass to its `returnLinkableKeys`
|
|
2855
|
-
* property any of the line item adjustment's relation attribute names.
|
|
2856
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2857
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2858
|
-
* The object's keys are the ID attribute names of the line item adjustment entity's relations,
|
|
2859
|
-
* and its value is an array of strings, each being the ID of the record associated with the line item adjustment through this relation.
|
|
2860
|
-
*
|
|
2861
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2862
|
-
*
|
|
2863
|
-
* @example
|
|
2864
|
-
* await orderModuleService.restoreOrderLineItemAdjustments([
|
|
2865
|
-
* "123", "321"
|
|
2866
|
-
* ])
|
|
2867
|
-
*/
|
|
2868
|
-
restoreOrderLineItemAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2869
|
-
/**
|
|
2870
|
-
* This method soft-deletes shipping method adjustments by their IDs.
|
|
2871
|
-
*
|
|
2872
|
-
* @param {string[]} ids - The IDs of the shipping method adjustments.
|
|
2873
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2874
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2875
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2876
|
-
* The object's keys are the ID attribute names of the shipping method adjustment entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2877
|
-
* with the shipping method adjustment through this relation.
|
|
2878
|
-
*
|
|
2879
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2880
|
-
*
|
|
2881
|
-
* @example
|
|
2882
|
-
* await orderModuleService.softDeleteOrderShippingMethodAdjustments([
|
|
2883
|
-
* "123", "321"
|
|
2884
|
-
* ])
|
|
2885
|
-
*/
|
|
2886
|
-
softDeleteOrderShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2887
|
-
/**
|
|
2888
|
-
* This method restores soft-deleted shipping method adjustments by their IDs.
|
|
2889
|
-
*
|
|
2890
|
-
* @param {string[]} ids - The IDs of the shipping method adjustments.
|
|
2891
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the shipping method adjustments. You can pass to its `returnLinkableKeys`
|
|
2892
|
-
* property any of the shipping method adjustment's relation attribute names.
|
|
2893
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2894
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2895
|
-
* The object's keys are the ID attribute names of the shipping method adjustment entity's relations,
|
|
2896
|
-
* and its value is an array of strings, each being the ID of the record associated with the shipping method adjustment through this relation.
|
|
2897
|
-
*
|
|
2898
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2899
|
-
*
|
|
2900
|
-
* @example
|
|
2901
|
-
* await orderModuleService.restoreOrderShippingMethodAdjustments([
|
|
2902
|
-
* "123", "321"
|
|
2903
|
-
* ])
|
|
2904
|
-
*/
|
|
2905
|
-
restoreOrderShippingMethodAdjustments<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2906
|
-
/**
|
|
2907
|
-
* This method soft-deletes line item tax lines by their IDs.
|
|
2908
|
-
*
|
|
2909
|
-
* @param {string[]} ids - The IDs of the line item tax lines.
|
|
2910
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2911
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2912
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2913
|
-
* The object's keys are the ID attribute names of the line item tax line entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2914
|
-
* with the line item tax line through this relation.
|
|
2915
|
-
*
|
|
2916
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2917
|
-
*
|
|
2918
|
-
* @example
|
|
2919
|
-
* await orderModuleService.softDeleteOrderLineItemTaxLines([
|
|
2920
|
-
* "123", "321"
|
|
2921
|
-
* ])
|
|
2922
|
-
*/
|
|
2923
|
-
softDeleteOrderLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2924
|
-
/**
|
|
2925
|
-
* This method restores soft-deleted line item tax lines by their IDs.
|
|
2926
|
-
*
|
|
2927
|
-
* @param {string[]} ids - The IDs of the line item tax lines.
|
|
2928
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the line item tax lines. You can pass to its `returnLinkableKeys`
|
|
2929
|
-
* property any of the line item tax line's relation attribute names.
|
|
2930
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2931
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2932
|
-
* The object's keys are the ID attribute names of the line item tax line entity's relations,
|
|
2933
|
-
* and its value is an array of strings, each being the ID of the record associated with the line item tax line through this relation.
|
|
2934
|
-
*
|
|
2935
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2936
|
-
*
|
|
2937
|
-
* @example
|
|
2938
|
-
* await orderModuleService.restoreOrderLineItemTaxLines([
|
|
2939
|
-
* "123", "321"
|
|
2940
|
-
* ])
|
|
2941
|
-
*/
|
|
2942
|
-
restoreOrderLineItemTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2943
|
-
/**
|
|
2944
|
-
* This method soft deletes shipping method tax lines by their IDs.
|
|
2945
|
-
*
|
|
2946
|
-
* @param {string[]} ids - The IDs of the shipping method tax lines.
|
|
2947
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
2948
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2949
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
2950
|
-
* The object's keys are the ID attribute names of the shipping method tax line entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
2951
|
-
* with the shipping method tax line through this relation.
|
|
2952
|
-
*
|
|
2953
|
-
* If there are no related records, the promise resolves to `void`.
|
|
2954
|
-
*
|
|
2955
|
-
* @example
|
|
2956
|
-
* await orderModuleService.softDeleteOrderShippingMethodTaxLines([
|
|
2957
|
-
* "123", "321"
|
|
2958
|
-
* ])
|
|
2959
|
-
*/
|
|
2960
|
-
softDeleteOrderShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2961
|
-
/**
|
|
2962
|
-
* This method restores soft-deleted shipping method tax lines by their IDs.
|
|
2963
|
-
*
|
|
2964
|
-
* @param {string[]} ids - The IDs of the shipping method tax lines.
|
|
2965
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the shipping method tax lines. You can pass to its `returnLinkableKeys`
|
|
2966
|
-
* property any of the shipping method tax line's relation attribute names.
|
|
2967
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2968
|
-
* @returns {Promise<void | Record<TReturnableLinkableKeys, string[]>>} An object that includes the IDs of related records that were restored.
|
|
2969
|
-
* The object's keys are the ID attribute names of the shipping method tax line entity's relations,
|
|
2970
|
-
* and its value is an array of strings, each being the ID of the record associated with the shipping method tax line through this relation.
|
|
2971
|
-
*
|
|
2972
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
2973
|
-
*
|
|
2974
|
-
* @example
|
|
2975
|
-
* await orderModuleService.restoreOrderShippingMethodTaxLines([
|
|
2976
|
-
* "123", "321"
|
|
2977
|
-
* ])
|
|
2978
|
-
*/
|
|
2979
|
-
restoreOrderShippingMethodTaxLines<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<TReturnableLinkableKeys, string[]> | void>;
|
|
2980
|
-
/**
|
|
2981
|
-
* This method reverts an order to its last version and cleanup data related to the changes.
|
|
2982
|
-
*
|
|
2983
|
-
* @param {string} orderId - The order's ID.
|
|
2984
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2985
|
-
* @returns {Promise<void>} Resolves when the order is reverted.
|
|
2986
|
-
*
|
|
2987
|
-
* @example
|
|
2988
|
-
* await orderModuleService.revertLastVersion("123")
|
|
2989
|
-
*/
|
|
2990
|
-
revertLastVersion(orderId: string, sharedContext?: Context): Promise<void>;
|
|
2991
|
-
/**
|
|
2992
|
-
* This method reverts an order to its last change and keep the order changes and actions not applied.
|
|
2993
|
-
*
|
|
2994
|
-
* @param {string} orderId - The order's ID.
|
|
2995
|
-
* @param {Partial<OrderChangeDTO>} lastOrderChange - The last order change status to revert to.
|
|
2996
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
2997
|
-
* @returns {Promise<void>} Resolves when the order is undone.
|
|
2998
|
-
*
|
|
2999
|
-
* @example
|
|
3000
|
-
* await orderModuleService.revertLastChange("123")
|
|
3001
|
-
*/
|
|
3002
|
-
undoLastChange(orderId: string, lastOrderChange?: Partial<OrderChangeDTO>, sharedContext?: Context): Promise<void>;
|
|
3003
|
-
/**
|
|
3004
|
-
* This method retrieves a paginated list of transactions based on optional filters and configuration.
|
|
3005
|
-
*
|
|
3006
|
-
* @param {FilterableOrderTransactionProps} filters - The filters to apply on the retrieved transactions.
|
|
3007
|
-
* @param {FindConfig<OrderTransactionDTO>} config - The configurations determining how the transaction is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
3008
|
-
* attributes or relations associated with a transaction.
|
|
3009
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3010
|
-
* @returns {Promise<OrderTransactionDTO[]>} The list of transactions.
|
|
3011
|
-
*
|
|
3012
|
-
* @example
|
|
3013
|
-
* To retrieve a list of transactions using their IDs:
|
|
3014
|
-
*
|
|
3015
|
-
* ```ts
|
|
3016
|
-
* const transactions = await orderModuleService.listOrderTransactions({
|
|
3017
|
-
* id: ["123", "321"]
|
|
3018
|
-
* })
|
|
3019
|
-
* ```
|
|
3020
|
-
*
|
|
3021
|
-
* To specify relations that should be retrieved within the transaction:
|
|
3022
|
-
*
|
|
3023
|
-
* :::note
|
|
3024
|
-
*
|
|
3025
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
3026
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
3027
|
-
*
|
|
3028
|
-
* :::
|
|
3029
|
-
*
|
|
3030
|
-
* ```ts
|
|
3031
|
-
* const transactions = await orderModuleService.listOrderTransactions({
|
|
3032
|
-
* id: ["123", "321"]
|
|
3033
|
-
* }, {
|
|
3034
|
-
* relations: ["order"]
|
|
3035
|
-
* })
|
|
3036
|
-
* ```
|
|
3037
|
-
*
|
|
3038
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
3039
|
-
*
|
|
3040
|
-
* ```ts
|
|
3041
|
-
* const transactions = await orderModuleService.listOrderTransactions({
|
|
3042
|
-
* id: ["123", "321"]
|
|
3043
|
-
* }, {
|
|
3044
|
-
* relations: ["order"],
|
|
3045
|
-
* take: 20,
|
|
3046
|
-
* skip: 2
|
|
3047
|
-
* })
|
|
3048
|
-
* ```
|
|
3049
|
-
*/
|
|
3050
|
-
listOrderTransactions(filters?: FilterableOrderTransactionProps, config?: FindConfig<OrderTransactionDTO>, sharedContext?: Context): Promise<OrderTransactionDTO[]>;
|
|
3051
|
-
/**
|
|
3052
|
-
* This method adds a transaction to an order.
|
|
3053
|
-
*
|
|
3054
|
-
* @param {CreateOrderTransactionDTO} data - The transaction to be created.
|
|
3055
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3056
|
-
* @returns {Promise<OrderTransactionDTO>} The created transaction.
|
|
3057
|
-
*
|
|
3058
|
-
* @example
|
|
3059
|
-
* const transaction = await orderModuleService.addOrderTransactions({
|
|
3060
|
-
* order_id: "123",
|
|
3061
|
-
* amount: 10,
|
|
3062
|
-
* currency_code: "usd"
|
|
3063
|
-
* })
|
|
3064
|
-
*/
|
|
3065
|
-
addOrderTransactions(data: CreateOrderTransactionDTO, sharedContext?: Context): Promise<OrderTransactionDTO>;
|
|
3066
|
-
/**
|
|
3067
|
-
* This method adds transactions to an order.
|
|
3068
|
-
*
|
|
3069
|
-
* @param {CreateOrderTransactionDTO[]} data - The order transactions to be created.
|
|
3070
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3071
|
-
* @returns {Promise<OrderTransactionDTO[]>} The created order transactions.
|
|
3072
|
-
*
|
|
3073
|
-
* @example
|
|
3074
|
-
* const transactions = await orderModuleService.addOrderTransactions([{
|
|
3075
|
-
* order_id: "123",
|
|
3076
|
-
* amount: 10,
|
|
3077
|
-
* currency_code: "usd"
|
|
3078
|
-
* }])
|
|
3079
|
-
*/
|
|
3080
|
-
addOrderTransactions(data: CreateOrderTransactionDTO[], sharedContext?: Context): Promise<OrderTransactionDTO[]>;
|
|
3081
|
-
/**
|
|
3082
|
-
* This method deletes transactions by their IDs.
|
|
3083
|
-
*
|
|
3084
|
-
* @param {string | object | string[] | object[]} transactionIds - The ID(s) of the transaction to delete.
|
|
3085
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3086
|
-
* @returns {Promise<void>} Resolves when the transaction(s) are deleted successfully.
|
|
3087
|
-
*
|
|
3088
|
-
* @example
|
|
3089
|
-
* To delete one transaction:
|
|
3090
|
-
*
|
|
3091
|
-
* ```ts
|
|
3092
|
-
* await orderModuleService.deleteOrderTransactions("123")
|
|
3093
|
-
* ```
|
|
3094
|
-
*
|
|
3095
|
-
* To delete multiple transactions:
|
|
3096
|
-
*
|
|
3097
|
-
* ```ts
|
|
3098
|
-
* await orderModuleService.deleteOrderTransactions(["123", "321"])
|
|
3099
|
-
* ```
|
|
3100
|
-
*/
|
|
3101
|
-
deleteOrderTransactions(transactionIds: string | object | string[] | object[], sharedContext?: Context): Promise<void>;
|
|
3102
|
-
/**
|
|
3103
|
-
* This method soft deletes transactions by their IDs.
|
|
3104
|
-
*
|
|
3105
|
-
* @param {string[]} transactionIds - The IDs of transactions.
|
|
3106
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
3107
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3108
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
3109
|
-
* The object's keys are the ID attribute names of the transaction entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
3110
|
-
* with the transaction through this relation.
|
|
3111
|
-
*
|
|
3112
|
-
* If there are no related records, the promise resolves to `void`.
|
|
3113
|
-
*
|
|
3114
|
-
* @example
|
|
3115
|
-
* await orderModuleService.softDeleteOrderTransactions(["123", "321"])
|
|
3116
|
-
*/
|
|
3117
|
-
softDeleteOrderTransactions<TReturnableLinkableKeys extends string = string>(transactionIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3118
|
-
/**
|
|
3119
|
-
* This method restores soft-deleted transactions by their IDs.
|
|
3120
|
-
*
|
|
3121
|
-
* @param {string[]} transactionIds - The IDs of transactions.
|
|
3122
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the transactions. You can pass to its `returnLinkableKeys`
|
|
3123
|
-
* property any of the transaction's relation attribute names.
|
|
3124
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3125
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
3126
|
-
* The object's keys are the ID attribute names of the transaction entity's relations,
|
|
3127
|
-
* and its value is an array of strings, each being the ID of the record associated with the transaction through this relation.
|
|
3128
|
-
*
|
|
3129
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
3130
|
-
*
|
|
3131
|
-
* @example
|
|
3132
|
-
* await orderModuleService.restoreOrderTransactions(["123", "321"])
|
|
3133
|
-
*/
|
|
3134
|
-
restoreOrderTransactions<TReturnableLinkableKeys extends string = string>(transactionIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3135
|
-
/**
|
|
3136
|
-
* This method retrieves a return reason by its ID.
|
|
3137
|
-
*
|
|
3138
|
-
* @param {string} reasonId - The return reason's ID.
|
|
3139
|
-
* @param {FindConfig<OrderReturnReasonDTO>} config - The configurations determining how the return reason is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
3140
|
-
* attributes or relations associated with a return reason.
|
|
3141
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3142
|
-
* @returns {Promise<OrderReturnReasonDTO>} The retrieved return reason.
|
|
3143
|
-
*
|
|
3144
|
-
* @example
|
|
3145
|
-
* A simple example that retrieves a return reason by its ID:
|
|
3146
|
-
*
|
|
3147
|
-
* ```ts
|
|
3148
|
-
* const returnReason = await orderModuleService.retrieveReturnReason(
|
|
3149
|
-
* "123"
|
|
3150
|
-
* )
|
|
3151
|
-
* ```
|
|
3152
|
-
*
|
|
3153
|
-
* To specify relations that should be retrieved:
|
|
3154
|
-
*
|
|
3155
|
-
* :::note
|
|
3156
|
-
*
|
|
3157
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
3158
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
3159
|
-
*
|
|
3160
|
-
* :::
|
|
3161
|
-
*
|
|
3162
|
-
* ```ts
|
|
3163
|
-
* const returnReason = await orderModuleService.retrieveReturnReason(
|
|
3164
|
-
* "123",
|
|
3165
|
-
* {
|
|
3166
|
-
* relations: ["parent_return_reason"]
|
|
3167
|
-
* }
|
|
3168
|
-
* )
|
|
3169
|
-
* ```
|
|
3170
|
-
*/
|
|
3171
|
-
retrieveReturnReason(reasonId: string, config?: FindConfig<OrderReturnReasonDTO>, sharedContext?: Context): Promise<OrderReturnReasonDTO>;
|
|
3172
|
-
/**
|
|
3173
|
-
* This method retrieves a paginated list of return reasons based on optional filters and configuration.
|
|
3174
|
-
*
|
|
3175
|
-
* @param {FilterableOrderReturnReasonProps} filters - The filters to apply on the retrieved return reasons.
|
|
3176
|
-
* @param {FindConfig<OrderReturnReasonDTO>} config - The configurations determining how the return reason is retrieved. Its properties, such as `select` or `relations`, accept the
|
|
3177
|
-
* attributes or relations associated with a return reason.
|
|
3178
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3179
|
-
* @returns {Promise<OrderReturnReasonDTO[]>} The list of return reasons.
|
|
3180
|
-
*
|
|
3181
|
-
* @example
|
|
3182
|
-
* To retrieve a list of return reasons using their IDs:
|
|
3183
|
-
*
|
|
3184
|
-
* ```ts
|
|
3185
|
-
* const returnReasons = await orderModuleService.listReturnReasons({
|
|
3186
|
-
* id: ["123", "321"]
|
|
3187
|
-
* })
|
|
3188
|
-
* ```
|
|
3189
|
-
*
|
|
3190
|
-
* To specify relations that should be retrieved within the return reason:
|
|
3191
|
-
*
|
|
3192
|
-
* :::note
|
|
3193
|
-
*
|
|
3194
|
-
* You can only retrieve data models defined in the same module. To retrieve linked data models
|
|
3195
|
-
* from other modules, use [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query) instead.
|
|
3196
|
-
*
|
|
3197
|
-
* :::
|
|
3198
|
-
*
|
|
3199
|
-
* ```ts
|
|
3200
|
-
* const returnReasons = await orderModuleService.listReturnReasons({
|
|
3201
|
-
* id: ["123", "321"]
|
|
3202
|
-
* }, {
|
|
3203
|
-
* relations: ["parent_return_reason"]
|
|
3204
|
-
* })
|
|
3205
|
-
* ```
|
|
3206
|
-
*
|
|
3207
|
-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
|
3208
|
-
*
|
|
3209
|
-
* ```ts
|
|
3210
|
-
* const returnReasons = await orderModuleService.listReturnReasons({
|
|
3211
|
-
* id: ["123", "321"]
|
|
3212
|
-
* }, {
|
|
3213
|
-
* relations: ["parent_return_reason"],
|
|
3214
|
-
* take: 20,
|
|
3215
|
-
* skip: 2
|
|
3216
|
-
* })
|
|
3217
|
-
* ```
|
|
3218
|
-
*/
|
|
3219
|
-
listReturnReasons(filters: FilterableOrderReturnReasonProps, config?: FindConfig<OrderReturnReasonDTO>, sharedContext?: Context): Promise<OrderReturnReasonDTO[]>;
|
|
3220
|
-
/**
|
|
3221
|
-
* This method creates a return reason.
|
|
3222
|
-
*
|
|
3223
|
-
* @param {CreateOrderReturnReasonDTO} returnReasonData - The return reason to be created.
|
|
3224
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3225
|
-
* @returns {Promise<OrderReturnReasonDTO>} The created return reason.
|
|
3226
|
-
*
|
|
3227
|
-
* @example
|
|
3228
|
-
* const returnReason = await orderModuleService.createReturnReasons({
|
|
3229
|
-
* label: "Damaged",
|
|
3230
|
-
* value: "damaged"
|
|
3231
|
-
* })
|
|
3232
|
-
*/
|
|
3233
|
-
createReturnReasons(returnReasonData: CreateOrderReturnReasonDTO, sharedContext?: Context): Promise<OrderReturnReasonDTO>;
|
|
3234
|
-
/**
|
|
3235
|
-
* This method creates return reasons.
|
|
3236
|
-
*
|
|
3237
|
-
* @param {CreateOrderReturnReasonDTO[]} returnReasonData - The return reasons to be created.
|
|
3238
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3239
|
-
* @returns {Promise<OrderReturnReasonDTO[]>} The created return reason.
|
|
3240
|
-
*
|
|
3241
|
-
* @example
|
|
3242
|
-
* const returnReasons = await orderModuleService.createReturnReasons([{
|
|
3243
|
-
* label: "Damaged",
|
|
3244
|
-
* value: "damaged"
|
|
3245
|
-
* }])
|
|
3246
|
-
*/
|
|
3247
|
-
createReturnReasons(returnReasonData: CreateOrderReturnReasonDTO[], sharedContext?: Context): Promise<OrderReturnReasonDTO[]>;
|
|
3248
|
-
/**
|
|
3249
|
-
* This method updates existing return reasons matching the specified filters.
|
|
3250
|
-
*
|
|
3251
|
-
* @param {Partial<FilterableOrderReturnReasonProps>} selector - The filters specifying which return reason to delete.
|
|
3252
|
-
* @param {Partial<UpdateOrderReturnReasonDTO>} data - The data to update in the return reasons.
|
|
3253
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3254
|
-
* @returns {Promise<OrderReturnReasonDTO[]>} The updated return reasons.
|
|
3255
|
-
*
|
|
3256
|
-
* @example
|
|
3257
|
-
* const returnReasons = await orderModuleService.updateReturnReasons({
|
|
3258
|
-
* id: "123"
|
|
3259
|
-
* }, {
|
|
3260
|
-
* label: "Damaged"
|
|
3261
|
-
* })
|
|
3262
|
-
*/
|
|
3263
|
-
updateReturnReasons(selector: Partial<FilterableOrderReturnReasonProps>, data: Partial<UpdateOrderReturnReasonDTO>, sharedContext?: Context): Promise<OrderReturnReasonDTO[]>;
|
|
3264
|
-
/**
|
|
3265
|
-
* This method updates an existing return reason.
|
|
3266
|
-
*
|
|
3267
|
-
* @param {string} id - The ID of the return reason.
|
|
3268
|
-
* @param {Partial<UpdateOrderReturnReasonDTO>} data - The data to update in the return reason.
|
|
3269
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3270
|
-
* @returns {Promise<OrderReturnReasonDTO>} The updated return reason.
|
|
3271
|
-
*
|
|
3272
|
-
* @example
|
|
3273
|
-
* const returnReason = await orderModuleService.updateReturnReasons(
|
|
3274
|
-
* "123",
|
|
3275
|
-
* {
|
|
3276
|
-
* label: "Damaged"
|
|
3277
|
-
* }
|
|
3278
|
-
* )
|
|
3279
|
-
*/
|
|
3280
|
-
updateReturnReasons(id: string, data: Partial<UpdateOrderReturnReasonDTO>, sharedContext?: Context): Promise<OrderReturnReasonDTO>;
|
|
3281
|
-
/**
|
|
3282
|
-
* This method deletes return reasons by their IDs.
|
|
3283
|
-
*
|
|
3284
|
-
* @param {string[]} returnReasonIds - The IDs of return reasons.
|
|
3285
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3286
|
-
* @returns {Promise<void>} Resolves when the return reasons are deleted successfully.
|
|
3287
|
-
*
|
|
3288
|
-
* @example
|
|
3289
|
-
* await orderModuleService.deleteReturnReasons([
|
|
3290
|
-
* "123", "321"
|
|
3291
|
-
* ])
|
|
3292
|
-
*/
|
|
3293
|
-
deleteReturnReasons(returnReasonIds: string[], sharedContext?: Context): Promise<void>;
|
|
3294
|
-
/**
|
|
3295
|
-
* This method soft deletes return reasons by their IDs.
|
|
3296
|
-
*
|
|
3297
|
-
* @param {string[]} ids - The IDs of the return reasons.
|
|
3298
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
3299
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3300
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
3301
|
-
* The object's keys are the ID attribute names of the return reason entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
3302
|
-
* with the return reason through this relation.
|
|
3303
|
-
*
|
|
3304
|
-
* If there are no related records, the promise resolves to `void`.
|
|
3305
|
-
*
|
|
3306
|
-
* @example
|
|
3307
|
-
* await orderModuleService.softDeleteReturnReasons([
|
|
3308
|
-
* "123", "321"
|
|
3309
|
-
* ])
|
|
3310
|
-
*/
|
|
3311
|
-
softDeleteReturnReasons<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3312
|
-
/**
|
|
3313
|
-
* This method restores soft-deleted return reasons by their IDs.
|
|
3314
|
-
*
|
|
3315
|
-
* @param {string[]} ids - The IDs of the return reasons.
|
|
3316
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the return reasons. You can pass to its `returnLinkableKeys`
|
|
3317
|
-
* property any of the return reason's relation attribute names.
|
|
3318
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3319
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
3320
|
-
* The object's keys are the ID attribute names of the return reason entity's relations,
|
|
3321
|
-
* and its value is an array of strings, each being the ID of the record associated with the return reason through this relation.
|
|
3322
|
-
*
|
|
3323
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
3324
|
-
*
|
|
3325
|
-
* @example
|
|
3326
|
-
* await orderModuleService.restoreReturnReasons([
|
|
3327
|
-
* "123", "321"
|
|
3328
|
-
* ])
|
|
3329
|
-
*/
|
|
3330
|
-
restoreReturnReasons<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3331
|
-
/**
|
|
3332
|
-
* This method creates a return item.
|
|
3333
|
-
*
|
|
3334
|
-
* @param {CreateOrderReturnItemDTO} data - The return item to be created.
|
|
3335
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3336
|
-
* @returns {Promise<OrderReturnItemDTO>} The created return item.
|
|
3337
|
-
*
|
|
3338
|
-
* @example
|
|
3339
|
-
* const returnItem = await orderModuleService.createReturnItems({
|
|
3340
|
-
* return_id: "123",
|
|
3341
|
-
* item_id: "321",
|
|
3342
|
-
* quantity: 1
|
|
3343
|
-
* })
|
|
3344
|
-
*/
|
|
3345
|
-
createReturnItems(data: CreateOrderReturnItemDTO, sharedContext?: Context): Promise<OrderReturnItemDTO>;
|
|
3346
|
-
/**
|
|
3347
|
-
* This method creates return items.
|
|
3348
|
-
*
|
|
3349
|
-
* @param {CreateOrderReturnItemDTO[]} data - The return items to be created.
|
|
3350
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3351
|
-
* @returns {Promise<OrderReturnItemDTO[]>} The created return items.
|
|
3352
|
-
*
|
|
3353
|
-
* @example
|
|
3354
|
-
* const returnItems = await orderModuleService.createReturnItems([{
|
|
3355
|
-
* return_id: "123",
|
|
3356
|
-
* item_id: "321",
|
|
3357
|
-
* quantity: 1
|
|
3358
|
-
* }])
|
|
3359
|
-
*/
|
|
3360
|
-
createReturnItems(data: CreateOrderReturnItemDTO[], sharedContext?: Context): Promise<OrderReturnItemDTO[]>;
|
|
3361
|
-
/**
|
|
3362
|
-
* This method creates a order claim item.
|
|
3363
|
-
*
|
|
3364
|
-
* @param {CreateOrderClaimItemDTO} data - The order claim item to be created.
|
|
3365
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3366
|
-
* @returns {Promise<OrderClaimItemDTO>} The created order claim item.
|
|
3367
|
-
*
|
|
3368
|
-
* @example
|
|
3369
|
-
* const orderClaimItem = await orderModuleService.createOrderClaimItems({
|
|
3370
|
-
* claim_id: "123",
|
|
3371
|
-
* item_id: "321",
|
|
3372
|
-
* quantity: 1
|
|
3373
|
-
* })
|
|
3374
|
-
*/
|
|
3375
|
-
createOrderClaimItems(data: CreateOrderClaimItemDTO, sharedContext?: Context): Promise<OrderClaimItemDTO>;
|
|
3376
|
-
/**
|
|
3377
|
-
* This method creates order claim items.
|
|
3378
|
-
*
|
|
3379
|
-
* @param {CreateOrderClaimItemDTO[]} data - The order claim items to be created.
|
|
3380
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3381
|
-
* @returns {Promise<OrderClaimItemDTO[]>} The created order claim items.
|
|
3382
|
-
*
|
|
3383
|
-
* @example
|
|
3384
|
-
* const orderClaimItems = await orderModuleService.createOrderClaimItems([
|
|
3385
|
-
* {
|
|
3386
|
-
* claim_id: "123",
|
|
3387
|
-
* item_id: "321",
|
|
3388
|
-
* quantity: 1
|
|
3389
|
-
* },
|
|
3390
|
-
* {
|
|
3391
|
-
* claim_id: "321",
|
|
3392
|
-
* item_id: "321",
|
|
3393
|
-
* is_additional_item: 1,
|
|
3394
|
-
* quantity: 1
|
|
3395
|
-
* }
|
|
3396
|
-
* ])
|
|
3397
|
-
*/
|
|
3398
|
-
createOrderClaimItems(data: CreateOrderClaimItemDTO[], sharedContext?: Context): Promise<OrderClaimItemDTO[]>;
|
|
3399
|
-
/**
|
|
3400
|
-
* This method creates an order exchange item.
|
|
3401
|
-
*
|
|
3402
|
-
* @param {CreateOrderExchangeItemDTO} data - The order exchange item to be created.
|
|
3403
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3404
|
-
* @returns {Promise<OrderExchangeItemDTO>} The created order exchange item.
|
|
3405
|
-
*
|
|
3406
|
-
* @example
|
|
3407
|
-
* const orderExchangeItem = await orderModuleService.createOrderExchangeItems({
|
|
3408
|
-
* exchange_id: "123",
|
|
3409
|
-
* item_id: "321",
|
|
3410
|
-
* quantity: 1
|
|
3411
|
-
* })
|
|
3412
|
-
*/
|
|
3413
|
-
createOrderExchangeItems(data: CreateOrderExchangeItemDTO, sharedContext?: Context): Promise<OrderExchangeItemDTO>;
|
|
3414
|
-
/**
|
|
3415
|
-
* This method creates order exchange items.
|
|
3416
|
-
*
|
|
3417
|
-
* @param {CreateOrderExchangeItemDTO[]} data - The order exchange items to be created.
|
|
3418
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3419
|
-
* @returns {Promise<OrderExchangeItemDTO[]>} The created order exchange items.
|
|
3420
|
-
*
|
|
3421
|
-
* @example
|
|
3422
|
-
* const orderExchangeItems = await orderModuleService.createOrderExchangeItems([
|
|
3423
|
-
* {
|
|
3424
|
-
* exchange_id: "123",
|
|
3425
|
-
* item_id: "321",
|
|
3426
|
-
* quantity: 1
|
|
3427
|
-
* },
|
|
3428
|
-
* {
|
|
3429
|
-
* exchange_id: "321",
|
|
3430
|
-
* item_id: "123",
|
|
3431
|
-
* quantity: 1
|
|
3432
|
-
* }
|
|
3433
|
-
* ])
|
|
3434
|
-
*/
|
|
3435
|
-
createOrderExchangeItems(data: CreateOrderExchangeItemDTO[], sharedContext?: Context): Promise<OrderExchangeItemDTO[]>;
|
|
3436
|
-
/**
|
|
3437
|
-
* This method creates a return.
|
|
3438
|
-
*
|
|
3439
|
-
* @param {CreateOrderReturnDTO} data - The return to be created.
|
|
3440
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3441
|
-
* @returns {Promise<ReturnDTO>} The created return.
|
|
3442
|
-
*
|
|
3443
|
-
* @example
|
|
3444
|
-
* const orderReturn = await orderModuleService.createReturns({
|
|
3445
|
-
* order_id: "123",
|
|
3446
|
-
* items: [
|
|
3447
|
-
* {
|
|
3448
|
-
* id: "321",
|
|
3449
|
-
* quantity: 1
|
|
3450
|
-
* }
|
|
3451
|
-
* ]
|
|
3452
|
-
* })
|
|
3453
|
-
*/
|
|
3454
|
-
createReturns(data: CreateOrderReturnDTO, sharedContext?: Context): Promise<ReturnDTO>;
|
|
3455
|
-
/**
|
|
3456
|
-
* This method creates returns.
|
|
3457
|
-
*
|
|
3458
|
-
* @param {CreateOrderReturnDTO[]} data - The returns to be created.
|
|
3459
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3460
|
-
* @returns {Promise<ReturnDTO[]>} The created returns.
|
|
3461
|
-
*
|
|
3462
|
-
* @example
|
|
3463
|
-
* const returns = await orderModuleService.createReturns([{
|
|
3464
|
-
* order_id: "123",
|
|
3465
|
-
* items: [
|
|
3466
|
-
* {
|
|
3467
|
-
* id: "321",
|
|
3468
|
-
* quantity: 1
|
|
3469
|
-
* }
|
|
3470
|
-
* ]
|
|
3471
|
-
* }])
|
|
3472
|
-
*/
|
|
3473
|
-
createReturns(data: CreateOrderReturnDTO[], sharedContext?: Context): Promise<ReturnDTO[]>;
|
|
3474
|
-
/**
|
|
3475
|
-
* This method updates existing returns.
|
|
3476
|
-
*
|
|
3477
|
-
* @param {UpdateOrderReturnWithSelectorDTO[]} data - The filters specifying which returns to update,
|
|
3478
|
-
* and the data to update in them.
|
|
3479
|
-
* @returns {Promise<ReturnDTO[]>} The updated returns.
|
|
3480
|
-
*
|
|
3481
|
-
* @example
|
|
3482
|
-
* const returns = await orderModuleService.updateReturns([{
|
|
3483
|
-
* selector: {
|
|
3484
|
-
* id: "123"
|
|
3485
|
-
* },
|
|
3486
|
-
* data: {
|
|
3487
|
-
* refund_amount: 10
|
|
3488
|
-
* }
|
|
3489
|
-
* }])
|
|
3490
|
-
*/
|
|
3491
|
-
updateReturns(data: UpdateOrderReturnWithSelectorDTO[], sharedContext?: Context): Promise<ReturnDTO[]>;
|
|
3492
|
-
/**
|
|
3493
|
-
* This method updates existing returns matching the specified filters.
|
|
3494
|
-
*
|
|
3495
|
-
* @param {Partial<FilterableReturnProps>} selector - The filters specifying which returns to update.
|
|
3496
|
-
* @param {Partial<UpdateReturnDTO>} data - The data to update in the returns.
|
|
3497
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3498
|
-
* @returns {Promise<ReturnDTO[]>} The updated returns.
|
|
3499
|
-
*
|
|
3500
|
-
* @example
|
|
3501
|
-
* const returns = await orderModuleService.updateReturns({
|
|
3502
|
-
* id: "123"
|
|
3503
|
-
* }, {
|
|
3504
|
-
* refund_amount: 10
|
|
3505
|
-
* })
|
|
3506
|
-
*/
|
|
3507
|
-
updateReturns(selector: Partial<FilterableReturnProps>, data: Partial<UpdateReturnDTO>, sharedContext?: Context): Promise<ReturnDTO[]>;
|
|
3508
|
-
/**
|
|
3509
|
-
* This method updates an existing return.
|
|
3510
|
-
*
|
|
3511
|
-
* @param {string} id - The ID of the return.
|
|
3512
|
-
* @param {Partial<UpdateReturnDTO>} data - The data to update.
|
|
3513
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3514
|
-
* @returns {Promise<ReturnDTO>} The updated return.
|
|
3515
|
-
*
|
|
3516
|
-
* @example
|
|
3517
|
-
* const orderReturn = await orderModuleService.updateReturns(
|
|
3518
|
-
* "123",
|
|
3519
|
-
* {
|
|
3520
|
-
* refund_amount: 10
|
|
3521
|
-
* }
|
|
3522
|
-
* )
|
|
3523
|
-
*/
|
|
3524
|
-
updateReturns(id: string, data: Partial<UpdateReturnDTO>, sharedContext?: Context): Promise<ReturnDTO>;
|
|
3525
|
-
/**
|
|
3526
|
-
* This method deletes returns by their IDs.
|
|
3527
|
-
*
|
|
3528
|
-
* @param {string[]} ids - The IDs of the returns.
|
|
3529
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3530
|
-
* @returns {Promise<void>} Resolves when the returns are deleted successfully.
|
|
3531
|
-
*
|
|
3532
|
-
* @example
|
|
3533
|
-
* await orderModuleService.deleteReturns(["123", "321"])
|
|
3534
|
-
*/
|
|
3535
|
-
deleteReturns(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3536
|
-
/**
|
|
3537
|
-
* This method deletes return items by their IDs.
|
|
3538
|
-
*
|
|
3539
|
-
* @param {string[]} ids - The IDs of the return items.
|
|
3540
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3541
|
-
* @returns {Promise<void>} Resolves when the return items are deleted successfully.
|
|
3542
|
-
*
|
|
3543
|
-
* @example
|
|
3544
|
-
* await orderModuleService.deleteReturnItems(["123", "321"])
|
|
3545
|
-
*/
|
|
3546
|
-
deleteReturnItems(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3547
|
-
/**
|
|
3548
|
-
* This method soft deletes returns by their IDs.
|
|
3549
|
-
*
|
|
3550
|
-
* @param {string[]} ids - The IDs of the returns.
|
|
3551
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
3552
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3553
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
3554
|
-
* The object's keys are the ID attribute names of the return entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
3555
|
-
* with the return through this relation.
|
|
3556
|
-
*
|
|
3557
|
-
* If there are no related records, the promise resolves to `void`.
|
|
3558
|
-
*
|
|
3559
|
-
* @example
|
|
3560
|
-
* await orderModuleService.softDeleteReturns(["123", "321"])
|
|
3561
|
-
*/
|
|
3562
|
-
softDeleteReturns<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3563
|
-
/**
|
|
3564
|
-
* This method restores soft-deleted returns by their IDs.
|
|
3565
|
-
*
|
|
3566
|
-
* @param {string[]} ids - The IDs of the returns.
|
|
3567
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the returns. You can pass to its `returnLinkableKeys`
|
|
3568
|
-
* property any of the return's relation attribute names.
|
|
3569
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3570
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
3571
|
-
* The object's keys are the ID attribute names of the return entity's relations,
|
|
3572
|
-
* and its value is an array of strings, each being the ID of the record associated with the return through this relation.
|
|
3573
|
-
*
|
|
3574
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
3575
|
-
*
|
|
3576
|
-
* @example
|
|
3577
|
-
* await orderModuleService.restoreReturns(["123", "321"])
|
|
3578
|
-
*/
|
|
3579
|
-
restoreReturns<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3580
|
-
/**
|
|
3581
|
-
* This method creates an order claim.
|
|
3582
|
-
*
|
|
3583
|
-
* @param {CreateOrderClaimDTO} data - The order claim to be created.
|
|
3584
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3585
|
-
* @returns {Promise<OrderClaimDTO>} The created order claim.
|
|
3586
|
-
*
|
|
3587
|
-
* @example
|
|
3588
|
-
* const claim = await orderModuleService.createOrderClaims({
|
|
3589
|
-
* order_id: "123",
|
|
3590
|
-
* type: "refund"
|
|
3591
|
-
* })
|
|
3592
|
-
*/
|
|
3593
|
-
createOrderClaims(data: CreateOrderClaimDTO, sharedContext?: Context): Promise<OrderClaimDTO>;
|
|
3594
|
-
/**
|
|
3595
|
-
* This method creates order claims.
|
|
3596
|
-
*
|
|
3597
|
-
* @param {CreateOrderClaimDTO[]} data - The order claims to be created.
|
|
3598
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3599
|
-
* @returns {Promise<OrderClaimDTO[]>} The created order claims.
|
|
3600
|
-
*
|
|
3601
|
-
* @example
|
|
3602
|
-
* const claims = await orderModuleService.createOrderClaims([{
|
|
3603
|
-
* order_id: "123",
|
|
3604
|
-
* type: "refund"
|
|
3605
|
-
* }])
|
|
3606
|
-
*/
|
|
3607
|
-
createOrderClaims(data: CreateOrderClaimDTO[], sharedContext?: Context): Promise<OrderClaimDTO[]>;
|
|
3608
|
-
/**
|
|
3609
|
-
* This method updates existing order claims.
|
|
3610
|
-
*
|
|
3611
|
-
* @param {UpdateOrderClaimWithSelectorDTO[]} data - The filters specifying which order claims to update,
|
|
3612
|
-
* and the data to update in them.
|
|
3613
|
-
* @returns {Promise<OrderClaimDTO[]>} The updated order claims.
|
|
3614
|
-
*
|
|
3615
|
-
* @example
|
|
3616
|
-
* const claims = await orderModuleService.updateOrderClaims([
|
|
3617
|
-
* {
|
|
3618
|
-
* selector: {
|
|
3619
|
-
* id: "123"
|
|
3620
|
-
* },
|
|
3621
|
-
* data: {
|
|
3622
|
-
* type: "refund"
|
|
3623
|
-
* }
|
|
3624
|
-
* }
|
|
3625
|
-
* ])
|
|
3626
|
-
*/
|
|
3627
|
-
updateOrderClaims(data: UpdateOrderClaimWithSelectorDTO[], sharedContext?: Context): Promise<OrderClaimDTO[]>;
|
|
3628
|
-
/**
|
|
3629
|
-
* This method updates existing order claims matching the specified filters.
|
|
3630
|
-
*
|
|
3631
|
-
* @param {Partial<FilterableOrderClaimProps>} selector - The filters specifying which order claims to update.
|
|
3632
|
-
* @param {Partial<UpdateOrderClaimDTO>} data - The data to update in the order claims.
|
|
3633
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3634
|
-
* @returns {Promise<OrderClaimDTO[]>} The updated order claims.
|
|
3635
|
-
*
|
|
3636
|
-
* @example
|
|
3637
|
-
* const claims = await orderModuleService.updateOrderClaims({
|
|
3638
|
-
* id: "123"
|
|
3639
|
-
* }, {
|
|
3640
|
-
* type: "refund"
|
|
3641
|
-
* })
|
|
3642
|
-
*/
|
|
3643
|
-
updateOrderClaims(selector: Partial<FilterableOrderClaimProps>, data: Partial<UpdateOrderClaimDTO>, sharedContext?: Context): Promise<OrderClaimDTO[]>;
|
|
3644
|
-
/**
|
|
3645
|
-
* This method updates an existing order claim.
|
|
3646
|
-
*
|
|
3647
|
-
* @param {string} id - The ID of the order claim.
|
|
3648
|
-
* @param {Partial<UpdateOrderClaimDTO>} data - The data to update in the order claim.
|
|
3649
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3650
|
-
* @returns {Promise<OrderClaimDTO>} The updated order claim.
|
|
3651
|
-
*
|
|
3652
|
-
* @example
|
|
3653
|
-
* const claim = await orderModuleService.updateOrderClaims("123", {
|
|
3654
|
-
* type: "refund"
|
|
3655
|
-
* })
|
|
3656
|
-
*/
|
|
3657
|
-
updateOrderClaims(id: string, data: Partial<UpdateOrderClaimDTO>, sharedContext?: Context): Promise<OrderClaimDTO>;
|
|
3658
|
-
/**
|
|
3659
|
-
* This method deletes an order claim by its ID.
|
|
3660
|
-
*
|
|
3661
|
-
* @param {string[]} ids - The IDs of the order claims.
|
|
3662
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3663
|
-
* @returns {Promise<void>} Resolves when the order claims are deleted successfully.
|
|
3664
|
-
*
|
|
3665
|
-
* @example
|
|
3666
|
-
* await orderModuleService.deleteOrderClaims(["123", "321"])
|
|
3667
|
-
*/
|
|
3668
|
-
deleteOrderClaims(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3669
|
-
/**
|
|
3670
|
-
* This method deletes order claim items by their IDs.
|
|
3671
|
-
*
|
|
3672
|
-
* @param {string[]} ids - The IDs of the order claim items.
|
|
3673
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3674
|
-
* @returns {Promise<void>} Resolves when the claim items are deleted.
|
|
3675
|
-
*
|
|
3676
|
-
* @example
|
|
3677
|
-
* await orderModuleService.deleteOrderClaimItems([
|
|
3678
|
-
* "123", "321"
|
|
3679
|
-
* ])
|
|
3680
|
-
*/
|
|
3681
|
-
deleteOrderClaimItems(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3682
|
-
/**
|
|
3683
|
-
* This method deletes order claim item images by their IDs.
|
|
3684
|
-
*
|
|
3685
|
-
* @param {string[]} ids - The IDs of the order claim item images.
|
|
3686
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3687
|
-
* @returns {Promise<void>} Resolves when the claim items are deleted.
|
|
3688
|
-
*
|
|
3689
|
-
* @example
|
|
3690
|
-
* await orderModuleService.deleteOrderClaimItemImages([
|
|
3691
|
-
* "123", "321"
|
|
3692
|
-
* ])
|
|
3693
|
-
*/
|
|
3694
|
-
deleteOrderClaimItemImages(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3695
|
-
/**
|
|
3696
|
-
* This method soft deletes order claims by their IDs.
|
|
3697
|
-
*
|
|
3698
|
-
* @param {string[]} ids - The IDs of the order claims.
|
|
3699
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
3700
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3701
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
3702
|
-
* The object's keys are the ID attribute names of the order claim entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
3703
|
-
* with the order claim through this relation.
|
|
3704
|
-
*
|
|
3705
|
-
* If there are no related records, the promise resolves to `void`.
|
|
3706
|
-
*
|
|
3707
|
-
* @example
|
|
3708
|
-
* await orderModuleService.softDeleteOrderClaims(["123", "321"])
|
|
3709
|
-
*/
|
|
3710
|
-
softDeleteOrderClaims<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3711
|
-
/**
|
|
3712
|
-
* This method restores soft-deleted order claims by their IDs.
|
|
3713
|
-
*
|
|
3714
|
-
* @param {string[]} ids - The IDs of the order claims.
|
|
3715
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the order. You can pass to its `returnLinkableKeys`
|
|
3716
|
-
* property any of the order claim's relation attribute names.
|
|
3717
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3718
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
3719
|
-
* The object's keys are the ID attribute names of the order claim entity's relations,
|
|
3720
|
-
* and its value is an array of strings, each being the ID of the record associated with the order claims through this relation.
|
|
3721
|
-
*
|
|
3722
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
3723
|
-
*
|
|
3724
|
-
* @example
|
|
3725
|
-
* await orderModuleService.restoreOrderClaims(["123", "321"])
|
|
3726
|
-
*/
|
|
3727
|
-
restoreOrderClaims<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3728
|
-
/**
|
|
3729
|
-
* This method creates an order exchange.
|
|
3730
|
-
*
|
|
3731
|
-
* @param {CreateOrderExchangeDTO} data - The order exchange to be created.
|
|
3732
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3733
|
-
* @returns {Promise<OrderExchangeDTO>} The created order exchange.
|
|
3734
|
-
*
|
|
3735
|
-
* @example
|
|
3736
|
-
* const exchange = await orderModuleService.createOrderExchanges({
|
|
3737
|
-
* order_id: "123",
|
|
3738
|
-
* additional_items: [
|
|
3739
|
-
* {
|
|
3740
|
-
* id: "123",
|
|
3741
|
-
* quantity: 1
|
|
3742
|
-
* }
|
|
3743
|
-
* ]
|
|
3744
|
-
* })
|
|
3745
|
-
*/
|
|
3746
|
-
createOrderExchanges(data: CreateOrderExchangeDTO, sharedContext?: Context): Promise<OrderExchangeDTO>;
|
|
3747
|
-
/**
|
|
3748
|
-
* This method creates order exchanges.
|
|
3749
|
-
*
|
|
3750
|
-
* @param {CreateOrderExchangeDTO[]} data - The order exchanges to be created.
|
|
3751
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3752
|
-
* @returns {Promise<OrderExchangeDTO[]>} The created order exchanges.
|
|
3753
|
-
*
|
|
3754
|
-
* @example
|
|
3755
|
-
* const exchanges = await orderModuleService.createOrderExchanges([{
|
|
3756
|
-
* order_id: "123",
|
|
3757
|
-
* additional_items: [
|
|
3758
|
-
* {
|
|
3759
|
-
* id: "123",
|
|
3760
|
-
* quantity: 1
|
|
3761
|
-
* }
|
|
3762
|
-
* ]
|
|
3763
|
-
* }])
|
|
3764
|
-
*/
|
|
3765
|
-
createOrderExchanges(data: CreateOrderExchangeDTO[], sharedContext?: Context): Promise<OrderExchangeDTO[]>;
|
|
3766
|
-
/**
|
|
3767
|
-
* This method updates existing order exchanges.
|
|
3768
|
-
*
|
|
3769
|
-
* @param {UpdateOrderExchangeWithSelectorDTO[]} data - The filters specifying which exchanges to update,
|
|
3770
|
-
* and the data to update in them.
|
|
3771
|
-
* @returns {Promise<OrderExchangeDTO[]>} The updated order exchanges.
|
|
3772
|
-
*
|
|
3773
|
-
* @example
|
|
3774
|
-
* const exchanges = await orderModuleService.updateOrderExchanges([
|
|
3775
|
-
* {
|
|
3776
|
-
* selector: {
|
|
3777
|
-
* id: "123"
|
|
3778
|
-
* },
|
|
3779
|
-
* data: {
|
|
3780
|
-
* return_id: "123"
|
|
3781
|
-
* }
|
|
3782
|
-
* }
|
|
3783
|
-
* ])
|
|
3784
|
-
*/
|
|
3785
|
-
updateOrderExchanges(data: UpdateOrderExchangeWithSelectorDTO[], sharedContext?: Context): Promise<OrderExchangeDTO[]>;
|
|
3786
|
-
/**
|
|
3787
|
-
* This method updates existing order exchanges matching the specified filters.
|
|
3788
|
-
*
|
|
3789
|
-
* @param {Partial<FilterableOrderExchangeProps>} selector - The filters specifying which order exchanges to update.
|
|
3790
|
-
* @param {Partial<UpdateOrderExchangeDTO>} data - The data to update in the order exchanges.
|
|
3791
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3792
|
-
* @returns {Promise<OrderExchangeDTO[]>} The updated order exchanges.
|
|
3793
|
-
*
|
|
3794
|
-
* @example
|
|
3795
|
-
* const exchanges = await orderModuleService.updateOrderExchanges({
|
|
3796
|
-
* id: "123"
|
|
3797
|
-
* }, {
|
|
3798
|
-
* return_id: "123"
|
|
3799
|
-
* })
|
|
3800
|
-
*/
|
|
3801
|
-
updateOrderExchanges(selector: Partial<FilterableOrderExchangeProps>, data: Partial<UpdateOrderExchangeDTO>, sharedContext?: Context): Promise<OrderExchangeDTO[]>;
|
|
3802
|
-
/**
|
|
3803
|
-
* This method updates an existing order exchange.
|
|
3804
|
-
*
|
|
3805
|
-
* @param {string} id - The ID of the order exchange.
|
|
3806
|
-
* @param {Partial<UpdateOrderExchangeDTO>} data - The data to update in the order exchange.
|
|
3807
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3808
|
-
* @returns {Promise<OrderExchangeDTO>} The updated order exchange.
|
|
3809
|
-
*
|
|
3810
|
-
* @example
|
|
3811
|
-
* const exchange = await orderModuleService.updateOrderExchanges(
|
|
3812
|
-
* "123",
|
|
3813
|
-
* {
|
|
3814
|
-
* return_id: "123"
|
|
3815
|
-
* }
|
|
3816
|
-
* )
|
|
3817
|
-
*/
|
|
3818
|
-
updateOrderExchanges(id: string, data: Partial<UpdateOrderExchangeDTO>, sharedContext?: Context): Promise<OrderExchangeDTO>;
|
|
3819
|
-
/**
|
|
3820
|
-
* This method deletes order exchanges by their IDs.
|
|
3821
|
-
*
|
|
3822
|
-
* @param {string[]} ids - The IDs of the order exchanges.
|
|
3823
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3824
|
-
* @returns {Promise<void>} Resolves when the order exchanges are deleted successfully.
|
|
3825
|
-
*
|
|
3826
|
-
* @example
|
|
3827
|
-
* await orderModuleService.deleteOrderExchanges(["123", "321"])
|
|
3828
|
-
*/
|
|
3829
|
-
deleteOrderExchanges(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3830
|
-
/**
|
|
3831
|
-
* This method deletes order exchange items by their IDs.
|
|
3832
|
-
*
|
|
3833
|
-
* @param {string[]} ids - The IDs of the order exchange items.
|
|
3834
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3835
|
-
* @returns {Promise<void>} Resolves when the order exchange items are deleted successfully.
|
|
3836
|
-
*
|
|
3837
|
-
* @example
|
|
3838
|
-
* await orderModuleService.deleteOrderExchangeItems([
|
|
3839
|
-
* "123", "321"
|
|
3840
|
-
* ])
|
|
3841
|
-
*/
|
|
3842
|
-
deleteOrderExchangeItems(ids: string[], sharedContext?: Context): Promise<void>;
|
|
3843
|
-
/**
|
|
3844
|
-
* This method soft deletes order exchanges by their IDs.
|
|
3845
|
-
*
|
|
3846
|
-
* @param {string[]} ids - The IDs of the order exchanges.
|
|
3847
|
-
* @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
|
3848
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3849
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
|
|
3850
|
-
* The object's keys are the ID attribute names of the order exchange entity's relations, and its value is an array of strings, each being the ID of a record associated
|
|
3851
|
-
* with the order exchange through this relation.
|
|
3852
|
-
*
|
|
3853
|
-
* If there are no related records, the promise resolves to `void`.
|
|
3854
|
-
*
|
|
3855
|
-
* @example
|
|
3856
|
-
* await orderModuleService.softDeleteOrderExchanges(["123", "321"])
|
|
3857
|
-
*/
|
|
3858
|
-
softDeleteOrderExchanges<TReturnableLinkableKeys extends string = string>(ids: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3859
|
-
/**
|
|
3860
|
-
* This method restores soft-deleted order exchanges by their IDs.
|
|
3861
|
-
*
|
|
3862
|
-
* @param {string[]} ids - The IDs of the order exchanges.
|
|
3863
|
-
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the order exchanges. You can pass to its `returnLinkableKeys`
|
|
3864
|
-
* property any of the order exchange's relation attribute names.
|
|
3865
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3866
|
-
* @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
|
|
3867
|
-
* The object's keys are the ID attribute names of the order exchange entity's relations,
|
|
3868
|
-
* and its value is an array of strings, each being the ID of the record associated with the order exchange through this relation.
|
|
3869
|
-
*
|
|
3870
|
-
* If there are no related records restored, the promise resolves to `void`.
|
|
3871
|
-
*
|
|
3872
|
-
* @example
|
|
3873
|
-
* await orderModuleService.restoreOrderExchanges(["123", "321"])
|
|
3874
|
-
*/
|
|
3875
|
-
restoreOrderExchanges<TReturnableLinkableKeys extends string = string>(ids: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
|
|
3876
|
-
/**
|
|
3877
|
-
* This method sets the status of orders to `archived`.
|
|
3878
|
-
*
|
|
3879
|
-
* @param {string[]} orderIds - The orders' ID.
|
|
3880
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3881
|
-
* @returns {Promise<OrderDTO[]>} The archived orders.
|
|
3882
|
-
*
|
|
3883
|
-
* @example
|
|
3884
|
-
* const orders = await orderModuleService.archive(["123", "321"])
|
|
3885
|
-
*/
|
|
3886
|
-
archive(orderIds: string[], sharedContext?: Context): Promise<OrderDTO[]>;
|
|
3887
|
-
/**
|
|
3888
|
-
* This method sets the status of an order to `archived`.
|
|
3889
|
-
*
|
|
3890
|
-
* @param {string} orderId - The order's ID.
|
|
3891
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3892
|
-
* @returns {Promise<OrderDTO>} The archived order.
|
|
3893
|
-
*
|
|
3894
|
-
* @example
|
|
3895
|
-
* const order = await orderModuleService.archive("123")
|
|
3896
|
-
*/
|
|
3897
|
-
archive(orderId: string, sharedContext?: Context): Promise<OrderDTO>;
|
|
3898
|
-
/**
|
|
3899
|
-
* This method sets the status of orders to `completed`.
|
|
3900
|
-
*
|
|
3901
|
-
* @param {string[]} orderIds - The orders' IDs.
|
|
3902
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3903
|
-
* @returns {Promise<OrderDTO[]>} The completed orders.
|
|
3904
|
-
*
|
|
3905
|
-
* @example
|
|
3906
|
-
* const orders = await orderModuleService.completeOrder([
|
|
3907
|
-
* "123", "321"
|
|
3908
|
-
* ])
|
|
3909
|
-
*/
|
|
3910
|
-
completeOrder(orderIds: string[], sharedContext?: Context): Promise<OrderDTO[]>;
|
|
3911
|
-
/**
|
|
3912
|
-
* This method sets the status of an order to `completed`.
|
|
3913
|
-
*
|
|
3914
|
-
* @param {string} orderId - The order's ID.
|
|
3915
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3916
|
-
* @returns {Promise<OrderDTO>} The completed order.
|
|
3917
|
-
*
|
|
3918
|
-
* @example
|
|
3919
|
-
* const order = await orderModuleService.completeOrder("123")
|
|
3920
|
-
*/
|
|
3921
|
-
completeOrder(orderId: string, sharedContext?: Context): Promise<OrderDTO>;
|
|
3922
|
-
/**
|
|
3923
|
-
* This method sets the status of orders to `canceled`.
|
|
3924
|
-
*
|
|
3925
|
-
* @param {string[]} orderId - The orders' IDs.
|
|
3926
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3927
|
-
* @returns {Promise<OrderDTO[]>} The canceled orders.
|
|
3928
|
-
*
|
|
3929
|
-
* @example
|
|
3930
|
-
* const orders = await orderModuleService.cancel(["123", "321"])
|
|
3931
|
-
*/
|
|
3932
|
-
cancel(orderId: string[], sharedContext?: Context): Promise<OrderDTO[]>;
|
|
3933
|
-
/**
|
|
3934
|
-
* This method sets the status of an order to `canceled`.
|
|
3935
|
-
*
|
|
3936
|
-
* @param {string} orderId - The order's ID.
|
|
3937
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3938
|
-
* @returns {Promise<OrderDTO>} Represents the completion of an asynchronous operation
|
|
3939
|
-
*
|
|
3940
|
-
* @example
|
|
3941
|
-
* const orders = await orderModuleService.cancel("123")
|
|
3942
|
-
*/
|
|
3943
|
-
cancel(orderId: string, sharedContext?: Context): Promise<OrderDTO>;
|
|
3944
|
-
/**
|
|
3945
|
-
* Register a fulfillment for an order, return, exchange, or claim.
|
|
3946
|
-
*
|
|
3947
|
-
* @param {RegisterOrderFulfillmentDTO} data - The fulfillment's details.
|
|
3948
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3949
|
-
* @returns {Promise<void>} Resolves when the fulfillment is registered successfully.
|
|
3950
|
-
*
|
|
3951
|
-
* @example
|
|
3952
|
-
* await orderModuleService.registerFulfillment({
|
|
3953
|
-
* order_id: "123",
|
|
3954
|
-
* items: [
|
|
3955
|
-
* {
|
|
3956
|
-
* id: "321",
|
|
3957
|
-
* quantity: 1
|
|
3958
|
-
* }
|
|
3959
|
-
* ]
|
|
3960
|
-
* })
|
|
3961
|
-
*/
|
|
3962
|
-
registerFulfillment(data: RegisterOrderFulfillmentDTO, sharedContext?: Context): Promise<void>;
|
|
3963
|
-
/**
|
|
3964
|
-
* This method cancels the fulfillment of an order, return, claim, or exchange.
|
|
3965
|
-
*
|
|
3966
|
-
* @param {CancelOrderFulfillmentDTO} data - The cancelation details.
|
|
3967
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3968
|
-
* @returns {Promise<void>} Resolves when the fulfillment is canceled.
|
|
3969
|
-
*
|
|
3970
|
-
* @example
|
|
3971
|
-
* await orderModuleService.cancelFulfillment({
|
|
3972
|
-
* order_id: "123",
|
|
3973
|
-
* items: [
|
|
3974
|
-
* {
|
|
3975
|
-
* id: "321",
|
|
3976
|
-
* quantity: 1
|
|
3977
|
-
* }
|
|
3978
|
-
* ]
|
|
3979
|
-
* })
|
|
3980
|
-
*/
|
|
3981
|
-
cancelFulfillment(data: CancelOrderFulfillmentDTO, sharedContext?: Context): Promise<void>;
|
|
3982
|
-
/**
|
|
3983
|
-
* This method registers a shipment for an order, return, claim, or exchange.
|
|
3984
|
-
*
|
|
3985
|
-
* @param {RegisterOrderShipmentDTO} data - The shipment's data.
|
|
3986
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
3987
|
-
* @returns {Promise<void>} Resolves when the shipment's data are registered successfully.
|
|
3988
|
-
*
|
|
3989
|
-
* @example
|
|
3990
|
-
* await orderModuleService.registerShipment({
|
|
3991
|
-
* order_id: "123",
|
|
3992
|
-
* items: [
|
|
3993
|
-
* {
|
|
3994
|
-
* id: "321",
|
|
3995
|
-
* quantity: 1
|
|
3996
|
-
* }
|
|
3997
|
-
* ]
|
|
3998
|
-
* })
|
|
3999
|
-
*/
|
|
4000
|
-
registerShipment(data: RegisterOrderShipmentDTO, sharedContext?: Context): Promise<void>;
|
|
4001
|
-
/**
|
|
4002
|
-
* This method registers a delivery for an order's fulfillment
|
|
4003
|
-
*
|
|
4004
|
-
* @param {RegisterOrderDeliveryDTO} data - The ordes's delivery data.
|
|
4005
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4006
|
-
* @returns {Promise<void>} Resolves when the delivery is registered successfully.
|
|
4007
|
-
*
|
|
4008
|
-
* @example
|
|
4009
|
-
* await orderModuleService.registerDelivery({
|
|
4010
|
-
* order_id: "123",
|
|
4011
|
-
* items: [
|
|
4012
|
-
* {
|
|
4013
|
-
* id: "321",
|
|
4014
|
-
* quantity: 1
|
|
4015
|
-
* }
|
|
4016
|
-
* ]
|
|
4017
|
-
* })
|
|
4018
|
-
*/
|
|
4019
|
-
registerDelivery(data: RegisterOrderDeliveryDTO, sharedContext?: Context): Promise<void>;
|
|
4020
|
-
/**
|
|
4021
|
-
* This method creates a return.
|
|
4022
|
-
*
|
|
4023
|
-
* @param {CreateOrderReturnDTO} returnData - The order return to be created.
|
|
4024
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4025
|
-
* @returns {Promise<ReturnDTO>} The created order return.
|
|
4026
|
-
*
|
|
4027
|
-
* @example
|
|
4028
|
-
* const orderReturn = await orderModuleService.createReturn({
|
|
4029
|
-
* order_id: "123",
|
|
4030
|
-
* items: [{
|
|
4031
|
-
* id: "321",
|
|
4032
|
-
* quantity: 1
|
|
4033
|
-
* }]
|
|
4034
|
-
* })
|
|
4035
|
-
*/
|
|
4036
|
-
createReturn(returnData: CreateOrderReturnDTO, sharedContext?: Context): Promise<ReturnDTO>;
|
|
4037
|
-
/**
|
|
4038
|
-
* This method cancels an order return.
|
|
4039
|
-
*
|
|
4040
|
-
* @param {CancelOrderReturnDTO} data - The cancelation details.
|
|
4041
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4042
|
-
* @returns {Promise<ReturnDTO>} The canceled return.
|
|
4043
|
-
*
|
|
4044
|
-
* @example
|
|
4045
|
-
* const orderReturn = await orderModuleService.cancelReturn({
|
|
4046
|
-
* return_id: "123"
|
|
4047
|
-
* })
|
|
4048
|
-
*/
|
|
4049
|
-
cancelReturn(data: CancelOrderReturnDTO, sharedContext?: Context): Promise<ReturnDTO>;
|
|
4050
|
-
/**
|
|
4051
|
-
* This method marks a return as received, changing its status to `received`.
|
|
4052
|
-
*
|
|
4053
|
-
* @param {ReceiveOrderReturnDTO} returnData - The receival details.
|
|
4054
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4055
|
-
* @returns {Promise<ReturnDTO>} The received return.
|
|
4056
|
-
*
|
|
4057
|
-
* @example
|
|
4058
|
-
* const orderReturn = await orderModuleService.receiveReturn({
|
|
4059
|
-
* return_id: "123",
|
|
4060
|
-
* items: [
|
|
4061
|
-
* {
|
|
4062
|
-
* id: "123",
|
|
4063
|
-
* quantity:1
|
|
4064
|
-
* }
|
|
4065
|
-
* ]
|
|
4066
|
-
* })
|
|
4067
|
-
*/
|
|
4068
|
-
receiveReturn(returnData: ReceiveOrderReturnDTO, sharedContext?: Context): Promise<ReturnDTO>;
|
|
4069
|
-
/**
|
|
4070
|
-
* This method creates a claim.
|
|
4071
|
-
*
|
|
4072
|
-
* @param {CreateOrderClaimDTO} claimData - The order claim to be created.
|
|
4073
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4074
|
-
* @returns {Promise<OrderClaimDTO>} The created claim.
|
|
4075
|
-
*
|
|
4076
|
-
* @example
|
|
4077
|
-
* const claim = await orderModuleService.createClaim({
|
|
4078
|
-
* order_id: "123",
|
|
4079
|
-
* type: "refund"
|
|
4080
|
-
* })
|
|
4081
|
-
*/
|
|
4082
|
-
createClaim(claimData: CreateOrderClaimDTO, sharedContext?: Context): Promise<OrderClaimDTO>;
|
|
4083
|
-
/**
|
|
4084
|
-
* This method cancels a claim.
|
|
4085
|
-
*
|
|
4086
|
-
* @param {CancelOrderClaimDTO} data - The cancelation details.
|
|
4087
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4088
|
-
* @returns {Promise<OrderClaimDTO>} The canceled claim.
|
|
4089
|
-
*
|
|
4090
|
-
* @example
|
|
4091
|
-
* const claim = await orderModuleService.cancelClaim({
|
|
4092
|
-
* claim_id: "123",
|
|
4093
|
-
* })
|
|
4094
|
-
*/
|
|
4095
|
-
cancelClaim(data: CancelOrderClaimDTO, sharedContext?: Context): Promise<OrderClaimDTO>;
|
|
4096
|
-
/**
|
|
4097
|
-
* This method creates an order exchange.
|
|
4098
|
-
*
|
|
4099
|
-
* @param {CreateOrderExchangeDTO} exchangeData - The order exchange to be created.
|
|
4100
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4101
|
-
* @returns {Promise<OrderExchangeDTO>} The created order exchange.
|
|
4102
|
-
*
|
|
4103
|
-
* @example
|
|
4104
|
-
* const exchange = await orderModuleService.createExchange({
|
|
4105
|
-
* order_id: "123",
|
|
4106
|
-
* additional_items: [
|
|
4107
|
-
* {
|
|
4108
|
-
* id: "123",
|
|
4109
|
-
* quantity: 1
|
|
4110
|
-
* }
|
|
4111
|
-
* ]
|
|
4112
|
-
* })
|
|
4113
|
-
*/
|
|
4114
|
-
createExchange(exchangeData: CreateOrderExchangeDTO, sharedContext?: Context): Promise<OrderExchangeDTO>;
|
|
4115
|
-
/**
|
|
4116
|
-
* This method cancels an exchange.
|
|
4117
|
-
*
|
|
4118
|
-
* @param {CancelOrderExchangeDTO} data - The cancelation details.
|
|
4119
|
-
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
|
4120
|
-
* @returns {Promise<OrderExchangeDTO>} The canceled order exchange.
|
|
4121
|
-
*
|
|
4122
|
-
* @example
|
|
4123
|
-
* const exchange = await orderModuleService.cancelExchange({
|
|
4124
|
-
* exchange_id: "123"
|
|
4125
|
-
* })
|
|
4126
|
-
*/
|
|
4127
|
-
cancelExchange(data: CancelOrderExchangeDTO, sharedContext?: Context): Promise<OrderExchangeDTO>;
|
|
4128
|
-
createOrderCreditLines(data: CreateOrderCreditLineDTO[], sharedContext?: Context): Promise<OrderCreditLineDTO[]>;
|
|
4129
|
-
}
|
|
4130
|
-
//# sourceMappingURL=service.d.ts.map
|