@wix/auto_sdk_payments_saved-payment-methods 1.0.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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.d.ts +20 -0
  11. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js +26 -0
  12. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js.map +1 -0
  13. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.d.ts +22 -0
  14. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js +221 -0
  15. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js.map +1 -0
  16. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.d.ts +26 -0
  17. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js +144 -0
  18. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js.map +1 -0
  19. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.d.ts +63 -0
  20. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js +80 -0
  21. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js.map +1 -0
  22. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.d.ts +371 -0
  23. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js +33 -0
  24. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js.map +1 -0
  25. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.d.ts +600 -0
  26. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js +292 -0
  27. package/build/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.d.ts +20 -0
  39. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js +20 -0
  40. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js.map +1 -0
  41. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.d.ts +22 -0
  42. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js +212 -0
  43. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js.map +1 -0
  44. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.d.ts +26 -0
  45. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js +112 -0
  46. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js.map +1 -0
  47. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.d.ts +63 -0
  48. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js +68 -0
  49. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js.map +1 -0
  50. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.d.ts +371 -0
  51. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js +30 -0
  52. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js.map +1 -0
  53. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.d.ts +600 -0
  54. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js +260 -0
  55. package/build/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.d.ts +20 -0
  66. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js +26 -0
  67. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js.map +1 -0
  68. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.d.ts +22 -0
  69. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js +221 -0
  70. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js.map +1 -0
  71. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.d.ts +26 -0
  72. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js +144 -0
  73. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js.map +1 -0
  74. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.d.ts +63 -0
  75. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js +80 -0
  76. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js.map +1 -0
  77. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.d.ts +371 -0
  78. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js +33 -0
  79. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js.map +1 -0
  80. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.d.ts +600 -0
  81. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js +292 -0
  82. package/build/internal/cjs/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.d.ts +20 -0
  93. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js +20 -0
  94. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.context.js.map +1 -0
  95. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.d.ts +22 -0
  96. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js +212 -0
  97. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.http.js.map +1 -0
  98. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.d.ts +26 -0
  99. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js +112 -0
  100. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.meta.js.map +1 -0
  101. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.d.ts +63 -0
  102. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js +68 -0
  103. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.public.js.map +1 -0
  104. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.d.ts +371 -0
  105. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js +30 -0
  106. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.types.js.map +1 -0
  107. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.d.ts +600 -0
  108. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js +260 -0
  109. package/build/internal/es/src/payments-saved-payment-methods-v1-saved-payment-method-saved-payment-methods.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,600 @@
1
+ export interface SavedPaymentMethod {
2
+ /**
3
+ * Unique identifier of a saved payment method.
4
+ * @readonly
5
+ */
6
+ _id?: string | null;
7
+ /**
8
+ * Represents the current state of a saved payment method. Each time saved payment method is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
9
+ * @readonly
10
+ */
11
+ revision?: string | null;
12
+ /**
13
+ * SavedPaymentMethod creation time.
14
+ * @readonly
15
+ */
16
+ _createdDate?: Date | null;
17
+ /**
18
+ * SavedPaymentMethod last update time.
19
+ * @readonly
20
+ */
21
+ _updatedDate?: Date | null;
22
+ /** Saved payment method owner's member ID. */
23
+ siteMemberId?: string | null;
24
+ /**
25
+ * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
26
+ * @readonly
27
+ */
28
+ primary?: boolean;
29
+ /** Payment method details. */
30
+ paymentMethod?: PaymentMethod;
31
+ /**
32
+ * Defines whether this payment method can be used by the merchant for making unscheduled payments.
33
+ * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
34
+ */
35
+ merchantUseAllowed?: boolean | null;
36
+ /**
37
+ * Saved payment method sensitive information.
38
+ * @readonly
39
+ */
40
+ sensitiveInfo?: SensitiveInfo;
41
+ /** Data Extensions */
42
+ extendedFields?: ExtendedFields;
43
+ }
44
+ export interface CardInfo {
45
+ /**
46
+ * Credit card's last 4 digits.
47
+ * @readonly
48
+ */
49
+ lastFourDigits?: string | null;
50
+ /**
51
+ * Credit card's BIN (Bank Identification Number). It's first 4-6 digits of card's number.
52
+ * @readonly
53
+ */
54
+ bin?: string | null;
55
+ /** Credit card's expiration month. */
56
+ expirationMonth?: number | null;
57
+ /** Credit card's expiration year. */
58
+ expirationYear?: number | null;
59
+ /** Card holder's full name specified on the card. */
60
+ cardholderName?: string | null;
61
+ }
62
+ export declare enum CardBrand {
63
+ UNKNOWN_CARD_BRAND = "UNKNOWN_CARD_BRAND",
64
+ AMEX = "AMEX",
65
+ DANKORT = "DANKORT",
66
+ DINERS = "DINERS",
67
+ DISCOVER = "DISCOVER",
68
+ ISRACARD = "ISRACARD",
69
+ JCB = "JCB",
70
+ MAESTRO = "MAESTRO",
71
+ MASTERCARD = "MASTERCARD",
72
+ UNIONPAY = "UNIONPAY",
73
+ VISA = "VISA",
74
+ RUPAY = "RUPAY"
75
+ }
76
+ export interface PaymentMethod {
77
+ /** Legacy payment method type ID. Supported values are `creditCard`, `payPal`. */
78
+ typeId?: string;
79
+ /**
80
+ * Payment method type ID.
81
+ * @readonly
82
+ */
83
+ paymentMethodTypeId?: string;
84
+ /**
85
+ * Payment method brand ID.
86
+ * @readonly
87
+ */
88
+ paymentMethodBrandId?: string | null;
89
+ /** Details of credit card. */
90
+ cardInfo?: CardInfo;
91
+ }
92
+ export interface SensitiveInfo {
93
+ /** Sensitive details of credit card like card token. */
94
+ cardSensitiveInfo?: CardSensitiveInfo;
95
+ }
96
+ export interface CardSensitiveInfo {
97
+ /** Persistent token of credit card tokenized by Wix. */
98
+ persistentToken?: string | null;
99
+ }
100
+ export interface ExtendedFields {
101
+ /**
102
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
103
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
104
+ *
105
+ * You can only access fields for which you have the appropriate permissions.
106
+ *
107
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
108
+ */
109
+ namespaces?: Record<string, Record<string, any>>;
110
+ }
111
+ export interface FindSavedCreditCardRequest {
112
+ /** temporary card token */
113
+ temporaryCardToken?: string;
114
+ /** site member id */
115
+ siteMemberId?: string;
116
+ /** expiration month */
117
+ expirationMonth?: number;
118
+ /** expiration year */
119
+ expirationYear?: number;
120
+ }
121
+ export interface FindSavedCreditCardResponse {
122
+ /** saved payment method id */
123
+ savedPaymentMethodId?: string | null;
124
+ }
125
+ export interface UpsertSavedPaymentMethodRequest {
126
+ /** Saved payment method. */
127
+ savedPaymentMethod: SavedPaymentMethod;
128
+ /** Temporary token of credit card tokenized by Wix. This token is used to create a persistent token */
129
+ temporaryCardToken: string | null;
130
+ }
131
+ export interface UpsertSavedPaymentMethodResponse {
132
+ /** Saved payment method. */
133
+ savedPaymentMethod?: SavedPaymentMethod;
134
+ }
135
+ export interface GetSavedPaymentMethodRequest {
136
+ /** Unique identifier of a saved payment method. */
137
+ savedPaymentMethodId: string;
138
+ /**
139
+ * List of heeded fields that will be returned.
140
+ * You should have additional permission in order to get them as described in HidedFields documentation.
141
+ */
142
+ fields?: RequestedFields[];
143
+ }
144
+ export declare enum RequestedFields {
145
+ /** Default value. This value is unused. */
146
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
147
+ SENSITIVE_INFO = "SENSITIVE_INFO"
148
+ }
149
+ export interface GetSavedPaymentMethodResponse {
150
+ /** Saved payment method. */
151
+ savedPaymentMethod?: SavedPaymentMethod;
152
+ }
153
+ export interface DeleteSavedPaymentMethodRequest {
154
+ /** Unique identifier of a saved payment method. */
155
+ savedPaymentMethodId: string;
156
+ }
157
+ export interface DeleteSavedPaymentMethodResponse {
158
+ }
159
+ export interface ListSavedPaymentMethodsRequest {
160
+ /**
161
+ * Site member that owns saved payment methods.
162
+ * Pass `me` to list saved payment method of the current site member.
163
+ */
164
+ siteMemberId?: string | null;
165
+ /** Payment method type id. Supported values are `creditCard`, `payPal`. */
166
+ paymentMethodTypeId?: string | null;
167
+ /**
168
+ * Defines whether this payment method can be used by the merchant for making unscheduled payments.
169
+ * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
170
+ */
171
+ merchantUseAllowed?: boolean | null;
172
+ /**
173
+ * List of requested fields that will be returned.
174
+ * Supported values:
175
+ * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
176
+ * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
177
+ */
178
+ fields?: RequestedFields[];
179
+ /**
180
+ * Paging for limit the response size.
181
+ * If no paging provider default response limit 100 will be used.
182
+ */
183
+ paging?: CursorPaging;
184
+ }
185
+ export interface CursorPaging {
186
+ /** Maximum number of items to return in the results. */
187
+ limit?: number | null;
188
+ /**
189
+ * Pointer to the next or previous page in the list of results.
190
+ *
191
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
192
+ * Not relevant for the first request.
193
+ */
194
+ cursor?: string | null;
195
+ }
196
+ export interface ListSavedPaymentMethodsResponse {
197
+ /** List of saved payment methods. */
198
+ savedPaymentMethods?: SavedPaymentMethod[];
199
+ /** Paging metadata. */
200
+ pagingMetadata?: CursorPagingMetadata;
201
+ }
202
+ export interface CursorPagingMetadata {
203
+ /** Number of items returned in the response. */
204
+ count?: number | null;
205
+ /** Cursor strings that point to the next page, previous page, or both. */
206
+ cursors?: Cursors;
207
+ /**
208
+ * Whether there are more pages to retrieve following the current page.
209
+ *
210
+ * + `true`: Another page of results can be retrieved.
211
+ * + `false`: This is the last page.
212
+ */
213
+ hasNext?: boolean | null;
214
+ }
215
+ export interface Cursors {
216
+ /** Cursor string pointing to the next page in the list of results. */
217
+ next?: string | null;
218
+ /** Cursor pointing to the previous page in the list of results. */
219
+ prev?: string | null;
220
+ }
221
+ export interface UpdateSavedPaymentMethodRequest {
222
+ /** Saved payment method to update. */
223
+ savedPaymentMethod?: SavedPaymentMethod;
224
+ }
225
+ export interface UpdateSavedPaymentMethodResponse {
226
+ /** Updated saved payment method. */
227
+ savedPaymentMethod?: SavedPaymentMethod;
228
+ }
229
+ export interface MarkSavedPaymentMethodPrimaryRequest {
230
+ /** Unique identifier of a saved payment method. */
231
+ savedPaymentMethodId: string;
232
+ }
233
+ export interface MarkSavedPaymentMethodPrimaryResponse {
234
+ }
235
+ export interface DomainEvent extends DomainEventBodyOneOf {
236
+ createdEvent?: EntityCreatedEvent;
237
+ updatedEvent?: EntityUpdatedEvent;
238
+ deletedEvent?: EntityDeletedEvent;
239
+ actionEvent?: ActionEvent;
240
+ /**
241
+ * Unique event ID.
242
+ * Allows clients to ignore duplicate webhooks.
243
+ */
244
+ _id?: string;
245
+ /**
246
+ * Assumes actions are also always typed to an entity_type
247
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
248
+ */
249
+ entityFqdn?: string;
250
+ /**
251
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
252
+ * This is although the created/updated/deleted notion is duplication of the oneof types
253
+ * Example: created/updated/deleted/started/completed/email_opened
254
+ */
255
+ slug?: string;
256
+ /** ID of the entity associated with the event. */
257
+ entityId?: string;
258
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
259
+ eventTime?: Date | null;
260
+ /**
261
+ * Whether the event was triggered as a result of a privacy regulation application
262
+ * (for example, GDPR).
263
+ */
264
+ triggeredByAnonymizeRequest?: boolean | null;
265
+ /** If present, indicates the action that triggered the event. */
266
+ originatedFrom?: string | null;
267
+ /**
268
+ * A sequence number defining the order of updates to the underlying entity.
269
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
270
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
271
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
272
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
273
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
274
+ */
275
+ entityEventSequence?: string | null;
276
+ }
277
+ /** @oneof */
278
+ export interface DomainEventBodyOneOf {
279
+ createdEvent?: EntityCreatedEvent;
280
+ updatedEvent?: EntityUpdatedEvent;
281
+ deletedEvent?: EntityDeletedEvent;
282
+ actionEvent?: ActionEvent;
283
+ }
284
+ export interface EntityCreatedEvent {
285
+ entity?: string;
286
+ }
287
+ export interface RestoreInfo {
288
+ deletedDate?: Date | null;
289
+ }
290
+ export interface EntityUpdatedEvent {
291
+ /**
292
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
293
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
294
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
295
+ */
296
+ currentEntity?: string;
297
+ }
298
+ export interface EntityDeletedEvent {
299
+ /** Entity that was deleted */
300
+ deletedEntity?: string | null;
301
+ }
302
+ export interface ActionEvent {
303
+ body?: string;
304
+ }
305
+ export interface MessageEnvelope {
306
+ /** App instance ID. */
307
+ instanceId?: string | null;
308
+ /** Event type. */
309
+ eventType?: string;
310
+ /** The identification type and identity data. */
311
+ identity?: IdentificationData;
312
+ /** Stringify payload. */
313
+ data?: string;
314
+ }
315
+ export interface IdentificationData extends IdentificationDataIdOneOf {
316
+ /** ID of a site visitor that has not logged in to the site. */
317
+ anonymousVisitorId?: string;
318
+ /** ID of a site visitor that has logged in to the site. */
319
+ memberId?: string;
320
+ /** ID of a Wix user (site owner, contributor, etc.). */
321
+ wixUserId?: string;
322
+ /** ID of an app. */
323
+ appId?: string;
324
+ /** @readonly */
325
+ identityType?: WebhookIdentityType;
326
+ }
327
+ /** @oneof */
328
+ export interface IdentificationDataIdOneOf {
329
+ /** ID of a site visitor that has not logged in to the site. */
330
+ anonymousVisitorId?: string;
331
+ /** ID of a site visitor that has logged in to the site. */
332
+ memberId?: string;
333
+ /** ID of a Wix user (site owner, contributor, etc.). */
334
+ wixUserId?: string;
335
+ /** ID of an app. */
336
+ appId?: string;
337
+ }
338
+ export declare enum WebhookIdentityType {
339
+ UNKNOWN = "UNKNOWN",
340
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
341
+ MEMBER = "MEMBER",
342
+ WIX_USER = "WIX_USER",
343
+ APP = "APP"
344
+ }
345
+ interface CardInfoNonNullableFields {
346
+ brand: CardBrand;
347
+ }
348
+ interface PaymentMethodNonNullableFields {
349
+ typeId: string;
350
+ paymentMethodTypeId: string;
351
+ cardInfo?: CardInfoNonNullableFields;
352
+ }
353
+ export interface SavedPaymentMethodNonNullableFields {
354
+ primary: boolean;
355
+ paymentMethod?: PaymentMethodNonNullableFields;
356
+ }
357
+ export interface UpsertSavedPaymentMethodResponseNonNullableFields {
358
+ savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
359
+ }
360
+ export interface GetSavedPaymentMethodResponseNonNullableFields {
361
+ savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
362
+ }
363
+ export interface ListSavedPaymentMethodsResponseNonNullableFields {
364
+ savedPaymentMethods: SavedPaymentMethodNonNullableFields[];
365
+ }
366
+ export interface UpdateSavedPaymentMethodResponseNonNullableFields {
367
+ savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
368
+ }
369
+ export interface BaseEventMetadata {
370
+ /** App instance ID. */
371
+ instanceId?: string | null;
372
+ /** Event type. */
373
+ eventType?: string;
374
+ /** The identification type and identity data. */
375
+ identity?: IdentificationData;
376
+ }
377
+ export interface EventMetadata extends BaseEventMetadata {
378
+ /**
379
+ * Unique event ID.
380
+ * Allows clients to ignore duplicate webhooks.
381
+ */
382
+ _id?: string;
383
+ /**
384
+ * Assumes actions are also always typed to an entity_type
385
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
386
+ */
387
+ entityFqdn?: string;
388
+ /**
389
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
390
+ * This is although the created/updated/deleted notion is duplication of the oneof types
391
+ * Example: created/updated/deleted/started/completed/email_opened
392
+ */
393
+ slug?: string;
394
+ /** ID of the entity associated with the event. */
395
+ entityId?: string;
396
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
397
+ eventTime?: Date | null;
398
+ /**
399
+ * Whether the event was triggered as a result of a privacy regulation application
400
+ * (for example, GDPR).
401
+ */
402
+ triggeredByAnonymizeRequest?: boolean | null;
403
+ /** If present, indicates the action that triggered the event. */
404
+ originatedFrom?: string | null;
405
+ /**
406
+ * A sequence number defining the order of updates to the underlying entity.
407
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
408
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
409
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
410
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
411
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
412
+ */
413
+ entityEventSequence?: string | null;
414
+ }
415
+ export interface SavedPaymentMethodCreatedEnvelope {
416
+ entity: SavedPaymentMethod;
417
+ metadata: EventMetadata;
418
+ }
419
+ /** @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
420
+ * @webhook
421
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_created
422
+ * @documentationMaturity preview
423
+ */
424
+ export declare function onSavedPaymentMethodCreated(handler: (event: SavedPaymentMethodCreatedEnvelope) => void | Promise<void>): void;
425
+ export interface SavedPaymentMethodUpdatedEnvelope {
426
+ entity: SavedPaymentMethod;
427
+ metadata: EventMetadata;
428
+ }
429
+ /** @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
430
+ * @webhook
431
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_updated
432
+ * @documentationMaturity preview
433
+ */
434
+ export declare function onSavedPaymentMethodUpdated(handler: (event: SavedPaymentMethodUpdatedEnvelope) => void | Promise<void>): void;
435
+ export interface SavedPaymentMethodDeletedEnvelope {
436
+ metadata: EventMetadata;
437
+ }
438
+ /** @webhook
439
+ * @eventType wix.payments.saved_payment_methods.v1.saved_payment_method_deleted
440
+ * @documentationMaturity preview
441
+ */
442
+ export declare function onSavedPaymentMethodDeleted(handler: (event: SavedPaymentMethodDeletedEnvelope) => void | Promise<void>): void;
443
+ /**
444
+ * Creates a new SavedPaymentMethod or updates existing one if SavedPaymentMethod already exists for the same site member.
445
+ * To check uniqueness SavedPaymentMethods are compared by credit card expiration year/month, last four digits and bin.
446
+ * If sensitiveInfo.cardSensitiveInfo.temporaryToken was passed than service will eventually create a persi from it.
447
+ * @param savedPaymentMethod - Saved payment method.
448
+ * @public
449
+ * @documentationMaturity preview
450
+ * @requiredField options
451
+ * @requiredField options.temporaryCardToken
452
+ * @requiredField savedPaymentMethod
453
+ * @requiredField savedPaymentMethod.paymentMethod
454
+ * @requiredField savedPaymentMethod.paymentMethod.cardInfo.expirationMonth
455
+ * @requiredField savedPaymentMethod.paymentMethod.cardInfo.expirationYear
456
+ * @requiredField savedPaymentMethod.paymentMethod.typeId
457
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPSERT
458
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPSERT_WITH_MEMBER_ID
459
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.UpsertSavedPaymentMethod
460
+ */
461
+ export declare function upsertSavedPaymentMethod(savedPaymentMethod: SavedPaymentMethod, options: UpsertSavedPaymentMethodOptions): Promise<UpsertSavedPaymentMethodResponse & UpsertSavedPaymentMethodResponseNonNullableFields>;
462
+ export interface UpsertSavedPaymentMethodOptions {
463
+ /** Temporary token of credit card tokenized by Wix. This token is used to create a persistent token */
464
+ temporaryCardToken: string | null;
465
+ }
466
+ /**
467
+ * Returns SavedPaymentMethod by ID.
468
+ * @param savedPaymentMethodId - Unique identifier of a saved payment method.
469
+ * @public
470
+ * @documentationMaturity preview
471
+ * @requiredField savedPaymentMethodId
472
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
473
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO
474
+ * @returns Saved payment method.
475
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.GetSavedPaymentMethod
476
+ */
477
+ export declare function getSavedPaymentMethod(savedPaymentMethodId: string, options?: GetSavedPaymentMethodOptions): Promise<SavedPaymentMethod & SavedPaymentMethodNonNullableFields>;
478
+ export interface GetSavedPaymentMethodOptions {
479
+ /**
480
+ * List of heeded fields that will be returned.
481
+ * You should have additional permission in order to get them as described in HidedFields documentation.
482
+ */
483
+ fields?: RequestedFields[];
484
+ }
485
+ /**
486
+ * Deletes SavedPaymentMethod by ID.
487
+ * @param savedPaymentMethodId - Unique identifier of a saved payment method.
488
+ * @public
489
+ * @documentationMaturity preview
490
+ * @requiredField savedPaymentMethodId
491
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_DELETE
492
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.DeleteSavedPaymentMethod
493
+ */
494
+ export declare function deleteSavedPaymentMethod(savedPaymentMethodId: string): Promise<void>;
495
+ /**
496
+ * Lists SavedPaymentMethods ordered by update date descending.
497
+ * @public
498
+ * @documentationMaturity preview
499
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ
500
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO
501
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.ListSavedPaymentMethods
502
+ */
503
+ export declare function listSavedPaymentMethods(options?: ListSavedPaymentMethodsOptions): Promise<ListSavedPaymentMethodsResponse & ListSavedPaymentMethodsResponseNonNullableFields>;
504
+ export interface ListSavedPaymentMethodsOptions {
505
+ /**
506
+ * Site member that owns saved payment methods.
507
+ * Pass `me` to list saved payment method of the current site member.
508
+ */
509
+ siteMemberId?: string | null;
510
+ /** Payment method type id. Supported values are `creditCard`, `payPal`. */
511
+ paymentMethodTypeId?: string | null;
512
+ /**
513
+ * Defines whether this payment method can be used by the merchant for making unscheduled payments.
514
+ * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
515
+ */
516
+ merchantUseAllowed?: boolean | null;
517
+ /**
518
+ * List of requested fields that will be returned.
519
+ * Supported values:
520
+ * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
521
+ * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
522
+ */
523
+ fields?: RequestedFields[];
524
+ /**
525
+ * Paging for limit the response size.
526
+ * If no paging provider default response limit 100 will be used.
527
+ */
528
+ paging?: CursorPaging;
529
+ }
530
+ /**
531
+ * Updates SavedPaymentMethod. Only fields listed in field_mask are updated.
532
+ * @param _id - Unique identifier of a saved payment method.
533
+ * @public
534
+ * @documentationMaturity preview
535
+ * @requiredField _id
536
+ * @requiredField options.savedPaymentMethod.revision
537
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_UPDATE
538
+ * @returns Updated saved payment method.
539
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.UpdateSavedPaymentMethod
540
+ */
541
+ export declare function updateSavedPaymentMethod(_id: string | null, options?: UpdateSavedPaymentMethodOptions): Promise<SavedPaymentMethod & SavedPaymentMethodNonNullableFields>;
542
+ export interface UpdateSavedPaymentMethodOptions {
543
+ savedPaymentMethod: {
544
+ /**
545
+ * Unique identifier of a saved payment method.
546
+ * @readonly
547
+ */
548
+ _id?: string | null;
549
+ /**
550
+ * Represents the current state of a saved payment method. Each time saved payment method is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
551
+ * @readonly
552
+ */
553
+ revision?: string | null;
554
+ /**
555
+ * SavedPaymentMethod creation time.
556
+ * @readonly
557
+ */
558
+ _createdDate?: Date | null;
559
+ /**
560
+ * SavedPaymentMethod last update time.
561
+ * @readonly
562
+ */
563
+ _updatedDate?: Date | null;
564
+ /** Saved payment method owner's member ID. */
565
+ siteMemberId?: string | null;
566
+ /**
567
+ * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
568
+ * @readonly
569
+ */
570
+ primary?: boolean;
571
+ /** Payment method details. */
572
+ paymentMethod?: PaymentMethod;
573
+ /**
574
+ * Defines whether this payment method can be used by the merchant for making unscheduled payments.
575
+ * Even if it's set to `false` payment method still can be used for scheduled payments e.g. subscription renewal without the buyer being present.
576
+ */
577
+ merchantUseAllowed?: boolean | null;
578
+ /**
579
+ * Saved payment method sensitive information.
580
+ * @readonly
581
+ */
582
+ sensitiveInfo?: SensitiveInfo;
583
+ /** Data Extensions */
584
+ extendedFields?: ExtendedFields;
585
+ };
586
+ }
587
+ /**
588
+ * Marks SavedPaymentMethod as primary for site member who's the owner of this SavedPaymentMethod.
589
+ * Primary SavedPaymentMethod is selected by default during the checkout.
590
+ * For every site member there can be at most one primary SavedPaymentMethod,
591
+ * so when one SavedPaymentMethod is marked as primary previous one is automatically unmarked.
592
+ * @param savedPaymentMethodId - Unique identifier of a saved payment method.
593
+ * @public
594
+ * @documentationMaturity preview
595
+ * @requiredField savedPaymentMethodId
596
+ * @permissionId PAYMENTS.SAVED_PAYMENT_METHOD_MARK_PRIMARY
597
+ * @fqn wix.payments.saved_payment_methods.v1.SavedPaymentMethodService.MarkSavedPaymentMethodPrimary
598
+ */
599
+ export declare function markSavedPaymentMethodPrimary(savedPaymentMethodId: string): Promise<void>;
600
+ export {};