@wix/referral 1.0.26 → 1.0.28
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.
- package/build/cjs/context.js +1 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.js +1 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -0
- package/package.json +7 -7
- package/type-bundles/context.bundle.d.ts +478 -167
- package/type-bundles/index.bundle.d.ts +478 -167
- package/type-bundles/meta.bundle.d.ts +1 -167
|
@@ -1,8 +1,47 @@
|
|
|
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 bast url to use for API requests, for example `www.wixapis.com`
|
|
17
|
+
*/
|
|
18
|
+
apiBaseUrl?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Possible data to be provided by every host, for cross cutting concerns
|
|
21
|
+
* like internationalization, billing, etc.
|
|
22
|
+
*/
|
|
23
|
+
essentials?: {
|
|
24
|
+
/**
|
|
25
|
+
* The language of the currently viewed session
|
|
26
|
+
*/
|
|
27
|
+
language?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The locale of the currently viewed session
|
|
30
|
+
*/
|
|
31
|
+
locale?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Any headers that should be passed through to the API requests
|
|
34
|
+
*/
|
|
35
|
+
passThroughHeaders?: Record<string, string>;
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
|
|
1
39
|
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
40
|
interface HttpClient {
|
|
3
41
|
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
42
|
fetchWithAuth: typeof fetch;
|
|
5
43
|
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
44
|
+
getActiveToken?: () => string | undefined;
|
|
6
45
|
}
|
|
7
46
|
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
47
|
type HttpResponse<T = any> = {
|
|
@@ -24,16 +63,65 @@ type APIMetadata = {
|
|
|
24
63
|
packageName?: string;
|
|
25
64
|
};
|
|
26
65
|
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
66
|
+
type EventDefinition$4<Payload = unknown, Type extends string = string> = {
|
|
28
67
|
__type: 'event-definition';
|
|
29
68
|
type: Type;
|
|
30
69
|
isDomainEvent?: boolean;
|
|
31
70
|
transformations?: (envelope: unknown) => Payload;
|
|
32
71
|
__payload: Payload;
|
|
33
72
|
};
|
|
34
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
73
|
+
declare function EventDefinition$4<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$4<Payload, Type>;
|
|
74
|
+
type EventHandler$4<T extends EventDefinition$4> = (payload: T['__payload']) => void | Promise<void>;
|
|
75
|
+
type BuildEventDefinition$4<T extends EventDefinition$4<any, string>> = (handler: EventHandler$4<T>) => void;
|
|
76
|
+
|
|
77
|
+
type ServicePluginMethodInput = {
|
|
78
|
+
request: any;
|
|
79
|
+
metadata: any;
|
|
80
|
+
};
|
|
81
|
+
type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
|
|
82
|
+
type ServicePluginMethodMetadata = {
|
|
83
|
+
name: string;
|
|
84
|
+
primaryHttpMappingPath: string;
|
|
85
|
+
transformations: {
|
|
86
|
+
fromREST: (...args: unknown[]) => ServicePluginMethodInput;
|
|
87
|
+
toREST: (...args: unknown[]) => unknown;
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
type ServicePluginDefinition<Contract extends ServicePluginContract> = {
|
|
91
|
+
__type: 'service-plugin-definition';
|
|
92
|
+
componentType: string;
|
|
93
|
+
methods: ServicePluginMethodMetadata[];
|
|
94
|
+
__contract: Contract;
|
|
95
|
+
};
|
|
96
|
+
declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
|
|
97
|
+
type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
|
|
98
|
+
declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
|
|
99
|
+
|
|
100
|
+
type RequestContext = {
|
|
101
|
+
isSSR: boolean;
|
|
102
|
+
host: string;
|
|
103
|
+
protocol?: string;
|
|
104
|
+
};
|
|
105
|
+
type ResponseTransformer = (data: any, headers?: any) => any;
|
|
106
|
+
/**
|
|
107
|
+
* Ambassador request options types are copied mostly from AxiosRequestConfig.
|
|
108
|
+
* They are copied and not imported to reduce the amount of dependencies (to reduce install time).
|
|
109
|
+
* https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
|
|
110
|
+
*/
|
|
111
|
+
type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
|
|
112
|
+
type AmbassadorRequestOptions<T = any> = {
|
|
113
|
+
_?: T;
|
|
114
|
+
url?: string;
|
|
115
|
+
method?: Method;
|
|
116
|
+
params?: any;
|
|
117
|
+
data?: any;
|
|
118
|
+
transformResponse?: ResponseTransformer | ResponseTransformer[];
|
|
119
|
+
};
|
|
120
|
+
type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
|
|
121
|
+
__isAmbassador: boolean;
|
|
122
|
+
};
|
|
123
|
+
type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
|
|
124
|
+
type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
|
|
37
125
|
|
|
38
126
|
declare global {
|
|
39
127
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
@@ -42,6 +130,284 @@ declare global {
|
|
|
42
130
|
}
|
|
43
131
|
}
|
|
44
132
|
|
|
133
|
+
declare const emptyObjectSymbol: unique symbol;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
Represents a strictly empty plain object, the `{}` value.
|
|
137
|
+
|
|
138
|
+
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)).
|
|
139
|
+
|
|
140
|
+
@example
|
|
141
|
+
```
|
|
142
|
+
import type {EmptyObject} from 'type-fest';
|
|
143
|
+
|
|
144
|
+
// The following illustrates the problem with `{}`.
|
|
145
|
+
const foo1: {} = {}; // Pass
|
|
146
|
+
const foo2: {} = []; // Pass
|
|
147
|
+
const foo3: {} = 42; // Pass
|
|
148
|
+
const foo4: {} = {a: 1}; // Pass
|
|
149
|
+
|
|
150
|
+
// With `EmptyObject` only the first case is valid.
|
|
151
|
+
const bar1: EmptyObject = {}; // Pass
|
|
152
|
+
const bar2: EmptyObject = 42; // Fail
|
|
153
|
+
const bar3: EmptyObject = []; // Fail
|
|
154
|
+
const bar4: EmptyObject = {a: 1}; // Fail
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
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}.
|
|
158
|
+
|
|
159
|
+
@category Object
|
|
160
|
+
*/
|
|
161
|
+
type EmptyObject = {[emptyObjectSymbol]?: never};
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
Returns a boolean for whether the two given types are equal.
|
|
165
|
+
|
|
166
|
+
@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
|
|
167
|
+
@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
|
|
168
|
+
|
|
169
|
+
Use-cases:
|
|
170
|
+
- If you want to make a conditional branch based on the result of a comparison of two types.
|
|
171
|
+
|
|
172
|
+
@example
|
|
173
|
+
```
|
|
174
|
+
import type {IsEqual} from 'type-fest';
|
|
175
|
+
|
|
176
|
+
// This type returns a boolean for whether the given array includes the given item.
|
|
177
|
+
// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
|
|
178
|
+
type Includes<Value extends readonly any[], Item> =
|
|
179
|
+
Value extends readonly [Value[0], ...infer rest]
|
|
180
|
+
? IsEqual<Value[0], Item> extends true
|
|
181
|
+
? true
|
|
182
|
+
: Includes<rest, Item>
|
|
183
|
+
: false;
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
@category Type Guard
|
|
187
|
+
@category Utilities
|
|
188
|
+
*/
|
|
189
|
+
type IsEqual<A, B> =
|
|
190
|
+
(<G>() => G extends A ? 1 : 2) extends
|
|
191
|
+
(<G>() => G extends B ? 1 : 2)
|
|
192
|
+
? true
|
|
193
|
+
: false;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
Filter out keys from an object.
|
|
197
|
+
|
|
198
|
+
Returns `never` if `Exclude` is strictly equal to `Key`.
|
|
199
|
+
Returns `never` if `Key` extends `Exclude`.
|
|
200
|
+
Returns `Key` otherwise.
|
|
201
|
+
|
|
202
|
+
@example
|
|
203
|
+
```
|
|
204
|
+
type Filtered = Filter<'foo', 'foo'>;
|
|
205
|
+
//=> never
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
@example
|
|
209
|
+
```
|
|
210
|
+
type Filtered = Filter<'bar', string>;
|
|
211
|
+
//=> never
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
@example
|
|
215
|
+
```
|
|
216
|
+
type Filtered = Filter<'bar', 'foo'>;
|
|
217
|
+
//=> 'bar'
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
@see {Except}
|
|
221
|
+
*/
|
|
222
|
+
type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
|
|
223
|
+
|
|
224
|
+
type ExceptOptions = {
|
|
225
|
+
/**
|
|
226
|
+
Disallow assigning non-specified properties.
|
|
227
|
+
|
|
228
|
+
Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
|
|
229
|
+
|
|
230
|
+
@default false
|
|
231
|
+
*/
|
|
232
|
+
requireExactProps?: boolean;
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
Create a type from an object type without certain keys.
|
|
237
|
+
|
|
238
|
+
We recommend setting the `requireExactProps` option to `true`.
|
|
239
|
+
|
|
240
|
+
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.
|
|
241
|
+
|
|
242
|
+
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)).
|
|
243
|
+
|
|
244
|
+
@example
|
|
245
|
+
```
|
|
246
|
+
import type {Except} from 'type-fest';
|
|
247
|
+
|
|
248
|
+
type Foo = {
|
|
249
|
+
a: number;
|
|
250
|
+
b: string;
|
|
251
|
+
};
|
|
252
|
+
|
|
253
|
+
type FooWithoutA = Except<Foo, 'a'>;
|
|
254
|
+
//=> {b: string}
|
|
255
|
+
|
|
256
|
+
const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
|
|
257
|
+
//=> errors: 'a' does not exist in type '{ b: string; }'
|
|
258
|
+
|
|
259
|
+
type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
|
|
260
|
+
//=> {a: number} & Partial<Record<"b", never>>
|
|
261
|
+
|
|
262
|
+
const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
|
|
263
|
+
//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
@category Object
|
|
267
|
+
*/
|
|
268
|
+
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
|
|
269
|
+
[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
|
|
270
|
+
} & (Options['requireExactProps'] extends true
|
|
271
|
+
? Partial<Record<KeysType, never>>
|
|
272
|
+
: {});
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
Extract the keys from a type where the value type of the key extends the given `Condition`.
|
|
276
|
+
|
|
277
|
+
Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
|
|
278
|
+
|
|
279
|
+
@example
|
|
280
|
+
```
|
|
281
|
+
import type {ConditionalKeys} from 'type-fest';
|
|
282
|
+
|
|
283
|
+
interface Example {
|
|
284
|
+
a: string;
|
|
285
|
+
b: string | number;
|
|
286
|
+
c?: string;
|
|
287
|
+
d: {};
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
type StringKeysOnly = ConditionalKeys<Example, string>;
|
|
291
|
+
//=> 'a'
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
|
|
295
|
+
|
|
296
|
+
@example
|
|
297
|
+
```
|
|
298
|
+
import type {ConditionalKeys} from 'type-fest';
|
|
299
|
+
|
|
300
|
+
type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
|
|
301
|
+
//=> 'a' | 'c'
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
@category Object
|
|
305
|
+
*/
|
|
306
|
+
type ConditionalKeys<Base, Condition> = NonNullable<
|
|
307
|
+
// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
|
|
308
|
+
{
|
|
309
|
+
// Map through all the keys of the given base type.
|
|
310
|
+
[Key in keyof Base]:
|
|
311
|
+
// Pick only keys with types extending the given `Condition` type.
|
|
312
|
+
Base[Key] extends Condition
|
|
313
|
+
// Retain this key since the condition passes.
|
|
314
|
+
? Key
|
|
315
|
+
// Discard this key since the condition fails.
|
|
316
|
+
: never;
|
|
317
|
+
|
|
318
|
+
// Convert the produced object into a union type of the keys which passed the conditional test.
|
|
319
|
+
}[keyof Base]
|
|
320
|
+
>;
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
Exclude keys from a shape that matches the given `Condition`.
|
|
324
|
+
|
|
325
|
+
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.
|
|
326
|
+
|
|
327
|
+
@example
|
|
328
|
+
```
|
|
329
|
+
import type {Primitive, ConditionalExcept} from 'type-fest';
|
|
330
|
+
|
|
331
|
+
class Awesome {
|
|
332
|
+
name: string;
|
|
333
|
+
successes: number;
|
|
334
|
+
failures: bigint;
|
|
335
|
+
|
|
336
|
+
run() {}
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
|
|
340
|
+
//=> {run: () => void}
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
@example
|
|
344
|
+
```
|
|
345
|
+
import type {ConditionalExcept} from 'type-fest';
|
|
346
|
+
|
|
347
|
+
interface Example {
|
|
348
|
+
a: string;
|
|
349
|
+
b: string | number;
|
|
350
|
+
c: () => void;
|
|
351
|
+
d: {};
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
type NonStringKeysOnly = ConditionalExcept<Example, string>;
|
|
355
|
+
//=> {b: string | number; c: () => void; d: {}}
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
@category Object
|
|
359
|
+
*/
|
|
360
|
+
type ConditionalExcept<Base, Condition> = Except<
|
|
361
|
+
Base,
|
|
362
|
+
ConditionalKeys<Base, Condition>
|
|
363
|
+
>;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Descriptors are objects that describe the API of a module, and the module
|
|
367
|
+
* can either be a REST module or a host module.
|
|
368
|
+
* This type is recursive, so it can describe nested modules.
|
|
369
|
+
*/
|
|
370
|
+
type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition$4<any> | ServicePluginDefinition<any> | {
|
|
371
|
+
[key: string]: Descriptors | PublicMetadata | any;
|
|
372
|
+
};
|
|
373
|
+
/**
|
|
374
|
+
* This type takes in a descriptors object of a certain Host (including an `unknown` host)
|
|
375
|
+
* and returns an object with the same structure, but with all descriptors replaced with their API.
|
|
376
|
+
* Any non-descriptor properties are removed from the returned object, including descriptors that
|
|
377
|
+
* do not match the given host (as they will not work with the given host).
|
|
378
|
+
*/
|
|
379
|
+
type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
|
|
380
|
+
done: T;
|
|
381
|
+
recurse: T extends {
|
|
382
|
+
__type: typeof SERVICE_PLUGIN_ERROR_TYPE;
|
|
383
|
+
} ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition$4<any> ? BuildEventDefinition$4<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
|
|
384
|
+
[Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
|
|
385
|
+
-1,
|
|
386
|
+
0,
|
|
387
|
+
1,
|
|
388
|
+
2,
|
|
389
|
+
3,
|
|
390
|
+
4,
|
|
391
|
+
5
|
|
392
|
+
][Depth]> : never;
|
|
393
|
+
}, EmptyObject>;
|
|
394
|
+
}[Depth extends -1 ? 'done' : 'recurse'];
|
|
395
|
+
type PublicMetadata = {
|
|
396
|
+
PACKAGE_NAME?: string;
|
|
397
|
+
};
|
|
398
|
+
|
|
399
|
+
declare global {
|
|
400
|
+
interface ContextualClient {
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
/**
|
|
404
|
+
* A type used to create concerete types from SDK descriptors in
|
|
405
|
+
* case a contextual client is available.
|
|
406
|
+
*/
|
|
407
|
+
type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
408
|
+
host: Host;
|
|
409
|
+
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
410
|
+
|
|
45
411
|
interface ReferralProgram {
|
|
46
412
|
/** Referral program name. */
|
|
47
413
|
name?: string | null;
|
|
@@ -310,85 +676,6 @@ interface ProgramInSite {
|
|
|
310
676
|
/** Retrieved referral program. */
|
|
311
677
|
referralProgram?: ReferralProgram;
|
|
312
678
|
}
|
|
313
|
-
interface QueryReferralProgramsRequest {
|
|
314
|
-
/** Query options. */
|
|
315
|
-
query: CursorQuery$4;
|
|
316
|
-
}
|
|
317
|
-
interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
|
|
318
|
-
/**
|
|
319
|
-
* Cursor paging options.
|
|
320
|
-
*
|
|
321
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
322
|
-
*/
|
|
323
|
-
cursorPaging?: CursorPaging$4;
|
|
324
|
-
/**
|
|
325
|
-
* Filter object.
|
|
326
|
-
*
|
|
327
|
-
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
328
|
-
*/
|
|
329
|
-
filter?: Record<string, any> | null;
|
|
330
|
-
/**
|
|
331
|
-
* Sort object.
|
|
332
|
-
*
|
|
333
|
-
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
334
|
-
*/
|
|
335
|
-
sort?: Sorting$4[];
|
|
336
|
-
}
|
|
337
|
-
/** @oneof */
|
|
338
|
-
interface CursorQueryPagingMethodOneOf$4 {
|
|
339
|
-
/**
|
|
340
|
-
* Cursor paging options.
|
|
341
|
-
*
|
|
342
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
343
|
-
*/
|
|
344
|
-
cursorPaging?: CursorPaging$4;
|
|
345
|
-
}
|
|
346
|
-
interface Sorting$4 {
|
|
347
|
-
/** Name of the field to sort by. */
|
|
348
|
-
fieldName?: string;
|
|
349
|
-
/** Sort order. */
|
|
350
|
-
order?: SortOrder$4;
|
|
351
|
-
}
|
|
352
|
-
declare enum SortOrder$4 {
|
|
353
|
-
ASC = "ASC",
|
|
354
|
-
DESC = "DESC"
|
|
355
|
-
}
|
|
356
|
-
interface CursorPaging$4 {
|
|
357
|
-
/** Maximum number of items to return in the results. */
|
|
358
|
-
limit?: number | null;
|
|
359
|
-
/**
|
|
360
|
-
* Pointer to the next or previous page in the list of results.
|
|
361
|
-
*
|
|
362
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
363
|
-
* Not relevant for the first request.
|
|
364
|
-
*/
|
|
365
|
-
cursor?: string | null;
|
|
366
|
-
}
|
|
367
|
-
interface QueryReferralProgramsResponse {
|
|
368
|
-
/** Referral programs matching the query. */
|
|
369
|
-
referralPrograms?: ReferralProgram[];
|
|
370
|
-
/** Paging metadata. */
|
|
371
|
-
pagingMetadata?: CursorPagingMetadata$4;
|
|
372
|
-
}
|
|
373
|
-
interface CursorPagingMetadata$4 {
|
|
374
|
-
/** Number of items returned in current page. */
|
|
375
|
-
count?: number | null;
|
|
376
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
377
|
-
cursors?: Cursors$4;
|
|
378
|
-
/**
|
|
379
|
-
* Whether there are more pages to retrieve following the current page.
|
|
380
|
-
*
|
|
381
|
-
* + `true`: Another page of results can be retrieved.
|
|
382
|
-
* + `false`: This is the last page.
|
|
383
|
-
*/
|
|
384
|
-
hasNext?: boolean | null;
|
|
385
|
-
}
|
|
386
|
-
interface Cursors$4 {
|
|
387
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
388
|
-
next?: string | null;
|
|
389
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
390
|
-
prev?: string | null;
|
|
391
|
-
}
|
|
392
679
|
interface UpdateReferralProgramRequest {
|
|
393
680
|
/** Referral program to update. Include the latest `revision` for a successful update. */
|
|
394
681
|
referralProgram: ReferralProgram;
|
|
@@ -1439,9 +1726,6 @@ interface ReferralProgramNonNullableFields {
|
|
|
1439
1726
|
interface GetReferralProgramResponseNonNullableFields {
|
|
1440
1727
|
referralProgram?: ReferralProgramNonNullableFields;
|
|
1441
1728
|
}
|
|
1442
|
-
interface QueryReferralProgramsResponseNonNullableFields {
|
|
1443
|
-
referralPrograms: ReferralProgramNonNullableFields[];
|
|
1444
|
-
}
|
|
1445
1729
|
interface UpdateReferralProgramResponseNonNullableFields {
|
|
1446
1730
|
referralProgram?: ReferralProgramNonNullableFields;
|
|
1447
1731
|
}
|
|
@@ -1514,31 +1798,6 @@ interface ProgramUpdatedEnvelope {
|
|
|
1514
1798
|
entity: ReferralProgram;
|
|
1515
1799
|
metadata: EventMetadata$3;
|
|
1516
1800
|
}
|
|
1517
|
-
interface QueryCursorResult$4 {
|
|
1518
|
-
cursors: Cursors$4;
|
|
1519
|
-
hasNext: () => boolean;
|
|
1520
|
-
hasPrev: () => boolean;
|
|
1521
|
-
length: number;
|
|
1522
|
-
pageSize: number;
|
|
1523
|
-
}
|
|
1524
|
-
interface ReferralProgramsQueryResult extends QueryCursorResult$4 {
|
|
1525
|
-
items: ReferralProgram[];
|
|
1526
|
-
query: ReferralProgramsQueryBuilder;
|
|
1527
|
-
next: () => Promise<ReferralProgramsQueryResult>;
|
|
1528
|
-
prev: () => Promise<ReferralProgramsQueryResult>;
|
|
1529
|
-
}
|
|
1530
|
-
interface ReferralProgramsQueryBuilder {
|
|
1531
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1532
|
-
* @documentationMaturity preview
|
|
1533
|
-
*/
|
|
1534
|
-
limit: (limit: number) => ReferralProgramsQueryBuilder;
|
|
1535
|
-
/** @param cursor - A pointer to specific record
|
|
1536
|
-
* @documentationMaturity preview
|
|
1537
|
-
*/
|
|
1538
|
-
skipTo: (cursor: string) => ReferralProgramsQueryBuilder;
|
|
1539
|
-
/** @documentationMaturity preview */
|
|
1540
|
-
find: () => Promise<ReferralProgramsQueryResult>;
|
|
1541
|
-
}
|
|
1542
1801
|
interface GetAiSocialMediaPostsSuggestionsOptions {
|
|
1543
1802
|
/** Topic to generate social media post suggestions for. For example, fitness, education, technology. */
|
|
1544
1803
|
topic?: string;
|
|
@@ -1555,19 +1814,6 @@ interface GetReferralProgramSignature {
|
|
|
1555
1814
|
*/
|
|
1556
1815
|
(): Promise<GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields>;
|
|
1557
1816
|
}
|
|
1558
|
-
declare function queryReferralPrograms$1(httpClient: HttpClient): QueryReferralProgramsSignature;
|
|
1559
|
-
interface QueryReferralProgramsSignature {
|
|
1560
|
-
/**
|
|
1561
|
-
* Retrieves a list of referral programs, given the provided paging, filtering, and sorting.
|
|
1562
|
-
*
|
|
1563
|
-
* To learn about working with _Query_ method, see
|
|
1564
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
1565
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
1566
|
-
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
1567
|
-
* @deprecated
|
|
1568
|
-
*/
|
|
1569
|
-
(): ReferralProgramsQueryBuilder;
|
|
1570
|
-
}
|
|
1571
1817
|
declare function updateReferralProgram$1(httpClient: HttpClient): UpdateReferralProgramSignature;
|
|
1572
1818
|
interface UpdateReferralProgramSignature {
|
|
1573
1819
|
/**
|
|
@@ -1623,18 +1869,35 @@ interface GetReferralProgramPremiumFeaturesSignature {
|
|
|
1623
1869
|
*/
|
|
1624
1870
|
(): Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
|
|
1625
1871
|
}
|
|
1626
|
-
declare const onProgramUpdated$1: EventDefinition<ProgramUpdatedEnvelope, "wix.loyalty.referral.v1.program_updated">;
|
|
1872
|
+
declare const onProgramUpdated$1: EventDefinition$4<ProgramUpdatedEnvelope, "wix.loyalty.referral.v1.program_updated">;
|
|
1627
1873
|
|
|
1628
|
-
|
|
1874
|
+
type EventDefinition$3<Payload = unknown, Type extends string = string> = {
|
|
1875
|
+
__type: 'event-definition';
|
|
1876
|
+
type: Type;
|
|
1877
|
+
isDomainEvent?: boolean;
|
|
1878
|
+
transformations?: (envelope: unknown) => Payload;
|
|
1879
|
+
__payload: Payload;
|
|
1880
|
+
};
|
|
1881
|
+
declare function EventDefinition$3<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$3<Payload, Type>;
|
|
1882
|
+
type EventHandler$3<T extends EventDefinition$3> = (payload: T['__payload']) => void | Promise<void>;
|
|
1883
|
+
type BuildEventDefinition$3<T extends EventDefinition$3<any, string>> = (handler: EventHandler$3<T>) => void;
|
|
1629
1884
|
|
|
1630
|
-
declare
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
declare
|
|
1885
|
+
declare global {
|
|
1886
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
1887
|
+
interface SymbolConstructor {
|
|
1888
|
+
readonly observable: symbol;
|
|
1889
|
+
}
|
|
1890
|
+
}
|
|
1891
|
+
|
|
1892
|
+
declare function createEventModule$3<T extends EventDefinition$3<any, string>>(eventDefinition: T): BuildEventDefinition$3<T> & T;
|
|
1893
|
+
|
|
1894
|
+
declare const getReferralProgram: MaybeContext<BuildRESTFunction<typeof getReferralProgram$1> & typeof getReferralProgram$1>;
|
|
1895
|
+
declare const updateReferralProgram: MaybeContext<BuildRESTFunction<typeof updateReferralProgram$1> & typeof updateReferralProgram$1>;
|
|
1896
|
+
declare const activateReferralProgram: MaybeContext<BuildRESTFunction<typeof activateReferralProgram$1> & typeof activateReferralProgram$1>;
|
|
1897
|
+
declare const pauseReferralProgram: MaybeContext<BuildRESTFunction<typeof pauseReferralProgram$1> & typeof pauseReferralProgram$1>;
|
|
1898
|
+
declare const getAiSocialMediaPostsSuggestions: MaybeContext<BuildRESTFunction<typeof getAiSocialMediaPostsSuggestions$1> & typeof getAiSocialMediaPostsSuggestions$1>;
|
|
1899
|
+
declare const generateAiSocialMediaPostsSuggestions: MaybeContext<BuildRESTFunction<typeof generateAiSocialMediaPostsSuggestions$1> & typeof generateAiSocialMediaPostsSuggestions$1>;
|
|
1900
|
+
declare const getReferralProgramPremiumFeatures: MaybeContext<BuildRESTFunction<typeof getReferralProgramPremiumFeatures$1> & typeof getReferralProgramPremiumFeatures$1>;
|
|
1638
1901
|
|
|
1639
1902
|
type _publicOnProgramUpdatedType = typeof onProgramUpdated$1;
|
|
1640
1903
|
/** */
|
|
@@ -1706,16 +1969,11 @@ declare const index_d$4_ProgramStatus: typeof ProgramStatus;
|
|
|
1706
1969
|
type index_d$4_ProgramUpdatedEnvelope = ProgramUpdatedEnvelope;
|
|
1707
1970
|
type index_d$4_ProviderName = ProviderName;
|
|
1708
1971
|
declare const index_d$4_ProviderName: typeof ProviderName;
|
|
1709
|
-
type index_d$4_QueryReferralProgramsRequest = QueryReferralProgramsRequest;
|
|
1710
|
-
type index_d$4_QueryReferralProgramsResponse = QueryReferralProgramsResponse;
|
|
1711
|
-
type index_d$4_QueryReferralProgramsResponseNonNullableFields = QueryReferralProgramsResponseNonNullableFields;
|
|
1712
1972
|
type index_d$4_ReactivationData = ReactivationData;
|
|
1713
1973
|
type index_d$4_ReactivationReasonEnum = ReactivationReasonEnum;
|
|
1714
1974
|
declare const index_d$4_ReactivationReasonEnum: typeof ReactivationReasonEnum;
|
|
1715
1975
|
type index_d$4_RecurringChargeSucceeded = RecurringChargeSucceeded;
|
|
1716
1976
|
type index_d$4_ReferralProgram = ReferralProgram;
|
|
1717
|
-
type index_d$4_ReferralProgramsQueryBuilder = ReferralProgramsQueryBuilder;
|
|
1718
|
-
type index_d$4_ReferralProgramsQueryResult = ReferralProgramsQueryResult;
|
|
1719
1977
|
type index_d$4_ServiceProvisioned = ServiceProvisioned;
|
|
1720
1978
|
type index_d$4_ServiceRemoved = ServiceRemoved;
|
|
1721
1979
|
type index_d$4_SiteCreated = SiteCreated;
|
|
@@ -1761,10 +2019,9 @@ declare const index_d$4_getReferralProgram: typeof getReferralProgram;
|
|
|
1761
2019
|
declare const index_d$4_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
|
|
1762
2020
|
declare const index_d$4_onProgramUpdated: typeof onProgramUpdated;
|
|
1763
2021
|
declare const index_d$4_pauseReferralProgram: typeof pauseReferralProgram;
|
|
1764
|
-
declare const index_d$4_queryReferralPrograms: typeof queryReferralPrograms;
|
|
1765
2022
|
declare const index_d$4_updateReferralProgram: typeof updateReferralProgram;
|
|
1766
2023
|
declare namespace index_d$4 {
|
|
1767
|
-
export { type index_d$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, index_d$4_Action as Action, type ActionEvent$4 as ActionEvent, type index_d$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type index_d$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type index_d$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, index_d$4_App as App, type index_d$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BillingReference as BillingReference, type index_d$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type index_d$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type index_d$4_CancellationDetails as CancellationDetails, index_d$4_ContractSwitchReason as ContractSwitchReason, index_d$4_ContractSwitchType as ContractSwitchType, type index_d$4_ContractSwitched as ContractSwitched, type Coupon$2 as Coupon, type CouponDiscountTypeOptionsOneOf$2 as CouponDiscountTypeOptionsOneOf, type CouponScope$2 as CouponScope, type CouponScopeOrMinSubtotalOneOf$2 as CouponScopeOrMinSubtotalOneOf, type
|
|
2024
|
+
export { type index_d$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, index_d$4_Action as Action, type ActionEvent$4 as ActionEvent, type index_d$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type index_d$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type index_d$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, index_d$4_App as App, type index_d$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BillingReference as BillingReference, type index_d$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type index_d$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type index_d$4_CancellationDetails as CancellationDetails, index_d$4_ContractSwitchReason as ContractSwitchReason, index_d$4_ContractSwitchType as ContractSwitchType, type index_d$4_ContractSwitched as ContractSwitched, type Coupon$2 as Coupon, type CouponDiscountTypeOptionsOneOf$2 as CouponDiscountTypeOptionsOneOf, type CouponScope$2 as CouponScope, type CouponScopeOrMinSubtotalOneOf$2 as CouponScopeOrMinSubtotalOneOf, type index_d$4_Cycle as Cycle, type index_d$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type index_d$4_DeleteContext as DeleteContext, index_d$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type index_d$4_Emails as Emails, type Empty$3 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type FixedAmountDiscount$2 as FixedAmountDiscount, type index_d$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type index_d$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type index_d$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type index_d$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type index_d$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type index_d$4_GetReferralProgramRequest as GetReferralProgramRequest, type index_d$4_GetReferralProgramResponse as GetReferralProgramResponse, type index_d$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type index_d$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, index_d$4_Initiator as Initiator, type index_d$4_Interval as Interval, index_d$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d$4_Namespace as Namespace, type index_d$4_NamespaceChanged as NamespaceChanged, type index_d$4_OneTime as OneTime, type index_d$4_Page as Page, type index_d$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type index_d$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type index_d$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, type index_d$4_PremiumFeatures as PremiumFeatures, index_d$4_PriceIncreaseTrigger as PriceIncreaseTrigger, index_d$4_ProductAdjustment as ProductAdjustment, type index_d$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type index_d$4_ProgramInSite as ProgramInSite, index_d$4_ProgramStatus as ProgramStatus, type index_d$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, index_d$4_ProviderName as ProviderName, type index_d$4_ReactivationData as ReactivationData, index_d$4_ReactivationReasonEnum as ReactivationReasonEnum, type index_d$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type index_d$4_ReferralProgram as ReferralProgram, type RestoreInfo$4 as RestoreInfo, type Reward$2 as Reward, type RewardOptionsOneOf$1 as RewardOptionsOneOf, type index_d$4_ServiceProvisioned as ServiceProvisioned, type index_d$4_ServiceRemoved as ServiceRemoved, type index_d$4_SiteCreated as SiteCreated, index_d$4_SiteCreatedContext as SiteCreatedContext, type index_d$4_SiteDeleted as SiteDeleted, type index_d$4_SiteHardDeleted as SiteHardDeleted, type index_d$4_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d$4_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d$4_SitePublished as SitePublished, type index_d$4_SiteRenamed as SiteRenamed, type index_d$4_SiteTransferred as SiteTransferred, type index_d$4_SiteUndeleted as SiteUndeleted, type index_d$4_SiteUnpublished as SiteUnpublished, index_d$4_State as State, type index_d$4_StudioAssigned as StudioAssigned, type index_d$4_StudioUnassigned as StudioUnassigned, type index_d$4_Subscription as Subscription, type index_d$4_SubscriptionAssigned as SubscriptionAssigned, type index_d$4_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type index_d$4_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type index_d$4_SubscriptionCancelled as SubscriptionCancelled, type index_d$4_SubscriptionCreated as SubscriptionCreated, type index_d$4_SubscriptionEvent as SubscriptionEvent, type index_d$4_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type index_d$4_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type index_d$4_SubscriptionPendingChange as SubscriptionPendingChange, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SubscriptionTransferred as SubscriptionTransferred, type index_d$4_SubscriptionUnassigned as SubscriptionUnassigned, Type$1 as Type, index_d$4_UnassignReason as UnassignReason, type index_d$4_UpdateReferralProgramRequest as UpdateReferralProgramRequest, type index_d$4_UpdateReferralProgramResponse as UpdateReferralProgramResponse, type index_d$4_UpdateReferralProgramResponseNonNullableFields as UpdateReferralProgramResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type index_d$4__publicOnProgramUpdatedType as _publicOnProgramUpdatedType, index_d$4_activateReferralProgram as activateReferralProgram, index_d$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, index_d$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, index_d$4_getReferralProgram as getReferralProgram, index_d$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, index_d$4_onProgramUpdated as onProgramUpdated, index_d$4_pauseReferralProgram as pauseReferralProgram, onProgramUpdated$1 as publicOnProgramUpdated, index_d$4_updateReferralProgram as updateReferralProgram };
|
|
1768
2025
|
}
|
|
1769
2026
|
|
|
1770
2027
|
interface ReferralEvent extends ReferralEventEventTypeOneOf {
|
|
@@ -2654,15 +2911,33 @@ interface QueryReferredFriendActionsSignature {
|
|
|
2654
2911
|
*/
|
|
2655
2912
|
(options?: QueryReferredFriendActionsOptions | undefined): Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
|
|
2656
2913
|
}
|
|
2657
|
-
declare const onReferralEventCreated$1: EventDefinition<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
|
|
2914
|
+
declare const onReferralEventCreated$1: EventDefinition$4<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
|
|
2915
|
+
|
|
2916
|
+
type EventDefinition$2<Payload = unknown, Type extends string = string> = {
|
|
2917
|
+
__type: 'event-definition';
|
|
2918
|
+
type: Type;
|
|
2919
|
+
isDomainEvent?: boolean;
|
|
2920
|
+
transformations?: (envelope: unknown) => Payload;
|
|
2921
|
+
__payload: Payload;
|
|
2922
|
+
};
|
|
2923
|
+
declare function EventDefinition$2<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$2<Payload, Type>;
|
|
2924
|
+
type EventHandler$2<T extends EventDefinition$2> = (payload: T['__payload']) => void | Promise<void>;
|
|
2925
|
+
type BuildEventDefinition$2<T extends EventDefinition$2<any, string>> = (handler: EventHandler$2<T>) => void;
|
|
2926
|
+
|
|
2927
|
+
declare global {
|
|
2928
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
2929
|
+
interface SymbolConstructor {
|
|
2930
|
+
readonly observable: symbol;
|
|
2931
|
+
}
|
|
2932
|
+
}
|
|
2658
2933
|
|
|
2659
|
-
declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
2934
|
+
declare function createEventModule$2<T extends EventDefinition$2<any, string>>(eventDefinition: T): BuildEventDefinition$2<T> & T;
|
|
2660
2935
|
|
|
2661
|
-
declare const getReferralEvent: BuildRESTFunction<typeof getReferralEvent$1> & typeof getReferralEvent$1
|
|
2662
|
-
declare const queryReferralEvent: BuildRESTFunction<typeof queryReferralEvent$1> & typeof queryReferralEvent$1
|
|
2663
|
-
declare const getReferralStatistics: BuildRESTFunction<typeof getReferralStatistics$1> & typeof getReferralStatistics$1
|
|
2664
|
-
declare const queryReferringCustomerTotals: BuildRESTFunction<typeof queryReferringCustomerTotals$1> & typeof queryReferringCustomerTotals$1
|
|
2665
|
-
declare const queryReferredFriendActions: BuildRESTFunction<typeof queryReferredFriendActions$1> & typeof queryReferredFriendActions$1
|
|
2936
|
+
declare const getReferralEvent: MaybeContext<BuildRESTFunction<typeof getReferralEvent$1> & typeof getReferralEvent$1>;
|
|
2937
|
+
declare const queryReferralEvent: MaybeContext<BuildRESTFunction<typeof queryReferralEvent$1> & typeof queryReferralEvent$1>;
|
|
2938
|
+
declare const getReferralStatistics: MaybeContext<BuildRESTFunction<typeof getReferralStatistics$1> & typeof getReferralStatistics$1>;
|
|
2939
|
+
declare const queryReferringCustomerTotals: MaybeContext<BuildRESTFunction<typeof queryReferringCustomerTotals$1> & typeof queryReferringCustomerTotals$1>;
|
|
2940
|
+
declare const queryReferredFriendActions: MaybeContext<BuildRESTFunction<typeof queryReferredFriendActions$1> & typeof queryReferredFriendActions$1>;
|
|
2666
2941
|
|
|
2667
2942
|
type _publicOnReferralEventCreatedType = typeof onReferralEventCreated$1;
|
|
2668
2943
|
/** */
|
|
@@ -3342,8 +3617,8 @@ interface QueryReferralRewardsSignature {
|
|
|
3342
3617
|
(options?: QueryReferralRewardsOptions | undefined): ReferralRewardsQueryBuilder;
|
|
3343
3618
|
}
|
|
3344
3619
|
|
|
3345
|
-
declare const getReferralReward: BuildRESTFunction<typeof getReferralReward$1> & typeof getReferralReward$1
|
|
3346
|
-
declare const queryReferralRewards: BuildRESTFunction<typeof queryReferralRewards$1> & typeof queryReferralRewards$1
|
|
3620
|
+
declare const getReferralReward: MaybeContext<BuildRESTFunction<typeof getReferralReward$1> & typeof getReferralReward$1>;
|
|
3621
|
+
declare const queryReferralRewards: MaybeContext<BuildRESTFunction<typeof queryReferralRewards$1> & typeof queryReferralRewards$1>;
|
|
3347
3622
|
|
|
3348
3623
|
type index_d$2_BulkGetReferralRewardsRequest = BulkGetReferralRewardsRequest;
|
|
3349
3624
|
type index_d$2_BulkGetReferralRewardsResponse = BulkGetReferralRewardsResponse;
|
|
@@ -3950,18 +4225,36 @@ interface QueryReferredFriendSignature {
|
|
|
3950
4225
|
*/
|
|
3951
4226
|
(): ReferredFriendsQueryBuilder;
|
|
3952
4227
|
}
|
|
3953
|
-
declare const onReferredFriendCreated$1: EventDefinition<ReferredFriendCreatedEnvelope, "wix.loyalty.referral.v1.referred_friend_created">;
|
|
3954
|
-
declare const onReferredFriendUpdated$1: EventDefinition<ReferredFriendUpdatedEnvelope, "wix.loyalty.referral.v1.referred_friend_updated">;
|
|
3955
|
-
declare const onReferredFriendDeleted$1: EventDefinition<ReferredFriendDeletedEnvelope, "wix.loyalty.referral.v1.referred_friend_deleted">;
|
|
4228
|
+
declare const onReferredFriendCreated$1: EventDefinition$4<ReferredFriendCreatedEnvelope, "wix.loyalty.referral.v1.referred_friend_created">;
|
|
4229
|
+
declare const onReferredFriendUpdated$1: EventDefinition$4<ReferredFriendUpdatedEnvelope, "wix.loyalty.referral.v1.referred_friend_updated">;
|
|
4230
|
+
declare const onReferredFriendDeleted$1: EventDefinition$4<ReferredFriendDeletedEnvelope, "wix.loyalty.referral.v1.referred_friend_deleted">;
|
|
3956
4231
|
|
|
3957
|
-
|
|
4232
|
+
type EventDefinition$1<Payload = unknown, Type extends string = string> = {
|
|
4233
|
+
__type: 'event-definition';
|
|
4234
|
+
type: Type;
|
|
4235
|
+
isDomainEvent?: boolean;
|
|
4236
|
+
transformations?: (envelope: unknown) => Payload;
|
|
4237
|
+
__payload: Payload;
|
|
4238
|
+
};
|
|
4239
|
+
declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
|
|
4240
|
+
type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
|
|
4241
|
+
type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
|
|
3958
4242
|
|
|
3959
|
-
declare
|
|
3960
|
-
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
|
-
|
|
3964
|
-
|
|
4243
|
+
declare global {
|
|
4244
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
4245
|
+
interface SymbolConstructor {
|
|
4246
|
+
readonly observable: symbol;
|
|
4247
|
+
}
|
|
4248
|
+
}
|
|
4249
|
+
|
|
4250
|
+
declare function createEventModule$1<T extends EventDefinition$1<any, string>>(eventDefinition: T): BuildEventDefinition$1<T> & T;
|
|
4251
|
+
|
|
4252
|
+
declare const createReferredFriend: MaybeContext<BuildRESTFunction<typeof createReferredFriend$1> & typeof createReferredFriend$1>;
|
|
4253
|
+
declare const getReferredFriend: MaybeContext<BuildRESTFunction<typeof getReferredFriend$1> & typeof getReferredFriend$1>;
|
|
4254
|
+
declare const getReferredFriendByContactId: MaybeContext<BuildRESTFunction<typeof getReferredFriendByContactId$1> & typeof getReferredFriendByContactId$1>;
|
|
4255
|
+
declare const updateReferredFriend: MaybeContext<BuildRESTFunction<typeof updateReferredFriend$1> & typeof updateReferredFriend$1>;
|
|
4256
|
+
declare const deleteReferredFriend: MaybeContext<BuildRESTFunction<typeof deleteReferredFriend$1> & typeof deleteReferredFriend$1>;
|
|
4257
|
+
declare const queryReferredFriend: MaybeContext<BuildRESTFunction<typeof queryReferredFriend$1> & typeof queryReferredFriend$1>;
|
|
3965
4258
|
|
|
3966
4259
|
type _publicOnReferredFriendCreatedType = typeof onReferredFriendCreated$1;
|
|
3967
4260
|
/** */
|
|
@@ -4480,16 +4773,34 @@ interface DeleteReferringCustomerSignature {
|
|
|
4480
4773
|
*/
|
|
4481
4774
|
(referringCustomerId: string, options?: DeleteReferringCustomerOptions | undefined): Promise<void>;
|
|
4482
4775
|
}
|
|
4483
|
-
declare const onReferringCustomerCreated$1: EventDefinition<ReferringCustomerCreatedEnvelope, "wix.loyalty.referral.v1.referring_customer_created">;
|
|
4484
|
-
declare const onReferringCustomerDeleted$1: EventDefinition<ReferringCustomerDeletedEnvelope, "wix.loyalty.referral.v1.referring_customer_deleted">;
|
|
4776
|
+
declare const onReferringCustomerCreated$1: EventDefinition$4<ReferringCustomerCreatedEnvelope, "wix.loyalty.referral.v1.referring_customer_created">;
|
|
4777
|
+
declare const onReferringCustomerDeleted$1: EventDefinition$4<ReferringCustomerDeletedEnvelope, "wix.loyalty.referral.v1.referring_customer_deleted">;
|
|
4778
|
+
|
|
4779
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
4780
|
+
__type: 'event-definition';
|
|
4781
|
+
type: Type;
|
|
4782
|
+
isDomainEvent?: boolean;
|
|
4783
|
+
transformations?: (envelope: unknown) => Payload;
|
|
4784
|
+
__payload: Payload;
|
|
4785
|
+
};
|
|
4786
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
4787
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
4788
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
4789
|
+
|
|
4790
|
+
declare global {
|
|
4791
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
4792
|
+
interface SymbolConstructor {
|
|
4793
|
+
readonly observable: symbol;
|
|
4794
|
+
}
|
|
4795
|
+
}
|
|
4485
4796
|
|
|
4486
4797
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
4487
4798
|
|
|
4488
|
-
declare const generateReferringCustomerForContact: BuildRESTFunction<typeof generateReferringCustomerForContact$1> & typeof generateReferringCustomerForContact$1
|
|
4489
|
-
declare const getReferringCustomer: BuildRESTFunction<typeof getReferringCustomer$1> & typeof getReferringCustomer$1
|
|
4490
|
-
declare const getReferringCustomerByReferralCode: BuildRESTFunction<typeof getReferringCustomerByReferralCode$1> & typeof getReferringCustomerByReferralCode$1
|
|
4491
|
-
declare const queryReferringCustomers: BuildRESTFunction<typeof queryReferringCustomers$1> & typeof queryReferringCustomers$1
|
|
4492
|
-
declare const deleteReferringCustomer: BuildRESTFunction<typeof deleteReferringCustomer$1> & typeof deleteReferringCustomer$1
|
|
4799
|
+
declare const generateReferringCustomerForContact: MaybeContext<BuildRESTFunction<typeof generateReferringCustomerForContact$1> & typeof generateReferringCustomerForContact$1>;
|
|
4800
|
+
declare const getReferringCustomer: MaybeContext<BuildRESTFunction<typeof getReferringCustomer$1> & typeof getReferringCustomer$1>;
|
|
4801
|
+
declare const getReferringCustomerByReferralCode: MaybeContext<BuildRESTFunction<typeof getReferringCustomerByReferralCode$1> & typeof getReferringCustomerByReferralCode$1>;
|
|
4802
|
+
declare const queryReferringCustomers: MaybeContext<BuildRESTFunction<typeof queryReferringCustomers$1> & typeof queryReferringCustomers$1>;
|
|
4803
|
+
declare const deleteReferringCustomer: MaybeContext<BuildRESTFunction<typeof deleteReferringCustomer$1> & typeof deleteReferringCustomer$1>;
|
|
4493
4804
|
|
|
4494
4805
|
type _publicOnReferringCustomerCreatedType = typeof onReferringCustomerCreated$1;
|
|
4495
4806
|
/** */
|