@wix/packages 1.0.15 → 1.0.17

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,8 +1,51 @@
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
+
1
43
  type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
44
  interface HttpClient {
3
45
  request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
46
  fetchWithAuth: typeof fetch;
5
47
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
48
+ getActiveToken?: () => string | undefined;
6
49
  }
7
50
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
51
  type HttpResponse<T = any> = {
@@ -24,6 +67,65 @@ type APIMetadata = {
24
67
  packageName?: string;
25
68
  };
26
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;
27
129
 
28
130
  declare global {
29
131
  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -32,6 +134,348 @@ declare global {
32
134
  }
33
135
  }
34
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
+
35
479
  /**
36
480
  * A package is group of instances of Wix services that a reseller offers to a
37
481
  * customer as part of a single transaction.
@@ -67,12 +511,12 @@ interface Package {
67
511
  * Date and time the package was created.
68
512
  * @readonly
69
513
  */
70
- _createdDate?: Date;
514
+ _createdDate?: Date | null;
71
515
  /**
72
516
  * Date and time the package was last updated.
73
517
  * @readonly
74
518
  */
75
- _updatedDate?: Date;
519
+ _updatedDate?: Date | null;
76
520
  }
77
521
  /**
78
522
  * A product instance is a specific instance of a Wix service that a reseller
@@ -120,12 +564,12 @@ interface ProductInstance extends ProductInstanceContractDetailsOneOf {
120
564
  * Date and time the product instance was created.
121
565
  * @readonly
122
566
  */
123
- _createdDate?: Date;
567
+ _createdDate?: Date | null;
124
568
  /**
125
569
  * Date and time the product instance was last updated.
126
570
  * @readonly
127
571
  */
128
- _updatedDate?: Date;
572
+ _updatedDate?: Date | null;
129
573
  /**
130
574
  * Two-letter country code in
131
575
  * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
@@ -139,7 +583,7 @@ interface ProductInstance extends ProductInstanceContractDetailsOneOf {
139
583
  * Used only for instances that don't auto renew at the end of the current billing cycle.
140
584
  * @readonly
141
585
  */
142
- expirationDate?: Date;
586
+ expirationDate?: Date | null;
143
587
  /**
144
588
  * Discount code indicating that the reseller provisioned the product instance
145
589
  * during a sale. Wix doesn't guarantee that a discount code reduces the
@@ -223,17 +667,6 @@ interface ProductInstanceCycle {
223
667
  /** Duration of the billing cycle. Available only for `RECURRING` payments. */
224
668
  cycleDuration?: CycleInterval;
225
669
  }
226
- interface MigrateSubscriptionToPackagesRequest {
227
- /** Created package. */
228
- productInstance?: ProductInstance;
229
- /** Existing subscriptionId to migrate */
230
- subscriptionId?: string | null;
231
- /** User id of the migration - only for Immigrator */
232
- userId?: string | null;
233
- }
234
- interface MigrateSubscriptionToPackagesResponse {
235
- package?: Package;
236
- }
237
670
  interface CreatePackageRequest {
238
671
  /** Idempotency key. */
239
672
  idempotencyKey?: string | null;
@@ -533,7 +966,7 @@ interface SubscriptionEvent extends SubscriptionEventEventOneOf {
533
966
  * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
534
967
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
535
968
  */
536
- eventDate?: Date;
969
+ eventDate?: Date | null;
537
970
  }
538
971
  /** @oneof */
539
972
  interface SubscriptionEventEventOneOf {
@@ -612,13 +1045,13 @@ interface Subscription {
612
1045
  * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
613
1046
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
614
1047
  */
615
- createdAt?: Date;
1048
+ createdAt?: Date | null;
616
1049
  /**
617
1050
  * Date and time the subscription was last updated in
618
1051
  * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
619
1052
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
620
1053
  */
621
- updatedAt?: Date;
1054
+ updatedAt?: Date | null;
622
1055
  /**
623
1056
  * ID of the metasite that the subscription is assigned to.
624
1057
  * Available only when the subscription is assigned to a Wix site.
@@ -646,7 +1079,7 @@ interface Subscription {
646
1079
  * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
647
1080
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
648
1081
  */
649
- transferredAt?: Date;
1082
+ transferredAt?: Date | null;
650
1083
  /**
651
1084
  * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
652
1085
  * that the product, for which the subscription was purchased, belongs to.
@@ -665,7 +1098,7 @@ interface Subscription {
665
1098
  * `YYYY-MM-DDThh:mm:ss.sssZ` format.
666
1099
  * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
667
1100
  */
668
- originalCreationDate?: Date;
1101
+ originalCreationDate?: Date | null;
669
1102
  /** Custom metadata about the subscription. */
670
1103
  metadata?: Record<string, string>;
671
1104
  /**
@@ -747,9 +1180,9 @@ interface ReactivationData {
747
1180
  * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
748
1181
  * number of days it was inactive during the time of resolving the dispute
749
1182
  */
750
- newEndOfPeriod?: Date;
1183
+ newEndOfPeriod?: Date | null;
751
1184
  /** The original end date, before the inactive period. */
752
- oldEndOfPeriod?: Date;
1185
+ oldEndOfPeriod?: Date | null;
753
1186
  /** The difference in days between the new new_end_of_period and old_end_of_period */
754
1187
  differenceInDays?: number | null;
755
1188
  }
@@ -1051,7 +1484,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
1051
1484
  /** ID of the entity associated with the event. */
1052
1485
  entityId?: string;
1053
1486
  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1054
- eventTime?: Date;
1487
+ eventTime?: Date | null;
1055
1488
  /**
1056
1489
  * Whether the event was triggered as a result of a privacy regulation application
1057
1490
  * (for example, GDPR).
@@ -1080,7 +1513,7 @@ interface EntityCreatedEvent {
1080
1513
  entity?: string;
1081
1514
  }
1082
1515
  interface RestoreInfo {
1083
- deletedDate?: Date;
1516
+ deletedDate?: Date | null;
1084
1517
  }
1085
1518
  interface EntityUpdatedEvent {
1086
1519
  /**
@@ -1116,7 +1549,7 @@ interface ProductInstanceFailed {
1116
1549
  }
1117
1550
  interface Task {
1118
1551
  key?: TaskKey;
1119
- executeAt?: Date;
1552
+ executeAt?: Date | null;
1120
1553
  payload?: string | null;
1121
1554
  }
1122
1555
  interface TaskKey {
@@ -1140,7 +1573,7 @@ interface Complete {
1140
1573
  interface Cancel {
1141
1574
  }
1142
1575
  interface Reschedule {
1143
- executeAt?: Date;
1576
+ executeAt?: Date | null;
1144
1577
  payload?: string | null;
1145
1578
  }
1146
1579
  interface UpdateProductInstanceRequest {
@@ -1217,6 +1650,17 @@ declare enum WebhookIdentityType {
1217
1650
  WIX_USER = "WIX_USER",
1218
1651
  APP = "APP"
1219
1652
  }
1653
+ interface MigrateSubscriptionToPackagesRequest {
1654
+ /** Created package. */
1655
+ productInstance?: ProductInstance;
1656
+ /** Existing subscriptionId to migrate */
1657
+ subscriptionId?: string | null;
1658
+ /** User id of the migration - only for Immigrator */
1659
+ userId?: string | null;
1660
+ }
1661
+ interface MigrateSubscriptionToPackagesResponse {
1662
+ package?: Package;
1663
+ }
1220
1664
  interface CycleIntervalNonNullableFields {
1221
1665
  unit: IntervalIntervalUnit;
1222
1666
  count: number;
@@ -1626,16 +2070,16 @@ interface UpdatePackageExternalIdSignature {
1626
2070
  (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
1627
2071
  }
1628
2072
 
1629
- declare const createPackage: BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1;
1630
- declare const createPackageV2: BuildRESTFunction<typeof createPackageV2$1> & typeof createPackageV2$1;
1631
- declare const cancelPackage: BuildRESTFunction<typeof cancelPackage$1> & typeof cancelPackage$1;
1632
- declare const getPackage: BuildRESTFunction<typeof getPackage$1> & typeof getPackage$1;
1633
- declare const queryPackages: BuildRESTFunction<typeof queryPackages$1> & typeof queryPackages$1;
1634
- declare const assignProductInstanceToSite: BuildRESTFunction<typeof assignProductInstanceToSite$1> & typeof assignProductInstanceToSite$1;
1635
- declare const unassignProductInstanceFromSite: BuildRESTFunction<typeof unassignProductInstanceFromSite$1> & typeof unassignProductInstanceFromSite$1;
1636
- declare const cancelProductInstance: BuildRESTFunction<typeof cancelProductInstance$1> & typeof cancelProductInstance$1;
1637
- declare const adjustProductInstanceSpecifications: BuildRESTFunction<typeof adjustProductInstanceSpecifications$1> & typeof adjustProductInstanceSpecifications$1;
1638
- declare const updatePackageExternalId: BuildRESTFunction<typeof updatePackageExternalId$1> & typeof updatePackageExternalId$1;
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>;
1639
2083
 
1640
2084
  type index_d_ActionEvent = ActionEvent;
1641
2085
  type index_d_AdjustProductInstanceSpecificationsOptions = AdjustProductInstanceSpecificationsOptions;