@wix/payments 1.0.26 → 1.0.27

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.
@@ -1,2464 +0,0 @@
1
- type HostModule<T, H extends Host> = {
2
- __type: 'host';
3
- create(host: H): T;
4
- };
5
- type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
6
- type Host<Environment = unknown> = {
7
- channel: {
8
- observeState(callback: (props: unknown, environment: Environment) => unknown): {
9
- disconnect: () => void;
10
- } | Promise<{
11
- disconnect: () => void;
12
- }>;
13
- };
14
- environment?: Environment;
15
- /**
16
- * Optional name of the environment, use for logging
17
- */
18
- name?: string;
19
- /**
20
- * Optional bast url to use for API requests, for example `www.wixapis.com`
21
- */
22
- apiBaseUrl?: string;
23
- /**
24
- * Possible data to be provided by every host, for cross cutting concerns
25
- * like internationalization, billing, etc.
26
- */
27
- essentials?: {
28
- /**
29
- * The language of the currently viewed session
30
- */
31
- language?: string;
32
- /**
33
- * The locale of the currently viewed session
34
- */
35
- locale?: string;
36
- /**
37
- * Any headers that should be passed through to the API requests
38
- */
39
- passThroughHeaders?: Record<string, string>;
40
- };
41
- };
42
-
43
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
44
- interface HttpClient {
45
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
46
- fetchWithAuth: typeof fetch;
47
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
48
- getActiveToken?: () => string | undefined;
49
- }
50
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
51
- type HttpResponse<T = any> = {
52
- data: T;
53
- status: number;
54
- statusText: string;
55
- headers: any;
56
- request?: any;
57
- };
58
- type RequestOptions<_TResponse = any, Data = any> = {
59
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
60
- url: string;
61
- data?: Data;
62
- params?: URLSearchParams;
63
- } & APIMetadata;
64
- type APIMetadata = {
65
- methodFqn?: string;
66
- entityFqdn?: string;
67
- packageName?: string;
68
- };
69
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
70
- type EventDefinition<Payload = unknown, Type extends string = string> = {
71
- __type: 'event-definition';
72
- type: Type;
73
- isDomainEvent?: boolean;
74
- transformations?: (envelope: unknown) => Payload;
75
- __payload: Payload;
76
- };
77
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
78
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
79
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
80
-
81
- type ServicePluginMethodInput = {
82
- request: any;
83
- metadata: any;
84
- };
85
- type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
86
- type ServicePluginMethodMetadata = {
87
- name: string;
88
- primaryHttpMappingPath: string;
89
- transformations: {
90
- fromREST: (...args: unknown[]) => ServicePluginMethodInput;
91
- toREST: (...args: unknown[]) => unknown;
92
- };
93
- };
94
- type ServicePluginDefinition<Contract extends ServicePluginContract> = {
95
- __type: 'service-plugin-definition';
96
- componentType: string;
97
- methods: ServicePluginMethodMetadata[];
98
- __contract: Contract;
99
- };
100
- declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
101
- type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
102
- declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
103
-
104
- type RequestContext = {
105
- isSSR: boolean;
106
- host: string;
107
- protocol?: string;
108
- };
109
- type ResponseTransformer = (data: any, headers?: any) => any;
110
- /**
111
- * Ambassador request options types are copied mostly from AxiosRequestConfig.
112
- * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
113
- * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
114
- */
115
- type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
116
- type AmbassadorRequestOptions<T = any> = {
117
- _?: T;
118
- url?: string;
119
- method?: Method;
120
- params?: any;
121
- data?: any;
122
- transformResponse?: ResponseTransformer | ResponseTransformer[];
123
- };
124
- type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
125
- __isAmbassador: boolean;
126
- };
127
- type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
128
- type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
129
-
130
- declare global {
131
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
132
- interface SymbolConstructor {
133
- readonly observable: symbol;
134
- }
135
- }
136
-
137
- declare const emptyObjectSymbol: unique symbol;
138
-
139
- /**
140
- Represents a strictly empty plain object, the `{}` value.
141
-
142
- When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
143
-
144
- @example
145
- ```
146
- import type {EmptyObject} from 'type-fest';
147
-
148
- // The following illustrates the problem with `{}`.
149
- const foo1: {} = {}; // Pass
150
- const foo2: {} = []; // Pass
151
- const foo3: {} = 42; // Pass
152
- const foo4: {} = {a: 1}; // Pass
153
-
154
- // With `EmptyObject` only the first case is valid.
155
- const bar1: EmptyObject = {}; // Pass
156
- const bar2: EmptyObject = 42; // Fail
157
- const bar3: EmptyObject = []; // Fail
158
- const bar4: EmptyObject = {a: 1}; // Fail
159
- ```
160
-
161
- Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
162
-
163
- @category Object
164
- */
165
- type EmptyObject = {[emptyObjectSymbol]?: never};
166
-
167
- /**
168
- Returns a boolean for whether the two given types are equal.
169
-
170
- @link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
171
- @link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
172
-
173
- Use-cases:
174
- - If you want to make a conditional branch based on the result of a comparison of two types.
175
-
176
- @example
177
- ```
178
- import type {IsEqual} from 'type-fest';
179
-
180
- // This type returns a boolean for whether the given array includes the given item.
181
- // `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
182
- type Includes<Value extends readonly any[], Item> =
183
- Value extends readonly [Value[0], ...infer rest]
184
- ? IsEqual<Value[0], Item> extends true
185
- ? true
186
- : Includes<rest, Item>
187
- : false;
188
- ```
189
-
190
- @category Type Guard
191
- @category Utilities
192
- */
193
- type IsEqual<A, B> =
194
- (<G>() => G extends A ? 1 : 2) extends
195
- (<G>() => G extends B ? 1 : 2)
196
- ? true
197
- : false;
198
-
199
- /**
200
- Filter out keys from an object.
201
-
202
- Returns `never` if `Exclude` is strictly equal to `Key`.
203
- Returns `never` if `Key` extends `Exclude`.
204
- Returns `Key` otherwise.
205
-
206
- @example
207
- ```
208
- type Filtered = Filter<'foo', 'foo'>;
209
- //=> never
210
- ```
211
-
212
- @example
213
- ```
214
- type Filtered = Filter<'bar', string>;
215
- //=> never
216
- ```
217
-
218
- @example
219
- ```
220
- type Filtered = Filter<'bar', 'foo'>;
221
- //=> 'bar'
222
- ```
223
-
224
- @see {Except}
225
- */
226
- type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
227
-
228
- type ExceptOptions = {
229
- /**
230
- Disallow assigning non-specified properties.
231
-
232
- Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
233
-
234
- @default false
235
- */
236
- requireExactProps?: boolean;
237
- };
238
-
239
- /**
240
- Create a type from an object type without certain keys.
241
-
242
- We recommend setting the `requireExactProps` option to `true`.
243
-
244
- This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
245
-
246
- This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
247
-
248
- @example
249
- ```
250
- import type {Except} from 'type-fest';
251
-
252
- type Foo = {
253
- a: number;
254
- b: string;
255
- };
256
-
257
- type FooWithoutA = Except<Foo, 'a'>;
258
- //=> {b: string}
259
-
260
- const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
261
- //=> errors: 'a' does not exist in type '{ b: string; }'
262
-
263
- type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
264
- //=> {a: number} & Partial<Record<"b", never>>
265
-
266
- const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
267
- //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
268
- ```
269
-
270
- @category Object
271
- */
272
- type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
273
- [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
274
- } & (Options['requireExactProps'] extends true
275
- ? Partial<Record<KeysType, never>>
276
- : {});
277
-
278
- /**
279
- Returns a boolean for whether the given type is `never`.
280
-
281
- @link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
282
- @link https://stackoverflow.com/a/53984913/10292952
283
- @link https://www.zhenghao.io/posts/ts-never
284
-
285
- Useful in type utilities, such as checking if something does not occur.
286
-
287
- @example
288
- ```
289
- import type {IsNever, And} from 'type-fest';
290
-
291
- // https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
292
- type AreStringsEqual<A extends string, B extends string> =
293
- And<
294
- IsNever<Exclude<A, B>> extends true ? true : false,
295
- IsNever<Exclude<B, A>> extends true ? true : false
296
- >;
297
-
298
- type EndIfEqual<I extends string, O extends string> =
299
- AreStringsEqual<I, O> extends true
300
- ? never
301
- : void;
302
-
303
- function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
304
- if (input === output) {
305
- process.exit(0);
306
- }
307
- }
308
-
309
- endIfEqual('abc', 'abc');
310
- //=> never
311
-
312
- endIfEqual('abc', '123');
313
- //=> void
314
- ```
315
-
316
- @category Type Guard
317
- @category Utilities
318
- */
319
- type IsNever<T> = [T] extends [never] ? true : false;
320
-
321
- /**
322
- An if-else-like type that resolves depending on whether the given type is `never`.
323
-
324
- @see {@link IsNever}
325
-
326
- @example
327
- ```
328
- import type {IfNever} from 'type-fest';
329
-
330
- type ShouldBeTrue = IfNever<never>;
331
- //=> true
332
-
333
- type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
334
- //=> 'bar'
335
- ```
336
-
337
- @category Type Guard
338
- @category Utilities
339
- */
340
- type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
341
- IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
342
- );
343
-
344
- /**
345
- Extract the keys from a type where the value type of the key extends the given `Condition`.
346
-
347
- Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
348
-
349
- @example
350
- ```
351
- import type {ConditionalKeys} from 'type-fest';
352
-
353
- interface Example {
354
- a: string;
355
- b: string | number;
356
- c?: string;
357
- d: {};
358
- }
359
-
360
- type StringKeysOnly = ConditionalKeys<Example, string>;
361
- //=> 'a'
362
- ```
363
-
364
- To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
365
-
366
- @example
367
- ```
368
- import type {ConditionalKeys} from 'type-fest';
369
-
370
- type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
371
- //=> 'a' | 'c'
372
- ```
373
-
374
- @category Object
375
- */
376
- type ConditionalKeys<Base, Condition> =
377
- {
378
- // Map through all the keys of the given base type.
379
- [Key in keyof Base]-?:
380
- // Pick only keys with types extending the given `Condition` type.
381
- Base[Key] extends Condition
382
- // Retain this key
383
- // If the value for the key extends never, only include it if `Condition` also extends never
384
- ? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
385
- // Discard this key since the condition fails.
386
- : never;
387
- // Convert the produced object into a union type of the keys which passed the conditional test.
388
- }[keyof Base];
389
-
390
- /**
391
- Exclude keys from a shape that matches the given `Condition`.
392
-
393
- This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
394
-
395
- @example
396
- ```
397
- import type {Primitive, ConditionalExcept} from 'type-fest';
398
-
399
- class Awesome {
400
- name: string;
401
- successes: number;
402
- failures: bigint;
403
-
404
- run() {}
405
- }
406
-
407
- type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
408
- //=> {run: () => void}
409
- ```
410
-
411
- @example
412
- ```
413
- import type {ConditionalExcept} from 'type-fest';
414
-
415
- interface Example {
416
- a: string;
417
- b: string | number;
418
- c: () => void;
419
- d: {};
420
- }
421
-
422
- type NonStringKeysOnly = ConditionalExcept<Example, string>;
423
- //=> {b: string | number; c: () => void; d: {}}
424
- ```
425
-
426
- @category Object
427
- */
428
- type ConditionalExcept<Base, Condition> = Except<
429
- Base,
430
- ConditionalKeys<Base, Condition>
431
- >;
432
-
433
- /**
434
- * Descriptors are objects that describe the API of a module, and the module
435
- * can either be a REST module or a host module.
436
- * This type is recursive, so it can describe nested modules.
437
- */
438
- type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
439
- [key: string]: Descriptors | PublicMetadata | any;
440
- };
441
- /**
442
- * This type takes in a descriptors object of a certain Host (including an `unknown` host)
443
- * and returns an object with the same structure, but with all descriptors replaced with their API.
444
- * Any non-descriptor properties are removed from the returned object, including descriptors that
445
- * do not match the given host (as they will not work with the given host).
446
- */
447
- type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
448
- done: T;
449
- recurse: T extends {
450
- __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
451
- } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
452
- [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
453
- -1,
454
- 0,
455
- 1,
456
- 2,
457
- 3,
458
- 4,
459
- 5
460
- ][Depth]> : never;
461
- }, EmptyObject>;
462
- }[Depth extends -1 ? 'done' : 'recurse'];
463
- type PublicMetadata = {
464
- PACKAGE_NAME?: string;
465
- };
466
-
467
- declare global {
468
- interface ContextualClient {
469
- }
470
- }
471
- /**
472
- * A type used to create concerete types from SDK descriptors in
473
- * case a contextual client is available.
474
- */
475
- type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
476
- host: Host;
477
- } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
478
-
479
- interface OnboardingAvailability {
480
- /**
481
- * ID of this entity
482
- * @readonly
483
- */
484
- _id?: string;
485
- /** Information about CBD specific flow. Will have DECLINED status if user is not in United States */
486
- cbdFlow?: CbdFlow;
487
- /** Information about all restricted goods user might sell. */
488
- restrictedGoodsFlow?: RestrictedGoodsFlow;
489
- /** Information about services Wix Partner sells. */
490
- partnerFlow?: PartnerFlow;
491
- /**
492
- * True, only if Wix Payments available to user due to the way account was created. False otherwise.
493
- * @readonly
494
- */
495
- wixPaymentsAvailable?: boolean;
496
- }
497
- interface CbdFlow {
498
- /**
499
- * Current status of CBD flow.
500
- * DECLINED - User does not sell CBD (or at least we do not know about it). Any payment service provider can be connected.
501
- * POSSIBLE - User possibly sells CBD and we should ask for confirmation. User still can connect Wix Payments.
502
- * CONFIRMED - User confirmed to sell CBD and now we should ask to complete attestation form. Only CBD providers can be connected. User can't connect Wix Payments.
503
- */
504
- status?: Status$1;
505
- /** Information about completion of attestation form. Include date of signing. */
506
- attestationInfo?: AttestationInfo;
507
- }
508
- declare enum Status$1 {
509
- UNDEFINED = "UNDEFINED",
510
- DECLINED = "DECLINED",
511
- POSSIBLE = "POSSIBLE",
512
- CONFIRMED = "CONFIRMED"
513
- }
514
- interface AttestationInfo {
515
- /**
516
- * Date of signing attestation form (only if status is CONFIRMED)
517
- * @readonly
518
- */
519
- attestationFormSignedDate?: Date | null;
520
- /** True, if attestation form was signed. False otherwise. */
521
- formSigned?: boolean | null;
522
- }
523
- interface RestrictedGoodsFlow {
524
- /**
525
- * Current status of Restricted Goods flow.
526
- * DECLINED - User confirmed that they don't sell any restricted goods. User may connect Wix Payments.
527
- * CONFIRMED - User confirmed that they do sell restricted goods. User can't connect Wix Payments.
528
- */
529
- status?: RestrictedGoodsFlowStatus;
530
- /** Contains detailed list of which restricted categories user sell. */
531
- categories?: RestrictedGoodsCategory[];
532
- }
533
- declare enum RestrictedGoodsFlowStatus {
534
- UNDEFINED = "UNDEFINED",
535
- DECLINED = "DECLINED",
536
- CONFIRMED = "CONFIRMED"
537
- }
538
- declare enum RestrictedGoodsCategory {
539
- UNDEFINED = "UNDEFINED",
540
- TOBACCO_ALCOHOL = "TOBACCO_ALCOHOL",
541
- FIREARMS_WEAPONS = "FIREARMS_WEAPONS",
542
- ADULT = "ADULT",
543
- MEDICAL = "MEDICAL",
544
- FINANCIAL = "FINANCIAL",
545
- TRAVEL_AGENCIES = "TRAVEL_AGENCIES",
546
- GAMBLING_LOTTERIES_SKILL_GAMES = "GAMBLING_LOTTERIES_SKILL_GAMES",
547
- BINARY_OPTIONS_CRYPTOCURRENCIES = "BINARY_OPTIONS_CRYPTOCURRENCIES",
548
- MARKETPLACES = "MARKETPLACES",
549
- OTHER = "OTHER",
550
- CBD = "CBD",
551
- TOBACCO_E_CIGARETTES = "TOBACCO_E_CIGARETTES",
552
- ALCOHOL = "ALCOHOL",
553
- NUTRACEUTICALS = "NUTRACEUTICALS"
554
- }
555
- interface PartnerFlow {
556
- /**
557
- * Current status of Partner flow.
558
- * DECLINED - User sells only approved services and may connect Wix Payments.
559
- * CONFIRMED - User sells not approved services and can't connect Wix Payments.
560
- */
561
- status?: PartnerFlowStatus;
562
- }
563
- declare enum PartnerFlowStatus {
564
- UNDEFINED = "UNDEFINED",
565
- DECLINED = "DECLINED",
566
- CONFIRMED = "CONFIRMED"
567
- }
568
- interface GetOnboardingAvailabilityRequest {
569
- }
570
- interface GetOnboardingAvailabilityResponse {
571
- /** Current state of onboarding availability for the merchant. */
572
- onboardingAvailability?: OnboardingAvailability;
573
- }
574
- interface UpdateCbdFlowRequest {
575
- /** New state of CBD flow for merchant. */
576
- cbdFlow?: CbdFlow;
577
- }
578
- interface UpdateCbdFlowResponse {
579
- /** Current state of onboarding availability for the merchant. */
580
- onboardingAvailability?: OnboardingAvailability;
581
- }
582
- interface UpdateRestrictedGoodsFlowRequest {
583
- /** New state of restricted goods flow for merchant. */
584
- restrictedGoods?: RestrictedGoodsFlow;
585
- }
586
- interface UpdateRestrictedGoodsFlowResponse {
587
- /** Current state of onboarding availability for the merchant. */
588
- onboardingAvailability?: OnboardingAvailability;
589
- }
590
- interface UpdatePartnerFlowRequest {
591
- /** New state of partner flow for merchant. */
592
- partnerFlow?: PartnerFlow;
593
- }
594
- interface UpdatePartnerFlowResponse {
595
- /** Current state of onboarding availability for the merchant. */
596
- onboardingAvailability?: OnboardingAvailability;
597
- }
598
- interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
599
- createdEvent?: EntityCreatedEvent$2;
600
- updatedEvent?: EntityUpdatedEvent$2;
601
- deletedEvent?: EntityDeletedEvent$2;
602
- actionEvent?: ActionEvent$2;
603
- /**
604
- * Unique event ID.
605
- * Allows clients to ignore duplicate webhooks.
606
- */
607
- _id?: string;
608
- /**
609
- * Assumes actions are also always typed to an entity_type
610
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
611
- */
612
- entityFqdn?: string;
613
- /**
614
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
615
- * This is although the created/updated/deleted notion is duplication of the oneof types
616
- * Example: created/updated/deleted/started/completed/email_opened
617
- */
618
- slug?: string;
619
- /** ID of the entity associated with the event. */
620
- entityId?: string;
621
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
622
- eventTime?: Date | null;
623
- /**
624
- * Whether the event was triggered as a result of a privacy regulation application
625
- * (for example, GDPR).
626
- */
627
- triggeredByAnonymizeRequest?: boolean | null;
628
- /** If present, indicates the action that triggered the event. */
629
- originatedFrom?: string | null;
630
- /**
631
- * A sequence number defining the order of updates to the underlying entity.
632
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
633
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
634
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
635
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
636
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
637
- */
638
- entityEventSequence?: string | null;
639
- }
640
- /** @oneof */
641
- interface DomainEventBodyOneOf$2 {
642
- createdEvent?: EntityCreatedEvent$2;
643
- updatedEvent?: EntityUpdatedEvent$2;
644
- deletedEvent?: EntityDeletedEvent$2;
645
- actionEvent?: ActionEvent$2;
646
- }
647
- interface EntityCreatedEvent$2 {
648
- entity?: string;
649
- }
650
- interface RestoreInfo$2 {
651
- deletedDate?: Date | null;
652
- }
653
- interface EntityUpdatedEvent$2 {
654
- /**
655
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
656
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
657
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
658
- */
659
- currentEntity?: string;
660
- }
661
- interface EntityDeletedEvent$2 {
662
- /** Entity that was deleted */
663
- deletedEntity?: string | null;
664
- }
665
- interface ActionEvent$2 {
666
- body?: string;
667
- }
668
- interface MessageEnvelope$2 {
669
- /** App instance ID. */
670
- instanceId?: string | null;
671
- /** Event type. */
672
- eventType?: string;
673
- /** The identification type and identity data. */
674
- identity?: IdentificationData$2;
675
- /** Stringify payload. */
676
- data?: string;
677
- }
678
- interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
679
- /** ID of a site visitor that has not logged in to the site. */
680
- anonymousVisitorId?: string;
681
- /** ID of a site visitor that has logged in to the site. */
682
- memberId?: string;
683
- /** ID of a Wix user (site owner, contributor, etc.). */
684
- wixUserId?: string;
685
- /** ID of an app. */
686
- appId?: string;
687
- /** @readonly */
688
- identityType?: WebhookIdentityType$2;
689
- }
690
- /** @oneof */
691
- interface IdentificationDataIdOneOf$2 {
692
- /** ID of a site visitor that has not logged in to the site. */
693
- anonymousVisitorId?: string;
694
- /** ID of a site visitor that has logged in to the site. */
695
- memberId?: string;
696
- /** ID of a Wix user (site owner, contributor, etc.). */
697
- wixUserId?: string;
698
- /** ID of an app. */
699
- appId?: string;
700
- }
701
- declare enum WebhookIdentityType$2 {
702
- UNKNOWN = "UNKNOWN",
703
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
704
- MEMBER = "MEMBER",
705
- WIX_USER = "WIX_USER",
706
- APP = "APP"
707
- }
708
- interface CbdFlowNonNullableFields {
709
- status: Status$1;
710
- }
711
- interface RestrictedGoodsFlowNonNullableFields {
712
- status: RestrictedGoodsFlowStatus;
713
- categories: RestrictedGoodsCategory[];
714
- }
715
- interface PartnerFlowNonNullableFields {
716
- status: PartnerFlowStatus;
717
- }
718
- interface OnboardingAvailabilityNonNullableFields {
719
- _id: string;
720
- cbdFlow?: CbdFlowNonNullableFields;
721
- restrictedGoodsFlow?: RestrictedGoodsFlowNonNullableFields;
722
- partnerFlow?: PartnerFlowNonNullableFields;
723
- wixPaymentsAvailable: boolean;
724
- }
725
- interface GetOnboardingAvailabilityResponseNonNullableFields {
726
- onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
727
- }
728
- interface UpdateCbdFlowResponseNonNullableFields {
729
- onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
730
- }
731
- interface UpdateRestrictedGoodsFlowResponseNonNullableFields {
732
- onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
733
- }
734
- interface UpdatePartnerFlowResponseNonNullableFields {
735
- onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
736
- }
737
- interface BaseEventMetadata$2 {
738
- /** App instance ID. */
739
- instanceId?: string | null;
740
- /** Event type. */
741
- eventType?: string;
742
- /** The identification type and identity data. */
743
- identity?: IdentificationData$2;
744
- }
745
- interface EventMetadata$2 extends BaseEventMetadata$2 {
746
- /**
747
- * Unique event ID.
748
- * Allows clients to ignore duplicate webhooks.
749
- */
750
- _id?: string;
751
- /**
752
- * Assumes actions are also always typed to an entity_type
753
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
754
- */
755
- entityFqdn?: string;
756
- /**
757
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
758
- * This is although the created/updated/deleted notion is duplication of the oneof types
759
- * Example: created/updated/deleted/started/completed/email_opened
760
- */
761
- slug?: string;
762
- /** ID of the entity associated with the event. */
763
- entityId?: string;
764
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
765
- eventTime?: Date | null;
766
- /**
767
- * Whether the event was triggered as a result of a privacy regulation application
768
- * (for example, GDPR).
769
- */
770
- triggeredByAnonymizeRequest?: boolean | null;
771
- /** If present, indicates the action that triggered the event. */
772
- originatedFrom?: string | null;
773
- /**
774
- * A sequence number defining the order of updates to the underlying entity.
775
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
776
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
777
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
778
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
779
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
780
- */
781
- entityEventSequence?: string | null;
782
- }
783
- interface OnboardingAvailabilityCreatedEnvelope {
784
- entity: OnboardingAvailability;
785
- metadata: EventMetadata$2;
786
- }
787
- interface OnboardingAvailabilityUpdatedEnvelope {
788
- entity: OnboardingAvailability;
789
- metadata: EventMetadata$2;
790
- }
791
- interface UpdateCbdFlowOptions {
792
- /** New state of CBD flow for merchant. */
793
- cbdFlow?: CbdFlow;
794
- }
795
- interface UpdateRestrictedGoodsFlowOptions {
796
- /** New state of restricted goods flow for merchant. */
797
- restrictedGoods?: RestrictedGoodsFlow;
798
- }
799
- interface UpdatePartnerFlowOptions {
800
- /** New state of partner flow for merchant. */
801
- partnerFlow?: PartnerFlow;
802
- }
803
-
804
- declare function getOnboardingAvailability$1(httpClient: HttpClient): GetOnboardingAvailabilitySignature;
805
- interface GetOnboardingAvailabilitySignature {
806
- /**
807
- * Fetch current state of onboarding availability for meta site.
808
- */
809
- (): Promise<GetOnboardingAvailabilityResponse & GetOnboardingAvailabilityResponseNonNullableFields>;
810
- }
811
- declare function updateCbdFlow$1(httpClient: HttpClient): UpdateCbdFlowSignature;
812
- interface UpdateCbdFlowSignature {
813
- /**
814
- * Update current state of CBD flow for meta site.
815
- */
816
- (options?: UpdateCbdFlowOptions | undefined): Promise<UpdateCbdFlowResponse & UpdateCbdFlowResponseNonNullableFields>;
817
- }
818
- declare function updateRestrictedGoodsFlow$1(httpClient: HttpClient): UpdateRestrictedGoodsFlowSignature;
819
- interface UpdateRestrictedGoodsFlowSignature {
820
- /**
821
- * Update current state of Restricted Goods flow for meta site.
822
- */
823
- (options?: UpdateRestrictedGoodsFlowOptions | undefined): Promise<UpdateRestrictedGoodsFlowResponse & UpdateRestrictedGoodsFlowResponseNonNullableFields>;
824
- }
825
- declare function updatePartnerFlow$1(httpClient: HttpClient): UpdatePartnerFlowSignature;
826
- interface UpdatePartnerFlowSignature {
827
- /**
828
- * Update current state of partner flow for meta site.
829
- */
830
- (options?: UpdatePartnerFlowOptions | undefined): Promise<UpdatePartnerFlowResponse & UpdatePartnerFlowResponseNonNullableFields>;
831
- }
832
- declare const onOnboardingAvailabilityCreated$1: EventDefinition<OnboardingAvailabilityCreatedEnvelope, "wix.cashier.onboarding_availability.v1.onboarding_availability_created">;
833
- declare const onOnboardingAvailabilityUpdated$1: EventDefinition<OnboardingAvailabilityUpdatedEnvelope, "wix.cashier.onboarding_availability.v1.onboarding_availability_updated">;
834
-
835
- declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
836
-
837
- declare const getOnboardingAvailability: MaybeContext<BuildRESTFunction<typeof getOnboardingAvailability$1> & typeof getOnboardingAvailability$1>;
838
- declare const updateCbdFlow: MaybeContext<BuildRESTFunction<typeof updateCbdFlow$1> & typeof updateCbdFlow$1>;
839
- declare const updateRestrictedGoodsFlow: MaybeContext<BuildRESTFunction<typeof updateRestrictedGoodsFlow$1> & typeof updateRestrictedGoodsFlow$1>;
840
- declare const updatePartnerFlow: MaybeContext<BuildRESTFunction<typeof updatePartnerFlow$1> & typeof updatePartnerFlow$1>;
841
-
842
- type _publicOnOnboardingAvailabilityCreatedType = typeof onOnboardingAvailabilityCreated$1;
843
- /** */
844
- declare const onOnboardingAvailabilityCreated: ReturnType<typeof createEventModule$2<_publicOnOnboardingAvailabilityCreatedType>>;
845
-
846
- type _publicOnOnboardingAvailabilityUpdatedType = typeof onOnboardingAvailabilityUpdated$1;
847
- /** */
848
- declare const onOnboardingAvailabilityUpdated: ReturnType<typeof createEventModule$2<_publicOnOnboardingAvailabilityUpdatedType>>;
849
-
850
- type context$3_AttestationInfo = AttestationInfo;
851
- type context$3_CbdFlow = CbdFlow;
852
- type context$3_GetOnboardingAvailabilityRequest = GetOnboardingAvailabilityRequest;
853
- type context$3_GetOnboardingAvailabilityResponse = GetOnboardingAvailabilityResponse;
854
- type context$3_GetOnboardingAvailabilityResponseNonNullableFields = GetOnboardingAvailabilityResponseNonNullableFields;
855
- type context$3_OnboardingAvailability = OnboardingAvailability;
856
- type context$3_OnboardingAvailabilityCreatedEnvelope = OnboardingAvailabilityCreatedEnvelope;
857
- type context$3_OnboardingAvailabilityUpdatedEnvelope = OnboardingAvailabilityUpdatedEnvelope;
858
- type context$3_PartnerFlow = PartnerFlow;
859
- type context$3_PartnerFlowStatus = PartnerFlowStatus;
860
- declare const context$3_PartnerFlowStatus: typeof PartnerFlowStatus;
861
- type context$3_RestrictedGoodsCategory = RestrictedGoodsCategory;
862
- declare const context$3_RestrictedGoodsCategory: typeof RestrictedGoodsCategory;
863
- type context$3_RestrictedGoodsFlow = RestrictedGoodsFlow;
864
- type context$3_RestrictedGoodsFlowStatus = RestrictedGoodsFlowStatus;
865
- declare const context$3_RestrictedGoodsFlowStatus: typeof RestrictedGoodsFlowStatus;
866
- type context$3_UpdateCbdFlowOptions = UpdateCbdFlowOptions;
867
- type context$3_UpdateCbdFlowRequest = UpdateCbdFlowRequest;
868
- type context$3_UpdateCbdFlowResponse = UpdateCbdFlowResponse;
869
- type context$3_UpdateCbdFlowResponseNonNullableFields = UpdateCbdFlowResponseNonNullableFields;
870
- type context$3_UpdatePartnerFlowOptions = UpdatePartnerFlowOptions;
871
- type context$3_UpdatePartnerFlowRequest = UpdatePartnerFlowRequest;
872
- type context$3_UpdatePartnerFlowResponse = UpdatePartnerFlowResponse;
873
- type context$3_UpdatePartnerFlowResponseNonNullableFields = UpdatePartnerFlowResponseNonNullableFields;
874
- type context$3_UpdateRestrictedGoodsFlowOptions = UpdateRestrictedGoodsFlowOptions;
875
- type context$3_UpdateRestrictedGoodsFlowRequest = UpdateRestrictedGoodsFlowRequest;
876
- type context$3_UpdateRestrictedGoodsFlowResponse = UpdateRestrictedGoodsFlowResponse;
877
- type context$3_UpdateRestrictedGoodsFlowResponseNonNullableFields = UpdateRestrictedGoodsFlowResponseNonNullableFields;
878
- type context$3__publicOnOnboardingAvailabilityCreatedType = _publicOnOnboardingAvailabilityCreatedType;
879
- type context$3__publicOnOnboardingAvailabilityUpdatedType = _publicOnOnboardingAvailabilityUpdatedType;
880
- declare const context$3_getOnboardingAvailability: typeof getOnboardingAvailability;
881
- declare const context$3_onOnboardingAvailabilityCreated: typeof onOnboardingAvailabilityCreated;
882
- declare const context$3_onOnboardingAvailabilityUpdated: typeof onOnboardingAvailabilityUpdated;
883
- declare const context$3_updateCbdFlow: typeof updateCbdFlow;
884
- declare const context$3_updatePartnerFlow: typeof updatePartnerFlow;
885
- declare const context$3_updateRestrictedGoodsFlow: typeof updateRestrictedGoodsFlow;
886
- declare namespace context$3 {
887
- export { type ActionEvent$2 as ActionEvent, type context$3_AttestationInfo as AttestationInfo, type BaseEventMetadata$2 as BaseEventMetadata, type context$3_CbdFlow as CbdFlow, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type context$3_GetOnboardingAvailabilityRequest as GetOnboardingAvailabilityRequest, type context$3_GetOnboardingAvailabilityResponse as GetOnboardingAvailabilityResponse, type context$3_GetOnboardingAvailabilityResponseNonNullableFields as GetOnboardingAvailabilityResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type MessageEnvelope$2 as MessageEnvelope, type context$3_OnboardingAvailability as OnboardingAvailability, type context$3_OnboardingAvailabilityCreatedEnvelope as OnboardingAvailabilityCreatedEnvelope, type context$3_OnboardingAvailabilityUpdatedEnvelope as OnboardingAvailabilityUpdatedEnvelope, type context$3_PartnerFlow as PartnerFlow, context$3_PartnerFlowStatus as PartnerFlowStatus, type RestoreInfo$2 as RestoreInfo, context$3_RestrictedGoodsCategory as RestrictedGoodsCategory, type context$3_RestrictedGoodsFlow as RestrictedGoodsFlow, context$3_RestrictedGoodsFlowStatus as RestrictedGoodsFlowStatus, Status$1 as Status, type context$3_UpdateCbdFlowOptions as UpdateCbdFlowOptions, type context$3_UpdateCbdFlowRequest as UpdateCbdFlowRequest, type context$3_UpdateCbdFlowResponse as UpdateCbdFlowResponse, type context$3_UpdateCbdFlowResponseNonNullableFields as UpdateCbdFlowResponseNonNullableFields, type context$3_UpdatePartnerFlowOptions as UpdatePartnerFlowOptions, type context$3_UpdatePartnerFlowRequest as UpdatePartnerFlowRequest, type context$3_UpdatePartnerFlowResponse as UpdatePartnerFlowResponse, type context$3_UpdatePartnerFlowResponseNonNullableFields as UpdatePartnerFlowResponseNonNullableFields, type context$3_UpdateRestrictedGoodsFlowOptions as UpdateRestrictedGoodsFlowOptions, type context$3_UpdateRestrictedGoodsFlowRequest as UpdateRestrictedGoodsFlowRequest, type context$3_UpdateRestrictedGoodsFlowResponse as UpdateRestrictedGoodsFlowResponse, type context$3_UpdateRestrictedGoodsFlowResponseNonNullableFields as UpdateRestrictedGoodsFlowResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, type context$3__publicOnOnboardingAvailabilityCreatedType as _publicOnOnboardingAvailabilityCreatedType, type context$3__publicOnOnboardingAvailabilityUpdatedType as _publicOnOnboardingAvailabilityUpdatedType, context$3_getOnboardingAvailability as getOnboardingAvailability, context$3_onOnboardingAvailabilityCreated as onOnboardingAvailabilityCreated, context$3_onOnboardingAvailabilityUpdated as onOnboardingAvailabilityUpdated, onOnboardingAvailabilityCreated$1 as publicOnOnboardingAvailabilityCreated, onOnboardingAvailabilityUpdated$1 as publicOnOnboardingAvailabilityUpdated, context$3_updateCbdFlow as updateCbdFlow, context$3_updatePartnerFlow as updatePartnerFlow, context$3_updateRestrictedGoodsFlow as updateRestrictedGoodsFlow };
888
- }
889
-
890
- /** Provider platform event */
891
- interface ProviderPlatformEvent extends ProviderPlatformEventResourceOneOf {
892
- /** Refund event data. */
893
- refund?: RefundEvent;
894
- /** Transaction event data. */
895
- transaction?: TransactionEvent;
896
- /** Capture event data */
897
- capture?: CaptureEvent;
898
- /** Void event data */
899
- void?: VoidEvent;
900
- /**
901
- * This field is ignored, do not send it.
902
- * @deprecated
903
- */
904
- pluginId?: string;
905
- }
906
- /** @oneof */
907
- interface ProviderPlatformEventResourceOneOf {
908
- /** Refund event data. */
909
- refund?: RefundEvent;
910
- /** Transaction event data. */
911
- transaction?: TransactionEvent;
912
- /** Capture event data */
913
- capture?: CaptureEvent;
914
- /** Void event data */
915
- void?: VoidEvent;
916
- }
917
- interface RefundEvent {
918
- /** Wix transaction ID. */
919
- wixTransactionId?: string;
920
- /** PSP refund ID. */
921
- pluginRefundId?: string;
922
- /** Wix [reason code](https://dev.wix.com/api/rest/all-apis/provider-platform/reason-codes#all-apis_provider-platform_reason-codes_refund-declined) indicating a failed request. */
923
- reasonCode?: number;
924
- /** Refunded amount. */
925
- amount?: string;
926
- /** Wix refund ID. This field is only required when a merchant initiates a refund from the Wix dashboard. */
927
- wixRefundId?: string | null;
928
- /** PSP-specific error code. */
929
- errorCode?: string | null;
930
- /** PSP-specific error message. */
931
- errorMessage?: string | null;
932
- }
933
- interface TransactionEvent {
934
- /** Wix transaction ID. */
935
- wixTransactionId?: string;
936
- /** PSP transaction ID. */
937
- pluginTransactionId?: string;
938
- /** Wix [reason code](https://dev.wix.com/api/rest/all-apis/provider-platform/reason-codes) indicating a failed or pending request. */
939
- reasonCode?: number;
940
- /** PSP-specific error code. */
941
- errorCode?: string | null;
942
- /** PSP-specific error message. */
943
- errorMessage?: string | null;
944
- /** Token data for stored payment method. */
945
- credentialsOnFile?: CredentialsOnFile;
946
- /** Details of actual customer's card, obtained from a Funding PAN as opposed to a Device PAN. */
947
- cardDetails?: CardDetails;
948
- }
949
- interface CredentialsOnFile extends CredentialsOnFileInfoOneOf {
950
- /** Network token data. */
951
- cardReference?: CardReference;
952
- /** Provider generated token data. */
953
- paymentMethodReference?: PaymentMethodReference;
954
- }
955
- /** @oneof */
956
- interface CredentialsOnFileInfoOneOf {
957
- /** Network token data. */
958
- cardReference?: CardReference;
959
- /** Provider generated token data. */
960
- paymentMethodReference?: PaymentMethodReference;
961
- }
962
- interface CardReference {
963
- /** Network token. */
964
- networkTransactionId?: string;
965
- /** Directory Server transaction ID */
966
- dsTransactionId?: string | null;
967
- }
968
- interface PaymentMethodReference {
969
- /** Payment method token created by the PSP. */
970
- token?: string;
971
- }
972
- interface CardDetails {
973
- /** Issuer (business) identification number. First 6 or 8 digits of the card's number. */
974
- bin?: string | null;
975
- /** Last 4 digits of the card's number. */
976
- lastFour?: string | null;
977
- }
978
- interface CaptureEvent {
979
- /** Wix transaction ID. */
980
- wixTransactionId?: string;
981
- /** Wix [reason code](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes#capture-declined) indicating request's status. */
982
- reasonCode?: number;
983
- /** Capture amount. */
984
- amount?: string;
985
- /** PSP-specific error code. */
986
- errorCode?: string | null;
987
- /** PSP-specific error message. */
988
- errorMessage?: string | null;
989
- }
990
- interface VoidEvent {
991
- /** Wix transaction ID. */
992
- wixTransactionId?: string;
993
- /** PSP void ID. */
994
- reasonCode?: number;
995
- /** Voided amount. */
996
- amount?: string;
997
- /** PSP-specific error code. */
998
- errorCode?: string | null;
999
- /** PSP-specific error message. */
1000
- errorMessage?: string | null;
1001
- }
1002
- /** Submit event request */
1003
- interface SubmitEventRequest {
1004
- /** Event data. */
1005
- event: ProviderPlatformEvent;
1006
- }
1007
- /** Submit event response */
1008
- interface SubmitEventResponse {
1009
- }
1010
-
1011
- declare function submitEvent$1(httpClient: HttpClient): SubmitEventSignature;
1012
- interface SubmitEventSignature {
1013
- /**
1014
- * This Wix API is used by a Payment Service Provider (PSP) to send webhooks about payment and refund states to Wix.
1015
- *
1016
- * Calls to this endpoint must include a `User-Agent` header with the name of the PSP and the integration version in this format: `{PSP}/{version}`.
1017
- * PSP's create their own version numbers.
1018
- *
1019
- * > You cannot try out this endpoint because an `Authorization` header value has to be obtained
1020
- * > with the OAuth 2.0 client credentials flow for a specific scope.
1021
- * > So please ignore the **Authorization** section below as well as the **Try It Out** button.
1022
- * @param - Event data.
1023
- * @returns Submit event response
1024
- */
1025
- (event: ProviderPlatformEvent): Promise<void>;
1026
- }
1027
-
1028
- declare const submitEvent: MaybeContext<BuildRESTFunction<typeof submitEvent$1> & typeof submitEvent$1>;
1029
-
1030
- type context$2_CaptureEvent = CaptureEvent;
1031
- type context$2_CardDetails = CardDetails;
1032
- type context$2_CardReference = CardReference;
1033
- type context$2_CredentialsOnFile = CredentialsOnFile;
1034
- type context$2_CredentialsOnFileInfoOneOf = CredentialsOnFileInfoOneOf;
1035
- type context$2_PaymentMethodReference = PaymentMethodReference;
1036
- type context$2_ProviderPlatformEvent = ProviderPlatformEvent;
1037
- type context$2_ProviderPlatformEventResourceOneOf = ProviderPlatformEventResourceOneOf;
1038
- type context$2_RefundEvent = RefundEvent;
1039
- type context$2_SubmitEventRequest = SubmitEventRequest;
1040
- type context$2_SubmitEventResponse = SubmitEventResponse;
1041
- type context$2_TransactionEvent = TransactionEvent;
1042
- type context$2_VoidEvent = VoidEvent;
1043
- declare const context$2_submitEvent: typeof submitEvent;
1044
- declare namespace context$2 {
1045
- export { type context$2_CaptureEvent as CaptureEvent, type context$2_CardDetails as CardDetails, type context$2_CardReference as CardReference, type context$2_CredentialsOnFile as CredentialsOnFile, type context$2_CredentialsOnFileInfoOneOf as CredentialsOnFileInfoOneOf, type context$2_PaymentMethodReference as PaymentMethodReference, type context$2_ProviderPlatformEvent as ProviderPlatformEvent, type context$2_ProviderPlatformEventResourceOneOf as ProviderPlatformEventResourceOneOf, type context$2_RefundEvent as RefundEvent, type context$2_SubmitEventRequest as SubmitEventRequest, type context$2_SubmitEventResponse as SubmitEventResponse, type context$2_TransactionEvent as TransactionEvent, type context$2_VoidEvent as VoidEvent, context$2_submitEvent as submitEvent };
1046
- }
1047
-
1048
- /**
1049
- * A refund a record of an attempt of
1050
- * returning funds for a charge from a merchant to a buyer who has made a purchase.
1051
- * Read more about refunds in this [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction>).
1052
- */
1053
- interface Refund {
1054
- /**
1055
- * Refund ID.
1056
- * @readonly
1057
- */
1058
- _id?: string | null;
1059
- /**
1060
- * Revision number, which increments by 1 each time the refund is updated.
1061
- *
1062
- * Ignored when creating a refund.
1063
- * @readonly
1064
- */
1065
- revision?: string | null;
1066
- /**
1067
- * Date and time the refund was created.
1068
- * @readonly
1069
- */
1070
- _createdDate?: Date | null;
1071
- /**
1072
- * Date and time the refund was last updated.
1073
- * @readonly
1074
- */
1075
- _updatedDate?: Date | null;
1076
- /** Data Extensions */
1077
- extendedFields?: ExtendedFields$1;
1078
- /** ID of charge for which the funds are returned by this refund. */
1079
- chargeId?: string | null;
1080
- /** Currency of refund, should be the same as currency of charge. */
1081
- currency?: string | null;
1082
- /**
1083
- * Amount of refund in base units, what's returned to the buyer.
1084
- * E.g. "12.95".
1085
- */
1086
- amount?: string | null;
1087
- /**
1088
- * Application fee returned to merchant from Wix.
1089
- * In base units, e.g. "12.95".
1090
- * Not present when no application fee was returned.
1091
- * @readonly
1092
- */
1093
- returnedApplicationFee?: string | null;
1094
- /**
1095
- * Processing fee returned to merchant from provider.
1096
- * In base units, e.g. "12.95".
1097
- * Applicable only to Wix Payments provider.
1098
- * Not present when no processing fee was returned.
1099
- * @readonly
1100
- */
1101
- returnedProcessingFee?: string | null;
1102
- /**
1103
- * True when refund returns all funds for a charge.
1104
- * @readonly
1105
- */
1106
- full?: boolean | null;
1107
- /**
1108
- * Status of the refund.
1109
- * Read more about statuses in this [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#lifecycle-of-a-refund>).
1110
- * @readonly
1111
- */
1112
- status?: Status;
1113
- /**
1114
- * ID of the refund on the PSP side.
1115
- * @readonly
1116
- */
1117
- providerRefundId?: string | null;
1118
- /** Reason why this refund was issued. */
1119
- reason?: string | null;
1120
- /**
1121
- * Details about refund status.
1122
- * Mostly used with statuses `FAILED` and `REVERSED`.
1123
- * @readonly
1124
- */
1125
- statusInfo?: StatusInfo;
1126
- /**
1127
- * Acquirer Reference Number.
1128
- * @readonly
1129
- */
1130
- acquirerReferenceNumber?: string | null;
1131
- /** Optional free-text note about this refund. */
1132
- note?: string | null;
1133
- }
1134
- interface ExtendedFields$1 {
1135
- /**
1136
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1137
- * The value of each key is structured according to the schema defined when the extended fields were configured.
1138
- *
1139
- * You can only access fields for which you have the appropriate permissions.
1140
- *
1141
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1142
- */
1143
- namespaces?: Record<string, Record<string, any>>;
1144
- }
1145
- declare enum Status {
1146
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
1147
- /**
1148
- * Initial status for all refunds.
1149
- * Provisional, refund should be in this status for less than a minute.
1150
- */
1151
- STARTING = "STARTING",
1152
- /** Status right after STARTED for asynchronous refunds. */
1153
- PENDING = "PENDING",
1154
- /**
1155
- * Refund was successful.
1156
- * Can transition to REVERSED in corner cases.
1157
- */
1158
- SUCCEEDED = "SUCCEEDED",
1159
- /** Regular error, terminal status. */
1160
- FAILED = "FAILED",
1161
- /**
1162
- * Either refund reversal
1163
- * or any other error that comes after success, terminal status.
1164
- */
1165
- REVERSED = "REVERSED"
1166
- }
1167
- declare enum Initiator {
1168
- UNKNOWN_INITIATOR = "UNKNOWN_INITIATOR",
1169
- WIX = "WIX",
1170
- API = "API",
1171
- PROVIDER = "PROVIDER"
1172
- }
1173
- interface StatusInfo {
1174
- /**
1175
- * Reason code.
1176
- * [Read more about reason codes.](https://dev.wix.com/docs/rest/api-reference/payment-provider-spi/reason-codes)
1177
- */
1178
- code?: string;
1179
- /** Free-text description. */
1180
- description?: string | null;
1181
- }
1182
- interface CreateRefundRequest {
1183
- /** Refund to be created. */
1184
- refund: Refund;
1185
- /**
1186
- * Optional parameter used to prevent unintended refunds.
1187
- * Used to check previously refunded amount according to the client
1188
- * against the amount from server perspective.
1189
- * If they don't match, error with code `PREVIOUSLY_REFUNDED_AMOUNT_MISMATCH` is returned.
1190
- *
1191
- * Read more about preventing unintended refunds in this
1192
- * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#preventing-unintended-refunds>).
1193
- */
1194
- previouslyRefundedAmount?: string | null;
1195
- }
1196
- interface CreateRefundResponse {
1197
- /** The created refund. */
1198
- refund?: Refund;
1199
- }
1200
- interface GetRefundRequest {
1201
- /** ID of the refund to retrieve. */
1202
- refundId: string;
1203
- }
1204
- interface GetRefundResponse {
1205
- /** The requested refund. */
1206
- refund?: Refund;
1207
- }
1208
- interface QueryRefundsRequest {
1209
- /** WQL expression. */
1210
- query?: CursorQuery;
1211
- }
1212
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
1213
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1214
- cursorPaging?: CursorPaging$1;
1215
- /**
1216
- * Filter object in the following format:
1217
- * `"filter" : {
1218
- * "fieldName1": "value1",
1219
- * "fieldName2":{"$operator":"value2"}
1220
- * }`
1221
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1222
- */
1223
- filter?: Record<string, any> | null;
1224
- /**
1225
- * Sort object in the following format:
1226
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1227
- */
1228
- sort?: Sorting[];
1229
- }
1230
- /** @oneof */
1231
- interface CursorQueryPagingMethodOneOf {
1232
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1233
- cursorPaging?: CursorPaging$1;
1234
- }
1235
- interface Sorting {
1236
- /** Name of the field to sort by. */
1237
- fieldName?: string;
1238
- /** Sort order. */
1239
- order?: SortOrder;
1240
- }
1241
- declare enum SortOrder {
1242
- ASC = "ASC",
1243
- DESC = "DESC"
1244
- }
1245
- interface CursorPaging$1 {
1246
- /** Number of items to load. */
1247
- limit?: number | null;
1248
- /**
1249
- * Pointer to the next or previous page in the list of results.
1250
- *
1251
- * You can get the relevant cursor token
1252
- * from the `pagingMetadata` object in the previous call's response.
1253
- * Not relevant for the first request.
1254
- */
1255
- cursor?: string | null;
1256
- }
1257
- interface QueryRefundsResponse {
1258
- /** List of refunds. */
1259
- refunds?: Refund[];
1260
- /** Paging metadata */
1261
- pagingMetadata?: CursorPagingMetadata$1;
1262
- }
1263
- interface CursorPagingMetadata$1 {
1264
- /** Number of items returned in the response. */
1265
- count?: number | null;
1266
- /** Offset that was requested. */
1267
- cursors?: Cursors$1;
1268
- /**
1269
- * Indicates if there are more results after the current page.
1270
- * If `true`, another page of results can be retrieved.
1271
- * If `false`, this is the last page.
1272
- */
1273
- hasNext?: boolean | null;
1274
- }
1275
- interface Cursors$1 {
1276
- /** Cursor pointing to next page in the list of results. */
1277
- next?: string | null;
1278
- /** Cursor pointing to previous page in the list of results. */
1279
- prev?: string | null;
1280
- }
1281
- interface UpdateExtendedFieldsRequest {
1282
- /** ID of the entity to update. */
1283
- _id: string;
1284
- /** Identifier for the app whose extended fields are being updated. */
1285
- namespace: string;
1286
- /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
1287
- namespaceData: Record<string, any> | null;
1288
- }
1289
- interface UpdateExtendedFieldsResponse {
1290
- /** Updated refund. */
1291
- refund?: Refund;
1292
- }
1293
- interface GetRefundabilityRequest {
1294
- /** ID of the charge for which refundability will be calculated. */
1295
- chargeId: string;
1296
- }
1297
- interface GetRefundabilityResponse {
1298
- /** Refundability for the charge. */
1299
- refundability?: Refundability;
1300
- }
1301
- /**
1302
- * Internal notes:
1303
- *
1304
- * Instead of separate Refundability and PartialRefundability, we provide min and max refund amount.
1305
- * If only full refund is possible, min_refund_amount = max_refund_amount = charge amount.
1306
- */
1307
- interface Refundability extends RefundabilityDetailsOneOf {
1308
- /** When charge is refundable, specifies what amounts are allowed for refund. */
1309
- refundOptions?: RefundOptions;
1310
- /** When charge is not refundable, specifies why refund is not allowed. */
1311
- rejection?: Rejection;
1312
- /** Whether the caller is allowed to refund the charge. */
1313
- refundable?: boolean;
1314
- /** Currency of the charge. */
1315
- currency?: string | null;
1316
- /**
1317
- * Sum of amounts of `SUCCEEDED` refunds for this charge in base units, e.g. "6.47".
1318
- * Used to prevent unintended refunds, read more in this
1319
- * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#preventing-unintended-refunds>).
1320
- */
1321
- previouslyRefundedAmount?: string | null;
1322
- }
1323
- /** @oneof */
1324
- interface RefundabilityDetailsOneOf {
1325
- /** When charge is refundable, specifies what amounts are allowed for refund. */
1326
- refundOptions?: RefundOptions;
1327
- /** When charge is not refundable, specifies why refund is not allowed. */
1328
- rejection?: Rejection;
1329
- }
1330
- interface RefundOptions {
1331
- /** Minimum amount allowed to be refunded in base units, e.g. "0.50". */
1332
- minRefundAmount?: string | null;
1333
- /** Maximum amount allowed to be refunded in base units, e.g. "12.95". */
1334
- maxRefundAmount?: string | null;
1335
- }
1336
- interface Rejection {
1337
- /**
1338
- * Following reasons are possible:
1339
- * - `CHARGE_REFUNDED` — charge is already fully refunded.
1340
- * - `CHARGE_REFUND_IN_PROGRESS` — another refund was initiated for this charge
1341
- * and is waiting for confirmation from the provider.
1342
- * - `CHARGE_DISPUTED` — charge was disputed.
1343
- * - `CHARGE_REFUND_PERIOD_ENDED` — charge is too old to be refunded.
1344
- * - `CHARGE_UNPAID` — charge is unpaid.
1345
- * - `PROVIDER_DOWN` — PSP is temporarily down.
1346
- * - `PROVIDER_NOT_SUPPORTED` — provider doesn't support refunds at the moment,
1347
- * charge is in the wrong state,
1348
- * or we don't have required information for this transaction.
1349
- * - `PAYMENT_METHOD_NOT_SUPPORTED` — payment method of a charge doesn't support refunds.
1350
- * - `MERCHANT_ACCOUNT_NOT_SUPPORTED` — merchant account doesn't support refunds at the moment.
1351
- * - `MERCHANT_BALANCE_INSUFFICIENT` — merchant doesn't have enough balance to issue a refund for this charge.
1352
- * - `NOT_AUTHORIZED` — logged in merchant has no permission to refund this charge.
1353
- */
1354
- reason?: RejectionReason;
1355
- }
1356
- declare enum RejectionReason {
1357
- UNKNOWN_REJECTION_REASON = "UNKNOWN_REJECTION_REASON",
1358
- /** Charge is already fully refunded. */
1359
- CHARGE_REFUNDED = "CHARGE_REFUNDED",
1360
- /** Another refund was initiated for this charge and is waiting for confirmation from the provider. */
1361
- CHARGE_REFUND_IN_PROGRESS = "CHARGE_REFUND_IN_PROGRESS",
1362
- /** Charge was disputed. */
1363
- CHARGE_DISPUTED = "CHARGE_DISPUTED",
1364
- /** Charge is too old to be refunded. */
1365
- CHARGE_REFUND_PERIOD_ENDED = "CHARGE_REFUND_PERIOD_ENDED",
1366
- /** Charge is unpaid. */
1367
- CHARGE_UNPAID = "CHARGE_UNPAID",
1368
- /** PSP is temporarily down. */
1369
- PROVIDER_DOWN = "PROVIDER_DOWN",
1370
- /**
1371
- * Provider doesn't support refunds at the moment, transaction in a wrong state or we don't
1372
- * have required information for this transaction.
1373
- */
1374
- PROVIDER_NOT_SUPPORTED = "PROVIDER_NOT_SUPPORTED",
1375
- /** Payment method of a charge doesn't support refunds. */
1376
- PAYMENT_METHOD_NOT_SUPPORTED = "PAYMENT_METHOD_NOT_SUPPORTED",
1377
- /** Merchant account doesn't support refunds at the moment. */
1378
- MERCHANT_ACCOUNT_NOT_SUPPORTED = "MERCHANT_ACCOUNT_NOT_SUPPORTED",
1379
- /** Merchant doesn't have enough balance to issue a refund for this charge. */
1380
- MERCHANT_BALANCE_INSUFFICIENT = "MERCHANT_BALANCE_INSUFFICIENT",
1381
- /** Logged in merchant has no permission to refund this charge. */
1382
- NOT_AUTHORIZED = "NOT_AUTHORIZED"
1383
- }
1384
- interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
1385
- createdEvent?: EntityCreatedEvent$1;
1386
- updatedEvent?: EntityUpdatedEvent$1;
1387
- deletedEvent?: EntityDeletedEvent$1;
1388
- actionEvent?: ActionEvent$1;
1389
- /**
1390
- * Unique event ID.
1391
- * Allows clients to ignore duplicate webhooks.
1392
- */
1393
- _id?: string;
1394
- /**
1395
- * Assumes actions are also always typed to an entity_type
1396
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1397
- */
1398
- entityFqdn?: string;
1399
- /**
1400
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1401
- * This is although the created/updated/deleted notion is duplication of the oneof types
1402
- * Example: created/updated/deleted/started/completed/email_opened
1403
- */
1404
- slug?: string;
1405
- /** ID of the entity associated with the event. */
1406
- entityId?: string;
1407
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1408
- eventTime?: Date | null;
1409
- /**
1410
- * Whether the event was triggered as a result of a privacy regulation application
1411
- * (for example, GDPR).
1412
- */
1413
- triggeredByAnonymizeRequest?: boolean | null;
1414
- /** If present, indicates the action that triggered the event. */
1415
- originatedFrom?: string | null;
1416
- /**
1417
- * A sequence number defining the order of updates to the underlying entity.
1418
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1419
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1420
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1421
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1422
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1423
- */
1424
- entityEventSequence?: string | null;
1425
- }
1426
- /** @oneof */
1427
- interface DomainEventBodyOneOf$1 {
1428
- createdEvent?: EntityCreatedEvent$1;
1429
- updatedEvent?: EntityUpdatedEvent$1;
1430
- deletedEvent?: EntityDeletedEvent$1;
1431
- actionEvent?: ActionEvent$1;
1432
- }
1433
- interface EntityCreatedEvent$1 {
1434
- entity?: string;
1435
- }
1436
- interface RestoreInfo$1 {
1437
- deletedDate?: Date | null;
1438
- }
1439
- interface EntityUpdatedEvent$1 {
1440
- /**
1441
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1442
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1443
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1444
- */
1445
- currentEntity?: string;
1446
- }
1447
- interface EntityDeletedEvent$1 {
1448
- /** Entity that was deleted */
1449
- deletedEntity?: string | null;
1450
- }
1451
- interface ActionEvent$1 {
1452
- body?: string;
1453
- }
1454
- interface MessageEnvelope$1 {
1455
- /** App instance ID. */
1456
- instanceId?: string | null;
1457
- /** Event type. */
1458
- eventType?: string;
1459
- /** The identification type and identity data. */
1460
- identity?: IdentificationData$1;
1461
- /** Stringify payload. */
1462
- data?: string;
1463
- }
1464
- interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
1465
- /** ID of a site visitor that has not logged in to the site. */
1466
- anonymousVisitorId?: string;
1467
- /** ID of a site visitor that has logged in to the site. */
1468
- memberId?: string;
1469
- /** ID of a Wix user (site owner, contributor, etc.). */
1470
- wixUserId?: string;
1471
- /** ID of an app. */
1472
- appId?: string;
1473
- /** @readonly */
1474
- identityType?: WebhookIdentityType$1;
1475
- }
1476
- /** @oneof */
1477
- interface IdentificationDataIdOneOf$1 {
1478
- /** ID of a site visitor that has not logged in to the site. */
1479
- anonymousVisitorId?: string;
1480
- /** ID of a site visitor that has logged in to the site. */
1481
- memberId?: string;
1482
- /** ID of a Wix user (site owner, contributor, etc.). */
1483
- wixUserId?: string;
1484
- /** ID of an app. */
1485
- appId?: string;
1486
- }
1487
- declare enum WebhookIdentityType$1 {
1488
- UNKNOWN = "UNKNOWN",
1489
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1490
- MEMBER = "MEMBER",
1491
- WIX_USER = "WIX_USER",
1492
- APP = "APP"
1493
- }
1494
- interface SyncRefundRequest {
1495
- /** Refund ID. */
1496
- refundId?: string | null;
1497
- /** ID of the refund on the PSP side. */
1498
- providerRefundId?: string | null;
1499
- /** ID of charge for which the funds are returned by this refund. */
1500
- chargeId?: string | null;
1501
- /**
1502
- * Status of the refund.
1503
- * Read more about statuses in this [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#lifecycle-of-a-refund>).
1504
- */
1505
- status?: Status;
1506
- /**
1507
- * Status code.
1508
- * [Read more about reason codes.](https://dev.wix.com/docs/rest/api-reference/payment-provider-spi/reason-codes)
1509
- */
1510
- statusCode?: string | null;
1511
- /** Currency of refund, should be the same as currency of charge. */
1512
- currency?: string | null;
1513
- /**
1514
- * Amount of refund in base units, what's returned to the buyer.
1515
- * E.g. "12.95".
1516
- */
1517
- amount?: string | null;
1518
- /**
1519
- * Application fee returned to merchant from Wix.
1520
- * Having this as a separate field since Refund.returned_application_fee is readOnly.
1521
- */
1522
- returnedApplicationFee?: string | null;
1523
- /** Reason why this refund was issued. */
1524
- reason?: string | null;
1525
- /** Optional free-text note about this refund. */
1526
- note?: string | null;
1527
- }
1528
- interface SyncRefundResponse {
1529
- /** Created/updated refund. */
1530
- refund?: Refund;
1531
- }
1532
- interface StatusInfoNonNullableFields {
1533
- code: string;
1534
- }
1535
- interface RefundNonNullableFields {
1536
- status: Status;
1537
- initiator: Initiator;
1538
- statusInfo?: StatusInfoNonNullableFields;
1539
- }
1540
- interface CreateRefundResponseNonNullableFields {
1541
- refund?: RefundNonNullableFields;
1542
- }
1543
- interface GetRefundResponseNonNullableFields {
1544
- refund?: RefundNonNullableFields;
1545
- }
1546
- interface QueryRefundsResponseNonNullableFields {
1547
- refunds: RefundNonNullableFields[];
1548
- }
1549
- interface UpdateExtendedFieldsResponseNonNullableFields {
1550
- refund?: RefundNonNullableFields;
1551
- }
1552
- interface RejectionNonNullableFields {
1553
- reason: RejectionReason;
1554
- }
1555
- interface RefundabilityNonNullableFields {
1556
- rejection?: RejectionNonNullableFields;
1557
- refundable: boolean;
1558
- }
1559
- interface GetRefundabilityResponseNonNullableFields {
1560
- refundability?: RefundabilityNonNullableFields;
1561
- }
1562
- interface BaseEventMetadata$1 {
1563
- /** App instance ID. */
1564
- instanceId?: string | null;
1565
- /** Event type. */
1566
- eventType?: string;
1567
- /** The identification type and identity data. */
1568
- identity?: IdentificationData$1;
1569
- }
1570
- interface EventMetadata$1 extends BaseEventMetadata$1 {
1571
- /**
1572
- * Unique event ID.
1573
- * Allows clients to ignore duplicate webhooks.
1574
- */
1575
- _id?: string;
1576
- /**
1577
- * Assumes actions are also always typed to an entity_type
1578
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1579
- */
1580
- entityFqdn?: string;
1581
- /**
1582
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1583
- * This is although the created/updated/deleted notion is duplication of the oneof types
1584
- * Example: created/updated/deleted/started/completed/email_opened
1585
- */
1586
- slug?: string;
1587
- /** ID of the entity associated with the event. */
1588
- entityId?: string;
1589
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1590
- eventTime?: Date | null;
1591
- /**
1592
- * Whether the event was triggered as a result of a privacy regulation application
1593
- * (for example, GDPR).
1594
- */
1595
- triggeredByAnonymizeRequest?: boolean | null;
1596
- /** If present, indicates the action that triggered the event. */
1597
- originatedFrom?: string | null;
1598
- /**
1599
- * A sequence number defining the order of updates to the underlying entity.
1600
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1601
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1602
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1603
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1604
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1605
- */
1606
- entityEventSequence?: string | null;
1607
- }
1608
- interface RefundCreatedEnvelope {
1609
- entity: Refund;
1610
- metadata: EventMetadata$1;
1611
- }
1612
- interface RefundUpdatedEnvelope {
1613
- entity: Refund;
1614
- metadata: EventMetadata$1;
1615
- }
1616
- interface CreateRefundOptions {
1617
- /**
1618
- * Optional parameter used to prevent unintended refunds.
1619
- * Used to check previously refunded amount according to the client
1620
- * against the amount from server perspective.
1621
- * If they don't match, error with code `PREVIOUSLY_REFUNDED_AMOUNT_MISMATCH` is returned.
1622
- *
1623
- * Read more about preventing unintended refunds in this
1624
- * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#preventing-unintended-refunds>).
1625
- */
1626
- previouslyRefundedAmount?: string | null;
1627
- }
1628
- interface QueryCursorResult {
1629
- cursors: Cursors$1;
1630
- hasNext: () => boolean;
1631
- hasPrev: () => boolean;
1632
- length: number;
1633
- pageSize: number;
1634
- }
1635
- interface RefundsQueryResult extends QueryCursorResult {
1636
- items: Refund[];
1637
- query: RefundsQueryBuilder;
1638
- next: () => Promise<RefundsQueryResult>;
1639
- prev: () => Promise<RefundsQueryResult>;
1640
- }
1641
- interface RefundsQueryBuilder {
1642
- /** @param propertyName - Property whose value is compared with `value`.
1643
- * @param value - Value to compare against.
1644
- * @documentationMaturity preview
1645
- */
1646
- eq: (propertyName: 'chargeId', value: any) => RefundsQueryBuilder;
1647
- /** @documentationMaturity preview */
1648
- in: (propertyName: 'chargeId', value: any) => RefundsQueryBuilder;
1649
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1650
- * @documentationMaturity preview
1651
- */
1652
- ascending: (...propertyNames: Array<'_createdDate'>) => RefundsQueryBuilder;
1653
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1654
- * @documentationMaturity preview
1655
- */
1656
- descending: (...propertyNames: Array<'_createdDate'>) => RefundsQueryBuilder;
1657
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1658
- * @documentationMaturity preview
1659
- */
1660
- limit: (limit: number) => RefundsQueryBuilder;
1661
- /** @param cursor - A pointer to specific record
1662
- * @documentationMaturity preview
1663
- */
1664
- skipTo: (cursor: string) => RefundsQueryBuilder;
1665
- /** @documentationMaturity preview */
1666
- find: () => Promise<RefundsQueryResult>;
1667
- }
1668
- interface UpdateExtendedFieldsOptions {
1669
- /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
1670
- namespaceData: Record<string, any> | null;
1671
- }
1672
-
1673
- declare function createRefund$1(httpClient: HttpClient): CreateRefundSignature;
1674
- interface CreateRefundSignature {
1675
- /**
1676
- * Creates a refund.
1677
- * Refunding process starts immediately after refund entity is created.
1678
- *
1679
- * If amount and currency are not specified,
1680
- * refund is created for full charge amount.
1681
- * If amount is specified, you also need to specify currency,
1682
- * and it should be the same as charge currency.
1683
- *
1684
- * The call blocks until refund status transitions from `STARTING`.
1685
- * Read more about refund statuses in this
1686
- * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#lifecycle-of-a-refund>).
1687
- * @param - Refund to be created.
1688
- * @returns The created refund.
1689
- */
1690
- (refund: Refund, options?: CreateRefundOptions | undefined): Promise<Refund & RefundNonNullableFields>;
1691
- }
1692
- declare function getRefund$1(httpClient: HttpClient): GetRefundSignature;
1693
- interface GetRefundSignature {
1694
- /**
1695
- * Retrieves a refund.
1696
- * @param - ID of the refund to retrieve.
1697
- * @returns The requested refund.
1698
- */
1699
- (refundId: string): Promise<Refund & RefundNonNullableFields>;
1700
- }
1701
- declare function queryRefunds$1(httpClient: HttpClient): QueryRefundsSignature;
1702
- interface QueryRefundsSignature {
1703
- /**
1704
- * Retrieves a list of refunds, given the provided [paging, filtering, and sorting][1].
1705
- *
1706
- * Up to 1,000 Refunds can be returned per request.
1707
- *
1708
- * To learn how to query refunds, see [API Query Language][2].
1709
- *
1710
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
1711
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
1712
- */
1713
- (): RefundsQueryBuilder;
1714
- }
1715
- declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
1716
- interface UpdateExtendedFieldsSignature {
1717
- /**
1718
- * Updates extended fields of a refund without incrementing revision.
1719
- * @param - ID of the entity to update.
1720
- * @param - Identifier for the app whose extended fields are being updated.
1721
- */
1722
- (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
1723
- }
1724
- declare function getRefundability$1(httpClient: HttpClient): GetRefundabilitySignature;
1725
- interface GetRefundabilitySignature {
1726
- /**
1727
- * Calculates refundability for a charge.
1728
- *
1729
- * Read more about refundability in this
1730
- * [article](<https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction#refundability>).
1731
- * @param - ID of the charge for which refundability will be calculated.
1732
- */
1733
- (chargeId: string): Promise<GetRefundabilityResponse & GetRefundabilityResponseNonNullableFields>;
1734
- }
1735
- declare const onRefundCreated$1: EventDefinition<RefundCreatedEnvelope, "wix.payments.refunds.v1.refund_created">;
1736
- declare const onRefundUpdated$1: EventDefinition<RefundUpdatedEnvelope, "wix.payments.refunds.v1.refund_updated">;
1737
-
1738
- declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1739
-
1740
- declare const createRefund: MaybeContext<BuildRESTFunction<typeof createRefund$1> & typeof createRefund$1>;
1741
- declare const getRefund: MaybeContext<BuildRESTFunction<typeof getRefund$1> & typeof getRefund$1>;
1742
- declare const queryRefunds: MaybeContext<BuildRESTFunction<typeof queryRefunds$1> & typeof queryRefunds$1>;
1743
- declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
1744
- declare const getRefundability: MaybeContext<BuildRESTFunction<typeof getRefundability$1> & typeof getRefundability$1>;
1745
-
1746
- type _publicOnRefundCreatedType = typeof onRefundCreated$1;
1747
- /** */
1748
- declare const onRefundCreated: ReturnType<typeof createEventModule$1<_publicOnRefundCreatedType>>;
1749
-
1750
- type _publicOnRefundUpdatedType = typeof onRefundUpdated$1;
1751
- /** */
1752
- declare const onRefundUpdated: ReturnType<typeof createEventModule$1<_publicOnRefundUpdatedType>>;
1753
-
1754
- type context$1_CreateRefundOptions = CreateRefundOptions;
1755
- type context$1_CreateRefundRequest = CreateRefundRequest;
1756
- type context$1_CreateRefundResponse = CreateRefundResponse;
1757
- type context$1_CreateRefundResponseNonNullableFields = CreateRefundResponseNonNullableFields;
1758
- type context$1_CursorQuery = CursorQuery;
1759
- type context$1_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;
1760
- type context$1_GetRefundRequest = GetRefundRequest;
1761
- type context$1_GetRefundResponse = GetRefundResponse;
1762
- type context$1_GetRefundResponseNonNullableFields = GetRefundResponseNonNullableFields;
1763
- type context$1_GetRefundabilityRequest = GetRefundabilityRequest;
1764
- type context$1_GetRefundabilityResponse = GetRefundabilityResponse;
1765
- type context$1_GetRefundabilityResponseNonNullableFields = GetRefundabilityResponseNonNullableFields;
1766
- type context$1_Initiator = Initiator;
1767
- declare const context$1_Initiator: typeof Initiator;
1768
- type context$1_QueryRefundsRequest = QueryRefundsRequest;
1769
- type context$1_QueryRefundsResponse = QueryRefundsResponse;
1770
- type context$1_QueryRefundsResponseNonNullableFields = QueryRefundsResponseNonNullableFields;
1771
- type context$1_Refund = Refund;
1772
- type context$1_RefundCreatedEnvelope = RefundCreatedEnvelope;
1773
- type context$1_RefundNonNullableFields = RefundNonNullableFields;
1774
- type context$1_RefundOptions = RefundOptions;
1775
- type context$1_RefundUpdatedEnvelope = RefundUpdatedEnvelope;
1776
- type context$1_Refundability = Refundability;
1777
- type context$1_RefundabilityDetailsOneOf = RefundabilityDetailsOneOf;
1778
- type context$1_RefundsQueryBuilder = RefundsQueryBuilder;
1779
- type context$1_RefundsQueryResult = RefundsQueryResult;
1780
- type context$1_Rejection = Rejection;
1781
- type context$1_RejectionReason = RejectionReason;
1782
- declare const context$1_RejectionReason: typeof RejectionReason;
1783
- type context$1_SortOrder = SortOrder;
1784
- declare const context$1_SortOrder: typeof SortOrder;
1785
- type context$1_Sorting = Sorting;
1786
- type context$1_Status = Status;
1787
- declare const context$1_Status: typeof Status;
1788
- type context$1_StatusInfo = StatusInfo;
1789
- type context$1_SyncRefundRequest = SyncRefundRequest;
1790
- type context$1_SyncRefundResponse = SyncRefundResponse;
1791
- type context$1_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;
1792
- type context$1_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;
1793
- type context$1_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;
1794
- type context$1_UpdateExtendedFieldsResponseNonNullableFields = UpdateExtendedFieldsResponseNonNullableFields;
1795
- type context$1__publicOnRefundCreatedType = _publicOnRefundCreatedType;
1796
- type context$1__publicOnRefundUpdatedType = _publicOnRefundUpdatedType;
1797
- declare const context$1_createRefund: typeof createRefund;
1798
- declare const context$1_getRefund: typeof getRefund;
1799
- declare const context$1_getRefundability: typeof getRefundability;
1800
- declare const context$1_onRefundCreated: typeof onRefundCreated;
1801
- declare const context$1_onRefundUpdated: typeof onRefundUpdated;
1802
- declare const context$1_queryRefunds: typeof queryRefunds;
1803
- declare const context$1_updateExtendedFields: typeof updateExtendedFields;
1804
- declare namespace context$1 {
1805
- export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_CreateRefundOptions as CreateRefundOptions, type context$1_CreateRefundRequest as CreateRefundRequest, type context$1_CreateRefundResponse as CreateRefundResponse, type context$1_CreateRefundResponseNonNullableFields as CreateRefundResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type context$1_CursorQuery as CursorQuery, type context$1_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type ExtendedFields$1 as ExtendedFields, type context$1_GetRefundRequest as GetRefundRequest, type context$1_GetRefundResponse as GetRefundResponse, type context$1_GetRefundResponseNonNullableFields as GetRefundResponseNonNullableFields, type context$1_GetRefundabilityRequest as GetRefundabilityRequest, type context$1_GetRefundabilityResponse as GetRefundabilityResponse, type context$1_GetRefundabilityResponseNonNullableFields as GetRefundabilityResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, context$1_Initiator as Initiator, type MessageEnvelope$1 as MessageEnvelope, type context$1_QueryRefundsRequest as QueryRefundsRequest, type context$1_QueryRefundsResponse as QueryRefundsResponse, type context$1_QueryRefundsResponseNonNullableFields as QueryRefundsResponseNonNullableFields, type context$1_Refund as Refund, type context$1_RefundCreatedEnvelope as RefundCreatedEnvelope, type context$1_RefundNonNullableFields as RefundNonNullableFields, type context$1_RefundOptions as RefundOptions, type context$1_RefundUpdatedEnvelope as RefundUpdatedEnvelope, type context$1_Refundability as Refundability, type context$1_RefundabilityDetailsOneOf as RefundabilityDetailsOneOf, type context$1_RefundsQueryBuilder as RefundsQueryBuilder, type context$1_RefundsQueryResult as RefundsQueryResult, type context$1_Rejection as Rejection, context$1_RejectionReason as RejectionReason, type RestoreInfo$1 as RestoreInfo, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, context$1_Status as Status, type context$1_StatusInfo as StatusInfo, type context$1_SyncRefundRequest as SyncRefundRequest, type context$1_SyncRefundResponse as SyncRefundResponse, type context$1_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions, type context$1_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest, type context$1_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse, type context$1_UpdateExtendedFieldsResponseNonNullableFields as UpdateExtendedFieldsResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicOnRefundCreatedType as _publicOnRefundCreatedType, type context$1__publicOnRefundUpdatedType as _publicOnRefundUpdatedType, context$1_createRefund as createRefund, context$1_getRefund as getRefund, context$1_getRefundability as getRefundability, context$1_onRefundCreated as onRefundCreated, context$1_onRefundUpdated as onRefundUpdated, onRefundCreated$1 as publicOnRefundCreated, onRefundUpdated$1 as publicOnRefundUpdated, context$1_queryRefunds as queryRefunds, context$1_updateExtendedFields as updateExtendedFields };
1806
- }
1807
-
1808
- interface SavedPaymentMethod {
1809
- /**
1810
- * Unique identifier of a saved payment method.
1811
- * @readonly
1812
- */
1813
- _id?: string | null;
1814
- /**
1815
- * 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.
1816
- * @readonly
1817
- */
1818
- revision?: string | null;
1819
- /**
1820
- * SavedPaymentMethod creation time.
1821
- * @readonly
1822
- */
1823
- _createdDate?: Date | null;
1824
- /**
1825
- * SavedPaymentMethod last update time.
1826
- * @readonly
1827
- */
1828
- _updatedDate?: Date | null;
1829
- /** Saved payment method owner's member ID. */
1830
- siteMemberId?: string | null;
1831
- /**
1832
- * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
1833
- * @readonly
1834
- */
1835
- primary?: boolean;
1836
- /** Payment method details. */
1837
- paymentMethod?: PaymentMethod;
1838
- /**
1839
- * Defines whether this payment method can be used by the merchant for making unscheduled payments.
1840
- * 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.
1841
- */
1842
- merchantUseAllowed?: boolean | null;
1843
- /**
1844
- * Saved payment method sensitive information.
1845
- * @readonly
1846
- */
1847
- sensitiveInfo?: SensitiveInfo;
1848
- /** Data Extensions */
1849
- extendedFields?: ExtendedFields;
1850
- }
1851
- interface CardInfo {
1852
- /**
1853
- * Credit card's last 4 digits.
1854
- * @readonly
1855
- */
1856
- lastFourDigits?: string | null;
1857
- /**
1858
- * Credit card's BIN (Bank Identification Number). It's first 4-6 digits of card's number.
1859
- * @readonly
1860
- */
1861
- bin?: string | null;
1862
- /** Credit card's expiration month. */
1863
- expirationMonth?: number | null;
1864
- /** Credit card's expiration year. */
1865
- expirationYear?: number | null;
1866
- /** Card holder's full name specified on the card. */
1867
- cardholderName?: string | null;
1868
- }
1869
- declare enum CardBrand {
1870
- UNKNOWN_CARD_BRAND = "UNKNOWN_CARD_BRAND",
1871
- AMEX = "AMEX",
1872
- DANKORT = "DANKORT",
1873
- DINERS = "DINERS",
1874
- DISCOVER = "DISCOVER",
1875
- ISRACARD = "ISRACARD",
1876
- JCB = "JCB",
1877
- MAESTRO = "MAESTRO",
1878
- MASTERCARD = "MASTERCARD",
1879
- UNIONPAY = "UNIONPAY",
1880
- VISA = "VISA",
1881
- RUPAY = "RUPAY"
1882
- }
1883
- interface PaymentMethod {
1884
- /** Legacy payment method type ID. Supported values are `creditCard`, `payPal`. */
1885
- typeId?: string;
1886
- /**
1887
- * Payment method type ID.
1888
- * @readonly
1889
- */
1890
- paymentMethodTypeId?: string;
1891
- /**
1892
- * Payment method brand ID.
1893
- * @readonly
1894
- */
1895
- paymentMethodBrandId?: string | null;
1896
- /** Details of credit card. */
1897
- cardInfo?: CardInfo;
1898
- }
1899
- interface SensitiveInfo {
1900
- /** Sensitive details of credit card like card token. */
1901
- cardSensitiveInfo?: CardSensitiveInfo;
1902
- }
1903
- interface CardSensitiveInfo {
1904
- /** Persistent token of credit card tokenized by Wix. */
1905
- persistentToken?: string | null;
1906
- }
1907
- interface ExtendedFields {
1908
- /**
1909
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1910
- * The value of each key is structured according to the schema defined when the extended fields were configured.
1911
- *
1912
- * You can only access fields for which you have the appropriate permissions.
1913
- *
1914
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1915
- */
1916
- namespaces?: Record<string, Record<string, any>>;
1917
- }
1918
- interface UpsertSavedPaymentMethodRequest {
1919
- /** Saved payment method. */
1920
- savedPaymentMethod: SavedPaymentMethod;
1921
- /** Temporary token of credit card tokenized by Wix. This token is used to create a persistent token */
1922
- temporaryCardToken: string | null;
1923
- }
1924
- interface UpsertSavedPaymentMethodResponse {
1925
- /** Saved payment method. */
1926
- savedPaymentMethod?: SavedPaymentMethod;
1927
- }
1928
- interface GetSavedPaymentMethodRequest {
1929
- /** Unique identifier of a saved payment method. */
1930
- savedPaymentMethodId: string;
1931
- /**
1932
- * List of heeded fields that will be returned.
1933
- * You should have additional permission in order to get them as described in HidedFields documentation.
1934
- */
1935
- fields?: RequestedFields[];
1936
- }
1937
- declare enum RequestedFields {
1938
- /** Default value. This value is unused. */
1939
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1940
- SENSITIVE_INFO = "SENSITIVE_INFO"
1941
- }
1942
- interface GetSavedPaymentMethodResponse {
1943
- /** Saved payment method. */
1944
- savedPaymentMethod?: SavedPaymentMethod;
1945
- }
1946
- interface DeleteSavedPaymentMethodRequest {
1947
- /** Unique identifier of a saved payment method. */
1948
- savedPaymentMethodId: string;
1949
- }
1950
- interface DeleteSavedPaymentMethodResponse {
1951
- }
1952
- interface ListSavedPaymentMethodsRequest {
1953
- /**
1954
- * Site member that owns saved payment methods.
1955
- * Pass `me` to list saved payment method of the current site member.
1956
- */
1957
- siteMemberId?: string | null;
1958
- /** Payment method type id. Supported values are `creditCard`, `payPal`. */
1959
- paymentMethodTypeId?: string | null;
1960
- /**
1961
- * Defines whether this payment method can be used by the merchant for making unscheduled payments.
1962
- * 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.
1963
- */
1964
- merchantUseAllowed?: boolean | null;
1965
- /**
1966
- * List of requested fields that will be returned.
1967
- * Supported values:
1968
- * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
1969
- * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
1970
- */
1971
- fields?: RequestedFields[];
1972
- /**
1973
- * Paging for limit the response size.
1974
- * If no paging provider default response limit 100 will be used.
1975
- */
1976
- paging?: CursorPaging;
1977
- }
1978
- interface CursorPaging {
1979
- /** Maximum number of items to return in the results. */
1980
- limit?: number | null;
1981
- /**
1982
- * Pointer to the next or previous page in the list of results.
1983
- *
1984
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1985
- * Not relevant for the first request.
1986
- */
1987
- cursor?: string | null;
1988
- }
1989
- interface ListSavedPaymentMethodsResponse {
1990
- /** List of saved payment methods. */
1991
- savedPaymentMethods?: SavedPaymentMethod[];
1992
- /** Paging metadata. */
1993
- pagingMetadata?: CursorPagingMetadata;
1994
- }
1995
- interface CursorPagingMetadata {
1996
- /** Number of items returned in the response. */
1997
- count?: number | null;
1998
- /** Cursor strings that point to the next page, previous page, or both. */
1999
- cursors?: Cursors;
2000
- /**
2001
- * Whether there are more pages to retrieve following the current page.
2002
- *
2003
- * + `true`: Another page of results can be retrieved.
2004
- * + `false`: This is the last page.
2005
- */
2006
- hasNext?: boolean | null;
2007
- }
2008
- interface Cursors {
2009
- /** Cursor string pointing to the next page in the list of results. */
2010
- next?: string | null;
2011
- /** Cursor pointing to the previous page in the list of results. */
2012
- prev?: string | null;
2013
- }
2014
- interface UpdateSavedPaymentMethodRequest {
2015
- /** Saved payment method to update. */
2016
- savedPaymentMethod?: SavedPaymentMethod;
2017
- }
2018
- interface UpdateSavedPaymentMethodResponse {
2019
- /** Updated saved payment method. */
2020
- savedPaymentMethod?: SavedPaymentMethod;
2021
- }
2022
- interface MarkSavedPaymentMethodPrimaryRequest {
2023
- /** Unique identifier of a saved payment method. */
2024
- savedPaymentMethodId: string;
2025
- }
2026
- interface MarkSavedPaymentMethodPrimaryResponse {
2027
- }
2028
- interface DomainEvent extends DomainEventBodyOneOf {
2029
- createdEvent?: EntityCreatedEvent;
2030
- updatedEvent?: EntityUpdatedEvent;
2031
- deletedEvent?: EntityDeletedEvent;
2032
- actionEvent?: ActionEvent;
2033
- /**
2034
- * Unique event ID.
2035
- * Allows clients to ignore duplicate webhooks.
2036
- */
2037
- _id?: string;
2038
- /**
2039
- * Assumes actions are also always typed to an entity_type
2040
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2041
- */
2042
- entityFqdn?: string;
2043
- /**
2044
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2045
- * This is although the created/updated/deleted notion is duplication of the oneof types
2046
- * Example: created/updated/deleted/started/completed/email_opened
2047
- */
2048
- slug?: string;
2049
- /** ID of the entity associated with the event. */
2050
- entityId?: string;
2051
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2052
- eventTime?: Date | null;
2053
- /**
2054
- * Whether the event was triggered as a result of a privacy regulation application
2055
- * (for example, GDPR).
2056
- */
2057
- triggeredByAnonymizeRequest?: boolean | null;
2058
- /** If present, indicates the action that triggered the event. */
2059
- originatedFrom?: string | null;
2060
- /**
2061
- * A sequence number defining the order of updates to the underlying entity.
2062
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2063
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2064
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2065
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2066
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2067
- */
2068
- entityEventSequence?: string | null;
2069
- }
2070
- /** @oneof */
2071
- interface DomainEventBodyOneOf {
2072
- createdEvent?: EntityCreatedEvent;
2073
- updatedEvent?: EntityUpdatedEvent;
2074
- deletedEvent?: EntityDeletedEvent;
2075
- actionEvent?: ActionEvent;
2076
- }
2077
- interface EntityCreatedEvent {
2078
- entity?: string;
2079
- }
2080
- interface RestoreInfo {
2081
- deletedDate?: Date | null;
2082
- }
2083
- interface EntityUpdatedEvent {
2084
- /**
2085
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2086
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2087
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2088
- */
2089
- currentEntity?: string;
2090
- }
2091
- interface EntityDeletedEvent {
2092
- /** Entity that was deleted */
2093
- deletedEntity?: string | null;
2094
- }
2095
- interface ActionEvent {
2096
- body?: string;
2097
- }
2098
- interface MessageEnvelope {
2099
- /** App instance ID. */
2100
- instanceId?: string | null;
2101
- /** Event type. */
2102
- eventType?: string;
2103
- /** The identification type and identity data. */
2104
- identity?: IdentificationData;
2105
- /** Stringify payload. */
2106
- data?: string;
2107
- }
2108
- interface IdentificationData extends IdentificationDataIdOneOf {
2109
- /** ID of a site visitor that has not logged in to the site. */
2110
- anonymousVisitorId?: string;
2111
- /** ID of a site visitor that has logged in to the site. */
2112
- memberId?: string;
2113
- /** ID of a Wix user (site owner, contributor, etc.). */
2114
- wixUserId?: string;
2115
- /** ID of an app. */
2116
- appId?: string;
2117
- /** @readonly */
2118
- identityType?: WebhookIdentityType;
2119
- }
2120
- /** @oneof */
2121
- interface IdentificationDataIdOneOf {
2122
- /** ID of a site visitor that has not logged in to the site. */
2123
- anonymousVisitorId?: string;
2124
- /** ID of a site visitor that has logged in to the site. */
2125
- memberId?: string;
2126
- /** ID of a Wix user (site owner, contributor, etc.). */
2127
- wixUserId?: string;
2128
- /** ID of an app. */
2129
- appId?: string;
2130
- }
2131
- declare enum WebhookIdentityType {
2132
- UNKNOWN = "UNKNOWN",
2133
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2134
- MEMBER = "MEMBER",
2135
- WIX_USER = "WIX_USER",
2136
- APP = "APP"
2137
- }
2138
- interface FindSavedCreditCardRequest {
2139
- /** temporary card token */
2140
- temporaryCardToken?: string;
2141
- /** site member id */
2142
- siteMemberId?: string;
2143
- /** expiration month */
2144
- expirationMonth?: number;
2145
- /** expiration year */
2146
- expirationYear?: number;
2147
- }
2148
- interface FindSavedCreditCardResponse {
2149
- /** saved payment method id */
2150
- savedPaymentMethodId?: string | null;
2151
- }
2152
- interface CardInfoNonNullableFields {
2153
- brand: CardBrand;
2154
- }
2155
- interface PaymentMethodNonNullableFields {
2156
- typeId: string;
2157
- paymentMethodTypeId: string;
2158
- cardInfo?: CardInfoNonNullableFields;
2159
- }
2160
- interface SavedPaymentMethodNonNullableFields {
2161
- primary: boolean;
2162
- paymentMethod?: PaymentMethodNonNullableFields;
2163
- }
2164
- interface UpsertSavedPaymentMethodResponseNonNullableFields {
2165
- savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
2166
- }
2167
- interface GetSavedPaymentMethodResponseNonNullableFields {
2168
- savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
2169
- }
2170
- interface ListSavedPaymentMethodsResponseNonNullableFields {
2171
- savedPaymentMethods: SavedPaymentMethodNonNullableFields[];
2172
- }
2173
- interface UpdateSavedPaymentMethodResponseNonNullableFields {
2174
- savedPaymentMethod?: SavedPaymentMethodNonNullableFields;
2175
- }
2176
- interface BaseEventMetadata {
2177
- /** App instance ID. */
2178
- instanceId?: string | null;
2179
- /** Event type. */
2180
- eventType?: string;
2181
- /** The identification type and identity data. */
2182
- identity?: IdentificationData;
2183
- }
2184
- interface EventMetadata extends BaseEventMetadata {
2185
- /**
2186
- * Unique event ID.
2187
- * Allows clients to ignore duplicate webhooks.
2188
- */
2189
- _id?: string;
2190
- /**
2191
- * Assumes actions are also always typed to an entity_type
2192
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2193
- */
2194
- entityFqdn?: string;
2195
- /**
2196
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2197
- * This is although the created/updated/deleted notion is duplication of the oneof types
2198
- * Example: created/updated/deleted/started/completed/email_opened
2199
- */
2200
- slug?: string;
2201
- /** ID of the entity associated with the event. */
2202
- entityId?: string;
2203
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2204
- eventTime?: Date | null;
2205
- /**
2206
- * Whether the event was triggered as a result of a privacy regulation application
2207
- * (for example, GDPR).
2208
- */
2209
- triggeredByAnonymizeRequest?: boolean | null;
2210
- /** If present, indicates the action that triggered the event. */
2211
- originatedFrom?: string | null;
2212
- /**
2213
- * A sequence number defining the order of updates to the underlying entity.
2214
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2215
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2216
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2217
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2218
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2219
- */
2220
- entityEventSequence?: string | null;
2221
- }
2222
- interface SavedPaymentMethodCreatedEnvelope {
2223
- entity: SavedPaymentMethod;
2224
- metadata: EventMetadata;
2225
- }
2226
- interface SavedPaymentMethodDeletedEnvelope {
2227
- metadata: EventMetadata;
2228
- }
2229
- interface SavedPaymentMethodUpdatedEnvelope {
2230
- entity: SavedPaymentMethod;
2231
- metadata: EventMetadata;
2232
- }
2233
- interface UpsertSavedPaymentMethodOptions {
2234
- /** Temporary token of credit card tokenized by Wix. This token is used to create a persistent token */
2235
- temporaryCardToken: string | null;
2236
- }
2237
- interface GetSavedPaymentMethodOptions {
2238
- /**
2239
- * List of heeded fields that will be returned.
2240
- * You should have additional permission in order to get them as described in HidedFields documentation.
2241
- */
2242
- fields?: RequestedFields[];
2243
- }
2244
- interface ListSavedPaymentMethodsOptions {
2245
- /**
2246
- * Site member that owns saved payment methods.
2247
- * Pass `me` to list saved payment method of the current site member.
2248
- */
2249
- siteMemberId?: string | null;
2250
- /** Payment method type id. Supported values are `creditCard`, `payPal`. */
2251
- paymentMethodTypeId?: string | null;
2252
- /**
2253
- * Defines whether this payment method can be used by the merchant for making unscheduled payments.
2254
- * 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.
2255
- */
2256
- merchantUseAllowed?: boolean | null;
2257
- /**
2258
- * List of requested fields that will be returned.
2259
- * Supported values:
2260
- * SENSITIVE_INFO - Sensitive information of a SavedPaymentMethod like credit card tokens that's needed to process payments with it.
2261
- * In order to receive it you should have `PAYMENTS.SAVED_PAYMENT_METHOD_READ_SENSITIVE_INFO` permission
2262
- */
2263
- fields?: RequestedFields[];
2264
- /**
2265
- * Paging for limit the response size.
2266
- * If no paging provider default response limit 100 will be used.
2267
- */
2268
- paging?: CursorPaging;
2269
- }
2270
- interface UpdateSavedPaymentMethodOptions {
2271
- savedPaymentMethod: {
2272
- /**
2273
- * Unique identifier of a saved payment method.
2274
- * @readonly
2275
- */
2276
- _id?: string | null;
2277
- /**
2278
- * 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.
2279
- * @readonly
2280
- */
2281
- revision?: string | null;
2282
- /**
2283
- * SavedPaymentMethod creation time.
2284
- * @readonly
2285
- */
2286
- _createdDate?: Date | null;
2287
- /**
2288
- * SavedPaymentMethod last update time.
2289
- * @readonly
2290
- */
2291
- _updatedDate?: Date | null;
2292
- /** Saved payment method owner's member ID. */
2293
- siteMemberId?: string | null;
2294
- /**
2295
- * Defines whether this payment method is primary for the member. Member can only have at most one primary saved payment method.
2296
- * @readonly
2297
- */
2298
- primary?: boolean;
2299
- /** Payment method details. */
2300
- paymentMethod?: PaymentMethod;
2301
- /**
2302
- * Defines whether this payment method can be used by the merchant for making unscheduled payments.
2303
- * 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.
2304
- */
2305
- merchantUseAllowed?: boolean | null;
2306
- /**
2307
- * Saved payment method sensitive information.
2308
- * @readonly
2309
- */
2310
- sensitiveInfo?: SensitiveInfo;
2311
- /** Data Extensions */
2312
- extendedFields?: ExtendedFields;
2313
- };
2314
- }
2315
-
2316
- declare function upsertSavedPaymentMethod$1(httpClient: HttpClient): UpsertSavedPaymentMethodSignature;
2317
- interface UpsertSavedPaymentMethodSignature {
2318
- /**
2319
- * Creates a new SavedPaymentMethod or updates existing one if SavedPaymentMethod already exists for the same site member.
2320
- * To check uniqueness SavedPaymentMethods are compared by credit card expiration year/month, last four digits and bin.
2321
- * If sensitiveInfo.cardSensitiveInfo.temporaryToken was passed than service will eventually create a persi from it.
2322
- * @param - Saved payment method.
2323
- */
2324
- (savedPaymentMethod: SavedPaymentMethod, options: UpsertSavedPaymentMethodOptions): Promise<UpsertSavedPaymentMethodResponse & UpsertSavedPaymentMethodResponseNonNullableFields>;
2325
- }
2326
- declare function getSavedPaymentMethod$1(httpClient: HttpClient): GetSavedPaymentMethodSignature;
2327
- interface GetSavedPaymentMethodSignature {
2328
- /**
2329
- * Returns SavedPaymentMethod by ID.
2330
- * @param - Unique identifier of a saved payment method.
2331
- * @returns Saved payment method.
2332
- */
2333
- (savedPaymentMethodId: string, options?: GetSavedPaymentMethodOptions | undefined): Promise<SavedPaymentMethod & SavedPaymentMethodNonNullableFields>;
2334
- }
2335
- declare function deleteSavedPaymentMethod$1(httpClient: HttpClient): DeleteSavedPaymentMethodSignature;
2336
- interface DeleteSavedPaymentMethodSignature {
2337
- /**
2338
- * Deletes SavedPaymentMethod by ID.
2339
- * @param - Unique identifier of a saved payment method.
2340
- */
2341
- (savedPaymentMethodId: string): Promise<void>;
2342
- }
2343
- declare function listSavedPaymentMethods$1(httpClient: HttpClient): ListSavedPaymentMethodsSignature;
2344
- interface ListSavedPaymentMethodsSignature {
2345
- /**
2346
- * Lists SavedPaymentMethods ordered by update date descending.
2347
- */
2348
- (options?: ListSavedPaymentMethodsOptions | undefined): Promise<ListSavedPaymentMethodsResponse & ListSavedPaymentMethodsResponseNonNullableFields>;
2349
- }
2350
- declare function updateSavedPaymentMethod$1(httpClient: HttpClient): UpdateSavedPaymentMethodSignature;
2351
- interface UpdateSavedPaymentMethodSignature {
2352
- /**
2353
- * Updates SavedPaymentMethod. Only fields listed in field_mask are updated.
2354
- * @param - Unique identifier of a saved payment method.
2355
- * @returns Updated saved payment method.
2356
- */
2357
- (_id: string | null, options?: UpdateSavedPaymentMethodOptions | undefined): Promise<SavedPaymentMethod & SavedPaymentMethodNonNullableFields>;
2358
- }
2359
- declare function markSavedPaymentMethodPrimary$1(httpClient: HttpClient): MarkSavedPaymentMethodPrimarySignature;
2360
- interface MarkSavedPaymentMethodPrimarySignature {
2361
- /**
2362
- * Marks SavedPaymentMethod as primary for site member who's the owner of this SavedPaymentMethod.
2363
- * Primary SavedPaymentMethod is selected by default during the checkout.
2364
- * For every site member there can be at most one primary SavedPaymentMethod,
2365
- * so when one SavedPaymentMethod is marked as primary previous one is automatically unmarked.
2366
- * @param - Unique identifier of a saved payment method.
2367
- */
2368
- (savedPaymentMethodId: string): Promise<void>;
2369
- }
2370
- declare const onSavedPaymentMethodCreated$1: EventDefinition<SavedPaymentMethodCreatedEnvelope, "wix.payments.saved_payment_methods.v1.saved_payment_method_created">;
2371
- declare const onSavedPaymentMethodDeleted$1: EventDefinition<SavedPaymentMethodDeletedEnvelope, "wix.payments.saved_payment_methods.v1.saved_payment_method_deleted">;
2372
- declare const onSavedPaymentMethodUpdated$1: EventDefinition<SavedPaymentMethodUpdatedEnvelope, "wix.payments.saved_payment_methods.v1.saved_payment_method_updated">;
2373
-
2374
- declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
2375
-
2376
- declare const upsertSavedPaymentMethod: MaybeContext<BuildRESTFunction<typeof upsertSavedPaymentMethod$1> & typeof upsertSavedPaymentMethod$1>;
2377
- declare const getSavedPaymentMethod: MaybeContext<BuildRESTFunction<typeof getSavedPaymentMethod$1> & typeof getSavedPaymentMethod$1>;
2378
- declare const deleteSavedPaymentMethod: MaybeContext<BuildRESTFunction<typeof deleteSavedPaymentMethod$1> & typeof deleteSavedPaymentMethod$1>;
2379
- declare const listSavedPaymentMethods: MaybeContext<BuildRESTFunction<typeof listSavedPaymentMethods$1> & typeof listSavedPaymentMethods$1>;
2380
- declare const updateSavedPaymentMethod: MaybeContext<BuildRESTFunction<typeof updateSavedPaymentMethod$1> & typeof updateSavedPaymentMethod$1>;
2381
- declare const markSavedPaymentMethodPrimary: MaybeContext<BuildRESTFunction<typeof markSavedPaymentMethodPrimary$1> & typeof markSavedPaymentMethodPrimary$1>;
2382
-
2383
- type _publicOnSavedPaymentMethodCreatedType = typeof onSavedPaymentMethodCreated$1;
2384
- /** */
2385
- declare const onSavedPaymentMethodCreated: ReturnType<typeof createEventModule<_publicOnSavedPaymentMethodCreatedType>>;
2386
-
2387
- type _publicOnSavedPaymentMethodDeletedType = typeof onSavedPaymentMethodDeleted$1;
2388
- /** */
2389
- declare const onSavedPaymentMethodDeleted: ReturnType<typeof createEventModule<_publicOnSavedPaymentMethodDeletedType>>;
2390
-
2391
- type _publicOnSavedPaymentMethodUpdatedType = typeof onSavedPaymentMethodUpdated$1;
2392
- /** */
2393
- declare const onSavedPaymentMethodUpdated: ReturnType<typeof createEventModule<_publicOnSavedPaymentMethodUpdatedType>>;
2394
-
2395
- type context_ActionEvent = ActionEvent;
2396
- type context_BaseEventMetadata = BaseEventMetadata;
2397
- type context_CardBrand = CardBrand;
2398
- declare const context_CardBrand: typeof CardBrand;
2399
- type context_CardInfo = CardInfo;
2400
- type context_CardSensitiveInfo = CardSensitiveInfo;
2401
- type context_CursorPaging = CursorPaging;
2402
- type context_CursorPagingMetadata = CursorPagingMetadata;
2403
- type context_Cursors = Cursors;
2404
- type context_DeleteSavedPaymentMethodRequest = DeleteSavedPaymentMethodRequest;
2405
- type context_DeleteSavedPaymentMethodResponse = DeleteSavedPaymentMethodResponse;
2406
- type context_DomainEvent = DomainEvent;
2407
- type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
2408
- type context_EntityCreatedEvent = EntityCreatedEvent;
2409
- type context_EntityDeletedEvent = EntityDeletedEvent;
2410
- type context_EntityUpdatedEvent = EntityUpdatedEvent;
2411
- type context_EventMetadata = EventMetadata;
2412
- type context_ExtendedFields = ExtendedFields;
2413
- type context_FindSavedCreditCardRequest = FindSavedCreditCardRequest;
2414
- type context_FindSavedCreditCardResponse = FindSavedCreditCardResponse;
2415
- type context_GetSavedPaymentMethodOptions = GetSavedPaymentMethodOptions;
2416
- type context_GetSavedPaymentMethodRequest = GetSavedPaymentMethodRequest;
2417
- type context_GetSavedPaymentMethodResponse = GetSavedPaymentMethodResponse;
2418
- type context_GetSavedPaymentMethodResponseNonNullableFields = GetSavedPaymentMethodResponseNonNullableFields;
2419
- type context_IdentificationData = IdentificationData;
2420
- type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
2421
- type context_ListSavedPaymentMethodsOptions = ListSavedPaymentMethodsOptions;
2422
- type context_ListSavedPaymentMethodsRequest = ListSavedPaymentMethodsRequest;
2423
- type context_ListSavedPaymentMethodsResponse = ListSavedPaymentMethodsResponse;
2424
- type context_ListSavedPaymentMethodsResponseNonNullableFields = ListSavedPaymentMethodsResponseNonNullableFields;
2425
- type context_MarkSavedPaymentMethodPrimaryRequest = MarkSavedPaymentMethodPrimaryRequest;
2426
- type context_MarkSavedPaymentMethodPrimaryResponse = MarkSavedPaymentMethodPrimaryResponse;
2427
- type context_MessageEnvelope = MessageEnvelope;
2428
- type context_PaymentMethod = PaymentMethod;
2429
- type context_RequestedFields = RequestedFields;
2430
- declare const context_RequestedFields: typeof RequestedFields;
2431
- type context_RestoreInfo = RestoreInfo;
2432
- type context_SavedPaymentMethod = SavedPaymentMethod;
2433
- type context_SavedPaymentMethodCreatedEnvelope = SavedPaymentMethodCreatedEnvelope;
2434
- type context_SavedPaymentMethodDeletedEnvelope = SavedPaymentMethodDeletedEnvelope;
2435
- type context_SavedPaymentMethodNonNullableFields = SavedPaymentMethodNonNullableFields;
2436
- type context_SavedPaymentMethodUpdatedEnvelope = SavedPaymentMethodUpdatedEnvelope;
2437
- type context_SensitiveInfo = SensitiveInfo;
2438
- type context_UpdateSavedPaymentMethodOptions = UpdateSavedPaymentMethodOptions;
2439
- type context_UpdateSavedPaymentMethodRequest = UpdateSavedPaymentMethodRequest;
2440
- type context_UpdateSavedPaymentMethodResponse = UpdateSavedPaymentMethodResponse;
2441
- type context_UpdateSavedPaymentMethodResponseNonNullableFields = UpdateSavedPaymentMethodResponseNonNullableFields;
2442
- type context_UpsertSavedPaymentMethodOptions = UpsertSavedPaymentMethodOptions;
2443
- type context_UpsertSavedPaymentMethodRequest = UpsertSavedPaymentMethodRequest;
2444
- type context_UpsertSavedPaymentMethodResponse = UpsertSavedPaymentMethodResponse;
2445
- type context_UpsertSavedPaymentMethodResponseNonNullableFields = UpsertSavedPaymentMethodResponseNonNullableFields;
2446
- type context_WebhookIdentityType = WebhookIdentityType;
2447
- declare const context_WebhookIdentityType: typeof WebhookIdentityType;
2448
- type context__publicOnSavedPaymentMethodCreatedType = _publicOnSavedPaymentMethodCreatedType;
2449
- type context__publicOnSavedPaymentMethodDeletedType = _publicOnSavedPaymentMethodDeletedType;
2450
- type context__publicOnSavedPaymentMethodUpdatedType = _publicOnSavedPaymentMethodUpdatedType;
2451
- declare const context_deleteSavedPaymentMethod: typeof deleteSavedPaymentMethod;
2452
- declare const context_getSavedPaymentMethod: typeof getSavedPaymentMethod;
2453
- declare const context_listSavedPaymentMethods: typeof listSavedPaymentMethods;
2454
- declare const context_markSavedPaymentMethodPrimary: typeof markSavedPaymentMethodPrimary;
2455
- declare const context_onSavedPaymentMethodCreated: typeof onSavedPaymentMethodCreated;
2456
- declare const context_onSavedPaymentMethodDeleted: typeof onSavedPaymentMethodDeleted;
2457
- declare const context_onSavedPaymentMethodUpdated: typeof onSavedPaymentMethodUpdated;
2458
- declare const context_updateSavedPaymentMethod: typeof updateSavedPaymentMethod;
2459
- declare const context_upsertSavedPaymentMethod: typeof upsertSavedPaymentMethod;
2460
- declare namespace context {
2461
- export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, context_CardBrand as CardBrand, type context_CardInfo as CardInfo, type context_CardSensitiveInfo as CardSensitiveInfo, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DeleteSavedPaymentMethodRequest as DeleteSavedPaymentMethodRequest, type context_DeleteSavedPaymentMethodResponse as DeleteSavedPaymentMethodResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_ExtendedFields as ExtendedFields, type context_FindSavedCreditCardRequest as FindSavedCreditCardRequest, type context_FindSavedCreditCardResponse as FindSavedCreditCardResponse, type context_GetSavedPaymentMethodOptions as GetSavedPaymentMethodOptions, type context_GetSavedPaymentMethodRequest as GetSavedPaymentMethodRequest, type context_GetSavedPaymentMethodResponse as GetSavedPaymentMethodResponse, type context_GetSavedPaymentMethodResponseNonNullableFields as GetSavedPaymentMethodResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListSavedPaymentMethodsOptions as ListSavedPaymentMethodsOptions, type context_ListSavedPaymentMethodsRequest as ListSavedPaymentMethodsRequest, type context_ListSavedPaymentMethodsResponse as ListSavedPaymentMethodsResponse, type context_ListSavedPaymentMethodsResponseNonNullableFields as ListSavedPaymentMethodsResponseNonNullableFields, type context_MarkSavedPaymentMethodPrimaryRequest as MarkSavedPaymentMethodPrimaryRequest, type context_MarkSavedPaymentMethodPrimaryResponse as MarkSavedPaymentMethodPrimaryResponse, type context_MessageEnvelope as MessageEnvelope, type context_PaymentMethod as PaymentMethod, context_RequestedFields as RequestedFields, type context_RestoreInfo as RestoreInfo, type context_SavedPaymentMethod as SavedPaymentMethod, type context_SavedPaymentMethodCreatedEnvelope as SavedPaymentMethodCreatedEnvelope, type context_SavedPaymentMethodDeletedEnvelope as SavedPaymentMethodDeletedEnvelope, type context_SavedPaymentMethodNonNullableFields as SavedPaymentMethodNonNullableFields, type context_SavedPaymentMethodUpdatedEnvelope as SavedPaymentMethodUpdatedEnvelope, type context_SensitiveInfo as SensitiveInfo, type context_UpdateSavedPaymentMethodOptions as UpdateSavedPaymentMethodOptions, type context_UpdateSavedPaymentMethodRequest as UpdateSavedPaymentMethodRequest, type context_UpdateSavedPaymentMethodResponse as UpdateSavedPaymentMethodResponse, type context_UpdateSavedPaymentMethodResponseNonNullableFields as UpdateSavedPaymentMethodResponseNonNullableFields, type context_UpsertSavedPaymentMethodOptions as UpsertSavedPaymentMethodOptions, type context_UpsertSavedPaymentMethodRequest as UpsertSavedPaymentMethodRequest, type context_UpsertSavedPaymentMethodResponse as UpsertSavedPaymentMethodResponse, type context_UpsertSavedPaymentMethodResponseNonNullableFields as UpsertSavedPaymentMethodResponseNonNullableFields, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnSavedPaymentMethodCreatedType as _publicOnSavedPaymentMethodCreatedType, type context__publicOnSavedPaymentMethodDeletedType as _publicOnSavedPaymentMethodDeletedType, type context__publicOnSavedPaymentMethodUpdatedType as _publicOnSavedPaymentMethodUpdatedType, context_deleteSavedPaymentMethod as deleteSavedPaymentMethod, context_getSavedPaymentMethod as getSavedPaymentMethod, context_listSavedPaymentMethods as listSavedPaymentMethods, context_markSavedPaymentMethodPrimary as markSavedPaymentMethodPrimary, context_onSavedPaymentMethodCreated as onSavedPaymentMethodCreated, context_onSavedPaymentMethodDeleted as onSavedPaymentMethodDeleted, context_onSavedPaymentMethodUpdated as onSavedPaymentMethodUpdated, onSavedPaymentMethodCreated$1 as publicOnSavedPaymentMethodCreated, onSavedPaymentMethodDeleted$1 as publicOnSavedPaymentMethodDeleted, onSavedPaymentMethodUpdated$1 as publicOnSavedPaymentMethodUpdated, context_updateSavedPaymentMethod as updateSavedPaymentMethod, context_upsertSavedPaymentMethod as upsertSavedPaymentMethod };
2462
- }
2463
-
2464
- export { context$3 as onboardingAvailability, context$2 as pspCallbacks, context$1 as refunds, context as savedPaymentMethods };