@medusajs/types 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144
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/cache/service.d.ts +27 -0
- package/dist/cache/service.d.ts.map +1 -1
- package/dist/cart/common.d.ts +81 -0
- package/dist/cart/common.d.ts.map +1 -1
- package/dist/cart/mutations.d.ts +17 -2
- package/dist/cart/mutations.d.ts.map +1 -1
- package/dist/cart/mutations.js.map +1 -1
- package/dist/cart/service.d.ts +114 -1
- package/dist/cart/service.d.ts.map +1 -1
- package/dist/cart/workflows.d.ts +9 -0
- package/dist/cart/workflows.d.ts.map +1 -1
- package/dist/common/config-module.d.ts +5 -1
- package/dist/common/config-module.d.ts.map +1 -1
- package/dist/dal/repository-service.d.ts +2 -2
- package/dist/dal/repository-service.d.ts.map +1 -1
- package/dist/dml/index.d.ts +8 -0
- package/dist/dml/index.d.ts.map +1 -1
- package/dist/event-bus/common.d.ts +24 -0
- package/dist/event-bus/common.d.ts.map +1 -1
- package/dist/event-bus/event-bus-module.d.ts +58 -0
- package/dist/event-bus/event-bus-module.d.ts.map +1 -1
- package/dist/file/common.d.ts +3 -2
- package/dist/file/common.d.ts.map +1 -1
- package/dist/file/mutations.d.ts +5 -2
- package/dist/file/mutations.d.ts.map +1 -1
- package/dist/file/provider.d.ts +9 -3
- package/dist/file/provider.d.ts.map +1 -1
- package/dist/file/service.d.ts +10 -9
- package/dist/file/service.d.ts.map +1 -1
- package/dist/fulfillment/common/order.d.ts +2 -72
- package/dist/fulfillment/common/order.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-option.d.ts +23 -2
- package/dist/fulfillment/mutations/shipping-option.d.ts.map +1 -1
- package/dist/fulfillment/mutations/shipping-profile.d.ts +1 -1
- package/dist/fulfillment/mutations/shipping-profile.d.ts.map +1 -1
- package/dist/fulfillment/service.d.ts +3 -0
- package/dist/fulfillment/service.d.ts.map +1 -1
- package/dist/http/auth/payloads.d.ts +3 -0
- package/dist/http/auth/payloads.d.ts.map +1 -1
- package/dist/http/common/request.d.ts +2 -2
- package/dist/http/common/response.d.ts +21 -0
- package/dist/http/common/response.d.ts.map +1 -1
- package/dist/http/draft-order/admin/entities.d.ts +6 -0
- package/dist/http/draft-order/admin/entities.d.ts.map +1 -0
- package/dist/http/draft-order/admin/entities.js +3 -0
- package/dist/http/draft-order/admin/entities.js.map +1 -0
- package/dist/http/draft-order/admin/index.d.ts +5 -0
- package/dist/http/draft-order/admin/index.d.ts.map +1 -0
- package/dist/http/draft-order/admin/index.js +21 -0
- package/dist/http/draft-order/admin/index.js.map +1 -0
- package/dist/http/draft-order/admin/payloads.d.ts +243 -0
- package/dist/http/draft-order/admin/payloads.d.ts.map +1 -0
- package/dist/http/draft-order/admin/payloads.js +3 -0
- package/dist/http/draft-order/admin/payloads.js.map +1 -0
- package/dist/http/draft-order/admin/queries.d.ts +35 -0
- package/dist/http/draft-order/admin/queries.d.ts.map +1 -0
- package/dist/http/draft-order/admin/queries.js +3 -0
- package/dist/http/draft-order/admin/queries.js.map +1 -0
- package/dist/http/draft-order/admin/responses.d.ts +13 -0
- package/dist/http/draft-order/admin/responses.d.ts.map +1 -0
- package/dist/http/draft-order/admin/responses.js +3 -0
- package/dist/http/draft-order/admin/responses.js.map +1 -0
- package/dist/http/draft-order/index.d.ts +2 -0
- package/dist/http/draft-order/index.d.ts.map +1 -0
- package/dist/http/draft-order/index.js +18 -0
- package/dist/http/draft-order/index.js.map +1 -0
- package/dist/http/file/admin/responses.d.ts +6 -0
- package/dist/http/file/admin/responses.d.ts.map +1 -1
- package/dist/http/file/common.d.ts +17 -0
- package/dist/http/file/common.d.ts.map +1 -1
- package/dist/http/fulfillment/store/index.d.ts +4 -0
- package/dist/http/fulfillment/store/index.d.ts.map +1 -1
- package/dist/http/fulfillment-provider/admin/responses.d.ts +3 -0
- package/dist/http/fulfillment-provider/admin/responses.d.ts.map +1 -1
- package/dist/http/index.d.ts +2 -0
- package/dist/http/index.d.ts.map +1 -1
- package/dist/http/index.js +2 -0
- package/dist/http/index.js.map +1 -1
- package/dist/http/inventory-level/admin/payloads.d.ts +0 -16
- package/dist/http/inventory-level/admin/payloads.d.ts.map +1 -1
- package/dist/http/order/admin/entities.d.ts +10 -1
- package/dist/http/order/admin/entities.d.ts.map +1 -1
- package/dist/http/order/admin/queries.d.ts +0 -9
- package/dist/http/order/admin/queries.d.ts.map +1 -1
- package/dist/http/order/admin/responses.d.ts +0 -6
- package/dist/http/order/admin/responses.d.ts.map +1 -1
- package/dist/http/order/common.d.ts +6 -39
- package/dist/http/order/common.d.ts.map +1 -1
- package/dist/http/payment/admin/queries.d.ts +6 -0
- package/dist/http/payment/admin/queries.d.ts.map +1 -1
- package/dist/http/payment/admin/responses.d.ts +3 -0
- package/dist/http/payment/admin/responses.d.ts.map +1 -1
- package/dist/http/plugins/admin/responses.d.ts +10 -0
- package/dist/http/plugins/admin/responses.d.ts.map +1 -0
- package/dist/http/plugins/admin/responses.js +3 -0
- package/dist/http/plugins/admin/responses.js.map +1 -0
- package/dist/http/plugins/index.d.ts +2 -0
- package/dist/http/plugins/index.d.ts.map +1 -0
- package/dist/http/plugins/index.js +18 -0
- package/dist/http/plugins/index.js.map +1 -0
- package/dist/http/pricing/common.d.ts +8 -0
- package/dist/http/pricing/common.d.ts.map +1 -1
- package/dist/http/product/admin/payloads.d.ts +2 -2
- package/dist/http/product/admin/payloads.d.ts.map +1 -1
- package/dist/http/promotion/admin/entities.d.ts +20 -0
- package/dist/http/promotion/admin/entities.d.ts.map +1 -1
- package/dist/http/promotion/admin/payloads.d.ts +156 -0
- package/dist/http/promotion/admin/payloads.d.ts.map +1 -1
- package/dist/http/promotion/admin/queries.d.ts +45 -1
- package/dist/http/promotion/admin/queries.d.ts.map +1 -1
- package/dist/http/promotion/admin/responses.d.ts +17 -2
- package/dist/http/promotion/admin/responses.d.ts.map +1 -1
- package/dist/http/promotion/common.d.ts +53 -0
- package/dist/http/promotion/common.d.ts.map +1 -1
- package/dist/http/region/admin/entities.d.ts +3 -0
- package/dist/http/region/admin/entities.d.ts.map +1 -1
- package/dist/http/region/admin/payloads.d.ts +68 -0
- package/dist/http/region/admin/payloads.d.ts.map +1 -1
- package/dist/http/region/admin/queries.d.ts +21 -0
- package/dist/http/region/admin/queries.d.ts.map +1 -1
- package/dist/http/region/admin/responses.d.ts +6 -0
- package/dist/http/region/admin/responses.d.ts.map +1 -1
- package/dist/http/reservation/admin/entities.d.ts +39 -0
- package/dist/http/reservation/admin/entities.d.ts.map +1 -1
- package/dist/http/reservation/admin/payloads.d.ts +32 -0
- package/dist/http/reservation/admin/payloads.d.ts.map +1 -1
- package/dist/http/reservation/admin/queries.d.ts +34 -0
- package/dist/http/reservation/admin/queries.d.ts.map +1 -1
- package/dist/http/reservation/admin/responses.d.ts +6 -0
- package/dist/http/reservation/admin/responses.d.ts.map +1 -1
- package/dist/http/return/admin/entities.d.ts +3 -0
- package/dist/http/return/admin/entities.d.ts.map +1 -1
- package/dist/http/return/admin/payloads.d.ts +154 -0
- package/dist/http/return/admin/payloads.d.ts.map +1 -1
- package/dist/http/return/admin/queries.d.ts +15 -0
- package/dist/http/return/admin/queries.d.ts.map +1 -1
- package/dist/http/return/admin/responses.d.ts +6 -0
- package/dist/http/return/admin/responses.d.ts.map +1 -1
- package/dist/http/return/common.d.ts +73 -0
- package/dist/http/return/common.d.ts.map +1 -1
- package/dist/http/return-reason/admin/payloads.d.ts +21 -0
- package/dist/http/return-reason/admin/payloads.d.ts.map +1 -1
- package/dist/http/return-reason/admin/queries.d.ts +3 -0
- package/dist/http/return-reason/admin/queries.d.ts.map +1 -1
- package/dist/http/return-reason/admin/responses.d.ts +6 -0
- package/dist/http/return-reason/admin/responses.d.ts.map +1 -1
- package/dist/http/return-reason/common.d.ts +27 -0
- package/dist/http/return-reason/common.d.ts.map +1 -1
- package/dist/http/sales-channel/admin/entities.d.ts +24 -0
- package/dist/http/sales-channel/admin/entities.d.ts.map +1 -1
- package/dist/http/sales-channel/admin/payloads.d.ts +32 -0
- package/dist/http/sales-channel/admin/payloads.d.ts.map +1 -1
- package/dist/http/sales-channel/admin/queries.d.ts +32 -0
- package/dist/http/sales-channel/admin/queries.d.ts.map +1 -1
- package/dist/http/sales-channel/admin/responses.d.ts +6 -0
- package/dist/http/sales-channel/admin/responses.d.ts.map +1 -1
- package/dist/http/shipping-option/admin/entities.d.ts +187 -0
- package/dist/http/shipping-option/admin/entities.d.ts.map +1 -1
- package/dist/http/shipping-option/admin/payloads.d.ts +181 -0
- package/dist/http/shipping-option/admin/payloads.d.ts.map +1 -1
- package/dist/http/shipping-option/admin/queries.d.ts +36 -0
- package/dist/http/shipping-option/admin/queries.d.ts.map +1 -1
- package/dist/http/shipping-option/admin/responses.d.ts +6 -0
- package/dist/http/shipping-option/admin/responses.d.ts.map +1 -1
- package/dist/http/shipping-option/store/payloads.d.ts +12 -0
- package/dist/http/shipping-option/store/payloads.d.ts.map +1 -1
- package/dist/http/shipping-option/store/responses.d.ts +12 -0
- package/dist/http/shipping-option/store/responses.d.ts.map +1 -1
- package/dist/http/shipping-profile/admin/entities.d.ts +21 -0
- package/dist/http/shipping-profile/admin/entities.d.ts.map +1 -1
- package/dist/http/shipping-profile/admin/payloads.d.ts +18 -0
- package/dist/http/shipping-profile/admin/payloads.d.ts.map +1 -1
- package/dist/http/shipping-profile/admin/queries.d.ts +27 -0
- package/dist/http/shipping-profile/admin/queries.d.ts.map +1 -1
- package/dist/http/shipping-profile/admin/responses.d.ts +6 -0
- package/dist/http/shipping-profile/admin/responses.d.ts.map +1 -1
- package/dist/http/stock-locations/admin/entities.d.ts +21 -0
- package/dist/http/stock-locations/admin/entities.d.ts.map +1 -1
- package/dist/http/stock-locations/admin/payloads.d.ts +69 -0
- package/dist/http/stock-locations/admin/payloads.d.ts.map +1 -1
- package/dist/http/stock-locations/admin/queries.d.ts +24 -2
- package/dist/http/stock-locations/admin/queries.d.ts.map +1 -1
- package/dist/http/stock-locations/admin/responses.d.ts +6 -0
- package/dist/http/stock-locations/admin/responses.d.ts.map +1 -1
- package/dist/http/store/admin/entities.d.ts +54 -0
- package/dist/http/store/admin/entities.d.ts.map +1 -1
- package/dist/http/store/admin/queries.d.ts +9 -0
- package/dist/http/store/admin/queries.d.ts.map +1 -1
- package/dist/http/store/admin/responses.d.ts +6 -0
- package/dist/http/store/admin/responses.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/entities.d.ts +54 -0
- package/dist/http/tax-rate/admin/entities.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/payloads.d.ts +57 -0
- package/dist/http/tax-rate/admin/payloads.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/queries.d.ts +30 -0
- package/dist/http/tax-rate/admin/queries.d.ts.map +1 -1
- package/dist/http/tax-rate/admin/responses.d.ts +6 -0
- package/dist/http/tax-rate/admin/responses.d.ts.map +1 -1
- package/dist/http/tax-region/admin/entities.d.ts +42 -0
- package/dist/http/tax-region/admin/entities.d.ts.map +1 -1
- package/dist/http/tax-region/admin/payloads.d.ts +30 -0
- package/dist/http/tax-region/admin/payloads.d.ts.map +1 -1
- package/dist/http/tax-region/admin/queries.d.ts +28 -0
- package/dist/http/tax-region/admin/queries.d.ts.map +1 -1
- package/dist/http/tax-region/admin/responses.d.ts +6 -0
- package/dist/http/tax-region/admin/responses.d.ts.map +1 -1
- package/dist/http/user/admin/entities.d.ts +27 -0
- package/dist/http/user/admin/entities.d.ts.map +1 -1
- package/dist/http/user/admin/payloads.d.ts +12 -0
- package/dist/http/user/admin/payloads.d.ts.map +1 -1
- package/dist/http/user/admin/queries.d.ts +24 -0
- package/dist/http/user/admin/queries.d.ts.map +1 -1
- package/dist/http/user/admin/responses.d.ts +6 -0
- package/dist/http/user/admin/responses.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/entities.d.ts +136 -2
- package/dist/http/workflow-execution/admin/entities.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/queries.d.ts +6 -0
- package/dist/http/workflow-execution/admin/queries.d.ts.map +1 -1
- package/dist/http/workflow-execution/admin/responses.d.ts +6 -0
- package/dist/http/workflow-execution/admin/responses.d.ts.map +1 -1
- package/dist/index-data/query-config/query-input-config.d.ts +1 -1
- package/dist/index-data/query-config/query-input-config.d.ts.map +1 -1
- package/dist/locking/index.d.ts +466 -0
- package/dist/locking/index.d.ts.map +1 -1
- package/dist/modules-sdk/index.d.ts +6 -1
- package/dist/modules-sdk/index.d.ts.map +1 -1
- package/dist/modules-sdk/medusa-internal-service.d.ts +5 -5
- package/dist/modules-sdk/medusa-internal-service.d.ts.map +1 -1
- package/dist/modules-sdk/remote-query-object-from-string.d.ts +4 -0
- package/dist/modules-sdk/remote-query-object-from-string.d.ts.map +1 -1
- package/dist/modules-sdk/remote-query.d.ts +16 -0
- package/dist/modules-sdk/remote-query.d.ts.map +1 -1
- package/dist/notification/mutations.d.ts +5 -4
- package/dist/notification/mutations.d.ts.map +1 -1
- package/dist/notification/service.d.ts +2 -5
- package/dist/notification/service.d.ts.map +1 -1
- package/dist/order/common.d.ts +45 -79
- package/dist/order/common.d.ts.map +1 -1
- package/dist/order/mutations.d.ts +38 -1
- package/dist/order/mutations.d.ts.map +1 -1
- package/dist/order/service.d.ts +101 -3
- package/dist/order/service.d.ts.map +1 -1
- package/dist/payment/common.d.ts +9 -1
- package/dist/payment/common.d.ts.map +1 -1
- package/dist/payment/mutations.d.ts +24 -1
- package/dist/payment/mutations.d.ts.map +1 -1
- package/dist/payment/provider.d.ts +121 -85
- package/dist/payment/provider.d.ts.map +1 -1
- package/dist/payment/service.d.ts +89 -10
- package/dist/payment/service.d.ts.map +1 -1
- package/dist/product/common.d.ts +11 -6
- package/dist/product/common.d.ts.map +1 -1
- package/dist/tax/provider.d.ts +9 -37
- package/dist/tax/provider.d.ts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/workflow/order/items.d.ts +5 -1
- package/dist/workflow/order/items.d.ts.map +1 -1
- package/dist/workflow/product-category/index.d.ts +5 -4
- package/dist/workflow/product-category/index.d.ts.map +1 -1
- package/dist/workflows/products/mutations.d.ts +2 -2
- package/dist/workflows/products/mutations.d.ts.map +1 -1
- package/dist/workflows-sdk/service.d.ts +12 -8
- package/dist/workflows-sdk/service.d.ts.map +1 -1
- package/package.json +3 -3
@@ -63,6 +63,10 @@ export type PaymentProviderContext = {
|
|
63
63
|
* The customer information from Medusa.
|
64
64
|
*/
|
65
65
|
customer?: PaymentCustomerDTO;
|
66
|
+
/**
|
67
|
+
* Idempotency key for the request, if the payment provider supports it. It will be ignored otherwise.
|
68
|
+
*/
|
69
|
+
idempotency_key?: string;
|
66
70
|
};
|
67
71
|
export type PaymentProviderInput = {
|
68
72
|
/**
|
@@ -75,12 +79,10 @@ export type PaymentProviderInput = {
|
|
75
79
|
context?: PaymentProviderContext;
|
76
80
|
};
|
77
81
|
/**
|
78
|
-
* @interface
|
79
|
-
*
|
80
82
|
* The data used initiate a payment in a provider when a payment
|
81
83
|
* session is created.
|
82
84
|
*/
|
83
|
-
export
|
85
|
+
export interface InitiatePaymentInput extends PaymentProviderInput {
|
84
86
|
/**
|
85
87
|
* The amount to be authorized.
|
86
88
|
*/
|
@@ -89,13 +91,11 @@ export type InitiatePaymentInput = PaymentProviderInput & {
|
|
89
91
|
* The ISO 3 character currency code.
|
90
92
|
*/
|
91
93
|
currency_code: string;
|
92
|
-
}
|
94
|
+
}
|
93
95
|
/**
|
94
|
-
* @interface
|
95
|
-
*
|
96
96
|
* The attributes to update a payment related to a payment session in a provider.
|
97
97
|
*/
|
98
|
-
export
|
98
|
+
export interface UpdatePaymentInput extends PaymentProviderInput {
|
99
99
|
/**
|
100
100
|
* The payment session's amount.
|
101
101
|
*/
|
@@ -104,54 +104,45 @@ export type UpdatePaymentInput = PaymentProviderInput & {
|
|
104
104
|
* The ISO 3 character code of the payment session.
|
105
105
|
*/
|
106
106
|
currency_code: string;
|
107
|
-
}
|
107
|
+
}
|
108
108
|
/**
|
109
|
-
* @interface
|
110
|
-
*
|
111
109
|
* The data to delete a payment.
|
112
110
|
*/
|
113
|
-
export
|
111
|
+
export interface DeletePaymentInput extends PaymentProviderInput {
|
112
|
+
}
|
114
113
|
/**
|
115
|
-
* @interface
|
116
|
-
*
|
117
114
|
* The data to authorize a payment.
|
118
115
|
*/
|
119
|
-
export
|
116
|
+
export interface AuthorizePaymentInput extends PaymentProviderInput {
|
117
|
+
}
|
120
118
|
/**
|
121
|
-
* @interface
|
122
|
-
*
|
123
119
|
* The data to capture a payment.
|
124
120
|
*/
|
125
|
-
export
|
121
|
+
export interface CapturePaymentInput extends PaymentProviderInput {
|
122
|
+
}
|
126
123
|
/**
|
127
|
-
* @interface
|
128
|
-
*
|
129
124
|
* The data to refund a payment.
|
130
125
|
*/
|
131
|
-
export
|
126
|
+
export interface RefundPaymentInput extends PaymentProviderInput {
|
132
127
|
/**
|
133
128
|
* The amount to refund.
|
134
129
|
*/
|
135
130
|
amount: BigNumberInput;
|
136
|
-
}
|
131
|
+
}
|
137
132
|
/**
|
138
|
-
* @interface
|
139
|
-
*
|
140
133
|
* The data to retrieve a payment.
|
141
134
|
*/
|
142
|
-
export
|
135
|
+
export interface RetrievePaymentInput extends PaymentProviderInput {
|
136
|
+
}
|
143
137
|
/**
|
144
|
-
* @interface
|
145
|
-
*
|
146
138
|
* The data to cancel a payment.
|
147
139
|
*/
|
148
|
-
export
|
140
|
+
export interface CancelPaymentInput extends PaymentProviderInput {
|
141
|
+
}
|
149
142
|
/**
|
150
|
-
* @interface
|
151
|
-
*
|
152
143
|
* The data to create an account holder.
|
153
144
|
*/
|
154
|
-
export
|
145
|
+
export interface CreateAccountHolderInput extends PaymentProviderInput {
|
155
146
|
/**
|
156
147
|
* The context of creating the account holder.
|
157
148
|
*/
|
@@ -161,13 +152,22 @@ export type CreateAccountHolderInput = PaymentProviderInput & {
|
|
161
152
|
*/
|
162
153
|
customer: PaymentCustomerDTO;
|
163
154
|
};
|
164
|
-
}
|
155
|
+
}
|
156
|
+
export interface UpdateAccountHolderInput extends PaymentProviderInput {
|
157
|
+
/**
|
158
|
+
* The context of updating the account holder.
|
159
|
+
*/
|
160
|
+
context: PaymentProviderContext & {
|
161
|
+
/**
|
162
|
+
* The account holder's details.
|
163
|
+
*/
|
164
|
+
account_holder: PaymentAccountHolderDTO;
|
165
|
+
};
|
166
|
+
}
|
165
167
|
/**
|
166
|
-
* @interface
|
167
|
-
*
|
168
168
|
* The data to delete an account holder.
|
169
169
|
*/
|
170
|
-
export
|
170
|
+
export interface DeleteAccountHolderInput extends Omit<PaymentProviderInput, "context"> {
|
171
171
|
/**
|
172
172
|
* The context of deleting the account holder.
|
173
173
|
*/
|
@@ -177,25 +177,22 @@ export type DeleteAccountHolderInput = PaymentProviderInput & {
|
|
177
177
|
*/
|
178
178
|
account_holder: Partial<AccountHolderDTO>;
|
179
179
|
};
|
180
|
-
}
|
180
|
+
}
|
181
181
|
/**
|
182
|
-
* @interface
|
183
|
-
*
|
184
182
|
* The data to list payment methods.
|
185
183
|
*/
|
186
|
-
export
|
184
|
+
export interface ListPaymentMethodsInput extends PaymentProviderInput {
|
185
|
+
}
|
187
186
|
/**
|
188
|
-
* @interface
|
189
|
-
*
|
190
187
|
* The data to save a payment method.
|
191
188
|
*/
|
192
|
-
export
|
189
|
+
export interface SavePaymentMethodInput extends PaymentProviderInput {
|
190
|
+
}
|
193
191
|
/**
|
194
|
-
* @interface
|
195
|
-
*
|
196
192
|
* The data to get the payment status.
|
197
193
|
*/
|
198
|
-
export
|
194
|
+
export interface GetPaymentStatusInput extends PaymentProviderInput {
|
195
|
+
}
|
199
196
|
/**
|
200
197
|
* @interface
|
201
198
|
*
|
@@ -208,105 +205,103 @@ export type PaymentProviderOutput = {
|
|
208
205
|
data?: Record<string, unknown>;
|
209
206
|
};
|
210
207
|
/**
|
211
|
-
* @interface
|
212
|
-
*
|
213
208
|
* The successful result of initiating a payment session using a third-party payment provider.
|
214
209
|
*/
|
215
|
-
export
|
210
|
+
export interface InitiatePaymentOutput extends PaymentProviderOutput {
|
216
211
|
/**
|
217
212
|
* The ID of the payment session in the payment provider.
|
218
213
|
*/
|
219
214
|
id: string;
|
220
|
-
}
|
215
|
+
}
|
221
216
|
/**
|
222
|
-
* @interface
|
223
|
-
*
|
224
217
|
* The successful result of authorizing a payment session using a payment provider.
|
225
218
|
*/
|
226
|
-
export
|
219
|
+
export interface AuthorizePaymentOutput extends PaymentProviderOutput {
|
227
220
|
/**
|
228
221
|
* The status of the payment, which will be stored in the payment session's `status` field.
|
229
222
|
*/
|
230
223
|
status: PaymentSessionStatus;
|
231
|
-
}
|
224
|
+
}
|
232
225
|
/**
|
233
|
-
* @interface
|
234
|
-
*
|
235
226
|
* The result of updating a payment.
|
236
227
|
*/
|
237
|
-
export
|
228
|
+
export interface UpdatePaymentOutput extends PaymentProviderOutput {
|
229
|
+
}
|
238
230
|
/**
|
239
|
-
* @interface
|
240
|
-
*
|
241
231
|
* The result of deleting a payment.
|
242
232
|
*/
|
243
|
-
export
|
233
|
+
export interface DeletePaymentOutput extends PaymentProviderOutput {
|
234
|
+
}
|
244
235
|
/**
|
245
|
-
* @interface
|
246
|
-
*
|
247
236
|
* The result of capturing the payment.
|
248
237
|
*/
|
249
|
-
export
|
238
|
+
export interface CapturePaymentOutput extends PaymentProviderOutput {
|
239
|
+
}
|
250
240
|
/**
|
251
|
-
* @interface
|
252
|
-
*
|
253
241
|
* The result of refunding the payment.
|
254
242
|
*/
|
255
|
-
export
|
243
|
+
export interface RefundPaymentOutput extends PaymentProviderOutput {
|
244
|
+
}
|
256
245
|
/**
|
257
|
-
* @interface
|
258
|
-
*
|
259
246
|
* The result of retrieving the payment.
|
260
247
|
*/
|
261
|
-
export
|
248
|
+
export interface RetrievePaymentOutput extends PaymentProviderOutput {
|
249
|
+
}
|
262
250
|
/**
|
263
|
-
* @interface
|
264
|
-
*
|
265
251
|
* The result of canceling the payment.
|
266
252
|
*/
|
267
|
-
export
|
253
|
+
export interface CancelPaymentOutput extends PaymentProviderOutput {
|
254
|
+
}
|
268
255
|
/**
|
269
|
-
* @interface
|
270
|
-
*
|
271
256
|
* The result of creating an account holder in the third-party payment provider. The `data`
|
272
257
|
* property is stored as-is in Medusa's account holder's `data` property.
|
273
258
|
*/
|
274
|
-
export
|
259
|
+
export interface CreateAccountHolderOutput extends PaymentProviderOutput {
|
275
260
|
/**
|
276
261
|
* The ID of the account holder in the payment provider.
|
277
262
|
* This is stored in Medusa's account holder in the `external_id` property.
|
278
263
|
*/
|
279
264
|
id: string;
|
280
|
-
}
|
281
|
-
|
282
|
-
|
265
|
+
}
|
266
|
+
/**
|
267
|
+
* The result of updating an account holder in the third-party payment provider. The `data`
|
268
|
+
* property is stored as-is in Medusa's account holder's `data` property.
|
269
|
+
*/
|
270
|
+
export interface UpdateAccountHolderOutput extends PaymentProviderOutput {
|
271
|
+
}
|
272
|
+
/**
|
273
|
+
* The result of deleting an account holder in the third-party payment provider.
|
274
|
+
*/
|
275
|
+
export interface DeleteAccountHolderOutput extends PaymentProviderOutput {
|
276
|
+
}
|
277
|
+
/**
|
278
|
+
* The result of listing payment methods for an account holder in the third-party payment provider.
|
279
|
+
*/
|
280
|
+
export interface ListPaymentMethodsOutput extends Array<PaymentProviderOutput & {
|
283
281
|
/**
|
284
282
|
* The ID of the payment method in the payment provider.
|
285
283
|
*/
|
286
284
|
id: string;
|
287
|
-
}
|
285
|
+
}> {
|
286
|
+
}
|
288
287
|
/**
|
289
|
-
* @interface
|
290
|
-
*
|
291
288
|
* The result of saving a payment method.
|
292
289
|
*/
|
293
|
-
export
|
290
|
+
export interface SavePaymentMethodOutput extends PaymentProviderOutput {
|
294
291
|
/**
|
295
292
|
* The ID of the payment method in the payment provider.
|
296
293
|
*/
|
297
294
|
id: string;
|
298
|
-
}
|
295
|
+
}
|
299
296
|
/**
|
300
|
-
* @interface
|
301
|
-
*
|
302
297
|
* The result of getting the payment status.
|
303
298
|
*/
|
304
|
-
export
|
299
|
+
export interface GetPaymentStatusOutput extends PaymentProviderOutput {
|
305
300
|
/**
|
306
301
|
* The status of the payment, which will be stored in the payment session's `status` field.
|
307
302
|
*/
|
308
303
|
status: PaymentSessionStatus;
|
309
|
-
}
|
304
|
+
}
|
310
305
|
/**
|
311
306
|
* @interface
|
312
307
|
*
|
@@ -401,6 +396,47 @@ export interface IPaymentProvider {
|
|
401
396
|
* }
|
402
397
|
*/
|
403
398
|
createAccountHolder?(data: CreateAccountHolderInput): Promise<CreateAccountHolderOutput>;
|
399
|
+
/**
|
400
|
+
* This method is used when updating an account holder in Medusa, allowing you to update
|
401
|
+
* the equivalent account in the third-party service.
|
402
|
+
*
|
403
|
+
* The returned data will be stored in the account holder created in Medusa. For example,
|
404
|
+
* the returned `id` property will be stored in the account holder's `external_id` property.
|
405
|
+
*
|
406
|
+
* @param data - Input data including the details of the account holder to update.
|
407
|
+
* @returns The result of updating the account holder. If an error occurs, throw it.
|
408
|
+
*
|
409
|
+
* @version 2.5.1
|
410
|
+
*
|
411
|
+
* @example
|
412
|
+
* import { MedusaError } from "@medusajs/framework/utils"
|
413
|
+
*
|
414
|
+
* class MyPaymentProviderService extends AbstractPaymentProvider<
|
415
|
+
* Options
|
416
|
+
* > {
|
417
|
+
* async updateAccountHolder({ context, data }: UpdateAccountHolderInput) {
|
418
|
+
* const { account_holder, customer } = context
|
419
|
+
*
|
420
|
+
* if (!account_holder?.data?.id) {
|
421
|
+
* throw new MedusaError(
|
422
|
+
* MedusaError.Types.INVALID_DATA,
|
423
|
+
* "Missing account holder ID."
|
424
|
+
* )
|
425
|
+
* }
|
426
|
+
*
|
427
|
+
* // assuming you have a client that updates the account holder
|
428
|
+
* const providerAccountHolder = await this.client.updateAccountHolder({
|
429
|
+
* id: account_holder.data.id,
|
430
|
+
* ...data
|
431
|
+
* })
|
432
|
+
*
|
433
|
+
* return {
|
434
|
+
* id: providerAccountHolder.id,
|
435
|
+
* data: providerAccountHolder as unknown as Record<string, unknown>
|
436
|
+
* }
|
437
|
+
* }
|
438
|
+
*/
|
439
|
+
updateAccountHolder?(data: UpdateAccountHolderInput): Promise<UpdateAccountHolderOutput>;
|
404
440
|
/**
|
405
441
|
* This method is used when an account holder is deleted in Medusa, allowing you
|
406
442
|
* to also delete the equivalent account holder in the third-party service.
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,eAAe,GACf,UAAU,GACV,eAAe,CAAA;AAEnB;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAA;
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,SAAS,GACT,eAAe,GACf,UAAU,GACV,eAAe,CAAA;AAEnB;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAA;IAE7B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;CAAG;AAEnE;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,oBAAoB;CAAG;AAEpE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;CAAG;AAErE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;CAAG;AAEnE;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC,sBAAsB,EAAE,UAAU,CAAC,GAAG;QAClD;;WAEG;QACH,QAAQ,EAAE,kBAAkB,CAAA;KAC7B,CAAA;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;OAEG;IACH,OAAO,EAAE,sBAAsB,GAAG;QAChC;;WAEG;QACH,cAAc,EAAE,uBAAuB,CAAA;KACxC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;IACrF;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,GAAG;QACxD;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;KAC1C,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;CAAG;AAExE;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;CAAG;AAEvE;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;CAAG;AAEtE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;CAAG;AAEvE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;CAAG;AAErE;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;CAAG;AAE3E;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;CAAG;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,KAAK,CAAC,qBAAqB,GAAG;IAC9E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAC;CAAG;AAEL;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;CACzB,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB,eAAe,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAE3E,aAAa,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAErE,aAAa,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAErE,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAE9E,cAAc,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAExE,aAAa,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAErE,eAAe,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAE3E,aAAa,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,mBAAmB,CAAC,CAClB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,mBAAmB,CAAC,CAClB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,mBAAmB,CAAC,CAClB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,kBAAkB,CAAC,CACjB,IAAI,EAAE,uBAAuB,GAC5B,OAAO,CAAC,wBAAwB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,iBAAiB,CAAC,CAChB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,uBAAuB,CAAC,CAAA;IAEnC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAE9E,uBAAuB,CACrB,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAChC"}
|
@@ -3,7 +3,7 @@ import { RestoreReturn, SoftDeleteReturn } from "../dal";
|
|
3
3
|
import { IModuleService } from "../modules-sdk";
|
4
4
|
import { Context } from "../shared-context";
|
5
5
|
import { AccountHolderDTO, CaptureDTO, FilterableCaptureProps, FilterablePaymentCollectionProps, FilterablePaymentMethodProps, FilterablePaymentProps, FilterablePaymentProviderProps, FilterablePaymentSessionProps, FilterableRefundProps, FilterableRefundReasonProps, PaymentCollectionDTO, PaymentDTO, PaymentMethodDTO, PaymentProviderDTO, PaymentSessionDTO, RefundDTO, RefundReasonDTO } from "./common";
|
6
|
-
import { CreateCaptureDTO, CreatePaymentCollectionDTO, CreatePaymentSessionDTO, CreateRefundDTO, CreateRefundReasonDTO, PaymentCollectionUpdatableFields, ProviderWebhookPayload, UpdatePaymentDTO, UpdatePaymentSessionDTO, UpdateRefundReasonDTO, CreateAccountHolderDTO, UpsertPaymentCollectionDTO, CreatePaymentMethodDTO } from "./mutations";
|
6
|
+
import { CreateCaptureDTO, CreatePaymentCollectionDTO, CreatePaymentSessionDTO, CreateRefundDTO, CreateRefundReasonDTO, PaymentCollectionUpdatableFields, ProviderWebhookPayload, UpdatePaymentDTO, UpdatePaymentSessionDTO, UpdateRefundReasonDTO, CreateAccountHolderDTO, UpsertPaymentCollectionDTO, CreatePaymentMethodDTO, UpdateAccountHolderDTO } from "./mutations";
|
7
7
|
import { WebhookActionResult } from "./provider";
|
8
8
|
/**
|
9
9
|
* The main service interface for the Payment Module.
|
@@ -55,7 +55,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
55
55
|
* @returns {Promise<PaymentCollectionDTO>} The retrieved payment collection.
|
56
56
|
*
|
57
57
|
* @example
|
58
|
-
* A simple example that retrieves a
|
58
|
+
* A simple example that retrieves a payment collection by its ID:
|
59
59
|
*
|
60
60
|
* ```ts
|
61
61
|
* const paymentCollection =
|
@@ -141,7 +141,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
141
141
|
* @returns {Promise<[PaymentCollectionDTO[], number]>} The list of payment collections along with their total count.
|
142
142
|
*
|
143
143
|
* @example
|
144
|
-
* To retrieve a list of
|
144
|
+
* To retrieve a list of payment collection using their IDs:
|
145
145
|
*
|
146
146
|
* ```ts
|
147
147
|
* const paymentCollections =
|
@@ -150,7 +150,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
150
150
|
* })
|
151
151
|
* ```
|
152
152
|
*
|
153
|
-
* To specify relations that should be retrieved within the
|
153
|
+
* To specify relations that should be retrieved within the payment collection:
|
154
154
|
*
|
155
155
|
* ```ts
|
156
156
|
* const paymentCollections =
|
@@ -164,7 +164,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
164
164
|
* )
|
165
165
|
* ```
|
166
166
|
*
|
167
|
-
* By default, only the first `
|
167
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
168
168
|
*
|
169
169
|
* ```ts
|
170
170
|
* const paymentCollections =
|
@@ -341,6 +341,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
341
341
|
*/
|
342
342
|
completePaymentCollections(paymentCollectionId: string[], sharedContext?: Context): Promise<PaymentCollectionDTO[]>;
|
343
343
|
retrievePaymentSession(paymentSessionId: string, config?: FindConfig<PaymentSessionDTO>, sharedContext?: Context): Promise<PaymentSessionDTO>;
|
344
|
+
retrievePayment(paymentId: string, config?: FindConfig<PaymentDTO>, sharedContext?: Context): Promise<PaymentDTO>;
|
344
345
|
/**
|
345
346
|
* This method creates a payment session in a payment collection.
|
346
347
|
*
|
@@ -594,13 +595,64 @@ export interface IPaymentModuleService extends IModuleService {
|
|
594
595
|
* ```
|
595
596
|
*/
|
596
597
|
listPaymentProviders(filters?: FilterablePaymentProviderProps, config?: FindConfig<PaymentProviderDTO>, sharedContext?: Context): Promise<PaymentProviderDTO[]>;
|
598
|
+
/**
|
599
|
+
* This method retrieves a paginated list of payment providers along with the total count of available payment providers satisfying the provided filters.
|
600
|
+
*
|
601
|
+
* @param {FilterablePaymentProviderProps} filters - The filters to apply on the retrieved payment provider.
|
602
|
+
* @param {FindConfig<PaymentProviderDTO>} config - The configurations determining how the payment provider is retrieved. Its properties, such as `select` or `relations`, accept the
|
603
|
+
* attributes or relations associated with a payment provider.
|
604
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
605
|
+
* @returns {Promise<[PaymentProviderDTO[], number]>} The list of payment providers along with their total count.
|
606
|
+
*
|
607
|
+
* @example
|
608
|
+
* To retrieve a list of payment providers using their IDs:
|
609
|
+
*
|
610
|
+
* ```ts
|
611
|
+
* const [paymentProviders, count] =
|
612
|
+
* await paymentModuleService.listAndCountPaymentProviders({
|
613
|
+
* id: ["pp_stripe_stripe"],
|
614
|
+
* })
|
615
|
+
* ```
|
616
|
+
*
|
617
|
+
* To specify relations that should be retrieved within the payment providers:
|
618
|
+
*
|
619
|
+
* ```ts
|
620
|
+
* const [paymentProviders, count] =
|
621
|
+
* await paymentModuleService.listAndCountPaymentProviders(
|
622
|
+
* {
|
623
|
+
* id: ["pp_stripe_stripe"],
|
624
|
+
* },
|
625
|
+
* {
|
626
|
+
* relations: ["payment_collections"],
|
627
|
+
* }
|
628
|
+
* )
|
629
|
+
* ```
|
630
|
+
*
|
631
|
+
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
632
|
+
*
|
633
|
+
* ```ts
|
634
|
+
* const [paymentProviders, count] =
|
635
|
+
* await paymentModuleService.listAndCountPaymentProviders(
|
636
|
+
* {
|
637
|
+
* id: ["pp_stripe_stripe"],
|
638
|
+
* },
|
639
|
+
* {
|
640
|
+
* relations: ["payment_collections"],
|
641
|
+
* take: 20,
|
642
|
+
* skip: 2,
|
643
|
+
* }
|
644
|
+
* )
|
645
|
+
* ```
|
646
|
+
*
|
647
|
+
*
|
648
|
+
*/
|
597
649
|
listAndCountPaymentProviders(filters?: FilterablePaymentProviderProps, config?: FindConfig<PaymentProviderDTO>, sharedContext?: Context): Promise<[PaymentProviderDTO[], number]>;
|
598
650
|
/**
|
599
|
-
* This method creates
|
651
|
+
* This method creates an account holder in the payment provider, if the provider supports account holders.
|
600
652
|
*
|
601
|
-
* @param {CreateAccountHolderDTO}
|
653
|
+
* @param {CreateAccountHolderDTO} input - The details of the account holder.
|
602
654
|
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
603
|
-
* @returns {Promise<
|
655
|
+
* @returns {Promise<AccountHolderDTO>} The created account holder's details.
|
604
656
|
*
|
605
657
|
* @example
|
606
658
|
* const accountHolder =
|
@@ -625,6 +677,33 @@ export interface IPaymentModuleService extends IModuleService {
|
|
625
677
|
* }])
|
626
678
|
*/
|
627
679
|
createAccountHolder(input: CreateAccountHolderDTO, sharedContext?: Context): Promise<AccountHolderDTO>;
|
680
|
+
/**
|
681
|
+
* This method updates an account holder in the payment provider, if the provider supports account holders.
|
682
|
+
*
|
683
|
+
* @param {UpdateAccountHolderDTO} input - The details of the account holder to update.
|
684
|
+
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
685
|
+
* @returns {Promise<AccountHolderDTO>} The updated account holder's details.
|
686
|
+
*
|
687
|
+
* @example
|
688
|
+
* const accountHolder =
|
689
|
+
* await paymentModuleService.updateAccountHolder(
|
690
|
+
* {
|
691
|
+
* provider_id: "stripe",
|
692
|
+
* context: {
|
693
|
+
* account_holder: {
|
694
|
+
* data: {
|
695
|
+
* id: "acc_holder_123",
|
696
|
+
* },
|
697
|
+
* },
|
698
|
+
* customer: {
|
699
|
+
* id: "cus_123",
|
700
|
+
* company_name: "new_name",
|
701
|
+
* },
|
702
|
+
* },
|
703
|
+
* }
|
704
|
+
* )
|
705
|
+
*/
|
706
|
+
updateAccountHolder(input: UpdateAccountHolderDTO, sharedContext?: Context): Promise<AccountHolderDTO>;
|
628
707
|
/**
|
629
708
|
* This method deletes the account holder in the payment provider.
|
630
709
|
*
|
@@ -675,7 +754,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
675
754
|
* ```
|
676
755
|
*
|
677
756
|
*/
|
678
|
-
listPaymentMethods(filters: FilterablePaymentMethodProps, config
|
757
|
+
listPaymentMethods(filters: FilterablePaymentMethodProps, config?: FindConfig<PaymentMethodDTO>, sharedContext?: Context): Promise<PaymentMethodDTO[]>;
|
679
758
|
/**
|
680
759
|
* This method retrieves all payment methods along with the total count of available payment methods, based on the context and configuration.
|
681
760
|
*
|
@@ -704,7 +783,7 @@ export interface IPaymentModuleService extends IModuleService {
|
|
704
783
|
* ```
|
705
784
|
*
|
706
785
|
*/
|
707
|
-
listAndCountPaymentMethods(filters: FilterablePaymentMethodProps, config
|
786
|
+
listAndCountPaymentMethods(filters: FilterablePaymentMethodProps, config?: FindConfig<PaymentMethodDTO>, sharedContext?: Context): Promise<[PaymentMethodDTO[], number]>;
|
708
787
|
/**
|
709
788
|
* This method creates payment methods.
|
710
789
|
*
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/payment/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,sBAAsB,EACtB,gCAAgC,EAChC,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,6BAA6B,EAC7B,qBAAqB,EACrB,2BAA2B,EAC3B,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,SAAS,EACT,eAAe,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,uBAAuB,EACvB,eAAe,EACf,qBAAqB,EACrB,gCAAgC,EAChC,sBAAsB,EACtB,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,0BAA0B,EAC1B,sBAAsB,EACvB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAEhD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAG3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAAE,EAClC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,yBAAyB,CACvB,mBAAmB,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,8BAA8B,CAC5B,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAE5C;;;;;;;;;;;;;;;;OAgBG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAC3B,IAAI,EAAE,gCAAgC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,CACtB,QAAQ,EAAE,gCAAgC,EAC1C,IAAI,EAAE,gCAAgC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAAE,EAClC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;OAYG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,4BAA4B,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC1E,EAAE,EAAE,MAAM,EAAE,EACZ,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACvE,EAAE,EAAE,MAAM,EAAE,EACZ,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;OAYG;IACH,0BAA0B,CACxB,mBAAmB,EAAE,MAAM,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;OAaG;IACH,0BAA0B,CACxB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC,sBAAsB,CACpB,gBAAgB,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;
|
1
|
+
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/payment/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,sBAAsB,EACtB,gCAAgC,EAChC,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,6BAA6B,EAC7B,qBAAqB,EACrB,2BAA2B,EAC3B,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,SAAS,EACT,eAAe,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,uBAAuB,EACvB,eAAe,EACf,qBAAqB,EACrB,gCAAgC,EAChC,sBAAsB,EACtB,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,0BAA0B,EAC1B,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAEhD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAG3D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAAE,EAClC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,yBAAyB,CACvB,mBAAmB,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,8BAA8B,CAC5B,OAAO,CAAC,EAAE,gCAAgC,EAC1C,MAAM,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,EACzC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,oBAAoB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAE5C;;;;;;;;;;;;;;;;OAgBG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAC3B,IAAI,EAAE,gCAAgC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,wBAAwB,CACtB,QAAQ,EAAE,gCAAgC,EAC1C,IAAI,EAAE,gCAAgC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAAE,EAClC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;OAYG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,mBAAmB,EAAE,MAAM,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,4BAA4B,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC1E,EAAE,EAAE,MAAM,EAAE,EACZ,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACvE,EAAE,EAAE,MAAM,EAAE,EACZ,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;OAYG;IACH,0BAA0B,CACxB,mBAAmB,EAAE,MAAM,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;;;OAaG;IACH,0BAA0B,CACxB,mBAAmB,EAAE,MAAM,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAElC,sBAAsB,CACpB,gBAAgB,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAItB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAClB,mBAAmB,EAAE,MAAM,EAC3B,IAAI,EAAE,uBAAuB,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAClB,IAAI,EAAE,uBAAuB,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE7B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAExE;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CACrB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,mBAAmB,CACjB,OAAO,CAAC,EAAE,6BAA6B,EACvC,MAAM,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,EACtC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;OAWG;IACH,aAAa,CACX,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,IAAI,EAAE,gBAAgB,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,CAAC,CAAA;IAEtB;;;;;;;;;;OAUG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,oBAAoB,CAClB,OAAO,CAAC,EAAE,8BAA8B,EACxC,MAAM,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,EACvC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,4BAA4B,CAC1B,OAAO,CAAC,EAAE,8BAA8B,EACxC,MAAM,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,EACvC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,mBAAmB,CACjB,KAAK,EAAE,sBAAsB,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,mBAAmB,CACjB,KAAK,EAAE,sBAAsB,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,kBAAkB,CAChB,OAAO,EAAE,4BAA4B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,0BAA0B,CACxB,OAAO,EAAE,4BAA4B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,sBAAsB,EAChC,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAExB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,WAAW,CACT,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,cAAc,EAAE,MAAM,EAAE,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,cAAc,EAAE,MAAM,EACtB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrE,cAAc,EAAE,MAAM,EAAE,EACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,cAAc,EAAE,MAAM,EAAE,EACxB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,iBAAiB,CACf,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAI7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,uBAAuB,CACrB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB"}
|
package/dist/product/common.d.ts
CHANGED
@@ -711,8 +711,9 @@ export interface FilterableProductProps extends BaseFilterable<FilterableProduct
|
|
711
711
|
*/
|
712
712
|
variants?: {
|
713
713
|
options?: {
|
714
|
-
value
|
715
|
-
option_id
|
714
|
+
value?: string;
|
715
|
+
option_id?: string;
|
716
|
+
option?: Record<string, any>;
|
716
717
|
};
|
717
718
|
};
|
718
719
|
/**
|
@@ -881,19 +882,23 @@ export interface FilterableProductVariantProps extends BaseFilterable<Filterable
|
|
881
882
|
/**
|
882
883
|
* The IDs to filter product variants by.
|
883
884
|
*/
|
884
|
-
id?: string | string[]
|
885
|
+
id?: string | string[] | OperatorMap<string | string[]>;
|
885
886
|
/**
|
886
887
|
* The SKUs to filter product variants by.
|
887
888
|
*/
|
888
|
-
sku?: string | string[]
|
889
|
+
sku?: string | string[] | OperatorMap<string | string[]>;
|
889
890
|
/**
|
890
891
|
* Filter the product variants by their associated products' IDs.
|
891
892
|
*/
|
892
|
-
product_id?: string | string[]
|
893
|
+
product_id?: string | string[] | OperatorMap<string | string[]>;
|
893
894
|
/**
|
894
895
|
* Filter product variants by their associated options.
|
895
896
|
*/
|
896
|
-
options?:
|
897
|
+
options?: {
|
898
|
+
value?: string;
|
899
|
+
option_id?: string;
|
900
|
+
option?: Record<string, any>;
|
901
|
+
};
|
897
902
|
}
|
898
903
|
/**
|
899
904
|
* @interface
|