@wix/packages 1.0.22 → 1.0.24

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,2240 +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
- /**
480
- * A package is group of instances of Wix services that a reseller offers to a
481
- * customer as part of a single transaction.
482
- */
483
- interface Package {
484
- /**
485
- * Package ID.
486
- * @readonly
487
- */
488
- _id?: string;
489
- /**
490
- * Wix account ID. See
491
- * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
492
- * for more details.
493
- * @readonly
494
- */
495
- accountId?: string;
496
- /**
497
- * External reference. For example, an external subscription ID.
498
- * This field isn't validated by Wix.
499
- *
500
- * Max: 100 characters
501
- */
502
- externalId?: string | null;
503
- /**
504
- * Product instances that are included in the package.
505
- *
506
- * Min: 1 product instance
507
- * Max: 1000 product instances
508
- */
509
- productInstances?: ProductInstance[];
510
- /**
511
- * Date and time the package was created.
512
- * @readonly
513
- */
514
- _createdDate?: Date | null;
515
- /**
516
- * Date and time the package was last updated.
517
- * @readonly
518
- */
519
- _updatedDate?: Date | null;
520
- }
521
- /**
522
- * A product instance is a specific instance of a Wix service that a reseller
523
- * offers to one of their customers.
524
- */
525
- interface ProductInstance extends ProductInstanceContractDetailsOneOf {
526
- /** Billing information for the contract between the reseller and Wix. */
527
- billingInfo?: ProductInstanceCycle;
528
- /**
529
- * ID of the instance of the resold Wix service. **Note:** Differs from the
530
- * `catalogProductId`. Allows you to identify different instances of the same
531
- * product in a package.
532
- * @readonly
533
- */
534
- instanceId?: string;
535
- /**
536
- * ID of the Wix site that the product instance is assigned to.
537
- * See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites)
538
- * for more information.
539
- */
540
- siteId?: string | null;
541
- /**
542
- * Product ID, as defined in the Wix Premium Product Catalog.
543
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com)
544
- * for more details about available Wix services.
545
- */
546
- catalogProductId?: string;
547
- /**
548
- * Status of the product instance.
549
- * @readonly
550
- */
551
- status?: Status;
552
- /**
553
- * Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`.
554
- * @readonly
555
- */
556
- failure?: FailureReason;
557
- /**
558
- * Date and time the product instance was created.
559
- * @readonly
560
- */
561
- _createdDate?: Date | null;
562
- /**
563
- * Date and time the product instance was last updated.
564
- * @readonly
565
- */
566
- _updatedDate?: Date | null;
567
- /**
568
- * Two-letter country code in
569
- * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
570
- * format. Specifies where customers can claim vouchers that may come with the
571
- * product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more
572
- * information about vouchers and supported locations.
573
- */
574
- countryCode?: string | null;
575
- /**
576
- * Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format.
577
- * Used only for instances that don't auto renew at the end of the current billing cycle.
578
- * @readonly
579
- */
580
- expirationDate?: Date | null;
581
- /**
582
- * Discount code indicating that the reseller provisioned the product instance
583
- * during a sale. Wix doesn't guarantee that a discount code reduces the
584
- * price between Wix and the reseller, even when it's valid. Contact the
585
- * [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
586
- *
587
- * Max: 25 characters
588
- */
589
- discountCode?: string | null;
590
- /**
591
- * ID of a different product instance that you can use to offer your customers
592
- * time-limited free access to an additional product or service. For example,
593
- * Wix offers a 1-year free domain registration to all customers who purchase a
594
- * Premium plan. The referenced product instance must have either status `"PENDING"` or
595
- * `"ACTIVE"`. You can use each product instance only a single time as reference
596
- * instance.
597
- */
598
- referenceProductInstanceId?: string | null;
599
- }
600
- /** @oneof */
601
- interface ProductInstanceContractDetailsOneOf {
602
- /** Billing information for the contract between the reseller and Wix. */
603
- billingInfo?: ProductInstanceCycle;
604
- }
605
- declare enum FailureReasonFailureReason {
606
- UNKNOWN = "UNKNOWN",
607
- /** The product instance couldn't be created because the Resellers API timed out. */
608
- DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT",
609
- /** The product instance couldn't be created because an external process failed. */
610
- EXTERNAL_FAILURE = "EXTERNAL_FAILURE"
611
- }
612
- declare enum IntervalIntervalUnit {
613
- /** unknown interval unit */
614
- UNKNOWN = "UNKNOWN",
615
- /** Day */
616
- DAY = "DAY",
617
- /** Week */
618
- WEEK = "WEEK",
619
- /** Month */
620
- MONTH = "MONTH",
621
- /** Year */
622
- YEAR = "YEAR"
623
- }
624
- declare enum CycleDescriptorType {
625
- /** The payment type hasn't been set. */
626
- UNKNOWN = "UNKNOWN",
627
- /** The reseller pays Wix in a single payment. */
628
- ONE_TIME = "ONE_TIME",
629
- /** The reseller pays Wix on a recurring schedule. */
630
- RECURRING = "RECURRING"
631
- }
632
- interface CycleInterval {
633
- /** Unit of the billing cycle. */
634
- unit?: IntervalIntervalUnit;
635
- /** Count of units that make up the billing cycle. */
636
- count?: number;
637
- }
638
- declare enum Status {
639
- /** The product instance isn't yet available to the customer. */
640
- PENDING = "PENDING",
641
- /** The customer can use the product instance. */
642
- ENABLED = "ENABLED",
643
- /** The product instance isn't any longer available to the customer. */
644
- CANCELED = "CANCELED",
645
- /** The product instance couldn't be delivered successfully and has never been available to the customer. */
646
- FAILED = "FAILED",
647
- /** The product instance isn't yet available to the customer, because an external provider or the customer must take an action. */
648
- AWAITING_ACTION = "AWAITING_ACTION"
649
- }
650
- interface FailureReason {
651
- /** Failure code. */
652
- code?: FailureReasonFailureReason;
653
- /** Failure message. */
654
- message?: string;
655
- }
656
- interface ProductInstanceCycle {
657
- /** Payment type. */
658
- type?: CycleDescriptorType;
659
- /** Duration of the billing cycle. Available only for `RECURRING` payments. */
660
- cycleDuration?: CycleInterval;
661
- }
662
- interface MigrateSubscriptionToPackagesRequest {
663
- /** Created package. */
664
- productInstance?: ProductInstance;
665
- /** Existing subscriptionId to migrate */
666
- subscriptionId?: string | null;
667
- /** User id of the migration - only for Immigrator */
668
- userId?: string | null;
669
- }
670
- interface MigrateSubscriptionToPackagesResponse {
671
- package?: Package;
672
- }
673
- interface FixBrokenMigrationRequest {
674
- /** Subscription id of the broken subscription */
675
- subscriptionId?: string;
676
- /** SBS service id that points to the broken subscription */
677
- sbsServiceId?: string;
678
- /** Owner of the broken subscription */
679
- userId?: string;
680
- }
681
- interface FixBrokenMigrationResponse {
682
- }
683
- interface CreatePackageRequest {
684
- /** Idempotency key. */
685
- idempotencyKey?: string | null;
686
- /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
687
- externalId?: string | null;
688
- /** Wix services that are resold. */
689
- products: ProductInstance[];
690
- }
691
- interface CreatePackageResponse {
692
- /** Idempotency key. */
693
- idempotencyKey?: string | null;
694
- /** Created package. */
695
- package?: Package;
696
- }
697
- interface CancelPackageRequest {
698
- /** Idempotency key. */
699
- idempotencyKey?: string | null;
700
- /** ID of the package to cancel. */
701
- _id: string;
702
- }
703
- interface CancelPackageResponse {
704
- /** Idempotency key. */
705
- idempotencyKey?: string | null;
706
- /** Canceled package. */
707
- package?: Package;
708
- }
709
- interface PackageCanceled {
710
- /** Canceled package. */
711
- package?: Package;
712
- }
713
- interface GetPackageRequest {
714
- /** Package ID. */
715
- _id: string;
716
- }
717
- interface GetPackageResponse {
718
- /** Retrieved package. */
719
- package?: Package;
720
- }
721
- interface QueryPackagesRequest {
722
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
723
- query: QueryV2;
724
- }
725
- interface QueryV2 extends QueryV2PagingMethodOneOf {
726
- /** Paging options to limit and skip the number of items. */
727
- paging?: Paging;
728
- /** 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`. */
729
- cursorPaging?: CursorPaging;
730
- /**
731
- * Filter object.
732
- *
733
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
734
- */
735
- filter?: Record<string, any> | null;
736
- /**
737
- * Sort object.
738
- *
739
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
740
- */
741
- sort?: Sorting[];
742
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
743
- fields?: string[];
744
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
745
- fieldsets?: string[];
746
- }
747
- /** @oneof */
748
- interface QueryV2PagingMethodOneOf {
749
- /** Paging options to limit and skip the number of items. */
750
- paging?: Paging;
751
- /** 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`. */
752
- cursorPaging?: CursorPaging;
753
- }
754
- interface Sorting {
755
- /** Name of the field to sort by. */
756
- fieldName?: string;
757
- /** Sort order. */
758
- order?: SortOrder;
759
- }
760
- declare enum SortOrder {
761
- ASC = "ASC",
762
- DESC = "DESC"
763
- }
764
- interface Paging {
765
- /** Number of items to load. */
766
- limit?: number | null;
767
- /** Number of items to skip in the current sort order. */
768
- offset?: number | null;
769
- }
770
- interface CursorPaging {
771
- /** Maximum number of items to return in the results. */
772
- limit?: number | null;
773
- /**
774
- * Pointer to the next or previous page in the list of results.
775
- *
776
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
777
- * Not relevant for the first request.
778
- */
779
- cursor?: string | null;
780
- }
781
- interface QueryPackagesResponse {
782
- /** Paging metadata. */
783
- metadata?: PagingMetadataV2;
784
- /**
785
- * Retrieved packages.
786
- *
787
- * Max: 1000 packages
788
- */
789
- packages?: Package[];
790
- }
791
- interface PagingMetadataV2 {
792
- /** Number of items returned in the response. */
793
- count?: number | null;
794
- /** Offset that was requested. */
795
- offset?: number | null;
796
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
797
- total?: number | null;
798
- /** Flag that indicates the server failed to calculate the `total` field. */
799
- tooManyToCount?: boolean | null;
800
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
801
- cursors?: Cursors;
802
- }
803
- interface Cursors {
804
- /** Cursor string pointing to the next page in the list of results. */
805
- next?: string | null;
806
- /** Cursor pointing to the previous page in the list of results. */
807
- prev?: string | null;
808
- }
809
- interface AssignProductInstanceToSiteRequest {
810
- /** Idempotency key. */
811
- idempotencyKey?: string | null;
812
- /** ID of the product instance to assign to a site. */
813
- instanceId: string;
814
- /** ID of the site to which the product instance is assigned. */
815
- siteId: string;
816
- }
817
- interface AssignProductInstanceToSiteResponse {
818
- /** Idempotency key. */
819
- idempotencyKey?: string | null;
820
- /** Updated package that includes the assigned product instance. */
821
- package?: Package;
822
- }
823
- interface AssignedProductInstanceToSite {
824
- /** Updated package. */
825
- package?: Package;
826
- /**
827
- * ID of the product instance that was assigned to the site.
828
- * @readonly
829
- */
830
- productInstanceId?: string;
831
- /**
832
- * ID of the site the product instance was assigned to.
833
- * @readonly
834
- */
835
- siteId?: string;
836
- }
837
- interface UnassignProductInstanceFromSiteRequest {
838
- /** Idempotency key. */
839
- idempotencyKey?: string | null;
840
- /** ID of the product instance to unassign from a site. */
841
- instanceId: string;
842
- }
843
- interface UnassignProductInstanceFromSiteResponse {
844
- /** Idempotency key. */
845
- idempotencyKey?: string | null;
846
- /** Updated package that includes the unassigned product instance. */
847
- package?: Package;
848
- }
849
- interface UnassignedProductInstanceFromSite {
850
- /** Updated package. */
851
- package?: Package;
852
- /**
853
- * ID of the product instance that was unassigned from the site.
854
- * @readonly
855
- */
856
- productInstanceId?: string;
857
- /**
858
- * MetasiteId of the site the product instance was unassigned from.
859
- * @readonly
860
- */
861
- metaSiteId?: string;
862
- }
863
- interface CancelProductInstanceRequest {
864
- /** Idempotency key. */
865
- idempotencyKey?: string | null;
866
- /** ID of the product instance to cancel. */
867
- instanceId: string;
868
- }
869
- interface CancelProductInstanceResponse {
870
- /** Idempotency key. */
871
- idempotencyKey?: string | null;
872
- /** Updated package that includes the previously included the canceled product instance. */
873
- package?: Package;
874
- }
875
- interface ProductInstanceCanceled {
876
- /** Updated package. */
877
- package?: Package;
878
- /**
879
- * ID of the product instance that was canceled.
880
- * @readonly
881
- */
882
- productInstanceId?: string;
883
- }
884
- interface AdjustProductInstanceSpecificationsRequest {
885
- /** Idempotency key. */
886
- idempotencyKey?: string | null;
887
- /** ID of the product instance to adjust. */
888
- instanceId: string;
889
- /**
890
- * ID of the product to replace the original instance. Required in case you don't
891
- * provide a new `billingInfo` object.
892
- */
893
- catalogProductId?: string | null;
894
- /**
895
- * Information about the billing cycle. Required in case you don't provide a new
896
- * `catalogProductId`. The new billing cycle must be supported for the service.
897
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
898
- * information about a service's supported billing cycles. If
899
- * you adjust the billing cycle for a product instance with `RECURRING`
900
- * payments, you must also provide `billingInfo.cycleDuration.unit`.
901
- */
902
- billingInfo?: ProductInstanceCycle;
903
- /**
904
- * Discount code indicating that the reseller provisioned the product instance
905
- * during a sale. In case you pass a code that isn't valid, the call succeeds and
906
- * no discount is applied to the product instance. Wix doesn't guarantee that a
907
- * discount code reduces the price between Wix and the reseller, even when it's
908
- * valid. You can't add a discount code after you've created the
909
- * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
910
- * more information about supported codes.
911
- *
912
- * Max: 25 characters
913
- */
914
- discountCode?: string | null;
915
- }
916
- interface AdjustProductInstanceSpecificationsResponse {
917
- /** Idempotency key. */
918
- idempotencyKey?: string | null;
919
- /** Updated package that includes the adjusted product instance. */
920
- package?: Package;
921
- }
922
- interface AdjustedProductInstanceSpecifications {
923
- /** Updated package. */
924
- package?: Package;
925
- /**
926
- * ID of the product instance to adjust.
927
- * @readonly
928
- */
929
- productInstanceId?: string;
930
- }
931
- interface SubscriptionEvent extends SubscriptionEventEventOneOf {
932
- /** Triggered when a subscription is created. */
933
- created?: SubscriptionCreated;
934
- /**
935
- * Triggered when a subscription is assigned to a Wix site, including the initial
936
- * assignment of a floating subscription or a re-assignement from a different site.
937
- */
938
- assigned?: SubscriptionAssigned;
939
- /** Triggered when a subscription is canceled. */
940
- cancelled?: SubscriptionCancelled;
941
- /** Triggered when the subscription's auto renew is turned on. */
942
- autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
943
- /** Triggered when the subscription's auto renew is turned off. */
944
- autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
945
- /**
946
- * Triggered when a subscription is unassigned from a Wix site and becomes
947
- * floating.
948
- */
949
- unassigned?: SubscriptionUnassigned;
950
- /**
951
- * Triggered when a subscription is transferred from one Wix account to another.
952
- * A transfer includes cancelling the original subscription and creating a new
953
- * subscription for the target account. The event returns both the original
954
- * and the new subscription.
955
- */
956
- transferred?: SubscriptionTransferred;
957
- /** Triggered when a recurring charge succeeds for a subscription. */
958
- recurringChargeSucceeded?: RecurringChargeSucceeded;
959
- /**
960
- * Triggered when a subscription was updated including when its product has been
961
- * up- or downgraded or the billing cycle is changed.
962
- */
963
- contractSwitched?: ContractSwitched;
964
- /**
965
- * Triggered when a subscription gets close to the end of its billing cycle.
966
- * The exact number of days is defined in the billing system.
967
- */
968
- nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
969
- /**
970
- * Triggered when a subscription is updated and the change doesn't happen
971
- * immediately but at the end of the current billing cycle.
972
- */
973
- pendingChange?: SubscriptionPendingChange;
974
- /** ID of the subscription's event. */
975
- eventId?: string | null;
976
- /**
977
- * Date and time of the event in
978
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
979
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
980
- */
981
- eventDate?: Date | null;
982
- }
983
- /** @oneof */
984
- interface SubscriptionEventEventOneOf {
985
- /** Triggered when a subscription is created. */
986
- created?: SubscriptionCreated;
987
- /**
988
- * Triggered when a subscription is assigned to a Wix site, including the initial
989
- * assignment of a floating subscription or a re-assignement from a different site.
990
- */
991
- assigned?: SubscriptionAssigned;
992
- /** Triggered when a subscription is canceled. */
993
- cancelled?: SubscriptionCancelled;
994
- /** Triggered when the subscription's auto renew is turned on. */
995
- autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
996
- /** Triggered when the subscription's auto renew is turned off. */
997
- autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
998
- /**
999
- * Triggered when a subscription is unassigned from a Wix site and becomes
1000
- * floating.
1001
- */
1002
- unassigned?: SubscriptionUnassigned;
1003
- /**
1004
- * Triggered when a subscription is transferred from one Wix account to another.
1005
- * A transfer includes cancelling the original subscription and creating a new
1006
- * subscription for the target account. The event returns both the original
1007
- * and the new subscription.
1008
- */
1009
- transferred?: SubscriptionTransferred;
1010
- /** Triggered when a recurring charge succeeds for a subscription. */
1011
- recurringChargeSucceeded?: RecurringChargeSucceeded;
1012
- /**
1013
- * Triggered when a subscription was updated including when its product has been
1014
- * up- or downgraded or the billing cycle is changed.
1015
- */
1016
- contractSwitched?: ContractSwitched;
1017
- /**
1018
- * Triggered when a subscription gets close to the end of its billing cycle.
1019
- * The exact number of days is defined in the billing system.
1020
- */
1021
- nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
1022
- /**
1023
- * Triggered when a subscription is updated and the change doesn't happen
1024
- * immediately but at the end of the current billing cycle.
1025
- */
1026
- pendingChange?: SubscriptionPendingChange;
1027
- }
1028
- /** Triggered when a subscription is created. */
1029
- interface SubscriptionCreated {
1030
- /** Created subscription. */
1031
- subscription?: Subscription;
1032
- /** Metadata for the `created` event. */
1033
- metadata?: Record<string, string>;
1034
- /**
1035
- * Subscription reactivation data.
1036
- * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated
1037
- * by the billing system
1038
- */
1039
- reactivationData?: ReactivationData;
1040
- }
1041
- /**
1042
- * A subscription holds information about a Premium product that a Wix account
1043
- * owner has purchased including details about the billing.
1044
- */
1045
- interface Subscription {
1046
- /** ID of the subscription. */
1047
- _id?: string;
1048
- /** ID of the Wix account that purchased the subscription. */
1049
- userId?: string;
1050
- /**
1051
- * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
1052
- * for which the subscription was purchased.
1053
- */
1054
- productId?: string;
1055
- /**
1056
- * Date and time the subscription was created in
1057
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1058
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1059
- */
1060
- createdAt?: Date | null;
1061
- /**
1062
- * Date and time the subscription was last updated in
1063
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1064
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1065
- */
1066
- updatedAt?: Date | null;
1067
- /**
1068
- * ID of the metasite that the subscription is assigned to.
1069
- * Available only when the subscription is assigned to a Wix site.
1070
- * Subscriptions for account level products can't be assigned to a Wix site.
1071
- */
1072
- metaSiteId?: string | null;
1073
- /** Information about the system that manages the subscription's billing. */
1074
- billingReference?: BillingReference;
1075
- /** Information about the billing cycle of the subscription. */
1076
- cycle?: Cycle;
1077
- /**
1078
- * Subscription status.
1079
- *
1080
- * + `UNKNOWN`: Default status.
1081
- * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.
1082
- * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.
1083
- * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.
1084
- * + `CANCELLED`: Subscription isn't active because it has been canceled.
1085
- * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
1086
- */
1087
- status?: SubscriptionStatus;
1088
- /**
1089
- * Date and time the subscription was last transferred from one Wix account to
1090
- * another in
1091
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1092
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1093
- */
1094
- transferredAt?: Date | null;
1095
- /**
1096
- * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
1097
- * that the product, for which the subscription was purchased, belongs to.
1098
- */
1099
- productTypeId?: string;
1100
- /** Version number, which increments by 1 each time the subscription is updated. */
1101
- version?: number;
1102
- /**
1103
- * Whether the subscription is active. Includes the statuses
1104
- * `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`.
1105
- */
1106
- active?: boolean;
1107
- /**
1108
- * Date and time the subscription was originally created in
1109
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1110
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1111
- * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
1112
- */
1113
- originalCreationDate?: Date | null;
1114
- /** Custom metadata about the subscription. */
1115
- metadata?: Record<string, string>;
1116
- /**
1117
- * 2-letter country code in
1118
- * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
1119
- * format.
1120
- */
1121
- countryCode?: string | null;
1122
- }
1123
- interface BillingReference {
1124
- /**
1125
- * Name of the billing system that manages the subscription.
1126
- *
1127
- * + `"UNKNOWN"`: Default value.
1128
- * + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).
1129
- * + `"LICENSER"`:
1130
- * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
1131
- * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
1132
- */
1133
- providerName?: ProviderName;
1134
- /** Current provider reference ID. */
1135
- providerReferenceId?: string | null;
1136
- /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
1137
- previousProviderReferenceIds?: string[];
1138
- }
1139
- declare enum ProviderName {
1140
- UNKNOWN = "UNKNOWN",
1141
- SBS = "SBS",
1142
- LICENSER = "LICENSER",
1143
- BASS = "BASS",
1144
- RESELLER = "RESELLER",
1145
- RECURRING_INVOICES = "RECURRING_INVOICES"
1146
- }
1147
- interface Cycle extends CycleCycleSelectorOneOf {
1148
- /** repetitive interval */
1149
- interval?: Interval;
1150
- /** one time */
1151
- oneTime?: OneTime;
1152
- }
1153
- /** @oneof */
1154
- interface CycleCycleSelectorOneOf {
1155
- /** repetitive interval */
1156
- interval?: Interval;
1157
- /** one time */
1158
- oneTime?: OneTime;
1159
- }
1160
- interface Interval {
1161
- /** interval unit of measure */
1162
- unit?: IntervalUnit;
1163
- /** number of interval */
1164
- count?: number;
1165
- }
1166
- declare enum IntervalUnit {
1167
- /** unknown interval unit */
1168
- UNKNOWN = "UNKNOWN",
1169
- /** day */
1170
- DAY = "DAY",
1171
- /** week */
1172
- WEEK = "WEEK",
1173
- /** month */
1174
- MONTH = "MONTH",
1175
- /** year */
1176
- YEAR = "YEAR"
1177
- }
1178
- interface OneTime {
1179
- }
1180
- declare enum SubscriptionStatus {
1181
- UNKNOWN = "UNKNOWN",
1182
- AUTO_RENEW_ON = "AUTO_RENEW_ON",
1183
- AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
1184
- MANUAL_RECURRING = "MANUAL_RECURRING",
1185
- CANCELLED = "CANCELLED",
1186
- TRANSFERRED = "TRANSFERRED"
1187
- }
1188
- /** Triggered when a subscription is reactivated. */
1189
- interface ReactivationData {
1190
- reactivationReason?: ReactivationReasonEnum;
1191
- /**
1192
- * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
1193
- * number of days it was inactive during the time of resolving the dispute
1194
- */
1195
- newEndOfPeriod?: Date | null;
1196
- /** The original end date, before the inactive period. */
1197
- oldEndOfPeriod?: Date | null;
1198
- /** The difference in days between the new new_end_of_period and old_end_of_period */
1199
- differenceInDays?: number | null;
1200
- }
1201
- /** Reason for subscription reactivation */
1202
- declare enum ReactivationReasonEnum {
1203
- UNKNOWN = "UNKNOWN",
1204
- /**
1205
- * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
1206
- * canceled because of suspicion of fraud
1207
- */
1208
- BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE",
1209
- /** Subscription was reactivated after a chargeback dispute */
1210
- REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
1211
- }
1212
- /**
1213
- * Triggered when a subscription is assigned to a Wix site, including the initial
1214
- * assignment of a floating subscription or a re-assignement from a different site.
1215
- */
1216
- interface SubscriptionAssigned {
1217
- /** Assigned subscription. */
1218
- subscription?: Subscription;
1219
- /** ID of the metasite that the subscription has been assigned to before the update. */
1220
- previousMetaSiteId?: string | null;
1221
- }
1222
- /** Triggered when a subscription is canceled. */
1223
- interface SubscriptionCancelled {
1224
- /** Canceled subscription. */
1225
- subscription?: Subscription;
1226
- /** Details about the cancellation including who canceled the subscription and why. */
1227
- cancellationDetails?: CancellationDetails;
1228
- /**
1229
- * Whether the subscription is canceled immediately or expires at the end of the current billing cycle.
1230
- *
1231
- * Default: `false`
1232
- */
1233
- immediateCancel?: boolean;
1234
- /** Whether the subscription was canceled during the free trial period. */
1235
- canceledInFreeTrial?: boolean;
1236
- }
1237
- /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
1238
- interface CancellationDetails {
1239
- /**
1240
- * Cancellation code.
1241
- *
1242
- * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.
1243
- * For cancellations on behalf of the site owner or the service provider `cancellationCode`
1244
- * is taken from the request of
1245
- * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
1246
- *
1247
- * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.
1248
- * + `-2`: There were payment problems.
1249
- * + `-3`: There was a chargeback.
1250
- * + `-4`: Customer support has canceled the subscription and issued a refund.
1251
- * + `-5`: The site owner has changed their existing subscription.
1252
- * + `-6`: The subscription has been transferred to a different Wix account.
1253
- * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.
1254
- * + `-8`: The Wix account that the subscription belonged to has been deleted.
1255
- */
1256
- cancellationCode?: number | null;
1257
- /**
1258
- * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`
1259
- * is taken from the request of
1260
- * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
1261
- * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.
1262
- */
1263
- cancellationReason?: string | null;
1264
- /**
1265
- * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
1266
- * `cancellationCode` and `cancellationReason` are taken from the request of
1267
- * [Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)
1268
- * or [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
1269
- * For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
1270
- * is `null` or an empty string.
1271
- *
1272
- * + `"UNKNOWN`: Default value.
1273
- * + `"USER_REQUESTED"`: The Wix account owner has canceled the subscription.
1274
- * + `"APP_MANAGED"`: The service provider has canceled the subscription.
1275
- * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
1276
- */
1277
- initiator?: Initiator;
1278
- }
1279
- declare enum Initiator {
1280
- UNKNOWN = "UNKNOWN",
1281
- USER_REQUESTED = "USER_REQUESTED",
1282
- APP_MANAGED = "APP_MANAGED",
1283
- PASSIVE = "PASSIVE"
1284
- }
1285
- /** Triggered when the subscription's auto renew is turned on. */
1286
- interface SubscriptionAutoRenewTurnedOn {
1287
- /** Subscription for which auto renew is turned on. */
1288
- subscription?: Subscription;
1289
- /**
1290
- * Supported values: `USER`, `APP`.
1291
- *
1292
- * Information about who turned auto renew on.
1293
- * + `"USER"`: The site owner who purchased the subscription has turned auto renew on.
1294
- * + `"APP"`: The service provider has turned auto renew on.
1295
- */
1296
- initiator?: string | null;
1297
- }
1298
- /** Triggered when the subscription's auto renew is turned off. */
1299
- interface SubscriptionAutoRenewTurnedOff {
1300
- /** Subscription for which auto renew is turned off. */
1301
- subscription?: Subscription;
1302
- /** Details about the cancellation including who canceled the subscription and why. */
1303
- cancellationDetails?: CancellationDetails;
1304
- /**
1305
- * Whether the subscription is immediately canceled or expires at the end of the current billing cycle.
1306
- *
1307
- * Default: `false`
1308
- */
1309
- immediateCancel?: boolean;
1310
- }
1311
- /**
1312
- * Triggered when a subscription is unassigned from a Wix site and becomes
1313
- * floating.
1314
- */
1315
- interface SubscriptionUnassigned {
1316
- /** Unassigned subscription. */
1317
- subscription?: Subscription;
1318
- /** ID of the metasite that the subscription has been assigned to before the event. */
1319
- previousMetaSiteId?: string;
1320
- /**
1321
- * Reason why the subscription is unassigned.
1322
- *
1323
- * + `"UNKNOWN"`: Default value.
1324
- * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
1325
- * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
1326
- */
1327
- unassignReason?: UnassignReason;
1328
- }
1329
- declare enum UnassignReason {
1330
- UNKNOWN = "UNKNOWN",
1331
- USER_REQUESTED = "USER_REQUESTED",
1332
- REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
1333
- }
1334
- /**
1335
- * Triggered when a subscription is transferred from one Wix account to another.
1336
- * A transfer includes cancelling the original subscription and creating a new
1337
- * subscription for the target account. The event returns both the original
1338
- * and the new subscription.
1339
- */
1340
- interface SubscriptionTransferred {
1341
- /** Original subscription that was canceled for the transfer. */
1342
- originSubscription?: Subscription;
1343
- /** Newly created subscription for the target account. */
1344
- targetSubscription?: Subscription;
1345
- }
1346
- /** Triggered when a recurring charge succeeds for a subscription. */
1347
- interface RecurringChargeSucceeded {
1348
- /** Subscription for which the recurring charge has succeeded. */
1349
- subscription?: Subscription;
1350
- /** Indication that there was a successful charge at the end of the free trial period */
1351
- freeTrialPeriodEnd?: boolean;
1352
- }
1353
- /**
1354
- * Triggered when a subscription was updated including when its product has been
1355
- * up- or downgraded or the billing cycle is changed.
1356
- */
1357
- interface ContractSwitched {
1358
- /** Updated subscription. */
1359
- subscription?: Subscription;
1360
- /** Billing cycle before the update. */
1361
- previousCycle?: Cycle;
1362
- /** ID of the product belonging to the subscription before the update. */
1363
- previousProductId?: string;
1364
- /** ID of the product type that the subscription's original product belonged to before the update. */
1365
- previousProductTypeId?: string;
1366
- /**
1367
- * Update type. __Note__: Doesn't include information about a product adjustment.
1368
- * For that purpose, see `productAdjustment`.
1369
- *
1370
- * + `"NOT_APPLICABLE"`: Default value.
1371
- * + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.
1372
- * + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.
1373
- * + `"REFUND_PRICE_DIFF"`: Not implemented.
1374
- * + `"ADJUST_PERIOD_END"`: Not implemented.
1375
- * + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.
1376
- * + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.
1377
- * + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade.
1378
- * + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
1379
- * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
1380
- */
1381
- contractSwitchType?: ContractSwitchType;
1382
- /**
1383
- * ID of the metasite the subscription has been assigned to previously.
1384
- * Available only in case the subscription is assigned to a different site.
1385
- */
1386
- previousMetaSiteId?: string | null;
1387
- /**
1388
- * Update reason.
1389
- *
1390
- * + `"PRICE_INCREASE"`: The subscription's price has been increased.
1391
- * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
1392
- */
1393
- contractSwitchReason?: ContractSwitchReason;
1394
- /** Information about the price update. Available only for updates with a price increase. */
1395
- productPriceIncreaseData?: ProductPriceIncreaseData;
1396
- /**
1397
- * Information about a product adjustment. For example, a downgrade.
1398
- * __Note__: This isn't the same as `contractSwitchType`.
1399
- *
1400
- * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
1401
- * + `DOWNGRADE`: The product has been downgraded.
1402
- */
1403
- productAdjustment?: ProductAdjustment;
1404
- }
1405
- /** Copied from SBS */
1406
- declare enum ContractSwitchType {
1407
- NOT_APPLICABLE = "NOT_APPLICABLE",
1408
- ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
1409
- CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
1410
- REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF",
1411
- ADJUST_PERIOD_END = "ADJUST_PERIOD_END",
1412
- DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD",
1413
- FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD",
1414
- END_OF_PERIOD = "END_OF_PERIOD",
1415
- PENDING_CHANGES = "PENDING_CHANGES",
1416
- DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
1417
- }
1418
- declare enum ContractSwitchReason {
1419
- EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
1420
- PRICE_INCREASE = "PRICE_INCREASE"
1421
- }
1422
- /** Triggered when a subscription's price is increased. */
1423
- interface ProductPriceIncreaseData {
1424
- /** Price of the subscription before the update. */
1425
- previousPrice?: string | null;
1426
- /** A value that is used in order to select the correct email template to send the user regarding the price increase. */
1427
- emailTemplateSelector?: string | null;
1428
- /** Used to differentiate between migration segments. Does not have to be unique per segment. */
1429
- segmentName?: string | null;
1430
- /** Used to determine how the price increase was triggered. */
1431
- priceIncreaseTrigger?: PriceIncreaseTrigger;
1432
- }
1433
- /** Reason for Price Increase Trigger */
1434
- declare enum PriceIncreaseTrigger {
1435
- NEAR_RENEWAL = "NEAR_RENEWAL",
1436
- RECURRING_SUCCESS = "RECURRING_SUCCESS",
1437
- MANUAL = "MANUAL"
1438
- }
1439
- /** Triggered when a subscription's product is adusted. */
1440
- declare enum ProductAdjustment {
1441
- /** flag to show that the ContractSwitchedEvent is not applicable / needed */
1442
- NOT_APPLICABLE = "NOT_APPLICABLE",
1443
- /** flag to show that the ContractSwitchedEvent is a Downgrade */
1444
- DOWNGRADE = "DOWNGRADE"
1445
- }
1446
- /**
1447
- * Triggered when a subscription gets close to the end of its billing cycle.
1448
- * The exact number of days is defined in the billing system.
1449
- */
1450
- interface SubscriptionNearEndOfPeriod {
1451
- /** Subscription that got close to the end of its billing cycle. */
1452
- subscription?: Subscription;
1453
- /** Whether the subscription is within the free trial period. */
1454
- inFreeTrial?: boolean;
1455
- }
1456
- /**
1457
- * Triggered when a subscription is updated and the change doesn't happen
1458
- * immediately but at the end of the current billing cycle.
1459
- */
1460
- interface SubscriptionPendingChange {
1461
- /** Subscription for which a pending update is triggered. */
1462
- subscription?: Subscription;
1463
- }
1464
- interface Empty {
1465
- }
1466
- interface ProductInstanceUpdated {
1467
- /** Updated package. */
1468
- package?: Package;
1469
- /**
1470
- * ID of the product instance that was adjusted.
1471
- * @readonly
1472
- */
1473
- productInstanceId?: string;
1474
- }
1475
- interface DomainEvent extends DomainEventBodyOneOf {
1476
- createdEvent?: EntityCreatedEvent;
1477
- updatedEvent?: EntityUpdatedEvent;
1478
- deletedEvent?: EntityDeletedEvent;
1479
- actionEvent?: ActionEvent;
1480
- /**
1481
- * Unique event ID.
1482
- * Allows clients to ignore duplicate webhooks.
1483
- */
1484
- _id?: string;
1485
- /**
1486
- * Assumes actions are also always typed to an entity_type
1487
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1488
- */
1489
- entityFqdn?: string;
1490
- /**
1491
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1492
- * This is although the created/updated/deleted notion is duplication of the oneof types
1493
- * Example: created/updated/deleted/started/completed/email_opened
1494
- */
1495
- slug?: string;
1496
- /** ID of the entity associated with the event. */
1497
- entityId?: string;
1498
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1499
- eventTime?: Date | null;
1500
- /**
1501
- * Whether the event was triggered as a result of a privacy regulation application
1502
- * (for example, GDPR).
1503
- */
1504
- triggeredByAnonymizeRequest?: boolean | null;
1505
- /** If present, indicates the action that triggered the event. */
1506
- originatedFrom?: string | null;
1507
- /**
1508
- * A sequence number defining the order of updates to the underlying entity.
1509
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1510
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1511
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1512
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1513
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1514
- */
1515
- entityEventSequence?: string | null;
1516
- }
1517
- /** @oneof */
1518
- interface DomainEventBodyOneOf {
1519
- createdEvent?: EntityCreatedEvent;
1520
- updatedEvent?: EntityUpdatedEvent;
1521
- deletedEvent?: EntityDeletedEvent;
1522
- actionEvent?: ActionEvent;
1523
- }
1524
- interface EntityCreatedEvent {
1525
- entity?: string;
1526
- }
1527
- interface RestoreInfo {
1528
- deletedDate?: Date | null;
1529
- }
1530
- interface EntityUpdatedEvent {
1531
- /**
1532
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1533
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1534
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1535
- */
1536
- currentEntity?: string;
1537
- }
1538
- interface EntityDeletedEvent {
1539
- /** Entity that was deleted */
1540
- deletedEntity?: string | null;
1541
- }
1542
- interface ActionEvent {
1543
- body?: string;
1544
- }
1545
- interface FailureReportRequest {
1546
- /** ID of the product instance that failed. */
1547
- instanceId?: string;
1548
- /** Failure reason. */
1549
- reason?: FailureReason;
1550
- }
1551
- interface ProductInstanceFailed {
1552
- /** Updated package. */
1553
- package?: Package;
1554
- /**
1555
- * ID of the product instance that `FAILED`.
1556
- * @readonly
1557
- */
1558
- productInstanceId?: string;
1559
- /** Failure reason. */
1560
- reason?: FailureReason;
1561
- }
1562
- interface Task {
1563
- key?: TaskKey;
1564
- executeAt?: Date | null;
1565
- payload?: string | null;
1566
- }
1567
- interface TaskKey {
1568
- appId?: string;
1569
- instanceId?: string;
1570
- subjectId?: string | null;
1571
- }
1572
- interface TaskAction extends TaskActionActionOneOf {
1573
- complete?: Complete;
1574
- cancel?: Cancel;
1575
- reschedule?: Reschedule;
1576
- }
1577
- /** @oneof */
1578
- interface TaskActionActionOneOf {
1579
- complete?: Complete;
1580
- cancel?: Cancel;
1581
- reschedule?: Reschedule;
1582
- }
1583
- interface Complete {
1584
- }
1585
- interface Cancel {
1586
- }
1587
- interface Reschedule {
1588
- executeAt?: Date | null;
1589
- payload?: string | null;
1590
- }
1591
- interface UpdateProductInstanceRequest {
1592
- /** ID of the product instance to update. */
1593
- instanceId?: string;
1594
- status?: Status;
1595
- countryCode?: string | null;
1596
- /** Which field to update, currently only status and countryCode are supported. */
1597
- fieldToUpdate?: FieldToUpdate;
1598
- }
1599
- declare enum FieldToUpdate {
1600
- STATUS = "STATUS",
1601
- COUNTRY_CODE = "COUNTRY_CODE"
1602
- }
1603
- interface UpdateProductInstanceResponse {
1604
- /** Updated Product Instance */
1605
- productInstance?: ProductInstance;
1606
- }
1607
- interface UpdatePackageExternalIdRequest {
1608
- /** ID of the package to update. */
1609
- packageId: string;
1610
- /** External ID that will be assigned to the package. */
1611
- externalId: string;
1612
- }
1613
- interface UpdatePackageExternalIdResponse {
1614
- /** Updated package. */
1615
- updatedPackage?: Package;
1616
- }
1617
- interface CountPackagesRequest {
1618
- /** Filter on what packages to count */
1619
- filter?: Record<string, any> | null;
1620
- }
1621
- interface CountPackagesResponse {
1622
- /** Number of packages */
1623
- count?: number;
1624
- }
1625
- interface MessageEnvelope {
1626
- /** App instance ID. */
1627
- instanceId?: string | null;
1628
- /** Event type. */
1629
- eventType?: string;
1630
- /** The identification type and identity data. */
1631
- identity?: IdentificationData;
1632
- /** Stringify payload. */
1633
- data?: string;
1634
- }
1635
- interface IdentificationData extends IdentificationDataIdOneOf {
1636
- /** ID of a site visitor that has not logged in to the site. */
1637
- anonymousVisitorId?: string;
1638
- /** ID of a site visitor that has logged in to the site. */
1639
- memberId?: string;
1640
- /** ID of a Wix user (site owner, contributor, etc.). */
1641
- wixUserId?: string;
1642
- /** ID of an app. */
1643
- appId?: string;
1644
- /** @readonly */
1645
- identityType?: WebhookIdentityType;
1646
- }
1647
- /** @oneof */
1648
- interface IdentificationDataIdOneOf {
1649
- /** ID of a site visitor that has not logged in to the site. */
1650
- anonymousVisitorId?: string;
1651
- /** ID of a site visitor that has logged in to the site. */
1652
- memberId?: string;
1653
- /** ID of a Wix user (site owner, contributor, etc.). */
1654
- wixUserId?: string;
1655
- /** ID of an app. */
1656
- appId?: string;
1657
- }
1658
- declare enum WebhookIdentityType {
1659
- UNKNOWN = "UNKNOWN",
1660
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1661
- MEMBER = "MEMBER",
1662
- WIX_USER = "WIX_USER",
1663
- APP = "APP"
1664
- }
1665
- interface CycleIntervalNonNullableFields {
1666
- unit: IntervalIntervalUnit;
1667
- count: number;
1668
- }
1669
- interface ProductInstanceCycleNonNullableFields {
1670
- type: CycleDescriptorType;
1671
- cycleDuration?: CycleIntervalNonNullableFields;
1672
- }
1673
- interface FailureReasonNonNullableFields {
1674
- code: FailureReasonFailureReason;
1675
- message: string;
1676
- }
1677
- interface ProductInstanceNonNullableFields {
1678
- billingInfo?: ProductInstanceCycleNonNullableFields;
1679
- instanceId: string;
1680
- catalogProductId: string;
1681
- status: Status;
1682
- failure?: FailureReasonNonNullableFields;
1683
- }
1684
- interface PackageNonNullableFields {
1685
- _id: string;
1686
- accountId: string;
1687
- productInstances: ProductInstanceNonNullableFields[];
1688
- }
1689
- interface CreatePackageResponseNonNullableFields {
1690
- package?: PackageNonNullableFields;
1691
- }
1692
- interface CancelPackageResponseNonNullableFields {
1693
- package?: PackageNonNullableFields;
1694
- }
1695
- interface GetPackageResponseNonNullableFields {
1696
- package?: PackageNonNullableFields;
1697
- }
1698
- interface QueryPackagesResponseNonNullableFields {
1699
- packages: PackageNonNullableFields[];
1700
- }
1701
- interface AssignProductInstanceToSiteResponseNonNullableFields {
1702
- package?: PackageNonNullableFields;
1703
- }
1704
- interface UnassignProductInstanceFromSiteResponseNonNullableFields {
1705
- package?: PackageNonNullableFields;
1706
- }
1707
- interface CancelProductInstanceResponseNonNullableFields {
1708
- package?: PackageNonNullableFields;
1709
- }
1710
- interface AdjustProductInstanceSpecificationsResponseNonNullableFields {
1711
- package?: PackageNonNullableFields;
1712
- }
1713
- interface UpdatePackageExternalIdResponseNonNullableFields {
1714
- updatedPackage?: PackageNonNullableFields;
1715
- }
1716
- interface CreatePackageOptions {
1717
- /** Idempotency key. */
1718
- idempotencyKey?: string | null;
1719
- /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
1720
- externalId?: string | null;
1721
- /** Wix services that are resold. */
1722
- products: ProductInstance[];
1723
- }
1724
- interface CreatePackageV2Options {
1725
- /** Idempotency key. */
1726
- idempotencyKey?: string | null;
1727
- /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
1728
- externalId?: string | null;
1729
- /** Wix services that are resold. */
1730
- products: ProductInstance[];
1731
- }
1732
- interface CancelPackageOptions {
1733
- /** Idempotency key. */
1734
- idempotencyKey?: string | null;
1735
- }
1736
- interface QueryCursorResult {
1737
- cursors: Cursors;
1738
- hasNext: () => boolean;
1739
- hasPrev: () => boolean;
1740
- length: number;
1741
- pageSize: number;
1742
- }
1743
- interface PackagesQueryResult extends QueryCursorResult {
1744
- items: Package[];
1745
- query: PackagesQueryBuilder;
1746
- next: () => Promise<PackagesQueryResult>;
1747
- prev: () => Promise<PackagesQueryResult>;
1748
- }
1749
- interface PackagesQueryBuilder {
1750
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1751
- * @documentationMaturity preview
1752
- */
1753
- limit: (limit: number) => PackagesQueryBuilder;
1754
- /** @param cursor - A pointer to specific record
1755
- * @documentationMaturity preview
1756
- */
1757
- skipTo: (cursor: string) => PackagesQueryBuilder;
1758
- /** @documentationMaturity preview */
1759
- find: () => Promise<PackagesQueryResult>;
1760
- }
1761
- interface AssignProductInstanceToSiteIdentifiers {
1762
- /** ID of the product instance to assign to a site. */
1763
- instanceId: string;
1764
- /** ID of the site to which the product instance is assigned. */
1765
- siteId: string;
1766
- }
1767
- interface AssignProductInstanceToSiteOptions {
1768
- /** Idempotency key. */
1769
- idempotencyKey?: string | null;
1770
- }
1771
- interface UnassignProductInstanceFromSiteOptions {
1772
- /** Idempotency key. */
1773
- idempotencyKey?: string | null;
1774
- }
1775
- interface CancelProductInstanceOptions {
1776
- /** Idempotency key. */
1777
- idempotencyKey?: string | null;
1778
- }
1779
- interface AdjustProductInstanceSpecificationsOptions {
1780
- /** Idempotency key. */
1781
- idempotencyKey?: string | null;
1782
- /**
1783
- * ID of the product to replace the original instance. Required in case you don't
1784
- * provide a new `billingInfo` object.
1785
- */
1786
- catalogProductId?: string | null;
1787
- /**
1788
- * Information about the billing cycle. Required in case you don't provide a new
1789
- * `catalogProductId`. The new billing cycle must be supported for the service.
1790
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
1791
- * information about a service's supported billing cycles. If
1792
- * you adjust the billing cycle for a product instance with `RECURRING`
1793
- * payments, you must also provide `billingInfo.cycleDuration.unit`.
1794
- */
1795
- billingInfo?: ProductInstanceCycle;
1796
- /**
1797
- * Discount code indicating that the reseller provisioned the product instance
1798
- * during a sale. In case you pass a code that isn't valid, the call succeeds and
1799
- * no discount is applied to the product instance. Wix doesn't guarantee that a
1800
- * discount code reduces the price between Wix and the reseller, even when it's
1801
- * valid. You can't add a discount code after you've created the
1802
- * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
1803
- * more information about supported codes.
1804
- *
1805
- * Max: 25 characters
1806
- */
1807
- discountCode?: string | null;
1808
- }
1809
- interface UpdatePackageExternalIdIdentifiers {
1810
- /** ID of the package to update. */
1811
- packageId: string;
1812
- /** External ID that will be assigned to the package. */
1813
- externalId: string;
1814
- }
1815
-
1816
- declare function createPackage$1(httpClient: HttpClient): CreatePackageSignature;
1817
- interface CreatePackageSignature {
1818
- /**
1819
- * Creates a new package.
1820
- *
1821
- * Deprecated: This method is deprecated and will be removed by 2024-12-31.
1822
- * Use com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2 instead.
1823
- *
1824
- * HTTP Request:
1825
- * POST /v1/packages
1826
- *
1827
- * Permissions:
1828
- * Requires the "premium.reseller-package.manage" permission with MANUAL type.
1829
- *
1830
- * Event:
1831
- * A PRIVATE callback will be triggered when the package is successfully created.
1832
- *
1833
- * Required Fields:
1834
- * - CreatePackageRequest.products
1835
- *
1836
- * Maturity: BETA
1837
- * Exposure: PUBLIC
1838
- * @deprecated
1839
- */
1840
- (options?: CreatePackageOptions | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
1841
- }
1842
- declare function createPackageV2$1(httpClient: HttpClient): CreatePackageV2Signature;
1843
- interface CreatePackageV2Signature {
1844
- /**
1845
- * Creates a package of product instances.
1846
- *
1847
- *
1848
- * You must pass the relevant Wix account ID in the header of the call. In
1849
- * the DIY flow, we recommend to pass the customer's sub-account ID instead
1850
- * of your main reseller account ID.
1851
- *
1852
- * You may also pass a Wix site ID for each product in the body of the call.
1853
- * If you omit the site ID, a floating product instance is created.
1854
- *
1855
- * When Wix customers purchase a specific paid service or product, Wix may offer
1856
- * them time-limited free access to a different product. For example, customers
1857
- * get a voucher for a free 1-year domain registration when purchasing any Wix
1858
- * Premium plan. If you want to offer your customers the same benefit, create a
1859
- * package containing the original product first. Then, create a second package
1860
- * with the additional product. In the second Create Package call, pass the
1861
- * instance ID of the original product as `referenceProductInstanceId`. This way,
1862
- * Wix doesn't charge you for the additional product. Make sure that the status
1863
- * of the referenced product is either `"PENDING"` or `"ACTIVE"`. Note that you
1864
- * can use each product instance only a single time as reference instance.
1865
- *
1866
- * You need to pass a `countryCode` to specify where customers can claim
1867
- * vouchers that may come with a product. Contact the
1868
- * [Wix B2B sales team](mailto:bizdev@wix.com) to get information about
1869
- * vouchers and supported locations.
1870
- *
1871
- * > **Important**: This call requires an account level API key and cannot be
1872
- * > authenticated with the standard authorization header.
1873
- */
1874
- (options?: CreatePackageV2Options | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
1875
- }
1876
- declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
1877
- interface CancelPackageSignature {
1878
- /**
1879
- * Cancels all product instances included in the package and the customer
1880
- * immediately loses access to the canceled functionality.
1881
- *
1882
- *
1883
- * You must pass the ID of the Wix account that the package belongs to in the
1884
- * header of the call. The call fails, if the package and Wix account don't
1885
- * match.
1886
- *
1887
- * If a canceled product instance is a requirement for another Wix service, that
1888
- * functionality is also no longer available to the customer. For example, if
1889
- * you cancel a Premium plan, a previously connected domain is automatically
1890
- * disconnected from the site.
1891
- *
1892
- * > **Important**: This call requires an account level API key and cannot be
1893
- * > authenticated with the standard authorization header.
1894
- * @param - ID of the package to cancel.
1895
- */
1896
- (_id: string, options?: CancelPackageOptions | undefined): Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
1897
- }
1898
- declare function getPackage$1(httpClient: HttpClient): GetPackageSignature;
1899
- interface GetPackageSignature {
1900
- /**
1901
- * Retrieves a package.
1902
- *
1903
- *
1904
- * You must pass the ID of the Wix account that the package belongs to in the
1905
- * header of the call. The call fails, if the package and Wix account don't
1906
- * match.
1907
- *
1908
- * > **Important**: This call requires an account level API key and cannot be
1909
- * > authenticated with the standard authorization header.
1910
- * @param - Package ID.
1911
- * @returns Retrieved package.
1912
- */
1913
- (_id: string): Promise<Package & PackageNonNullableFields>;
1914
- }
1915
- declare function queryPackages$1(httpClient: HttpClient): QueryPackagesSignature;
1916
- interface QueryPackagesSignature {
1917
- /**
1918
- * Retrieves a list of packages, given the provided paging, filtering, and sorting.
1919
- *
1920
- *
1921
- * You must pass the ID of the Wix account that the packages belong to in the
1922
- * header of the call. The call returns packages that belong to the parent
1923
- * account, regardless if you pass the ID of a parent or sub-account. In case
1924
- * you want to retrieve only packages that belong to a sub-account, you must
1925
- * pass the sub-account ID as `filter` in the `query` object like this:
1926
- *
1927
- * ```json
1928
- * {
1929
- * "query": {
1930
- * "filter": {
1931
- * "accountId": {
1932
- * "$eq": "<SUB_ACCOUNT_ID>"
1933
- * }
1934
- * }
1935
- * }
1936
- * }
1937
- * ```
1938
- *
1939
- * Query Packages runs with these defaults, which you can override:
1940
- *
1941
- * - `createdDate` is sorted in `DESC` order
1942
- * - `cursorPaging.limit` is `100`
1943
- *
1944
- * By default `pagingMetadata.cursors` are returned, unless you specifically pass
1945
- * `query.paging`.
1946
- *
1947
- * The maximum for `cursorPaging.limit` is `100`.
1948
- *
1949
- * If you pass a cursor token that you have received in a previous Query Package response,
1950
- * passing additional sort or filter information results in an invalid cursor
1951
- * error. Since the received cursor token already holds all the needed information
1952
- * for sort and filter. Changing the sort and filter properties during the span of
1953
- * a cursor query isn't supported. But you can provide a different limit.
1954
- *
1955
- * For field support for filters and sorting,
1956
- * see [Query Packages: Supported Filters and Sorting](https://dev.wix.com/api/rest/account-level-apis/resellers/supported-filters).
1957
- *
1958
- * To learn about working with _Query_ endpoints, see
1959
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
1960
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
1961
- * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
1962
- *
1963
- * > **Important**: This call requires an account level API key and cannot be
1964
- * > authenticated with the standard authorization header.
1965
- */
1966
- (): PackagesQueryBuilder;
1967
- }
1968
- declare function assignProductInstanceToSite$1(httpClient: HttpClient): AssignProductInstanceToSiteSignature;
1969
- interface AssignProductInstanceToSiteSignature {
1970
- /**
1971
- * Assigns a product instance to a site.
1972
- *
1973
- * You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
1974
- *
1975
- * The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.
1976
- *
1977
- * It's possible to assign a product instance that's already assigned to a site, to a different site without [unassigning](/packages/unassign-product-instance-from-site) it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by [retrieving the relevant package](/packages/get-package).
1978
- *
1979
- * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
1980
- */
1981
- (identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions | undefined): Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
1982
- }
1983
- declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): UnassignProductInstanceFromSiteSignature;
1984
- interface UnassignProductInstanceFromSiteSignature {
1985
- /**
1986
- * Unassigns a product instance from a site.
1987
- *
1988
- * You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
1989
- *
1990
- * The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.
1991
- *
1992
- * If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a `Combo Plan` plan from a site, a previously connected domain is disconnected.
1993
- *
1994
- * You can assign floating product instances to sites using the [Assign Product Instance to Site](/packages/assign-product-instance-to-site) method.
1995
- *
1996
- * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
1997
- * @param - ID of the product instance to unassign from a site.
1998
- */
1999
- (instanceId: string, options?: UnassignProductInstanceFromSiteOptions | undefined): Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
2000
- }
2001
- declare function cancelProductInstance$1(httpClient: HttpClient): CancelProductInstanceSignature;
2002
- interface CancelProductInstanceSignature {
2003
- /**
2004
- * Cancels a product instance.
2005
- *
2006
- *
2007
- * You must pass the ID of the Wix account that the product instance belongs
2008
- * to in the header of the call. The call fails, if the product instance and
2009
- * Wix account don't match.
2010
- *
2011
- * The customer immediately loses access to features included in the
2012
- * canceled service. It's up to the reseller to decide whether the adjustment
2013
- * affects the customer’s payment.
2014
- *
2015
- * If a canceled service is a requirement for another service, that service
2016
- * may not be available to the customer any longer. For example, if you cancel
2017
- * a `Combo Plan` plan, a previously connected domain is disconnected
2018
- * from the site.
2019
- *
2020
- *
2021
- * > **Important**: This call requires an account level API key and cannot be
2022
- * > authenticated with the standard authorization header.
2023
- * @param - ID of the product instance to cancel.
2024
- */
2025
- (instanceId: string, options?: CancelProductInstanceOptions | undefined): Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
2026
- }
2027
- declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): AdjustProductInstanceSpecificationsSignature;
2028
- interface AdjustProductInstanceSpecificationsSignature {
2029
- /**
2030
- * Upgrades or downgrades a product instance. For example, you can upgrade a
2031
- * customer's `Business Unlimited Premium` plan to `Business VIP` using this
2032
- * endpoint.
2033
- *
2034
- *
2035
- * You must pass the ID of the Wix account that the product instance belongs
2036
- * to in the header of the call. The call fails, if the product instance and
2037
- * Wix account don't match.
2038
- *
2039
- * The customer has immediate access to new features, while losing access to
2040
- * features not included in the new service. It's up to the reseller to
2041
- * decide whether the adjustment affects the customer’s payment.
2042
- *
2043
- * You can only exchange a product instance with a service of the same type.
2044
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about
2045
- * which services belong to the same type.
2046
- *
2047
- * You must provide either a new `catalogProductId` or a new `billingInfo`
2048
- * object. The new billing cycle must be supported for the product. Contact the
2049
- * [Wix B2B sales team](mailto:bizdev@wix.com) for information
2050
- * about which billing cycles are supported for each product. If you adjust the
2051
- * billing cycle for a product instance with `RECURRING` payments, you must
2052
- * also provide `billingInfo.cycleDuration.unit`.
2053
- *
2054
- * If a removed feature is a requirement for another service, that service
2055
- * may not be available to the customer any longer. For example, if you downgrade a
2056
- * `Business Unlimited` plan to `Business Basic`, the site owners won’t be
2057
- * able to use `Pro eCommerce Features` any longer.
2058
- *
2059
- * > **Important**: This call requires an account level API key and cannot be
2060
- * > authenticated with the standard authorization header.
2061
- * @param - ID of the product instance to adjust.
2062
- */
2063
- (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions | undefined): Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
2064
- }
2065
- declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
2066
- interface UpdatePackageExternalIdSignature {
2067
- /**
2068
- * Updates a package's external ID field.
2069
- */
2070
- (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
2071
- }
2072
-
2073
- declare const createPackage: MaybeContext<BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1>;
2074
- declare const createPackageV2: MaybeContext<BuildRESTFunction<typeof createPackageV2$1> & typeof createPackageV2$1>;
2075
- declare const cancelPackage: MaybeContext<BuildRESTFunction<typeof cancelPackage$1> & typeof cancelPackage$1>;
2076
- declare const getPackage: MaybeContext<BuildRESTFunction<typeof getPackage$1> & typeof getPackage$1>;
2077
- declare const queryPackages: MaybeContext<BuildRESTFunction<typeof queryPackages$1> & typeof queryPackages$1>;
2078
- declare const assignProductInstanceToSite: MaybeContext<BuildRESTFunction<typeof assignProductInstanceToSite$1> & typeof assignProductInstanceToSite$1>;
2079
- declare const unassignProductInstanceFromSite: MaybeContext<BuildRESTFunction<typeof unassignProductInstanceFromSite$1> & typeof unassignProductInstanceFromSite$1>;
2080
- declare const cancelProductInstance: MaybeContext<BuildRESTFunction<typeof cancelProductInstance$1> & typeof cancelProductInstance$1>;
2081
- declare const adjustProductInstanceSpecifications: MaybeContext<BuildRESTFunction<typeof adjustProductInstanceSpecifications$1> & typeof adjustProductInstanceSpecifications$1>;
2082
- declare const updatePackageExternalId: MaybeContext<BuildRESTFunction<typeof updatePackageExternalId$1> & typeof updatePackageExternalId$1>;
2083
-
2084
- type index_d_ActionEvent = ActionEvent;
2085
- type index_d_AdjustProductInstanceSpecificationsOptions = AdjustProductInstanceSpecificationsOptions;
2086
- type index_d_AdjustProductInstanceSpecificationsRequest = AdjustProductInstanceSpecificationsRequest;
2087
- type index_d_AdjustProductInstanceSpecificationsResponse = AdjustProductInstanceSpecificationsResponse;
2088
- type index_d_AdjustProductInstanceSpecificationsResponseNonNullableFields = AdjustProductInstanceSpecificationsResponseNonNullableFields;
2089
- type index_d_AdjustedProductInstanceSpecifications = AdjustedProductInstanceSpecifications;
2090
- type index_d_AssignProductInstanceToSiteIdentifiers = AssignProductInstanceToSiteIdentifiers;
2091
- type index_d_AssignProductInstanceToSiteOptions = AssignProductInstanceToSiteOptions;
2092
- type index_d_AssignProductInstanceToSiteRequest = AssignProductInstanceToSiteRequest;
2093
- type index_d_AssignProductInstanceToSiteResponse = AssignProductInstanceToSiteResponse;
2094
- type index_d_AssignProductInstanceToSiteResponseNonNullableFields = AssignProductInstanceToSiteResponseNonNullableFields;
2095
- type index_d_AssignedProductInstanceToSite = AssignedProductInstanceToSite;
2096
- type index_d_BillingReference = BillingReference;
2097
- type index_d_Cancel = Cancel;
2098
- type index_d_CancelPackageOptions = CancelPackageOptions;
2099
- type index_d_CancelPackageRequest = CancelPackageRequest;
2100
- type index_d_CancelPackageResponse = CancelPackageResponse;
2101
- type index_d_CancelPackageResponseNonNullableFields = CancelPackageResponseNonNullableFields;
2102
- type index_d_CancelProductInstanceOptions = CancelProductInstanceOptions;
2103
- type index_d_CancelProductInstanceRequest = CancelProductInstanceRequest;
2104
- type index_d_CancelProductInstanceResponse = CancelProductInstanceResponse;
2105
- type index_d_CancelProductInstanceResponseNonNullableFields = CancelProductInstanceResponseNonNullableFields;
2106
- type index_d_CancellationDetails = CancellationDetails;
2107
- type index_d_Complete = Complete;
2108
- type index_d_ContractSwitchReason = ContractSwitchReason;
2109
- declare const index_d_ContractSwitchReason: typeof ContractSwitchReason;
2110
- type index_d_ContractSwitchType = ContractSwitchType;
2111
- declare const index_d_ContractSwitchType: typeof ContractSwitchType;
2112
- type index_d_ContractSwitched = ContractSwitched;
2113
- type index_d_CountPackagesRequest = CountPackagesRequest;
2114
- type index_d_CountPackagesResponse = CountPackagesResponse;
2115
- type index_d_CreatePackageOptions = CreatePackageOptions;
2116
- type index_d_CreatePackageRequest = CreatePackageRequest;
2117
- type index_d_CreatePackageResponse = CreatePackageResponse;
2118
- type index_d_CreatePackageResponseNonNullableFields = CreatePackageResponseNonNullableFields;
2119
- type index_d_CreatePackageV2Options = CreatePackageV2Options;
2120
- type index_d_CursorPaging = CursorPaging;
2121
- type index_d_Cursors = Cursors;
2122
- type index_d_Cycle = Cycle;
2123
- type index_d_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;
2124
- type index_d_CycleDescriptorType = CycleDescriptorType;
2125
- declare const index_d_CycleDescriptorType: typeof CycleDescriptorType;
2126
- type index_d_CycleInterval = CycleInterval;
2127
- type index_d_DomainEvent = DomainEvent;
2128
- type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
2129
- type index_d_Empty = Empty;
2130
- type index_d_EntityCreatedEvent = EntityCreatedEvent;
2131
- type index_d_EntityDeletedEvent = EntityDeletedEvent;
2132
- type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
2133
- type index_d_FailureReason = FailureReason;
2134
- type index_d_FailureReasonFailureReason = FailureReasonFailureReason;
2135
- declare const index_d_FailureReasonFailureReason: typeof FailureReasonFailureReason;
2136
- type index_d_FailureReportRequest = FailureReportRequest;
2137
- type index_d_FieldToUpdate = FieldToUpdate;
2138
- declare const index_d_FieldToUpdate: typeof FieldToUpdate;
2139
- type index_d_FixBrokenMigrationRequest = FixBrokenMigrationRequest;
2140
- type index_d_FixBrokenMigrationResponse = FixBrokenMigrationResponse;
2141
- type index_d_GetPackageRequest = GetPackageRequest;
2142
- type index_d_GetPackageResponse = GetPackageResponse;
2143
- type index_d_GetPackageResponseNonNullableFields = GetPackageResponseNonNullableFields;
2144
- type index_d_IdentificationData = IdentificationData;
2145
- type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
2146
- type index_d_Initiator = Initiator;
2147
- declare const index_d_Initiator: typeof Initiator;
2148
- type index_d_Interval = Interval;
2149
- type index_d_IntervalIntervalUnit = IntervalIntervalUnit;
2150
- declare const index_d_IntervalIntervalUnit: typeof IntervalIntervalUnit;
2151
- type index_d_IntervalUnit = IntervalUnit;
2152
- declare const index_d_IntervalUnit: typeof IntervalUnit;
2153
- type index_d_MessageEnvelope = MessageEnvelope;
2154
- type index_d_MigrateSubscriptionToPackagesRequest = MigrateSubscriptionToPackagesRequest;
2155
- type index_d_MigrateSubscriptionToPackagesResponse = MigrateSubscriptionToPackagesResponse;
2156
- type index_d_OneTime = OneTime;
2157
- type index_d_Package = Package;
2158
- type index_d_PackageCanceled = PackageCanceled;
2159
- type index_d_PackageNonNullableFields = PackageNonNullableFields;
2160
- type index_d_PackagesQueryBuilder = PackagesQueryBuilder;
2161
- type index_d_PackagesQueryResult = PackagesQueryResult;
2162
- type index_d_Paging = Paging;
2163
- type index_d_PagingMetadataV2 = PagingMetadataV2;
2164
- type index_d_PriceIncreaseTrigger = PriceIncreaseTrigger;
2165
- declare const index_d_PriceIncreaseTrigger: typeof PriceIncreaseTrigger;
2166
- type index_d_ProductAdjustment = ProductAdjustment;
2167
- declare const index_d_ProductAdjustment: typeof ProductAdjustment;
2168
- type index_d_ProductInstance = ProductInstance;
2169
- type index_d_ProductInstanceCanceled = ProductInstanceCanceled;
2170
- type index_d_ProductInstanceContractDetailsOneOf = ProductInstanceContractDetailsOneOf;
2171
- type index_d_ProductInstanceCycle = ProductInstanceCycle;
2172
- type index_d_ProductInstanceFailed = ProductInstanceFailed;
2173
- type index_d_ProductInstanceUpdated = ProductInstanceUpdated;
2174
- type index_d_ProductPriceIncreaseData = ProductPriceIncreaseData;
2175
- type index_d_ProviderName = ProviderName;
2176
- declare const index_d_ProviderName: typeof ProviderName;
2177
- type index_d_QueryPackagesRequest = QueryPackagesRequest;
2178
- type index_d_QueryPackagesResponse = QueryPackagesResponse;
2179
- type index_d_QueryPackagesResponseNonNullableFields = QueryPackagesResponseNonNullableFields;
2180
- type index_d_QueryV2 = QueryV2;
2181
- type index_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
2182
- type index_d_ReactivationData = ReactivationData;
2183
- type index_d_ReactivationReasonEnum = ReactivationReasonEnum;
2184
- declare const index_d_ReactivationReasonEnum: typeof ReactivationReasonEnum;
2185
- type index_d_RecurringChargeSucceeded = RecurringChargeSucceeded;
2186
- type index_d_Reschedule = Reschedule;
2187
- type index_d_RestoreInfo = RestoreInfo;
2188
- type index_d_SortOrder = SortOrder;
2189
- declare const index_d_SortOrder: typeof SortOrder;
2190
- type index_d_Sorting = Sorting;
2191
- type index_d_Status = Status;
2192
- declare const index_d_Status: typeof Status;
2193
- type index_d_Subscription = Subscription;
2194
- type index_d_SubscriptionAssigned = SubscriptionAssigned;
2195
- type index_d_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;
2196
- type index_d_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;
2197
- type index_d_SubscriptionCancelled = SubscriptionCancelled;
2198
- type index_d_SubscriptionCreated = SubscriptionCreated;
2199
- type index_d_SubscriptionEvent = SubscriptionEvent;
2200
- type index_d_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;
2201
- type index_d_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;
2202
- type index_d_SubscriptionPendingChange = SubscriptionPendingChange;
2203
- type index_d_SubscriptionStatus = SubscriptionStatus;
2204
- declare const index_d_SubscriptionStatus: typeof SubscriptionStatus;
2205
- type index_d_SubscriptionTransferred = SubscriptionTransferred;
2206
- type index_d_SubscriptionUnassigned = SubscriptionUnassigned;
2207
- type index_d_Task = Task;
2208
- type index_d_TaskAction = TaskAction;
2209
- type index_d_TaskActionActionOneOf = TaskActionActionOneOf;
2210
- type index_d_TaskKey = TaskKey;
2211
- type index_d_UnassignProductInstanceFromSiteOptions = UnassignProductInstanceFromSiteOptions;
2212
- type index_d_UnassignProductInstanceFromSiteRequest = UnassignProductInstanceFromSiteRequest;
2213
- type index_d_UnassignProductInstanceFromSiteResponse = UnassignProductInstanceFromSiteResponse;
2214
- type index_d_UnassignProductInstanceFromSiteResponseNonNullableFields = UnassignProductInstanceFromSiteResponseNonNullableFields;
2215
- type index_d_UnassignReason = UnassignReason;
2216
- declare const index_d_UnassignReason: typeof UnassignReason;
2217
- type index_d_UnassignedProductInstanceFromSite = UnassignedProductInstanceFromSite;
2218
- type index_d_UpdatePackageExternalIdIdentifiers = UpdatePackageExternalIdIdentifiers;
2219
- type index_d_UpdatePackageExternalIdRequest = UpdatePackageExternalIdRequest;
2220
- type index_d_UpdatePackageExternalIdResponse = UpdatePackageExternalIdResponse;
2221
- type index_d_UpdatePackageExternalIdResponseNonNullableFields = UpdatePackageExternalIdResponseNonNullableFields;
2222
- type index_d_UpdateProductInstanceRequest = UpdateProductInstanceRequest;
2223
- type index_d_UpdateProductInstanceResponse = UpdateProductInstanceResponse;
2224
- type index_d_WebhookIdentityType = WebhookIdentityType;
2225
- declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
2226
- declare const index_d_adjustProductInstanceSpecifications: typeof adjustProductInstanceSpecifications;
2227
- declare const index_d_assignProductInstanceToSite: typeof assignProductInstanceToSite;
2228
- declare const index_d_cancelPackage: typeof cancelPackage;
2229
- declare const index_d_cancelProductInstance: typeof cancelProductInstance;
2230
- declare const index_d_createPackage: typeof createPackage;
2231
- declare const index_d_createPackageV2: typeof createPackageV2;
2232
- declare const index_d_getPackage: typeof getPackage;
2233
- declare const index_d_queryPackages: typeof queryPackages;
2234
- declare const index_d_unassignProductInstanceFromSite: typeof unassignProductInstanceFromSite;
2235
- declare const index_d_updatePackageExternalId: typeof updatePackageExternalId;
2236
- declare namespace index_d {
2237
- export { type index_d_ActionEvent as ActionEvent, type index_d_AdjustProductInstanceSpecificationsOptions as AdjustProductInstanceSpecificationsOptions, type index_d_AdjustProductInstanceSpecificationsRequest as AdjustProductInstanceSpecificationsRequest, type index_d_AdjustProductInstanceSpecificationsResponse as AdjustProductInstanceSpecificationsResponse, type index_d_AdjustProductInstanceSpecificationsResponseNonNullableFields as AdjustProductInstanceSpecificationsResponseNonNullableFields, type index_d_AdjustedProductInstanceSpecifications as AdjustedProductInstanceSpecifications, type index_d_AssignProductInstanceToSiteIdentifiers as AssignProductInstanceToSiteIdentifiers, type index_d_AssignProductInstanceToSiteOptions as AssignProductInstanceToSiteOptions, type index_d_AssignProductInstanceToSiteRequest as AssignProductInstanceToSiteRequest, type index_d_AssignProductInstanceToSiteResponse as AssignProductInstanceToSiteResponse, type index_d_AssignProductInstanceToSiteResponseNonNullableFields as AssignProductInstanceToSiteResponseNonNullableFields, type index_d_AssignedProductInstanceToSite as AssignedProductInstanceToSite, type index_d_BillingReference as BillingReference, type index_d_Cancel as Cancel, type index_d_CancelPackageOptions as CancelPackageOptions, type index_d_CancelPackageRequest as CancelPackageRequest, type index_d_CancelPackageResponse as CancelPackageResponse, type index_d_CancelPackageResponseNonNullableFields as CancelPackageResponseNonNullableFields, type index_d_CancelProductInstanceOptions as CancelProductInstanceOptions, type index_d_CancelProductInstanceRequest as CancelProductInstanceRequest, type index_d_CancelProductInstanceResponse as CancelProductInstanceResponse, type index_d_CancelProductInstanceResponseNonNullableFields as CancelProductInstanceResponseNonNullableFields, type index_d_CancellationDetails as CancellationDetails, type index_d_Complete as Complete, index_d_ContractSwitchReason as ContractSwitchReason, index_d_ContractSwitchType as ContractSwitchType, type index_d_ContractSwitched as ContractSwitched, type index_d_CountPackagesRequest as CountPackagesRequest, type index_d_CountPackagesResponse as CountPackagesResponse, type index_d_CreatePackageOptions as CreatePackageOptions, type index_d_CreatePackageRequest as CreatePackageRequest, type index_d_CreatePackageResponse as CreatePackageResponse, type index_d_CreatePackageResponseNonNullableFields as CreatePackageResponseNonNullableFields, type index_d_CreatePackageV2Options as CreatePackageV2Options, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_Cycle as Cycle, type index_d_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, index_d_CycleDescriptorType as CycleDescriptorType, type index_d_CycleInterval as CycleInterval, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_FailureReason as FailureReason, index_d_FailureReasonFailureReason as FailureReasonFailureReason, type index_d_FailureReportRequest as FailureReportRequest, index_d_FieldToUpdate as FieldToUpdate, type index_d_FixBrokenMigrationRequest as FixBrokenMigrationRequest, type index_d_FixBrokenMigrationResponse as FixBrokenMigrationResponse, type index_d_GetPackageRequest as GetPackageRequest, type index_d_GetPackageResponse as GetPackageResponse, type index_d_GetPackageResponseNonNullableFields as GetPackageResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_Initiator as Initiator, type index_d_Interval as Interval, index_d_IntervalIntervalUnit as IntervalIntervalUnit, index_d_IntervalUnit as IntervalUnit, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MigrateSubscriptionToPackagesRequest as MigrateSubscriptionToPackagesRequest, type index_d_MigrateSubscriptionToPackagesResponse as MigrateSubscriptionToPackagesResponse, type index_d_OneTime as OneTime, type index_d_Package as Package, type index_d_PackageCanceled as PackageCanceled, type index_d_PackageNonNullableFields as PackageNonNullableFields, type index_d_PackagesQueryBuilder as PackagesQueryBuilder, type index_d_PackagesQueryResult as PackagesQueryResult, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, index_d_PriceIncreaseTrigger as PriceIncreaseTrigger, index_d_ProductAdjustment as ProductAdjustment, type index_d_ProductInstance as ProductInstance, type index_d_ProductInstanceCanceled as ProductInstanceCanceled, type index_d_ProductInstanceContractDetailsOneOf as ProductInstanceContractDetailsOneOf, type index_d_ProductInstanceCycle as ProductInstanceCycle, type index_d_ProductInstanceFailed as ProductInstanceFailed, type index_d_ProductInstanceUpdated as ProductInstanceUpdated, type index_d_ProductPriceIncreaseData as ProductPriceIncreaseData, index_d_ProviderName as ProviderName, type index_d_QueryPackagesRequest as QueryPackagesRequest, type index_d_QueryPackagesResponse as QueryPackagesResponse, type index_d_QueryPackagesResponseNonNullableFields as QueryPackagesResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_ReactivationData as ReactivationData, index_d_ReactivationReasonEnum as ReactivationReasonEnum, type index_d_RecurringChargeSucceeded as RecurringChargeSucceeded, type index_d_Reschedule as Reschedule, type index_d_RestoreInfo as RestoreInfo, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_Status as Status, type index_d_Subscription as Subscription, type index_d_SubscriptionAssigned as SubscriptionAssigned, type index_d_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type index_d_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type index_d_SubscriptionCancelled as SubscriptionCancelled, type index_d_SubscriptionCreated as SubscriptionCreated, type index_d_SubscriptionEvent as SubscriptionEvent, type index_d_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type index_d_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type index_d_SubscriptionPendingChange as SubscriptionPendingChange, index_d_SubscriptionStatus as SubscriptionStatus, type index_d_SubscriptionTransferred as SubscriptionTransferred, type index_d_SubscriptionUnassigned as SubscriptionUnassigned, type index_d_Task as Task, type index_d_TaskAction as TaskAction, type index_d_TaskActionActionOneOf as TaskActionActionOneOf, type index_d_TaskKey as TaskKey, type index_d_UnassignProductInstanceFromSiteOptions as UnassignProductInstanceFromSiteOptions, type index_d_UnassignProductInstanceFromSiteRequest as UnassignProductInstanceFromSiteRequest, type index_d_UnassignProductInstanceFromSiteResponse as UnassignProductInstanceFromSiteResponse, type index_d_UnassignProductInstanceFromSiteResponseNonNullableFields as UnassignProductInstanceFromSiteResponseNonNullableFields, index_d_UnassignReason as UnassignReason, type index_d_UnassignedProductInstanceFromSite as UnassignedProductInstanceFromSite, type index_d_UpdatePackageExternalIdIdentifiers as UpdatePackageExternalIdIdentifiers, type index_d_UpdatePackageExternalIdRequest as UpdatePackageExternalIdRequest, type index_d_UpdatePackageExternalIdResponse as UpdatePackageExternalIdResponse, type index_d_UpdatePackageExternalIdResponseNonNullableFields as UpdatePackageExternalIdResponseNonNullableFields, type index_d_UpdateProductInstanceRequest as UpdateProductInstanceRequest, type index_d_UpdateProductInstanceResponse as UpdateProductInstanceResponse, index_d_WebhookIdentityType as WebhookIdentityType, index_d_adjustProductInstanceSpecifications as adjustProductInstanceSpecifications, index_d_assignProductInstanceToSite as assignProductInstanceToSite, index_d_cancelPackage as cancelPackage, index_d_cancelProductInstance as cancelProductInstance, index_d_createPackage as createPackage, index_d_createPackageV2 as createPackageV2, index_d_getPackage as getPackage, index_d_queryPackages as queryPackages, index_d_unassignProductInstanceFromSite as unassignProductInstanceFromSite, index_d_updatePackageExternalId as updatePackageExternalId };
2238
- }
2239
-
2240
- export { index_d as packages };