@wix/auto_sdk_payments_site-payment-method-types 1.0.2 → 1.0.4

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 (49) hide show
  1. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.d.ts +1 -1
  2. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js +2 -1
  3. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js.map +1 -1
  4. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.d.ts +1 -1
  5. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js +2 -1
  6. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js.map +1 -1
  7. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.d.ts +92 -10
  8. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js +6 -1
  9. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js.map +1 -1
  10. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.d.ts +114 -9
  11. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js +18 -1
  12. package/build/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js.map +1 -1
  13. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.d.ts +1 -1
  14. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js +1 -1
  15. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js.map +1 -1
  16. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.d.ts +1 -1
  17. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js +1 -1
  18. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js.map +1 -1
  19. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.d.ts +92 -10
  20. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js +5 -0
  21. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js.map +1 -1
  22. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.d.ts +114 -9
  23. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js +17 -0
  24. package/build/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js.map +1 -1
  25. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.d.ts +1 -1
  26. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js +2 -1
  27. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js.map +1 -1
  28. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.d.ts +1 -1
  29. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js +2 -1
  30. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js.map +1 -1
  31. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.d.ts +92 -10
  32. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js +6 -1
  33. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js.map +1 -1
  34. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.d.ts +114 -9
  35. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js +18 -1
  36. package/build/internal/cjs/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js.map +1 -1
  37. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.d.ts +1 -1
  38. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js +1 -1
  39. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js.map +1 -1
  40. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.d.ts +1 -1
  41. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js +1 -1
  42. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js.map +1 -1
  43. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.d.ts +92 -10
  44. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js +5 -0
  45. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js.map +1 -1
  46. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.d.ts +114 -9
  47. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js +17 -0
  48. package/build/internal/es/src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js.map +1 -1
  49. package/package.json +2 -2
@@ -2,5 +2,5 @@ import { getSitePaymentMethodType as publicGetSitePaymentMethodType, listSitePay
2
2
  import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
3
3
  export declare const getSitePaymentMethodType: MaybeContext<BuildRESTFunction<typeof publicGetSitePaymentMethodType> & typeof publicGetSitePaymentMethodType>;
4
4
  export declare const listSitePaymentMethodTypes: MaybeContext<BuildRESTFunction<typeof publicListSitePaymentMethodTypes> & typeof publicListSitePaymentMethodTypes>;
5
- export { Format } from './payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js';
5
+ export { Format, RequestedFields, } from './payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js';
6
6
  export { SitePaymentMethodType, Features, IFrame, NewTab, FullPageRedirect, Barcode, QrCode, ExpressFlow, RegularFlow, Disputes, Installments, Refunds, AuthCapture, RegularTokenization, CustomTokenization, NextAction, CredentialOnFile, Moto, PromotionalMessages, MerchantFlow, Icon, BuyerFlow, GetSitePaymentMethodTypeRequest, GetSitePaymentMethodTypeResponse, ListSitePaymentMethodTypesRequest, ListSitePaymentMethodTypesResponse, SitePaymentMethodTypeNonNullableFields, GetSitePaymentMethodTypeResponseNonNullableFields, ListSitePaymentMethodTypesResponseNonNullableFields, GetSitePaymentMethodTypeOptions, ListSitePaymentMethodTypesOptions, } from './payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js';
@@ -1,10 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Format = exports.listSitePaymentMethodTypes = exports.getSitePaymentMethodType = void 0;
3
+ exports.RequestedFields = exports.Format = exports.listSitePaymentMethodTypes = exports.getSitePaymentMethodType = void 0;
4
4
  const payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_public_js_1 = require("./payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js");
5
5
  const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
6
6
  exports.getSitePaymentMethodType = (0, rest_modules_1.createRESTModule)(payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_public_js_1.getSitePaymentMethodType);
7
7
  exports.listSitePaymentMethodTypes = (0, rest_modules_1.createRESTModule)(payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_public_js_1.listSitePaymentMethodTypes);
8
8
  var payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_1 = require("./payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js");
9
9
  Object.defineProperty(exports, "Format", { enumerable: true, get: function () { return payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_1.Format; } });
10
+ Object.defineProperty(exports, "RequestedFields", { enumerable: true, get: function () { return payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_1.RequestedFields; } });
10
11
  //# sourceMappingURL=payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.ts"],"names":[],"mappings":";;;AAAA,6NAG8G;AAC9G,gEAAiE;AAGpD,QAAA,wBAAwB,GAGnB,IAAA,+BAAgB,EAAC,6HAA8B,CAAC,CAAC;AACtD,QAAA,0BAA0B,GAGrB,IAAA,+BAAgB,EAAC,+HAAgC,CAAC,CAAC;AAErE,iOAAiI;AAAxH,+LAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.context.ts"],"names":[],"mappings":";;;AAAA,6NAG8G;AAC9G,gEAAiE;AAGpD,QAAA,wBAAwB,GAGnB,IAAA,+BAAgB,EAAC,6HAA8B,CAAC,CAAC;AACtD,QAAA,0BAA0B,GAGrB,IAAA,+BAAgB,EAAC,+HAAgC,CAAC,CAAC;AAErE,iOAGiH;AAF/G,+LAAA,MAAM,OAAA;AACN,wMAAA,eAAe,OAAA"}
@@ -37,4 +37,4 @@ interface ListSitePaymentMethodTypesSignature {
37
37
  */
38
38
  (options?: ListSitePaymentMethodTypesOptions | undefined): Promise<ListSitePaymentMethodTypesResponse & ListSitePaymentMethodTypesResponseNonNullableFields>;
39
39
  }
40
- export { AuthCapture, Barcode, BuyerFlow, CredentialOnFile, CustomTokenization, Disputes, ExpressFlow, Features, Format, FullPageRedirect, GetSitePaymentMethodTypeOptions, GetSitePaymentMethodTypeRequest, GetSitePaymentMethodTypeResponse, GetSitePaymentMethodTypeResponseNonNullableFields, IFrame, Icon, Installments, ListSitePaymentMethodTypesOptions, ListSitePaymentMethodTypesRequest, ListSitePaymentMethodTypesResponse, ListSitePaymentMethodTypesResponseNonNullableFields, MerchantFlow, Moto, NewTab, NextAction, PromotionalMessages, QrCode, Refunds, RegularFlow, RegularTokenization, SitePaymentMethodType, SitePaymentMethodTypeNonNullableFields, } from './payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js';
40
+ export { AuthCapture, Barcode, BuyerFlow, CredentialOnFile, CustomTokenization, Disputes, ExpressFlow, Features, Format, FullPageRedirect, GetSitePaymentMethodTypeOptions, GetSitePaymentMethodTypeRequest, GetSitePaymentMethodTypeResponse, GetSitePaymentMethodTypeResponseNonNullableFields, IFrame, Icon, Installments, ListSitePaymentMethodTypesOptions, ListSitePaymentMethodTypesRequest, ListSitePaymentMethodTypesResponse, ListSitePaymentMethodTypesResponseNonNullableFields, MerchantFlow, Moto, NewTab, NextAction, PromotionalMessages, QrCode, Refunds, RegularFlow, RegularTokenization, RequestedFields, SitePaymentMethodType, SitePaymentMethodTypeNonNullableFields, } from './payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js';
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Format = exports.listSitePaymentMethodTypes = exports.getSitePaymentMethodType = exports.__metadata = void 0;
3
+ exports.RequestedFields = exports.Format = exports.listSitePaymentMethodTypes = exports.getSitePaymentMethodType = exports.__metadata = void 0;
4
4
  const payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_1 = require("./payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js");
5
5
  exports.__metadata = { PACKAGE_NAME: '@wix/payments' };
6
6
  function getSitePaymentMethodType(httpClient) {
@@ -17,4 +17,5 @@ function listSitePaymentMethodTypes(httpClient) {
17
17
  exports.listSitePaymentMethodTypes = listSitePaymentMethodTypes;
18
18
  var payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_2 = require("./payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.universal.js");
19
19
  Object.defineProperty(exports, "Format", { enumerable: true, get: function () { return payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_2.Format; } });
20
+ Object.defineProperty(exports, "RequestedFields", { enumerable: true, get: function () { return payments_site_payment_method_types_v1_site_payment_method_type_site_payment_method_types_universal_js_2.RequestedFields; } });
20
21
  //# sourceMappingURL=payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.ts"],"names":[],"mappings":";;;AACA,mOASiH;AAEpG,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CACL,uBAA+B,EAC/B,OAAyC,EACzC,EAAE,CACF,IAAA,gIAAiC,EAC/B,uBAAuB,EACvB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4DAaC;AAqBD,SAAgB,0BAA0B,CACxC,UAAsB;IAEtB,OAAO,CAAC,OAA2C,EAAE,EAAE,CACrD,IAAA,kIAAmC,EACjC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gEASC;AAuBD,iOAiCiH;AAxB/G,+LAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.public.ts"],"names":[],"mappings":";;;AACA,mOASiH;AAEpG,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CACL,uBAA+B,EAC/B,OAAyC,EACzC,EAAE,CACF,IAAA,gIAAiC,EAC/B,uBAAuB,EACvB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4DAaC;AAqBD,SAAgB,0BAA0B,CACxC,UAAsB;IAEtB,OAAO,CAAC,OAA2C,EAAE,EAAE,CACrD,IAAA,kIAAmC,EACjC,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gEASC;AAuBD,iOAkCiH;AAzB/G,+LAAA,MAAM,OAAA;AAsBN,wMAAA,eAAe,OAAA"}
@@ -1,8 +1,17 @@
1
1
  /** A way to pay online or offline for goods or services offered by a specific site. */
2
2
  export interface SitePaymentMethodType {
3
- /** Payment method type ID. */
3
+ /**
4
+ * Payment method type ID.
5
+ * @format GUID
6
+ * @immutable
7
+ */
4
8
  id?: string;
5
- /** Value used buy some legacy APIs to refer to this payment method type. Can be empty. */
9
+ /**
10
+ * Value used buy some legacy APIs to refer to this payment method type. Can be empty.
11
+ * @minLength 1
12
+ * @maxLength 50
13
+ * @immutable
14
+ */
6
15
  legacyId?: string | null;
7
16
  /**
8
17
  * Payment method type display name, based on locale.
@@ -11,6 +20,8 @@ export interface SitePaymentMethodType {
11
20
  *
12
21
  * Define your locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
13
22
  * For more detailed information, see the descriptions for the `country` and `language` parameters for those methods.
23
+ * @minLength 1
24
+ * @maxLength 100
14
25
  */
15
26
  displayName?: string | null;
16
27
  /**
@@ -20,6 +31,8 @@ export interface SitePaymentMethodType {
20
31
  *
21
32
  * Define your locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
22
33
  * For more detailed information, see the descriptions for the `country` and `language` parameters for those methods.
34
+ * @minLength 1
35
+ * @maxLength 1000
23
36
  */
24
37
  description?: string | null;
25
38
  /** Features supported for this payment method type. */
@@ -42,12 +55,20 @@ export interface SitePaymentMethodType {
42
55
  * Time (in seconds after which a transaction is marked as expired if it is not completed.
43
56
  *
44
57
  * Max: `15552000` (180 days)
58
+ * @min 1
59
+ * @max 15552000
45
60
  */
46
61
  transactionExpirationDelayInSeconds?: number | null;
47
62
  /** Indicates that payment method type is restricted for the provided currency. */
48
63
  currencyRestricted?: boolean;
49
64
  /** Indicates the payment method type has currency restriction and it is enabled. */
50
65
  currencyRestrictionEnabled?: boolean;
66
+ /**
67
+ * allowed currencies
68
+ * @maxSize 100
69
+ * @format CURRENCY
70
+ */
71
+ allowedCurrencies?: string[];
51
72
  }
52
73
  export interface Features {
53
74
  /** Express flow configuration. */
@@ -110,21 +131,38 @@ export interface Disputes {
110
131
  export interface Installments {
111
132
  /** Whether installments are supported for this payment method type. */
112
133
  supported?: boolean;
113
- /** Countries for which installments can be enabled. */
134
+ /**
135
+ * Countries for which installments can be enabled.
136
+ * @format COUNTRY
137
+ * @minSize 1
138
+ * @maxSize 200
139
+ */
114
140
  allowedCountries?: string[];
115
- /** Max number of installments that can be configured by a provider. */
141
+ /**
142
+ * Max number of installments that can be configured by a provider.
143
+ * @min 2
144
+ * @max 36
145
+ */
116
146
  maxInstallmentLimit?: number | null;
117
147
  }
118
148
  export interface Refunds {
119
149
  /** Whether refunds are supported for this payment method type. */
120
150
  supported?: boolean;
121
- /** Maximum period in which payments made using this payment method type can be refunded. */
151
+ /**
152
+ * Maximum period in which payments made using this payment method type can be refunded.
153
+ * @min 1
154
+ * @max 365
155
+ */
122
156
  maxRefundabilityPeriodInDays?: number | null;
123
157
  }
124
158
  export interface AuthCapture {
125
159
  /** Whether the authorize and capture flow is supported for this payment method type. */
126
160
  supported?: boolean;
127
- /** Period to wait for the auth capture to be completed before canceling the transaction. */
161
+ /**
162
+ * Period to wait for the auth capture to be completed before canceling the transaction.
163
+ * @min 1
164
+ * @max 365
165
+ */
128
166
  maxCapturePeriodInDays?: number | null;
129
167
  }
130
168
  export interface RegularTokenization {
@@ -165,11 +203,14 @@ export interface MerchantFlow {
165
203
  *
166
204
  * Define a locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
167
205
  * For more detailed information, see the method descriptions.
206
+ * @maxSize 200
168
207
  */
169
208
  icons?: Icon[];
170
209
  /**
171
210
  * Priority given to this payment method type in the list shown to the merchant.
172
211
  * A lower value relative to other payment method types means a higher position on the list.
212
+ * @min 1
213
+ * @max 10000
173
214
  */
174
215
  priority?: number;
175
216
  /** Whether the payment method type is promoted. Promoted payment method types are displayed more prominently on the Accept Payments page. */
@@ -189,15 +230,23 @@ export interface Icon {
189
230
  /**
190
231
  * Icon tag. Payment method types can have multiple icons, and tags are used to differentiate between them.
191
232
  * For example, the UI design for multiple payment method types is upgraded, and now they each have an old icon tagged "v1" and a new icon tagged "v2". Developers can then easily choose to display all the original "v1" style of icons, or all the new "v2" style.
233
+ * @minLength 1
234
+ * @maxLength 100
192
235
  */
193
236
  tag?: string | null;
194
237
  /** Icon image format. */
195
238
  format?: Format;
196
239
  }
197
240
  export interface Image {
198
- /** WixMedia image ID. */
241
+ /**
242
+ * WixMedia image ID.
243
+ * @format GUID
244
+ */
199
245
  id?: string;
200
- /** Image URL. */
246
+ /**
247
+ * Image URL.
248
+ * @format WEB_URL
249
+ */
201
250
  url?: string;
202
251
  /**
203
252
  * Original image height.
@@ -221,11 +270,14 @@ export interface BuyerFlow {
221
270
  *
222
271
  * Define a locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
223
272
  * For more detailed information, see the method descriptions.
273
+ * @maxSize 200
224
274
  */
225
275
  icons?: Icon[];
226
276
  /**
227
277
  * The priority given to this payment method type in the list of payment method types shown to the buyer.
228
278
  * A lower value relative to other payment method types means a higher position on the list.
279
+ * @min 1
280
+ * @max 10000
229
281
  */
230
282
  priority?: number;
231
283
  /** Whether the merchant cannot choose to accept payments from this payment method type. */
@@ -235,56 +287,85 @@ export interface BuyerFlow {
235
287
  /**
236
288
  * If set, indicates the minimum payment amount that can be made using this payment method type.
237
289
  * If no currency provided, this field will not be set, as the value depends on the currency.
290
+ * @decimalValue options { maxScale:8, gte:0.00 }
238
291
  */
239
292
  minPaymentAmount?: string | null;
240
293
  }
241
294
  export interface GetSitePaymentMethodTypeRequest {
242
- /** Payment method type ID. */
295
+ /**
296
+ * Payment method type ID.
297
+ * @format GUID
298
+ */
243
299
  sitePaymentMethodTypeId: string;
244
300
  /**
245
301
  * Language used to determine localized values for fields in the response.
246
302
  *
247
303
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
304
+ * @format LANGUAGE
248
305
  */
249
306
  language?: string | null;
250
307
  /**
251
308
  * Country used to determine localized values for fields in the response.
252
309
  *
253
310
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
311
+ * @format COUNTRY
254
312
  */
255
313
  country?: string | null;
256
314
  /**
257
315
  * Currency used to determine localized values for fields in the response.
258
316
  *
259
317
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
318
+ * @format CURRENCY
260
319
  */
261
320
  currency?: string | null;
321
+ /**
322
+ * Requested additional fields
323
+ * @maxSize 2
324
+ */
325
+ requestedFields?: RequestedFields[];
326
+ }
327
+ export declare enum RequestedFields {
328
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
329
+ ALLOWED_CURRENCIES = "ALLOWED_CURRENCIES"
262
330
  }
263
331
  export interface GetSitePaymentMethodTypeResponse {
264
332
  /** Requested site payment method type. */
265
333
  sitePaymentMethodType?: SitePaymentMethodType;
266
334
  }
267
335
  export interface ListSitePaymentMethodTypesRequest {
268
- /** IDs or legacy IDs of payment method types to retrieve. */
336
+ /**
337
+ * IDs or legacy IDs of payment method types to retrieve.
338
+ * @maxSize 250
339
+ * @minLength 1
340
+ * @maxLength 50
341
+ */
269
342
  ids?: string[];
270
343
  /**
271
344
  * Language used to determine localized values for fields in the response.
272
345
  *
273
346
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
347
+ * @format LANGUAGE
274
348
  */
275
349
  language?: string | null;
276
350
  /**
277
351
  * Country used to filter payment method types and determine localized values for fields in the response.
278
352
  *
279
353
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
354
+ * @format COUNTRY
280
355
  */
281
356
  country?: string | null;
282
357
  /**
283
358
  * Currency used to determine localized values for fields in the response.
284
359
  *
285
360
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
361
+ * @format CURRENCY
286
362
  */
287
363
  currency?: string | null;
364
+ /**
365
+ * Requested additional fields
366
+ * @maxSize 2
367
+ */
368
+ requestedFields?: RequestedFields[];
288
369
  }
289
370
  export interface ListSitePaymentMethodTypesResponse {
290
371
  /** List of site payment method types. */
@@ -393,6 +474,7 @@ interface SitePaymentMethodTypeNonNullableFields {
393
474
  inPerson: boolean;
394
475
  currencyRestricted: boolean;
395
476
  currencyRestrictionEnabled: boolean;
477
+ allowedCurrencies: string[];
396
478
  }
397
479
  export interface GetSitePaymentMethodTypeResponseNonNullableFields {
398
480
  sitePaymentMethodType?: SitePaymentMethodTypeNonNullableFields;
@@ -1,10 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Format = void 0;
3
+ exports.RequestedFields = exports.Format = void 0;
4
4
  var Format;
5
5
  (function (Format) {
6
6
  Format["UNKNOWN_FORMAT"] = "UNKNOWN_FORMAT";
7
7
  Format["SVG"] = "SVG";
8
8
  Format["PNG"] = "PNG";
9
9
  })(Format || (exports.Format = Format = {}));
10
+ var RequestedFields;
11
+ (function (RequestedFields) {
12
+ RequestedFields["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
13
+ RequestedFields["ALLOWED_CURRENCIES"] = "ALLOWED_CURRENCIES";
14
+ })(RequestedFields || (exports.RequestedFields = RequestedFields = {}));
10
15
  //# sourceMappingURL=payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.ts"],"names":[],"mappings":";;;AA0OA,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,qBAAW,CAAA;IACX,qBAAW,CAAA;AACb,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB"}
1
+ {"version":3,"file":"payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.js","sourceRoot":"","sources":["../../../src/payments-site-payment-method-types-v1-site-payment-method-type-site-payment-method-types.types.ts"],"names":[],"mappings":";;;AA2RA,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2CAAiC,CAAA;IACjC,qBAAW,CAAA;IACX,qBAAW,CAAA;AACb,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;AAgED,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sEAAmD,CAAA;IACnD,4DAAyC,CAAA;AAC3C,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}
@@ -1,8 +1,17 @@
1
1
  /** A way to pay online or offline for goods or services offered by a specific site. */
2
2
  export interface SitePaymentMethodType {
3
- /** Payment method type ID. */
3
+ /**
4
+ * Payment method type ID.
5
+ * @format GUID
6
+ * @immutable
7
+ */
4
8
  _id?: string;
5
- /** Value used buy some legacy APIs to refer to this payment method type. Can be empty. */
9
+ /**
10
+ * Value used buy some legacy APIs to refer to this payment method type. Can be empty.
11
+ * @minLength 1
12
+ * @maxLength 50
13
+ * @immutable
14
+ */
6
15
  legacyId?: string | null;
7
16
  /**
8
17
  * Payment method type display name, based on locale.
@@ -11,6 +20,8 @@ export interface SitePaymentMethodType {
11
20
  *
12
21
  * Define your locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
13
22
  * For more detailed information, see the descriptions for the `country` and `language` parameters for those methods.
23
+ * @minLength 1
24
+ * @maxLength 100
14
25
  */
15
26
  displayName?: string | null;
16
27
  /**
@@ -20,6 +31,8 @@ export interface SitePaymentMethodType {
20
31
  *
21
32
  * Define your locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
22
33
  * For more detailed information, see the descriptions for the `country` and `language` parameters for those methods.
34
+ * @minLength 1
35
+ * @maxLength 1000
23
36
  */
24
37
  description?: string | null;
25
38
  /** Features supported for this payment method type. */
@@ -42,12 +55,20 @@ export interface SitePaymentMethodType {
42
55
  * Time (in seconds after which a transaction is marked as expired if it is not completed.
43
56
  *
44
57
  * Max: `15552000` (180 days)
58
+ * @min 1
59
+ * @max 15552000
45
60
  */
46
61
  transactionExpirationDelayInSeconds?: number | null;
47
62
  /** Indicates that payment method type is restricted for the provided currency. */
48
63
  currencyRestricted?: boolean;
49
64
  /** Indicates the payment method type has currency restriction and it is enabled. */
50
65
  currencyRestrictionEnabled?: boolean;
66
+ /**
67
+ * allowed currencies
68
+ * @maxSize 100
69
+ * @format CURRENCY
70
+ */
71
+ allowedCurrencies?: string[];
51
72
  }
52
73
  export interface Features {
53
74
  /** Express flow configuration. */
@@ -110,21 +131,38 @@ export interface Disputes {
110
131
  export interface Installments {
111
132
  /** Whether installments are supported for this payment method type. */
112
133
  supported?: boolean;
113
- /** Countries for which installments can be enabled. */
134
+ /**
135
+ * Countries for which installments can be enabled.
136
+ * @format COUNTRY
137
+ * @minSize 1
138
+ * @maxSize 200
139
+ */
114
140
  allowedCountries?: string[];
115
- /** Max number of installments that can be configured by a provider. */
141
+ /**
142
+ * Max number of installments that can be configured by a provider.
143
+ * @min 2
144
+ * @max 36
145
+ */
116
146
  maxInstallmentLimit?: number | null;
117
147
  }
118
148
  export interface Refunds {
119
149
  /** Whether refunds are supported for this payment method type. */
120
150
  supported?: boolean;
121
- /** Maximum period in which payments made using this payment method type can be refunded. */
151
+ /**
152
+ * Maximum period in which payments made using this payment method type can be refunded.
153
+ * @min 1
154
+ * @max 365
155
+ */
122
156
  maxRefundabilityPeriodInDays?: number | null;
123
157
  }
124
158
  export interface AuthCapture {
125
159
  /** Whether the authorize and capture flow is supported for this payment method type. */
126
160
  supported?: boolean;
127
- /** Period to wait for the auth capture to be completed before canceling the transaction. */
161
+ /**
162
+ * Period to wait for the auth capture to be completed before canceling the transaction.
163
+ * @min 1
164
+ * @max 365
165
+ */
128
166
  maxCapturePeriodInDays?: number | null;
129
167
  }
130
168
  export interface RegularTokenization {
@@ -165,11 +203,14 @@ export interface MerchantFlow {
165
203
  *
166
204
  * Define a locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
167
205
  * For more detailed information, see the method descriptions.
206
+ * @maxSize 200
168
207
  */
169
208
  icons?: Icon[];
170
209
  /**
171
210
  * Priority given to this payment method type in the list shown to the merchant.
172
211
  * A lower value relative to other payment method types means a higher position on the list.
212
+ * @min 1
213
+ * @max 10000
173
214
  */
174
215
  priority?: number;
175
216
  /** Whether the payment method type is promoted. Promoted payment method types are displayed more prominently on the Accept Payments page. */
@@ -189,6 +230,8 @@ export interface Icon {
189
230
  /**
190
231
  * Icon tag. Payment method types can have multiple icons, and tags are used to differentiate between them.
191
232
  * For example, the UI design for multiple payment method types is upgraded, and now they each have an old icon tagged "v1" and a new icon tagged "v2". Developers can then easily choose to display all the original "v1" style of icons, or all the new "v2" style.
233
+ * @minLength 1
234
+ * @maxLength 100
192
235
  */
193
236
  tag?: string | null;
194
237
  /** Icon image format. */
@@ -205,11 +248,14 @@ export interface BuyerFlow {
205
248
  *
206
249
  * Define a locale by specifying a `country` and `language` when calling `Get Payment Method Type` or `List Payment Method Types`.
207
250
  * For more detailed information, see the method descriptions.
251
+ * @maxSize 200
208
252
  */
209
253
  icons?: Icon[];
210
254
  /**
211
255
  * The priority given to this payment method type in the list of payment method types shown to the buyer.
212
256
  * A lower value relative to other payment method types means a higher position on the list.
257
+ * @min 1
258
+ * @max 10000
213
259
  */
214
260
  priority?: number;
215
261
  /** Whether the merchant cannot choose to accept payments from this payment method type. */
@@ -219,56 +265,85 @@ export interface BuyerFlow {
219
265
  /**
220
266
  * If set, indicates the minimum payment amount that can be made using this payment method type.
221
267
  * If no currency provided, this field will not be set, as the value depends on the currency.
268
+ * @decimalValue options { maxScale:8, gte:0.00 }
222
269
  */
223
270
  minPaymentAmount?: string | null;
224
271
  }
225
272
  export interface GetSitePaymentMethodTypeRequest {
226
- /** Payment method type ID. */
273
+ /**
274
+ * Payment method type ID.
275
+ * @format GUID
276
+ */
227
277
  sitePaymentMethodTypeId: string;
228
278
  /**
229
279
  * Language used to determine localized values for fields in the response.
230
280
  *
231
281
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
282
+ * @format LANGUAGE
232
283
  */
233
284
  language?: string | null;
234
285
  /**
235
286
  * Country used to determine localized values for fields in the response.
236
287
  *
237
288
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
289
+ * @format COUNTRY
238
290
  */
239
291
  country?: string | null;
240
292
  /**
241
293
  * Currency used to determine localized values for fields in the response.
242
294
  *
243
295
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
296
+ * @format CURRENCY
244
297
  */
245
298
  currency?: string | null;
299
+ /**
300
+ * Requested additional fields
301
+ * @maxSize 2
302
+ */
303
+ requestedFields?: RequestedFields[];
304
+ }
305
+ export declare enum RequestedFields {
306
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
307
+ ALLOWED_CURRENCIES = "ALLOWED_CURRENCIES"
246
308
  }
247
309
  export interface GetSitePaymentMethodTypeResponse {
248
310
  /** Requested site payment method type. */
249
311
  sitePaymentMethodType?: SitePaymentMethodType;
250
312
  }
251
313
  export interface ListSitePaymentMethodTypesRequest {
252
- /** IDs or legacy IDs of payment method types to retrieve. */
314
+ /**
315
+ * IDs or legacy IDs of payment method types to retrieve.
316
+ * @maxSize 250
317
+ * @minLength 1
318
+ * @maxLength 50
319
+ */
253
320
  ids?: string[];
254
321
  /**
255
322
  * Language used to determine localized values for fields in the response.
256
323
  *
257
324
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
325
+ * @format LANGUAGE
258
326
  */
259
327
  language?: string | null;
260
328
  /**
261
329
  * Country used to filter payment method types and determine localized values for fields in the response.
262
330
  *
263
331
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
332
+ * @format COUNTRY
264
333
  */
265
334
  country?: string | null;
266
335
  /**
267
336
  * Currency used to determine localized values for fields in the response.
268
337
  *
269
338
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
339
+ * @format CURRENCY
270
340
  */
271
341
  currency?: string | null;
342
+ /**
343
+ * Requested additional fields
344
+ * @maxSize 2
345
+ */
346
+ requestedFields?: RequestedFields[];
272
347
  }
273
348
  export interface ListSitePaymentMethodTypesResponse {
274
349
  /** List of site payment method types. */
@@ -371,6 +446,7 @@ export interface SitePaymentMethodTypeNonNullableFields {
371
446
  inPerson: boolean;
372
447
  currencyRestricted: boolean;
373
448
  currencyRestrictionEnabled: boolean;
449
+ allowedCurrencies: string[];
374
450
  }
375
451
  export interface GetSitePaymentMethodTypeResponseNonNullableFields {
376
452
  sitePaymentMethodType?: SitePaymentMethodTypeNonNullableFields;
@@ -396,12 +472,16 @@ export interface ListSitePaymentMethodTypesResponseNonNullableFields {
396
472
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
397
473
  * @permissionScope Manage Events
398
474
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
475
+ * @permissionScope Manage Challenges
476
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
399
477
  * @permissionScope Manage Portfolio
400
478
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
401
479
  * @permissionScope Access Verticals by Automations
402
480
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
403
481
  * @permissionScope Manage Restaurants - all permissions
404
482
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
483
+ * @permissionScope Set Up Automations
484
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
405
485
  * @applicableIdentity APP
406
486
  * @applicableIdentity VISITOR
407
487
  * @returns Requested site payment method type.
@@ -413,20 +493,28 @@ export interface GetSitePaymentMethodTypeOptions {
413
493
  * Language used to determine localized values for fields in the response.
414
494
  *
415
495
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
496
+ * @format LANGUAGE
416
497
  */
417
498
  language?: string | null;
418
499
  /**
419
500
  * Country used to determine localized values for fields in the response.
420
501
  *
421
502
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
503
+ * @format COUNTRY
422
504
  */
423
505
  country?: string | null;
424
506
  /**
425
507
  * Currency used to determine localized values for fields in the response.
426
508
  *
427
509
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
510
+ * @format CURRENCY
428
511
  */
429
512
  currency?: string | null;
513
+ /**
514
+ * Requested additional fields
515
+ * @maxSize 2
516
+ */
517
+ requestedFields?: RequestedFields[];
430
518
  }
431
519
  /**
432
520
  * Retrieves a list of payment method types.
@@ -448,37 +536,54 @@ export interface GetSitePaymentMethodTypeOptions {
448
536
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
449
537
  * @permissionScope Manage Events
450
538
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
539
+ * @permissionScope Manage Challenges
540
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
451
541
  * @permissionScope Manage Portfolio
452
542
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
453
543
  * @permissionScope Access Verticals by Automations
454
544
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
455
545
  * @permissionScope Manage Restaurants - all permissions
456
546
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
547
+ * @permissionScope Set Up Automations
548
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
457
549
  * @applicableIdentity APP
458
550
  * @applicableIdentity VISITOR
459
551
  * @fqn wix.payments.site_payment_method_types.v1.SitePaymentMethodTypeService.ListSitePaymentMethodTypes
460
552
  */
461
553
  export declare function listSitePaymentMethodTypes(options?: ListSitePaymentMethodTypesOptions): Promise<ListSitePaymentMethodTypesResponse & ListSitePaymentMethodTypesResponseNonNullableFields>;
462
554
  export interface ListSitePaymentMethodTypesOptions {
463
- /** IDs or legacy IDs of payment method types to retrieve. */
555
+ /**
556
+ * IDs or legacy IDs of payment method types to retrieve.
557
+ * @maxSize 250
558
+ * @minLength 1
559
+ * @maxLength 50
560
+ */
464
561
  ids?: string[];
465
562
  /**
466
563
  * Language used to determine localized values for fields in the response.
467
564
  *
468
565
  * Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
566
+ * @format LANGUAGE
469
567
  */
470
568
  language?: string | null;
471
569
  /**
472
570
  * Country used to filter payment method types and determine localized values for fields in the response.
473
571
  *
474
572
  * Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format.
573
+ * @format COUNTRY
475
574
  */
476
575
  country?: string | null;
477
576
  /**
478
577
  * Currency used to determine localized values for fields in the response.
479
578
  *
480
579
  * Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
580
+ * @format CURRENCY
481
581
  */
482
582
  currency?: string | null;
583
+ /**
584
+ * Requested additional fields
585
+ * @maxSize 2
586
+ */
587
+ requestedFields?: RequestedFields[];
483
588
  }
484
589
  export {};