@gradientedge/commercetools-utils 6.6.0 → 6.8.0

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.
Files changed (204) hide show
  1. package/dist/cjs/api/CommercetoolsApi.d.ts +2 -4
  2. package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -1
  3. package/dist/cjs/api/CommercetoolsApi.js.map +1 -1
  4. package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -1
  5. package/dist/cjs/types/models/business-unit.d.ts +18 -12
  6. package/dist/cjs/types/models/business-unit.d.ts.map +1 -1
  7. package/dist/cjs/types/models/cart-discount.d.ts +44 -10
  8. package/dist/cjs/types/models/cart-discount.d.ts.map +1 -1
  9. package/dist/cjs/types/models/cart-discount.js.map +1 -1
  10. package/dist/cjs/types/models/cart.d.ts +131 -103
  11. package/dist/cjs/types/models/cart.d.ts.map +1 -1
  12. package/dist/cjs/types/models/cart.js +5 -1
  13. package/dist/cjs/types/models/cart.js.map +1 -1
  14. package/dist/cjs/types/models/common.d.ts +19 -10
  15. package/dist/cjs/types/models/common.d.ts.map +1 -1
  16. package/dist/cjs/types/models/common.js +4 -0
  17. package/dist/cjs/types/models/common.js.map +1 -1
  18. package/dist/cjs/types/models/customer.d.ts +37 -13
  19. package/dist/cjs/types/models/customer.d.ts.map +1 -1
  20. package/dist/cjs/types/models/discount-group.d.ts +252 -0
  21. package/dist/cjs/types/models/discount-group.d.ts.map +1 -0
  22. package/dist/cjs/types/models/discount-group.js +8 -0
  23. package/dist/cjs/types/models/discount-group.js.map +1 -0
  24. package/dist/cjs/types/models/error.d.ts +68 -4
  25. package/dist/cjs/types/models/error.d.ts.map +1 -1
  26. package/dist/cjs/types/models/event.d.ts +405 -58
  27. package/dist/cjs/types/models/event.d.ts.map +1 -1
  28. package/dist/cjs/types/models/extension.d.ts +2 -1
  29. package/dist/cjs/types/models/extension.d.ts.map +1 -1
  30. package/dist/cjs/types/models/extension.js +1 -0
  31. package/dist/cjs/types/models/extension.js.map +1 -1
  32. package/dist/cjs/types/models/index.d.ts +4 -3
  33. package/dist/cjs/types/models/index.d.ts.map +1 -1
  34. package/dist/cjs/types/models/index.js +4 -3
  35. package/dist/cjs/types/models/index.js.map +1 -1
  36. package/dist/cjs/types/models/me.d.ts +135 -10
  37. package/dist/cjs/types/models/me.d.ts.map +1 -1
  38. package/dist/cjs/types/models/me.js.map +1 -1
  39. package/dist/cjs/types/models/message.d.ts +7118 -3267
  40. package/dist/cjs/types/models/message.d.ts.map +1 -1
  41. package/dist/cjs/types/models/order-edit.d.ts +29 -3
  42. package/dist/cjs/types/models/order-edit.d.ts.map +1 -1
  43. package/dist/cjs/types/models/order.d.ts +23 -9
  44. package/dist/cjs/types/models/order.d.ts.map +1 -1
  45. package/dist/cjs/types/models/order.js.map +1 -1
  46. package/dist/cjs/types/models/payment-method.d.ts +439 -0
  47. package/dist/cjs/types/models/payment-method.d.ts.map +1 -0
  48. package/dist/cjs/types/models/payment-method.js +14 -0
  49. package/dist/cjs/types/models/payment-method.js.map +1 -0
  50. package/dist/cjs/types/models/payment.d.ts +225 -8
  51. package/dist/cjs/types/models/payment.d.ts.map +1 -1
  52. package/dist/cjs/types/models/payment.js.map +1 -1
  53. package/dist/cjs/types/models/product-search.d.ts +77 -2
  54. package/dist/cjs/types/models/product-search.d.ts.map +1 -1
  55. package/dist/cjs/types/models/product-search.js.map +1 -1
  56. package/dist/cjs/types/models/product-tailoring.d.ts +54 -1
  57. package/dist/cjs/types/models/product-tailoring.d.ts.map +1 -1
  58. package/dist/cjs/types/models/product-type.d.ts +20 -2
  59. package/dist/cjs/types/models/product-type.d.ts.map +1 -1
  60. package/dist/cjs/types/models/product-type.js +6 -1
  61. package/dist/cjs/types/models/product-type.js.map +1 -1
  62. package/dist/cjs/types/models/product.d.ts +67 -16
  63. package/dist/cjs/types/models/product.d.ts.map +1 -1
  64. package/dist/cjs/types/models/product.js.map +1 -1
  65. package/dist/cjs/types/models/project.d.ts +35 -4
  66. package/dist/cjs/types/models/project.d.ts.map +1 -1
  67. package/dist/cjs/types/models/project.js.map +1 -1
  68. package/dist/cjs/types/models/quote-request.d.ts +6 -0
  69. package/dist/cjs/types/models/quote-request.d.ts.map +1 -1
  70. package/dist/cjs/types/models/quote-request.js.map +1 -1
  71. package/dist/cjs/types/models/quote.d.ts +6 -0
  72. package/dist/cjs/types/models/quote.d.ts.map +1 -1
  73. package/dist/cjs/types/models/quote.js.map +1 -1
  74. package/dist/cjs/types/models/recurrence-policy.d.ts +233 -71
  75. package/dist/cjs/types/models/recurrence-policy.d.ts.map +1 -1
  76. package/dist/cjs/types/models/recurrence-policy.js +14 -8
  77. package/dist/cjs/types/models/recurrence-policy.js.map +1 -1
  78. package/dist/cjs/types/models/recurring-order.d.ts +463 -103
  79. package/dist/cjs/types/models/recurring-order.d.ts.map +1 -1
  80. package/dist/cjs/types/models/recurring-order.js +23 -15
  81. package/dist/cjs/types/models/recurring-order.js.map +1 -1
  82. package/dist/cjs/types/models/search.d.ts +1 -1
  83. package/dist/cjs/types/models/search.d.ts.map +1 -1
  84. package/dist/cjs/types/models/shopping-list.d.ts +11 -4
  85. package/dist/cjs/types/models/shopping-list.d.ts.map +1 -1
  86. package/dist/cjs/types/models/standalone-price.d.ts +10 -8
  87. package/dist/cjs/types/models/standalone-price.d.ts.map +1 -1
  88. package/dist/cjs/types/models/state.d.ts +2 -1
  89. package/dist/cjs/types/models/state.d.ts.map +1 -1
  90. package/dist/cjs/types/models/state.js +1 -0
  91. package/dist/cjs/types/models/state.js.map +1 -1
  92. package/dist/cjs/types/models/subscription.d.ts +31 -19
  93. package/dist/cjs/types/models/subscription.d.ts.map +1 -1
  94. package/dist/cjs/types/models/subscription.js +12 -0
  95. package/dist/cjs/types/models/subscription.js.map +1 -1
  96. package/dist/cjs/types/models/type.d.ts +2 -1
  97. package/dist/cjs/types/models/type.d.ts.map +1 -1
  98. package/dist/cjs/types/models/type.js +1 -0
  99. package/dist/cjs/types/models/type.js.map +1 -1
  100. package/dist/cjs/utils/get-attribute-value.d.ts +1 -1
  101. package/dist/cjs/utils/get-attribute-value.d.ts.map +1 -1
  102. package/dist/mjs/api/CommercetoolsApi.d.ts +2 -4
  103. package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -1
  104. package/dist/mjs/api/CommercetoolsApi.js +1 -1
  105. package/dist/mjs/api/CommercetoolsApi.js.map +1 -1
  106. package/dist/mjs/tsconfig.tsbuildinfo +1 -1
  107. package/dist/mjs/types/models/business-unit.d.ts +18 -12
  108. package/dist/mjs/types/models/business-unit.d.ts.map +1 -1
  109. package/dist/mjs/types/models/cart-discount.d.ts +44 -10
  110. package/dist/mjs/types/models/cart-discount.d.ts.map +1 -1
  111. package/dist/mjs/types/models/cart-discount.js.map +1 -1
  112. package/dist/mjs/types/models/cart.d.ts +131 -103
  113. package/dist/mjs/types/models/cart.d.ts.map +1 -1
  114. package/dist/mjs/types/models/cart.js +5 -1
  115. package/dist/mjs/types/models/cart.js.map +1 -1
  116. package/dist/mjs/types/models/common.d.ts +19 -10
  117. package/dist/mjs/types/models/common.d.ts.map +1 -1
  118. package/dist/mjs/types/models/common.js +4 -0
  119. package/dist/mjs/types/models/common.js.map +1 -1
  120. package/dist/mjs/types/models/customer.d.ts +37 -13
  121. package/dist/mjs/types/models/customer.d.ts.map +1 -1
  122. package/dist/mjs/types/models/discount-group.d.ts +252 -0
  123. package/dist/mjs/types/models/discount-group.d.ts.map +1 -0
  124. package/dist/mjs/types/models/discount-group.js +7 -0
  125. package/dist/mjs/types/models/discount-group.js.map +1 -0
  126. package/dist/mjs/types/models/error.d.ts +68 -4
  127. package/dist/mjs/types/models/error.d.ts.map +1 -1
  128. package/dist/mjs/types/models/event.d.ts +405 -58
  129. package/dist/mjs/types/models/event.d.ts.map +1 -1
  130. package/dist/mjs/types/models/extension.d.ts +2 -1
  131. package/dist/mjs/types/models/extension.d.ts.map +1 -1
  132. package/dist/mjs/types/models/extension.js +1 -0
  133. package/dist/mjs/types/models/extension.js.map +1 -1
  134. package/dist/mjs/types/models/index.d.ts +4 -3
  135. package/dist/mjs/types/models/index.d.ts.map +1 -1
  136. package/dist/mjs/types/models/index.js +4 -3
  137. package/dist/mjs/types/models/index.js.map +1 -1
  138. package/dist/mjs/types/models/me.d.ts +135 -10
  139. package/dist/mjs/types/models/me.d.ts.map +1 -1
  140. package/dist/mjs/types/models/me.js.map +1 -1
  141. package/dist/mjs/types/models/message.d.ts +7118 -3267
  142. package/dist/mjs/types/models/message.d.ts.map +1 -1
  143. package/dist/mjs/types/models/order-edit.d.ts +29 -3
  144. package/dist/mjs/types/models/order-edit.d.ts.map +1 -1
  145. package/dist/mjs/types/models/order.d.ts +23 -9
  146. package/dist/mjs/types/models/order.d.ts.map +1 -1
  147. package/dist/mjs/types/models/order.js.map +1 -1
  148. package/dist/mjs/types/models/payment-method.d.ts +439 -0
  149. package/dist/mjs/types/models/payment-method.d.ts.map +1 -0
  150. package/dist/mjs/types/models/payment-method.js +11 -0
  151. package/dist/mjs/types/models/payment-method.js.map +1 -0
  152. package/dist/mjs/types/models/payment.d.ts +225 -8
  153. package/dist/mjs/types/models/payment.d.ts.map +1 -1
  154. package/dist/mjs/types/models/payment.js.map +1 -1
  155. package/dist/mjs/types/models/product-search.d.ts +77 -2
  156. package/dist/mjs/types/models/product-search.d.ts.map +1 -1
  157. package/dist/mjs/types/models/product-search.js.map +1 -1
  158. package/dist/mjs/types/models/product-tailoring.d.ts +54 -1
  159. package/dist/mjs/types/models/product-tailoring.d.ts.map +1 -1
  160. package/dist/mjs/types/models/product-type.d.ts +20 -2
  161. package/dist/mjs/types/models/product-type.d.ts.map +1 -1
  162. package/dist/mjs/types/models/product-type.js +5 -0
  163. package/dist/mjs/types/models/product-type.js.map +1 -1
  164. package/dist/mjs/types/models/product.d.ts +67 -16
  165. package/dist/mjs/types/models/product.d.ts.map +1 -1
  166. package/dist/mjs/types/models/product.js.map +1 -1
  167. package/dist/mjs/types/models/project.d.ts +35 -4
  168. package/dist/mjs/types/models/project.d.ts.map +1 -1
  169. package/dist/mjs/types/models/project.js.map +1 -1
  170. package/dist/mjs/types/models/quote-request.d.ts +6 -0
  171. package/dist/mjs/types/models/quote-request.d.ts.map +1 -1
  172. package/dist/mjs/types/models/quote-request.js.map +1 -1
  173. package/dist/mjs/types/models/quote.d.ts +6 -0
  174. package/dist/mjs/types/models/quote.d.ts.map +1 -1
  175. package/dist/mjs/types/models/quote.js.map +1 -1
  176. package/dist/mjs/types/models/recurrence-policy.d.ts +233 -71
  177. package/dist/mjs/types/models/recurrence-policy.d.ts.map +1 -1
  178. package/dist/mjs/types/models/recurrence-policy.js +13 -7
  179. package/dist/mjs/types/models/recurrence-policy.js.map +1 -1
  180. package/dist/mjs/types/models/recurring-order.d.ts +463 -103
  181. package/dist/mjs/types/models/recurring-order.d.ts.map +1 -1
  182. package/dist/mjs/types/models/recurring-order.js +22 -14
  183. package/dist/mjs/types/models/recurring-order.js.map +1 -1
  184. package/dist/mjs/types/models/search.d.ts +1 -1
  185. package/dist/mjs/types/models/search.d.ts.map +1 -1
  186. package/dist/mjs/types/models/shopping-list.d.ts +11 -4
  187. package/dist/mjs/types/models/shopping-list.d.ts.map +1 -1
  188. package/dist/mjs/types/models/standalone-price.d.ts +10 -8
  189. package/dist/mjs/types/models/standalone-price.d.ts.map +1 -1
  190. package/dist/mjs/types/models/state.d.ts +2 -1
  191. package/dist/mjs/types/models/state.d.ts.map +1 -1
  192. package/dist/mjs/types/models/state.js +1 -0
  193. package/dist/mjs/types/models/state.js.map +1 -1
  194. package/dist/mjs/types/models/subscription.d.ts +31 -19
  195. package/dist/mjs/types/models/subscription.d.ts.map +1 -1
  196. package/dist/mjs/types/models/subscription.js +12 -0
  197. package/dist/mjs/types/models/subscription.js.map +1 -1
  198. package/dist/mjs/types/models/type.d.ts +2 -1
  199. package/dist/mjs/types/models/type.d.ts.map +1 -1
  200. package/dist/mjs/types/models/type.js +1 -0
  201. package/dist/mjs/types/models/type.js.map +1 -1
  202. package/dist/mjs/utils/get-attribute-value.d.ts +1 -1
  203. package/dist/mjs/utils/get-attribute-value.d.ts.map +1 -1
  204. package/package.json +1 -2
@@ -0,0 +1,439 @@
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ import { BusinessUnitKeyReference, BusinessUnitResourceIdentifier } from './business-unit.js';
7
+ import { BaseResource, CreatedBy, IReference, LastModifiedBy, LocalizedString } from './common.js';
8
+ import { CustomerReference, CustomerResourceIdentifier } from './customer.js';
9
+ import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
10
+ export interface PaymentMethod extends BaseResource {
11
+ /**
12
+ * Unique identifier of the PaymentMethod.
13
+ *
14
+ *
15
+ */
16
+ readonly id: string;
17
+ /**
18
+ * Current version of the PaymentMethod.
19
+ *
20
+ *
21
+ */
22
+ readonly version: number;
23
+ /**
24
+ * User-defined unique identifier of the PaymentMethod.
25
+ *
26
+ *
27
+ */
28
+ readonly key?: string;
29
+ /**
30
+ * Name of the PaymentMethod.
31
+ *
32
+ *
33
+ */
34
+ readonly name?: LocalizedString;
35
+ /**
36
+ * Reference to a Customer associated with the PaymentMethod.
37
+ *
38
+ * If `businessUnit` is set, the Customer is an [Associate](ctp:api:type:Associate) of the Business Unit.
39
+ *
40
+ *
41
+ */
42
+ readonly customer?: CustomerReference;
43
+ /**
44
+ * Reference to a BusinessUnit associated with the PaymentMethod.
45
+ *
46
+ * Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
47
+ *
48
+ *
49
+ */
50
+ readonly businessUnit?: BusinessUnitKeyReference;
51
+ /**
52
+ * Payment Method used for the Payment—for example, a credit card or direct debit.
53
+ *
54
+ *
55
+ */
56
+ readonly method?: string;
57
+ /**
58
+ * Payment service that processes the Payment—for example, a PSP.
59
+ *
60
+ *
61
+ */
62
+ readonly paymentInterface?: string;
63
+ /**
64
+ * Account or instance of the payment interface when multiple accounts are used (per interface).
65
+ *
66
+ *
67
+ */
68
+ readonly interfaceAccount?: string;
69
+ /**
70
+ * Tokenized representation of the PaymentMethod used by the payment interface.
71
+ *
72
+ *
73
+ */
74
+ readonly token?: PaymentMethodToken;
75
+ /**
76
+ * Status of the PaymentMethod.
77
+ *
78
+ *
79
+ */
80
+ readonly paymentMethodStatus: PaymentMethodStatus;
81
+ /**
82
+ * Indicates if the PaymentMethod is the default.
83
+ *
84
+ * The default applies per Customer, Business Unit, or the combination of both (Associate).
85
+ *
86
+ *
87
+ */
88
+ readonly default: boolean;
89
+ /**
90
+ * Custom Fields of the PaymentMethod.
91
+ *
92
+ *
93
+ */
94
+ readonly custom?: CustomFields;
95
+ /**
96
+ * Date and time (UTC) the PaymentMethod was initially created.
97
+ *
98
+ *
99
+ */
100
+ readonly createdAt: string;
101
+ /**
102
+ * Date and time (UTC) the PaymentMethod was last updated.
103
+ *
104
+ *
105
+ */
106
+ readonly lastModifiedAt: string;
107
+ /**
108
+ * IDs and references that last modified the PaymentMethod.
109
+ *
110
+ *
111
+ */
112
+ readonly lastModifiedBy?: LastModifiedBy;
113
+ /**
114
+ * IDs and references that created the PaymentMethod.
115
+ *
116
+ *
117
+ */
118
+ readonly createdBy?: CreatedBy;
119
+ }
120
+ export interface PaymentMethodDraft {
121
+ /**
122
+ * User-defined unique identifier for the PaymentMethod.
123
+ *
124
+ *
125
+ */
126
+ readonly key?: string;
127
+ /**
128
+ * Name of the PaymentMethod.
129
+ *
130
+ *
131
+ */
132
+ readonly name?: LocalizedString;
133
+ /**
134
+ * Reference to a Customer the PaymentMethod should belong to.
135
+ *
136
+ * If `businessUnit` is set, the Customer must be an [Associate](ctp:api:type:Associate) of the Business Unit.
137
+ *
138
+ *
139
+ */
140
+ readonly customer?: CustomerResourceIdentifier;
141
+ /**
142
+ * Reference to a BusinessUnit the PaymentMethod should belong to.
143
+ *
144
+ * Only available for [B2B](/../offering/composable-commerce#composable-commerce-for-b2b)-enabled Projects.
145
+ *
146
+ *
147
+ */
148
+ readonly businessUnit?: BusinessUnitResourceIdentifier;
149
+ /**
150
+ * Payment method to use for the Payment—for example, a credit card or direct debit.
151
+ *
152
+ *
153
+ */
154
+ readonly method?: string;
155
+ /**
156
+ * Payment service that processes the Payment—for example, a PSP.
157
+ *
158
+ *
159
+ */
160
+ readonly paymentInterface?: string;
161
+ /**
162
+ * Account or instance of the payment interface when multiple accounts are used (per interface).
163
+ *
164
+ *
165
+ */
166
+ readonly interfaceAccount?: string;
167
+ /**
168
+ * Tokenized representation of the PaymentMethod used by the payment interface.
169
+ *
170
+ *
171
+ */
172
+ readonly token?: PaymentMethodToken;
173
+ /**
174
+ * Status of the PaymentMethod.
175
+ *
176
+ *
177
+ */
178
+ readonly paymentMethodStatus?: PaymentMethodStatus;
179
+ /**
180
+ * Set to `true` if the PaymentMethod should be the default.
181
+ *
182
+ * The default applies per Customer, Business Unit, or the combination of both (Associate).
183
+ *
184
+ *
185
+ */
186
+ readonly default?: boolean;
187
+ /**
188
+ * Custom Fields for the PaymentMethod.
189
+ *
190
+ *
191
+ */
192
+ readonly custom?: CustomFieldsDraft;
193
+ }
194
+ /**
195
+ * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [PaymentMethod](ctp:api:type:PaymentMethod).
196
+ *
197
+ */
198
+ export interface PaymentMethodPagedQueryResponse {
199
+ /**
200
+ * Number of [results requested](/../api/general-concepts#limit).
201
+ *
202
+ *
203
+ */
204
+ readonly limit: number;
205
+ /**
206
+ * Number of [elements skipped](/../api/general-concepts#offset).
207
+ *
208
+ *
209
+ */
210
+ readonly offset: number;
211
+ /**
212
+ * Actual number of results returned.
213
+ *
214
+ *
215
+ */
216
+ readonly count: number;
217
+ /**
218
+ * Total number of results matching the query.
219
+ * This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
220
+ * This field is returned by default.
221
+ * For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
222
+ * When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
223
+ *
224
+ *
225
+ */
226
+ readonly total?: number;
227
+ /**
228
+ * [PaymentMethods](ctp:api:type:PaymentMethod) matching the query.
229
+ *
230
+ *
231
+ */
232
+ readonly results: PaymentMethod[];
233
+ }
234
+ /**
235
+ * [Reference](ctp:api:type:Reference) to a [PaymentMethod](ctp:api:type:PaymentMethod).
236
+ *
237
+ */
238
+ export interface PaymentMethodReference extends IReference {
239
+ readonly typeId: 'payment-method';
240
+ /**
241
+ * Unique identifier of the referenced [PaymentMethod](ctp:api:type:PaymentMethod).
242
+ *
243
+ *
244
+ */
245
+ readonly id: string;
246
+ /**
247
+ * Contains the representation of the expanded PaymentMethod. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for PaymentMethods.
248
+ *
249
+ *
250
+ */
251
+ readonly obj?: PaymentMethod;
252
+ }
253
+ export declare enum PaymentMethodStatusValues {
254
+ Active = "Active",
255
+ Inactive = "Inactive"
256
+ }
257
+ export type PaymentMethodStatus = 'Active' | 'Inactive' | (string & {});
258
+ export interface PaymentMethodToken {
259
+ /**
260
+ * Tokenized representation of the Payment Method.
261
+ *
262
+ * It is _displayed_ in the following instances:
263
+ *
264
+ * - in the payload of an API Extension for Payments and PaymentMethods
265
+ * - when querying Payments and PaymentMethods
266
+ *
267
+ * It is _masked_ in the following instances:
268
+ *
269
+ * - in the payload of Payment and PaymentMethod messages
270
+ * - when querying MyPayments
271
+ * - in referenced Payments and PaymentMethods embedded through [Reference Expansion](/general-concepts#reference-expansion)
272
+ *
273
+ */
274
+ readonly value: string;
275
+ }
276
+ export interface PaymentMethodUpdate {
277
+ /**
278
+ * Expected version of the PaymentMethod on which the changes should be applied.
279
+ * If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
280
+ *
281
+ *
282
+ */
283
+ readonly version: number;
284
+ /**
285
+ * Update actions to be performed on the PaymentMethod.
286
+ *
287
+ *
288
+ */
289
+ readonly actions: PaymentMethodUpdateAction[];
290
+ }
291
+ export type PaymentMethodUpdateAction = PaymentMethodSetCustomFieldAction | PaymentMethodSetCustomTypeAction | PaymentMethodSetDefaultAction | PaymentMethodSetInterfaceAccountAction | PaymentMethodSetKeyAction | PaymentMethodSetMethodAction | PaymentMethodSetNameAction | PaymentMethodSetPaymentInterfaceAction | PaymentMethodSetPaymentMethodStatusAction;
292
+ export interface IPaymentMethodUpdateAction {
293
+ /**
294
+ *
295
+ */
296
+ readonly action: string;
297
+ }
298
+ /**
299
+ * Adding a Custom Field to a PaymentMethod generates the [PaymentMethodCustomFieldAdded](ctp:api:type:PaymentMethodCustomFieldAddedMessage) Message, removing one generates the [PaymentMethodCustomFieldRemoved](ctp:api:type:PaymentMethodCustomFieldRemovedMessage) Message, and updating an existing one generates the [PaymentMethodCustomFieldChanged](ctp:api:type:PaymentMethodCustomFieldChangedMessage) Message.
300
+ *
301
+ */
302
+ export interface PaymentMethodSetCustomFieldAction extends IPaymentMethodUpdateAction {
303
+ readonly action: 'setCustomField';
304
+ /**
305
+ * Name of the [Custom Field](/../api/projects/custom-fields) to add, update, or remove.
306
+ *
307
+ *
308
+ */
309
+ readonly name: string;
310
+ /**
311
+ * If `value` is absent or `null`, this field will be removed if it exists.
312
+ * Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
313
+ * If `value` is provided, it is set for the field defined by `name`.
314
+ *
315
+ *
316
+ */
317
+ readonly value?: any;
318
+ }
319
+ /**
320
+ * Adding or updating a Custom Type on a PaymentMethod generates the [PaymentMethodCustomTypeSet](ctp:api:type:PaymentMethodCustomTypeSetMessage) Message, removing one generates the [PaymentMethodCustomTypeRemoved](ctp:api:type:PaymentMethodCustomTypeRemovedMessage) Message.
321
+ *
322
+ */
323
+ export interface PaymentMethodSetCustomTypeAction extends IPaymentMethodUpdateAction {
324
+ readonly action: 'setCustomType';
325
+ /**
326
+ * Defines the [Type](ctp:api:type:Type) that extends the PaymentMethod with [Custom Fields](/../api/projects/custom-fields).
327
+ * If absent, any existing Type and Custom Fields are removed from the PaymentMethod.
328
+ *
329
+ *
330
+ */
331
+ readonly type?: TypeResourceIdentifier;
332
+ /**
333
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the PaymentMethod.
334
+ *
335
+ *
336
+ */
337
+ readonly fields?: FieldContainer;
338
+ }
339
+ /**
340
+ * This action generates the [PaymentMethodDefaultSet](ctp:api:type:PaymentMethodDefaultSetMessage) Message.
341
+ *
342
+ * An inactive Payment Method cannot be set as the default, and the action will return an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
343
+ *
344
+ */
345
+ export interface PaymentMethodSetDefaultAction extends IPaymentMethodUpdateAction {
346
+ readonly action: 'setDefault';
347
+ /**
348
+ * Value to set.
349
+ *
350
+ *
351
+ */
352
+ readonly default: boolean;
353
+ }
354
+ /**
355
+ * This action generates the [PaymentMethodInterfaceAccountSet](ctp:api:type:PaymentMethodInterfaceAccountSetMessage) Message.
356
+ *
357
+ */
358
+ export interface PaymentMethodSetInterfaceAccountAction extends IPaymentMethodUpdateAction {
359
+ readonly action: 'setInterfaceAccount';
360
+ /**
361
+ * New account or instance of the payment interface.
362
+ * If empty, any existing value will be removed.
363
+ *
364
+ *
365
+ */
366
+ readonly interfaceAccount?: string;
367
+ }
368
+ /**
369
+ * This action generates the [PaymentMethodKeySet](ctp:api:type:PaymentMethodKeySetMessage) Message.
370
+ *
371
+ */
372
+ export interface PaymentMethodSetKeyAction extends IPaymentMethodUpdateAction {
373
+ readonly action: 'setKey';
374
+ /**
375
+ * Value to set.
376
+ * If empty, any existing value will be removed.
377
+ *
378
+ *
379
+ */
380
+ readonly key?: string;
381
+ }
382
+ /**
383
+ * This action generates the [PaymentMethodMethodSet](ctp:api:type:PaymentMethodMethodSetMessage) Message.
384
+ *
385
+ */
386
+ export interface PaymentMethodSetMethodAction extends IPaymentMethodUpdateAction {
387
+ readonly action: 'setMethod';
388
+ /**
389
+ * New payment method—for example, a credit card or direct debit.
390
+ * If empty, any existing value will be removed.
391
+ *
392
+ *
393
+ */
394
+ readonly method?: string;
395
+ }
396
+ /**
397
+ * This update action generates the [PaymentMethodNameSet](ctp:api:type:PaymentMethodNameSetMessage) Message.
398
+ *
399
+ */
400
+ export interface PaymentMethodSetNameAction extends IPaymentMethodUpdateAction {
401
+ readonly action: 'setName';
402
+ /**
403
+ * Value to set.
404
+ * If empty, any existing value will be removed.
405
+ *
406
+ *
407
+ */
408
+ readonly name?: LocalizedString;
409
+ }
410
+ /**
411
+ * This action generates the [PaymentMethodPaymentInterfaceSet](ctp:api:type:PaymentMethodPaymentInterfaceSetMessage) Message.
412
+ *
413
+ */
414
+ export interface PaymentMethodSetPaymentInterfaceAction extends IPaymentMethodUpdateAction {
415
+ readonly action: 'setPaymentInterface';
416
+ /**
417
+ * New payment service that processes the Payment—for example, a PSP.
418
+ * If empty, any existing value will be removed.
419
+ *
420
+ *
421
+ */
422
+ readonly paymentInterface?: string;
423
+ }
424
+ /**
425
+ * This action generates the [PaymentMethodPaymentMethodStatusSet](ctp:api:type:PaymentMethodPaymentMethodStatusSetMessage) Message.
426
+ *
427
+ * A default Payment Method cannot be set as inactive, and the action will return an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
428
+ *
429
+ */
430
+ export interface PaymentMethodSetPaymentMethodStatusAction extends IPaymentMethodUpdateAction {
431
+ readonly action: 'setPaymentMethodStatus';
432
+ /**
433
+ * Value to set.
434
+ *
435
+ *
436
+ */
437
+ readonly paymentMethodStatus: PaymentMethodStatus;
438
+ }
439
+ //# sourceMappingURL=payment-method.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"payment-method.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/payment-method.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,wBAAwB,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAA;AAC7F,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClG,OAAO,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEnG,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,wBAAwB,CAAA;IAChD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAA;IACjD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAC/B;AACD,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAA;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,8BAA8B,CAAA;IACtD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;IAClD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,CAAA;CAClC;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,aAAa,CAAA;CAC7B;AACD,oBAAY,yBAAyB;IACnC,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACvE,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAC9C;AACD,MAAM,MAAM,yBAAyB,GACjC,iCAAiC,GACjC,gCAAgC,GAChC,6BAA6B,GAC7B,sCAAsC,GACtC,yBAAyB,GACzB,4BAA4B,GAC5B,0BAA0B,GAC1B,sCAAsC,GACtC,yCAAyC,CAAA;AAC7C,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AACD;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,0BAA0B;IACnF,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB;AACD;;;GAGG;AACH,MAAM,WAAW,gCAAiC,SAAQ,0BAA0B;IAClF,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,0BAA0B;IAC/E,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,0BAA0B;IAC9E,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;IAC5E,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;CAChC;AACD;;;GAGG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAA;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC;AACD;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,0BAA0B;IAC3F,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAA;IACzC;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAA;CAClD"}
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ /**
3
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
4
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
5
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.PaymentMethodStatusValues = void 0;
9
+ var PaymentMethodStatusValues;
10
+ (function (PaymentMethodStatusValues) {
11
+ PaymentMethodStatusValues["Active"] = "Active";
12
+ PaymentMethodStatusValues["Inactive"] = "Inactive";
13
+ })(PaymentMethodStatusValues || (exports.PaymentMethodStatusValues = PaymentMethodStatusValues = {}));
14
+ //# sourceMappingURL=payment-method.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"payment-method.js","sourceRoot":"","sources":["../../../../src/lib/types/models/payment-method.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AA0PH,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACnC,8CAAiB,CAAA;IACjB,kDAAqB,CAAA;AACvB,CAAC,EAHW,yBAAyB,yCAAzB,yBAAyB,QAGpC"}