@wix/domains 1.0.53 → 1.0.55
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/es/package.json +3 -0
- package/meta/package.json +1 -5
- package/package.json +23 -20
- package/build/cjs/context.d.ts +0 -5
- package/build/cjs/context.js +0 -32
- package/build/cjs/context.js.map +0 -1
- package/build/es/context.d.ts +0 -5
- package/build/es/context.js +0 -6
- package/build/es/context.js.map +0 -1
- package/context/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -1843
- package/type-bundles/index.bundle.d.ts +0 -1843
- package/type-bundles/meta.bundle.d.ts +0 -1477
|
@@ -1,1843 +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
|
-
/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
|
|
480
|
-
interface ConnectedDomain {
|
|
481
|
-
/**
|
|
482
|
-
* ID of the connected domain. Identical to the domain name including TLD.
|
|
483
|
-
* @readonly
|
|
484
|
-
*/
|
|
485
|
-
_id?: string;
|
|
486
|
-
/**
|
|
487
|
-
* Domain name including TLD.
|
|
488
|
-
* Both root domains and subdomains are supported.
|
|
489
|
-
*/
|
|
490
|
-
domain?: string;
|
|
491
|
-
/** How the domain is connected to the Wix site. */
|
|
492
|
-
connectionType?: ConnectionType$1;
|
|
493
|
-
/**
|
|
494
|
-
* Information about the site to which the domain is assigned, and whether
|
|
495
|
-
* it's the primary domain or a redirect.
|
|
496
|
-
*/
|
|
497
|
-
siteInfo?: SiteInfo;
|
|
498
|
-
/**
|
|
499
|
-
* Whether the site owner receives standard email notifications from Wix about
|
|
500
|
-
* the connected domain.
|
|
501
|
-
*
|
|
502
|
-
* Default: `false`
|
|
503
|
-
*/
|
|
504
|
-
suppressNotifications?: boolean;
|
|
505
|
-
/**
|
|
506
|
-
* DNS propagation status.
|
|
507
|
-
* @readonly
|
|
508
|
-
*/
|
|
509
|
-
dnsPropagationStatus?: DnsPropagationStatus;
|
|
510
|
-
/**
|
|
511
|
-
* Date and time the `connectedDomain` object was created in
|
|
512
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
513
|
-
* @readonly
|
|
514
|
-
*/
|
|
515
|
-
_createdDate?: Date | null;
|
|
516
|
-
/**
|
|
517
|
-
* Date and time the `connectedDomain` object was last updated in
|
|
518
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
519
|
-
* @readonly
|
|
520
|
-
*/
|
|
521
|
-
_updatedDate?: Date | null;
|
|
522
|
-
}
|
|
523
|
-
declare enum ConnectionType$1 {
|
|
524
|
-
/** There is no information about the connection type. */
|
|
525
|
-
UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
|
|
526
|
-
/** The domain is connected by pointing. Wix doesn't manage DNS information. */
|
|
527
|
-
POINTING = "POINTING",
|
|
528
|
-
/** The domain is connected by nameservers. Wix manages DNS information. */
|
|
529
|
-
NAMESERVERS = "NAMESERVERS",
|
|
530
|
-
/** The domain isn't visible to site visitors. */
|
|
531
|
-
HIDDEN = "HIDDEN"
|
|
532
|
-
}
|
|
533
|
-
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
534
|
-
/**
|
|
535
|
-
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
536
|
-
* @readonly
|
|
537
|
-
*/
|
|
538
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
539
|
-
/**
|
|
540
|
-
* ID of the site to which the domain is assigned.
|
|
541
|
-
* @readonly
|
|
542
|
-
*/
|
|
543
|
-
_id?: string | null;
|
|
544
|
-
/**
|
|
545
|
-
* The relationship assigned for this domain to the site.
|
|
546
|
-
*
|
|
547
|
-
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
548
|
-
*/
|
|
549
|
-
assignmentType?: AssignmentType;
|
|
550
|
-
}
|
|
551
|
-
/** @oneof */
|
|
552
|
-
interface SiteInfoAssignmentInfoOneOf {
|
|
553
|
-
/**
|
|
554
|
-
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
555
|
-
* @readonly
|
|
556
|
-
*/
|
|
557
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
558
|
-
}
|
|
559
|
-
declare enum AssignmentType {
|
|
560
|
-
/** There is no information about the domain assignment type. */
|
|
561
|
-
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
562
|
-
/** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */
|
|
563
|
-
PRIMARY = "PRIMARY",
|
|
564
|
-
/** A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain. */
|
|
565
|
-
REDIRECT = "REDIRECT"
|
|
566
|
-
}
|
|
567
|
-
interface RedirectAssignmentInfo {
|
|
568
|
-
/**
|
|
569
|
-
* Primary domain to which this domain will redirect.
|
|
570
|
-
* @readonly
|
|
571
|
-
*/
|
|
572
|
-
primaryDomain?: string;
|
|
573
|
-
}
|
|
574
|
-
declare enum DnsPropagationStatus {
|
|
575
|
-
/** There's no information about the domain's DNS propagation status. */
|
|
576
|
-
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
577
|
-
/** The domain's DNS propagation process has successfully finished. */
|
|
578
|
-
COMPLETED = "COMPLETED",
|
|
579
|
-
/** The domain's DNS propagation process has failed. */
|
|
580
|
-
FAILED = "FAILED",
|
|
581
|
-
/** The domain's DNS propagation process has started but hasn't successfully completed yet. */
|
|
582
|
-
IN_PROGRESS = "IN_PROGRESS"
|
|
583
|
-
}
|
|
584
|
-
interface DomainRemovedEvent$1 {
|
|
585
|
-
/**
|
|
586
|
-
* Domain name including TLD.
|
|
587
|
-
* Both root domains and subdomains are supported.
|
|
588
|
-
*/
|
|
589
|
-
domain?: string;
|
|
590
|
-
}
|
|
591
|
-
interface CreateConnectedDomainRequest {
|
|
592
|
-
/** Domain to connect. */
|
|
593
|
-
connectedDomain: ConnectedDomain;
|
|
594
|
-
}
|
|
595
|
-
interface CreateConnectedDomainResponse {
|
|
596
|
-
/** Connected domain. */
|
|
597
|
-
connectedDomain?: ConnectedDomain;
|
|
598
|
-
}
|
|
599
|
-
interface GetConnectedDomainRequest {
|
|
600
|
-
/** ID of the connected domain. Identical to the domain name including TLD. */
|
|
601
|
-
connectedDomainId: string;
|
|
602
|
-
}
|
|
603
|
-
interface GetConnectedDomainResponse {
|
|
604
|
-
/** Retrieved connected domain. */
|
|
605
|
-
connectedDomain?: ConnectedDomain;
|
|
606
|
-
}
|
|
607
|
-
interface DeleteConnectedDomainRequest {
|
|
608
|
-
/** ID of the connected domain to delete. Identical to the domain name including TLD. */
|
|
609
|
-
connectedDomainId: string;
|
|
610
|
-
}
|
|
611
|
-
interface DeleteConnectedDomainResponse {
|
|
612
|
-
}
|
|
613
|
-
interface ListConnectedDomainsRequest {
|
|
614
|
-
/** Cursor paging options. */
|
|
615
|
-
paging?: CursorPaging$1;
|
|
616
|
-
}
|
|
617
|
-
interface CursorPaging$1 {
|
|
618
|
-
/**
|
|
619
|
-
* Number of domains to load.
|
|
620
|
-
*
|
|
621
|
-
* Min: `0`
|
|
622
|
-
* Max: `100`
|
|
623
|
-
*/
|
|
624
|
-
limit?: number | null;
|
|
625
|
-
/**
|
|
626
|
-
* Pointer to the next or previous page in the list of results.
|
|
627
|
-
*
|
|
628
|
-
* You can get the relevant cursor token
|
|
629
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
630
|
-
* Not relevant for the first request.
|
|
631
|
-
*/
|
|
632
|
-
cursor?: string | null;
|
|
633
|
-
}
|
|
634
|
-
interface ListConnectedDomainsResponse {
|
|
635
|
-
/** Metadata about the returned list of connected domains. */
|
|
636
|
-
pagingMetadata?: CursorPagingMetadata$1;
|
|
637
|
-
/** Retrieved connected domains. */
|
|
638
|
-
connectedDomains?: ConnectedDomain[];
|
|
639
|
-
}
|
|
640
|
-
interface CursorPagingMetadata$1 {
|
|
641
|
-
/** Number of domains returned in the response. */
|
|
642
|
-
count?: number | null;
|
|
643
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
644
|
-
cursors?: Cursors$1;
|
|
645
|
-
/**
|
|
646
|
-
* Indicates if there are more results after the current page.
|
|
647
|
-
* If `true`, another page of results can be retrieved.
|
|
648
|
-
* If `false`, this is the last page.
|
|
649
|
-
*/
|
|
650
|
-
hasNext?: boolean | null;
|
|
651
|
-
}
|
|
652
|
-
interface Cursors$1 {
|
|
653
|
-
/** Cursor pointing to next page in the list of results. */
|
|
654
|
-
next?: string | null;
|
|
655
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
656
|
-
prev?: string | null;
|
|
657
|
-
}
|
|
658
|
-
interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
|
659
|
-
createdEvent?: EntityCreatedEvent$1;
|
|
660
|
-
updatedEvent?: EntityUpdatedEvent$1;
|
|
661
|
-
deletedEvent?: EntityDeletedEvent$1;
|
|
662
|
-
actionEvent?: ActionEvent$1;
|
|
663
|
-
/**
|
|
664
|
-
* Unique event ID.
|
|
665
|
-
* Allows clients to ignore duplicate webhooks.
|
|
666
|
-
*/
|
|
667
|
-
_id?: string;
|
|
668
|
-
/**
|
|
669
|
-
* Assumes actions are also always typed to an entity_type
|
|
670
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
671
|
-
*/
|
|
672
|
-
entityFqdn?: string;
|
|
673
|
-
/**
|
|
674
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
675
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
676
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
677
|
-
*/
|
|
678
|
-
slug?: string;
|
|
679
|
-
/** ID of the entity associated with the event. */
|
|
680
|
-
entityId?: string;
|
|
681
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
682
|
-
eventTime?: Date | null;
|
|
683
|
-
/**
|
|
684
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
685
|
-
* (for example, GDPR).
|
|
686
|
-
*/
|
|
687
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
688
|
-
/** If present, indicates the action that triggered the event. */
|
|
689
|
-
originatedFrom?: string | null;
|
|
690
|
-
/**
|
|
691
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
692
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
693
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
694
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
695
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
696
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
697
|
-
*/
|
|
698
|
-
entityEventSequence?: string | null;
|
|
699
|
-
}
|
|
700
|
-
/** @oneof */
|
|
701
|
-
interface DomainEventBodyOneOf$1 {
|
|
702
|
-
createdEvent?: EntityCreatedEvent$1;
|
|
703
|
-
updatedEvent?: EntityUpdatedEvent$1;
|
|
704
|
-
deletedEvent?: EntityDeletedEvent$1;
|
|
705
|
-
actionEvent?: ActionEvent$1;
|
|
706
|
-
}
|
|
707
|
-
interface EntityCreatedEvent$1 {
|
|
708
|
-
entity?: string;
|
|
709
|
-
}
|
|
710
|
-
interface RestoreInfo$1 {
|
|
711
|
-
deletedDate?: Date | null;
|
|
712
|
-
}
|
|
713
|
-
interface EntityUpdatedEvent$1 {
|
|
714
|
-
/**
|
|
715
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
716
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
717
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
718
|
-
*/
|
|
719
|
-
currentEntity?: string;
|
|
720
|
-
}
|
|
721
|
-
interface EntityDeletedEvent$1 {
|
|
722
|
-
/** Entity that was deleted */
|
|
723
|
-
deletedEntity?: string | null;
|
|
724
|
-
}
|
|
725
|
-
interface ActionEvent$1 {
|
|
726
|
-
body?: string;
|
|
727
|
-
}
|
|
728
|
-
interface MessageEnvelope$1 {
|
|
729
|
-
/** App instance ID. */
|
|
730
|
-
instanceId?: string | null;
|
|
731
|
-
/** Event type. */
|
|
732
|
-
eventType?: string;
|
|
733
|
-
/** The identification type and identity data. */
|
|
734
|
-
identity?: IdentificationData$1;
|
|
735
|
-
/** Stringify payload. */
|
|
736
|
-
data?: string;
|
|
737
|
-
}
|
|
738
|
-
interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
|
739
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
740
|
-
anonymousVisitorId?: string;
|
|
741
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
742
|
-
memberId?: string;
|
|
743
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
744
|
-
wixUserId?: string;
|
|
745
|
-
/** ID of an app. */
|
|
746
|
-
appId?: string;
|
|
747
|
-
/** @readonly */
|
|
748
|
-
identityType?: WebhookIdentityType$1;
|
|
749
|
-
}
|
|
750
|
-
/** @oneof */
|
|
751
|
-
interface IdentificationDataIdOneOf$1 {
|
|
752
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
753
|
-
anonymousVisitorId?: string;
|
|
754
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
755
|
-
memberId?: string;
|
|
756
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
757
|
-
wixUserId?: string;
|
|
758
|
-
/** ID of an app. */
|
|
759
|
-
appId?: string;
|
|
760
|
-
}
|
|
761
|
-
declare enum WebhookIdentityType$1 {
|
|
762
|
-
UNKNOWN = "UNKNOWN",
|
|
763
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
764
|
-
MEMBER = "MEMBER",
|
|
765
|
-
WIX_USER = "WIX_USER",
|
|
766
|
-
APP = "APP"
|
|
767
|
-
}
|
|
768
|
-
interface RedirectAssignmentInfoNonNullableFields {
|
|
769
|
-
primaryDomain: string;
|
|
770
|
-
}
|
|
771
|
-
interface SiteInfoNonNullableFields {
|
|
772
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields;
|
|
773
|
-
assignmentType: AssignmentType;
|
|
774
|
-
}
|
|
775
|
-
interface ConnectedDomainNonNullableFields {
|
|
776
|
-
_id: string;
|
|
777
|
-
domain: string;
|
|
778
|
-
connectionType: ConnectionType$1;
|
|
779
|
-
siteInfo?: SiteInfoNonNullableFields;
|
|
780
|
-
suppressNotifications: boolean;
|
|
781
|
-
dnsPropagationStatus: DnsPropagationStatus;
|
|
782
|
-
}
|
|
783
|
-
interface CreateConnectedDomainResponseNonNullableFields {
|
|
784
|
-
connectedDomain?: ConnectedDomainNonNullableFields;
|
|
785
|
-
}
|
|
786
|
-
interface GetConnectedDomainResponseNonNullableFields {
|
|
787
|
-
connectedDomain?: ConnectedDomainNonNullableFields;
|
|
788
|
-
}
|
|
789
|
-
interface ListConnectedDomainsResponseNonNullableFields {
|
|
790
|
-
connectedDomains: ConnectedDomainNonNullableFields[];
|
|
791
|
-
}
|
|
792
|
-
interface ListConnectedDomainsOptions {
|
|
793
|
-
/** Cursor paging options. */
|
|
794
|
-
paging?: CursorPaging$1;
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
declare function createConnectedDomain$1(httpClient: HttpClient): CreateConnectedDomainSignature;
|
|
798
|
-
interface CreateConnectedDomainSignature {
|
|
799
|
-
/**
|
|
800
|
-
* Creates a `connectedDomain` object and starts the domain connection process. It may take up to 48 hours for the DNS changes to take effect.
|
|
801
|
-
*
|
|
802
|
-
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header.
|
|
803
|
-
*
|
|
804
|
-
* You can only connect external domains using this endpoint.
|
|
805
|
-
*
|
|
806
|
-
* You can connect both root domains and subdomains to Wix sites.
|
|
807
|
-
*
|
|
808
|
-
* The domain can be assigned as a primary domain or a redirect. You can read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains). If you connect a domain as `"PRIMARY"` to a Wix site, the existing primary domain automatically becomes unassigned.
|
|
809
|
-
*
|
|
810
|
-
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
811
|
-
* @param - Domain to connect.
|
|
812
|
-
* @returns Connected domain.
|
|
813
|
-
*/
|
|
814
|
-
(connectedDomain: ConnectedDomain): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
815
|
-
}
|
|
816
|
-
declare function getConnectedDomain$1(httpClient: HttpClient): GetConnectedDomainSignature;
|
|
817
|
-
interface GetConnectedDomainSignature {
|
|
818
|
-
/**
|
|
819
|
-
* Retrieves a connected domain.
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
823
|
-
*
|
|
824
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
825
|
-
* @param - ID of the connected domain. Identical to the domain name including TLD.
|
|
826
|
-
* @returns Retrieved connected domain.
|
|
827
|
-
*/
|
|
828
|
-
(connectedDomainId: string): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
829
|
-
}
|
|
830
|
-
declare function deleteConnectedDomain$1(httpClient: HttpClient): DeleteConnectedDomainSignature;
|
|
831
|
-
interface DeleteConnectedDomainSignature {
|
|
832
|
-
/**
|
|
833
|
-
* Deletes a `connectedDomain` object and removes related DNS records from
|
|
834
|
-
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
838
|
-
*
|
|
839
|
-
* If you delete a `"PRIMARY"` domain, the site automatically uses the standard
|
|
840
|
-
* URL for free Wix sites. Read more about
|
|
841
|
-
* [URLs of free Wix sites](https://support.wix.com/en/article/changing-your-free-wix-url-8591528).
|
|
842
|
-
*
|
|
843
|
-
* When you delete a subdomain, its CNAME record is deleted from Google's Cloud DNS.
|
|
844
|
-
*
|
|
845
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
846
|
-
* @param - ID of the connected domain to delete. Identical to the domain name including TLD.
|
|
847
|
-
*/
|
|
848
|
-
(connectedDomainId: string): Promise<void>;
|
|
849
|
-
}
|
|
850
|
-
declare function listConnectedDomains$1(httpClient: HttpClient): ListConnectedDomainsSignature;
|
|
851
|
-
interface ListConnectedDomainsSignature {
|
|
852
|
-
/**
|
|
853
|
-
* Retrieves a list of up to 100 connected domains.
|
|
854
|
-
*
|
|
855
|
-
*
|
|
856
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
857
|
-
*
|
|
858
|
-
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
859
|
-
*
|
|
860
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
861
|
-
* @param - Filter options.
|
|
862
|
-
*/
|
|
863
|
-
(options?: ListConnectedDomainsOptions | undefined): Promise<ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields>;
|
|
864
|
-
}
|
|
865
|
-
|
|
866
|
-
declare const createConnectedDomain: MaybeContext<BuildRESTFunction<typeof createConnectedDomain$1> & typeof createConnectedDomain$1>;
|
|
867
|
-
declare const getConnectedDomain: MaybeContext<BuildRESTFunction<typeof getConnectedDomain$1> & typeof getConnectedDomain$1>;
|
|
868
|
-
declare const deleteConnectedDomain: MaybeContext<BuildRESTFunction<typeof deleteConnectedDomain$1> & typeof deleteConnectedDomain$1>;
|
|
869
|
-
declare const listConnectedDomains: MaybeContext<BuildRESTFunction<typeof listConnectedDomains$1> & typeof listConnectedDomains$1>;
|
|
870
|
-
|
|
871
|
-
type context$4_AssignmentType = AssignmentType;
|
|
872
|
-
declare const context$4_AssignmentType: typeof AssignmentType;
|
|
873
|
-
type context$4_ConnectedDomain = ConnectedDomain;
|
|
874
|
-
type context$4_ConnectedDomainNonNullableFields = ConnectedDomainNonNullableFields;
|
|
875
|
-
type context$4_CreateConnectedDomainRequest = CreateConnectedDomainRequest;
|
|
876
|
-
type context$4_CreateConnectedDomainResponse = CreateConnectedDomainResponse;
|
|
877
|
-
type context$4_CreateConnectedDomainResponseNonNullableFields = CreateConnectedDomainResponseNonNullableFields;
|
|
878
|
-
type context$4_DeleteConnectedDomainRequest = DeleteConnectedDomainRequest;
|
|
879
|
-
type context$4_DeleteConnectedDomainResponse = DeleteConnectedDomainResponse;
|
|
880
|
-
type context$4_DnsPropagationStatus = DnsPropagationStatus;
|
|
881
|
-
declare const context$4_DnsPropagationStatus: typeof DnsPropagationStatus;
|
|
882
|
-
type context$4_GetConnectedDomainRequest = GetConnectedDomainRequest;
|
|
883
|
-
type context$4_GetConnectedDomainResponse = GetConnectedDomainResponse;
|
|
884
|
-
type context$4_GetConnectedDomainResponseNonNullableFields = GetConnectedDomainResponseNonNullableFields;
|
|
885
|
-
type context$4_ListConnectedDomainsOptions = ListConnectedDomainsOptions;
|
|
886
|
-
type context$4_ListConnectedDomainsRequest = ListConnectedDomainsRequest;
|
|
887
|
-
type context$4_ListConnectedDomainsResponse = ListConnectedDomainsResponse;
|
|
888
|
-
type context$4_ListConnectedDomainsResponseNonNullableFields = ListConnectedDomainsResponseNonNullableFields;
|
|
889
|
-
type context$4_RedirectAssignmentInfo = RedirectAssignmentInfo;
|
|
890
|
-
type context$4_SiteInfo = SiteInfo;
|
|
891
|
-
type context$4_SiteInfoAssignmentInfoOneOf = SiteInfoAssignmentInfoOneOf;
|
|
892
|
-
declare const context$4_createConnectedDomain: typeof createConnectedDomain;
|
|
893
|
-
declare const context$4_deleteConnectedDomain: typeof deleteConnectedDomain;
|
|
894
|
-
declare const context$4_getConnectedDomain: typeof getConnectedDomain;
|
|
895
|
-
declare const context$4_listConnectedDomains: typeof listConnectedDomains;
|
|
896
|
-
declare namespace context$4 {
|
|
897
|
-
export { type ActionEvent$1 as ActionEvent, context$4_AssignmentType as AssignmentType, type context$4_ConnectedDomain as ConnectedDomain, type context$4_ConnectedDomainNonNullableFields as ConnectedDomainNonNullableFields, ConnectionType$1 as ConnectionType, type context$4_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type context$4_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type context$4_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type context$4_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type context$4_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, context$4_DnsPropagationStatus as DnsPropagationStatus, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type context$4_GetConnectedDomainRequest as GetConnectedDomainRequest, type context$4_GetConnectedDomainResponse as GetConnectedDomainResponse, type context$4_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type context$4_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type context$4_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type context$4_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type context$4_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$4_RedirectAssignmentInfo as RedirectAssignmentInfo, type RestoreInfo$1 as RestoreInfo, type context$4_SiteInfo as SiteInfo, type context$4_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$1 as WebhookIdentityType, context$4_createConnectedDomain as createConnectedDomain, context$4_deleteConnectedDomain as deleteConnectedDomain, context$4_getConnectedDomain as getConnectedDomain, context$4_listConnectedDomains as listConnectedDomains };
|
|
898
|
-
}
|
|
899
|
-
|
|
900
|
-
/**
|
|
901
|
-
* A `connectedDomainSetupInfo` object holds information the connected domain's
|
|
902
|
-
* external registrar and some DNS records. You can use this information to guide
|
|
903
|
-
* the site owner through the domain's setup process.
|
|
904
|
-
*/
|
|
905
|
-
interface ConnectedDomainSetupInfo extends ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
906
|
-
/**
|
|
907
|
-
* Information about domains connected using nameservers. Available only for
|
|
908
|
-
* `{"connectionType": "NAMESERVERS"}`.
|
|
909
|
-
*/
|
|
910
|
-
nameserverRecord?: NameserverRecord;
|
|
911
|
-
/**
|
|
912
|
-
* Information about domains connected by pointing. Available only for
|
|
913
|
-
* `{"connectionType": "POINTING"}`.
|
|
914
|
-
* @readonly
|
|
915
|
-
*/
|
|
916
|
-
pointingRecords?: PointingRecords;
|
|
917
|
-
/**
|
|
918
|
-
* Information about subdomains. Available only for subdomains.
|
|
919
|
-
* @readonly
|
|
920
|
-
*/
|
|
921
|
-
subdomainRecords?: SubdomainRecords;
|
|
922
|
-
/** ID of the connected domain. Identical to the domain name including TLD. */
|
|
923
|
-
connectedDomainId?: string;
|
|
924
|
-
/**
|
|
925
|
-
* Information about the external domain registrar including current name
|
|
926
|
-
* servers.
|
|
927
|
-
*/
|
|
928
|
-
registrar?: Registrar;
|
|
929
|
-
}
|
|
930
|
-
/** @oneof */
|
|
931
|
-
interface ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
932
|
-
/**
|
|
933
|
-
* Information about domains connected using nameservers. Available only for
|
|
934
|
-
* `{"connectionType": "NAMESERVERS"}`.
|
|
935
|
-
*/
|
|
936
|
-
nameserverRecord?: NameserverRecord;
|
|
937
|
-
/**
|
|
938
|
-
* Information about domains connected by pointing. Available only for
|
|
939
|
-
* `{"connectionType": "POINTING"}`.
|
|
940
|
-
* @readonly
|
|
941
|
-
*/
|
|
942
|
-
pointingRecords?: PointingRecords;
|
|
943
|
-
/**
|
|
944
|
-
* Information about subdomains. Available only for subdomains.
|
|
945
|
-
* @readonly
|
|
946
|
-
*/
|
|
947
|
-
subdomainRecords?: SubdomainRecords;
|
|
948
|
-
}
|
|
949
|
-
interface Registrar {
|
|
950
|
-
/**
|
|
951
|
-
* Name of the external domain registrar. For subdomains it's the registrar of the root domain.
|
|
952
|
-
* @readonly
|
|
953
|
-
*/
|
|
954
|
-
name?: string | null;
|
|
955
|
-
/**
|
|
956
|
-
* Values of the current name server records. In case you connect an external
|
|
957
|
-
* domain using name servers, site owners must replace these current name servers
|
|
958
|
-
* with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
|
|
959
|
-
* during the initial domain setup.
|
|
960
|
-
* The replacement can't be performed through Wix APIs, you must use the
|
|
961
|
-
* infrastructure of the external domain registrar. Read more about
|
|
962
|
-
* [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
|
|
963
|
-
* @readonly
|
|
964
|
-
*/
|
|
965
|
-
nameServers?: string[];
|
|
966
|
-
}
|
|
967
|
-
/** Information about domains connected by nameservers. */
|
|
968
|
-
interface NameserverRecord {
|
|
969
|
-
/**
|
|
970
|
-
* Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
|
|
971
|
-
* @readonly
|
|
972
|
-
*/
|
|
973
|
-
nsRecord?: NsRecord;
|
|
974
|
-
}
|
|
975
|
-
interface NsRecord {
|
|
976
|
-
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
977
|
-
hostName?: string;
|
|
978
|
-
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
979
|
-
ttl?: number;
|
|
980
|
-
/** DNS record values. */
|
|
981
|
-
values?: string[];
|
|
982
|
-
}
|
|
983
|
-
/** Information about domains connected by pointing. */
|
|
984
|
-
interface PointingRecords {
|
|
985
|
-
/**
|
|
986
|
-
* [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
|
|
987
|
-
* @readonly
|
|
988
|
-
*/
|
|
989
|
-
aRecord?: ARecord;
|
|
990
|
-
/**
|
|
991
|
-
* [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
|
|
992
|
-
* @readonly
|
|
993
|
-
*/
|
|
994
|
-
cnameRecord?: CnameRecord;
|
|
995
|
-
}
|
|
996
|
-
interface ARecord {
|
|
997
|
-
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
998
|
-
hostName?: string;
|
|
999
|
-
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
1000
|
-
ttl?: number;
|
|
1001
|
-
/** DNS record values. */
|
|
1002
|
-
values?: string[];
|
|
1003
|
-
}
|
|
1004
|
-
interface CnameRecord {
|
|
1005
|
-
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
1006
|
-
hostName?: string;
|
|
1007
|
-
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
1008
|
-
ttl?: number;
|
|
1009
|
-
/** DNS record value. */
|
|
1010
|
-
value?: string;
|
|
1011
|
-
}
|
|
1012
|
-
/** Information about subdomains. */
|
|
1013
|
-
interface SubdomainRecords {
|
|
1014
|
-
/**
|
|
1015
|
-
* [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
|
|
1016
|
-
* @readonly
|
|
1017
|
-
*/
|
|
1018
|
-
cnameRecords?: CnameRecord[];
|
|
1019
|
-
}
|
|
1020
|
-
interface GetSetupInfoRequest {
|
|
1021
|
-
/** Domain name including TLD */
|
|
1022
|
-
domain?: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* How the domain should be to connected the Wix site.
|
|
1025
|
-
*
|
|
1026
|
-
* + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
|
|
1027
|
-
* + `"POINTING"`: Get domain or subdomain setup by pointing
|
|
1028
|
-
* + `"NAMESERVERS"`: Get domain setup by nameservers
|
|
1029
|
-
* + `"HIDDEN"`: supported only for subdomain.
|
|
1030
|
-
*/
|
|
1031
|
-
connectionType?: ConnectionType;
|
|
1032
|
-
/** Whether to return registrar information or not. Default is false. */
|
|
1033
|
-
includeRegistrar?: boolean;
|
|
1034
|
-
}
|
|
1035
|
-
declare enum ConnectionType {
|
|
1036
|
-
/** Used by sub domain */
|
|
1037
|
-
UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
|
|
1038
|
-
POINTING = "POINTING",
|
|
1039
|
-
NAMESERVERS = "NAMESERVERS",
|
|
1040
|
-
/**
|
|
1041
|
-
* internal used by photography company.
|
|
1042
|
-
* when a customer creates a photo album, each album has its sub domain and this sub domain
|
|
1043
|
-
* is not visible in my domains page.
|
|
1044
|
-
*/
|
|
1045
|
-
HIDDEN = "HIDDEN"
|
|
1046
|
-
}
|
|
1047
|
-
interface GetSetupInfoResponse {
|
|
1048
|
-
/** Retrieved setup information. */
|
|
1049
|
-
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
1050
|
-
}
|
|
1051
|
-
interface PreCreateConnectedDomainRequest {
|
|
1052
|
-
/** Domain name including TLD */
|
|
1053
|
-
domain?: string;
|
|
1054
|
-
}
|
|
1055
|
-
interface PreCreateConnectedDomainResponse {
|
|
1056
|
-
}
|
|
1057
|
-
interface GetConnectedDomainSetupInfoRequest {
|
|
1058
|
-
/**
|
|
1059
|
-
* ID of the connected domain to retrieve setup information for.
|
|
1060
|
-
* Identical to the domain name including TLD.
|
|
1061
|
-
*/
|
|
1062
|
-
connectedDomainId: string;
|
|
1063
|
-
}
|
|
1064
|
-
interface GetConnectedDomainSetupInfoResponse {
|
|
1065
|
-
/** Retrieved setup information. */
|
|
1066
|
-
connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
|
|
1067
|
-
}
|
|
1068
|
-
interface NsRecordNonNullableFields {
|
|
1069
|
-
hostName: string;
|
|
1070
|
-
ttl: number;
|
|
1071
|
-
values: string[];
|
|
1072
|
-
}
|
|
1073
|
-
interface NameserverRecordNonNullableFields {
|
|
1074
|
-
nsRecord?: NsRecordNonNullableFields;
|
|
1075
|
-
}
|
|
1076
|
-
interface ARecordNonNullableFields {
|
|
1077
|
-
hostName: string;
|
|
1078
|
-
ttl: number;
|
|
1079
|
-
values: string[];
|
|
1080
|
-
}
|
|
1081
|
-
interface CnameRecordNonNullableFields {
|
|
1082
|
-
hostName: string;
|
|
1083
|
-
ttl: number;
|
|
1084
|
-
value: string;
|
|
1085
|
-
}
|
|
1086
|
-
interface PointingRecordsNonNullableFields {
|
|
1087
|
-
aRecord?: ARecordNonNullableFields;
|
|
1088
|
-
cnameRecord?: CnameRecordNonNullableFields;
|
|
1089
|
-
}
|
|
1090
|
-
interface SubdomainRecordsNonNullableFields {
|
|
1091
|
-
cnameRecords: CnameRecordNonNullableFields[];
|
|
1092
|
-
}
|
|
1093
|
-
interface RegistrarNonNullableFields {
|
|
1094
|
-
nameServers: string[];
|
|
1095
|
-
}
|
|
1096
|
-
interface ConnectedDomainSetupInfoNonNullableFields {
|
|
1097
|
-
nameserverRecord?: NameserverRecordNonNullableFields;
|
|
1098
|
-
pointingRecords?: PointingRecordsNonNullableFields;
|
|
1099
|
-
subdomainRecords?: SubdomainRecordsNonNullableFields;
|
|
1100
|
-
connectedDomainId: string;
|
|
1101
|
-
registrar?: RegistrarNonNullableFields;
|
|
1102
|
-
}
|
|
1103
|
-
interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
1104
|
-
connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
|
|
1105
|
-
}
|
|
1106
|
-
|
|
1107
|
-
declare function getConnectedDomainSetupInfo$1(httpClient: HttpClient): GetConnectedDomainSetupInfoSignature;
|
|
1108
|
-
interface GetConnectedDomainSetupInfoSignature {
|
|
1109
|
-
/**
|
|
1110
|
-
* Retrieves information for the initial setup of a connected domain.
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1113
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
1114
|
-
*
|
|
1115
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1116
|
-
* @param - ID of the connected domain to retrieve setup information for.
|
|
1117
|
-
* Identical to the domain name including TLD.
|
|
1118
|
-
* @returns Retrieved setup information.
|
|
1119
|
-
*/
|
|
1120
|
-
(connectedDomainId: string): Promise<ConnectedDomainSetupInfo & ConnectedDomainSetupInfoNonNullableFields>;
|
|
1121
|
-
}
|
|
1122
|
-
|
|
1123
|
-
declare const getConnectedDomainSetupInfo: MaybeContext<BuildRESTFunction<typeof getConnectedDomainSetupInfo$1> & typeof getConnectedDomainSetupInfo$1>;
|
|
1124
|
-
|
|
1125
|
-
type context$3_ARecord = ARecord;
|
|
1126
|
-
type context$3_CnameRecord = CnameRecord;
|
|
1127
|
-
type context$3_ConnectedDomainSetupInfo = ConnectedDomainSetupInfo;
|
|
1128
|
-
type context$3_ConnectedDomainSetupInfoDnsRecordsOneOf = ConnectedDomainSetupInfoDnsRecordsOneOf;
|
|
1129
|
-
type context$3_ConnectedDomainSetupInfoNonNullableFields = ConnectedDomainSetupInfoNonNullableFields;
|
|
1130
|
-
type context$3_ConnectionType = ConnectionType;
|
|
1131
|
-
declare const context$3_ConnectionType: typeof ConnectionType;
|
|
1132
|
-
type context$3_GetConnectedDomainSetupInfoRequest = GetConnectedDomainSetupInfoRequest;
|
|
1133
|
-
type context$3_GetConnectedDomainSetupInfoResponse = GetConnectedDomainSetupInfoResponse;
|
|
1134
|
-
type context$3_GetConnectedDomainSetupInfoResponseNonNullableFields = GetConnectedDomainSetupInfoResponseNonNullableFields;
|
|
1135
|
-
type context$3_GetSetupInfoRequest = GetSetupInfoRequest;
|
|
1136
|
-
type context$3_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
1137
|
-
type context$3_NameserverRecord = NameserverRecord;
|
|
1138
|
-
type context$3_NsRecord = NsRecord;
|
|
1139
|
-
type context$3_PointingRecords = PointingRecords;
|
|
1140
|
-
type context$3_PreCreateConnectedDomainRequest = PreCreateConnectedDomainRequest;
|
|
1141
|
-
type context$3_PreCreateConnectedDomainResponse = PreCreateConnectedDomainResponse;
|
|
1142
|
-
type context$3_Registrar = Registrar;
|
|
1143
|
-
type context$3_SubdomainRecords = SubdomainRecords;
|
|
1144
|
-
declare const context$3_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
1145
|
-
declare namespace context$3 {
|
|
1146
|
-
export { type context$3_ARecord as ARecord, type context$3_CnameRecord as CnameRecord, type context$3_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type context$3_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, type context$3_ConnectedDomainSetupInfoNonNullableFields as ConnectedDomainSetupInfoNonNullableFields, context$3_ConnectionType as ConnectionType, type context$3_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type context$3_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type context$3_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type context$3_GetSetupInfoRequest as GetSetupInfoRequest, type context$3_GetSetupInfoResponse as GetSetupInfoResponse, type context$3_NameserverRecord as NameserverRecord, type context$3_NsRecord as NsRecord, type context$3_PointingRecords as PointingRecords, type context$3_PreCreateConnectedDomainRequest as PreCreateConnectedDomainRequest, type context$3_PreCreateConnectedDomainResponse as PreCreateConnectedDomainResponse, type context$3_Registrar as Registrar, type context$3_SubdomainRecords as SubdomainRecords, context$3_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
1147
|
-
}
|
|
1148
|
-
|
|
1149
|
-
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
1150
|
-
interface DnsZone {
|
|
1151
|
-
/** Domain name including the TLD. Both root domains and subdomains are supported. */
|
|
1152
|
-
domainName?: string;
|
|
1153
|
-
/**
|
|
1154
|
-
* DNS records. You can only set up a single `record` object per DNS record
|
|
1155
|
-
* type. If you want to specify multiple values for the same record type, you
|
|
1156
|
-
* must save them in the `values` for the relevant type.
|
|
1157
|
-
*
|
|
1158
|
-
* Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
|
|
1159
|
-
* Max: 5000 DNS records
|
|
1160
|
-
*/
|
|
1161
|
-
records?: DnsRecord[];
|
|
1162
|
-
/**
|
|
1163
|
-
* ID of the Dns Zone. Identical to the domain name including TLD.
|
|
1164
|
-
* @readonly
|
|
1165
|
-
*/
|
|
1166
|
-
_id?: string;
|
|
1167
|
-
/**
|
|
1168
|
-
* Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)
|
|
1169
|
-
* are enabled.
|
|
1170
|
-
*
|
|
1171
|
-
* Default: `false`
|
|
1172
|
-
*/
|
|
1173
|
-
dnssecEnabled?: boolean;
|
|
1174
|
-
/**
|
|
1175
|
-
* Information about [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).
|
|
1176
|
-
* Available only if `{"dnssecEnabled": true}`.
|
|
1177
|
-
* @readonly
|
|
1178
|
-
*/
|
|
1179
|
-
dnssecInfo?: DnssecInfo;
|
|
1180
|
-
}
|
|
1181
|
-
interface DnsRecord {
|
|
1182
|
-
/** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
|
|
1183
|
-
type?: RecordType;
|
|
1184
|
-
/**
|
|
1185
|
-
* Host name. Can be a subdomain. For example, `domain.com` or
|
|
1186
|
-
* `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
|
|
1187
|
-
*/
|
|
1188
|
-
hostName?: string;
|
|
1189
|
-
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
1190
|
-
ttl?: number;
|
|
1191
|
-
/**
|
|
1192
|
-
* DNS record values. Wix limits DNS records to 50 values per type. External
|
|
1193
|
-
* providers may support a different maximum number of DNS records for a
|
|
1194
|
-
* specific type, Wix doesn't validate that you don't exceed these external
|
|
1195
|
-
* limits.
|
|
1196
|
-
*
|
|
1197
|
-
* Max: 50 records
|
|
1198
|
-
*/
|
|
1199
|
-
values?: string[];
|
|
1200
|
-
}
|
|
1201
|
-
declare enum RecordType {
|
|
1202
|
-
/** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */
|
|
1203
|
-
UNKNOWN = "UNKNOWN",
|
|
1204
|
-
/** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
|
|
1205
|
-
A = "A",
|
|
1206
|
-
/** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
|
|
1207
|
-
AAAA = "AAAA",
|
|
1208
|
-
/** Name server record. Describes which server contains the actual DNS record. */
|
|
1209
|
-
NS = "NS",
|
|
1210
|
-
/** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
|
|
1211
|
-
SOA = "SOA",
|
|
1212
|
-
/** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
|
|
1213
|
-
CNAME = "CNAME",
|
|
1214
|
-
/** MX record. Directs emails to mail servers. */
|
|
1215
|
-
MX = "MX",
|
|
1216
|
-
/** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
|
|
1217
|
-
TXT = "TXT",
|
|
1218
|
-
/** SPF record. Used for email authentication. */
|
|
1219
|
-
SPF = "SPF",
|
|
1220
|
-
/** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
|
|
1221
|
-
SRV = "SRV",
|
|
1222
|
-
/** Pointer record. Specifies which host is supported for a given IP address. */
|
|
1223
|
-
PTR = "PTR",
|
|
1224
|
-
/** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
|
|
1225
|
-
NAPTR = "NAPTR"
|
|
1226
|
-
}
|
|
1227
|
-
interface DnssecInfo {
|
|
1228
|
-
/**
|
|
1229
|
-
* Unique 16-bit identifier for a [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
|
|
1230
|
-
* record that allows efficient DNSSEC validation in zones with multiple keys.
|
|
1231
|
-
*/
|
|
1232
|
-
keyTag?: number;
|
|
1233
|
-
/**
|
|
1234
|
-
* Cryptographic hash of the [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
|
|
1235
|
-
* record that's included in the delegation signer (DS) record and ensures secure
|
|
1236
|
-
* DNSSEC validation.
|
|
1237
|
-
*/
|
|
1238
|
-
digest?: string;
|
|
1239
|
-
}
|
|
1240
|
-
interface DnsRecordsChangedEvent {
|
|
1241
|
-
domainName?: string;
|
|
1242
|
-
changeTime?: Date | null;
|
|
1243
|
-
}
|
|
1244
|
-
interface DomainRemovedEvent {
|
|
1245
|
-
/**
|
|
1246
|
-
* Domain name including TLD.
|
|
1247
|
-
* Both root domains and subdomains are supported.
|
|
1248
|
-
*/
|
|
1249
|
-
domain?: string;
|
|
1250
|
-
}
|
|
1251
|
-
interface CreateDnsZoneRequest {
|
|
1252
|
-
/** DNS zone to create. */
|
|
1253
|
-
dnsZone: DnsZone;
|
|
1254
|
-
}
|
|
1255
|
-
interface CreateDnsZoneResponse {
|
|
1256
|
-
/** Created DNS zone. */
|
|
1257
|
-
dnsZone?: DnsZone;
|
|
1258
|
-
}
|
|
1259
|
-
interface GetDnsZoneRequest {
|
|
1260
|
-
/** Domain to retrieve the DNS zone for. */
|
|
1261
|
-
domainName: string;
|
|
1262
|
-
}
|
|
1263
|
-
interface GetDnsZoneResponse {
|
|
1264
|
-
/** Retrieved DNS zone. */
|
|
1265
|
-
dnsZone?: DnsZone;
|
|
1266
|
-
}
|
|
1267
|
-
interface UpdateDnsZoneRequest {
|
|
1268
|
-
/** Domain to update the DNS zone for. Must include the TLD. */
|
|
1269
|
-
domainName: string;
|
|
1270
|
-
/**
|
|
1271
|
-
* DNS records to add to the DNS zone.
|
|
1272
|
-
*
|
|
1273
|
-
* Max: 10 additions
|
|
1274
|
-
*/
|
|
1275
|
-
additions?: DnsRecord[];
|
|
1276
|
-
/**
|
|
1277
|
-
* DNS records to remove from the DNS zone.
|
|
1278
|
-
*
|
|
1279
|
-
* Max: 10 deletions
|
|
1280
|
-
*/
|
|
1281
|
-
deletions?: DnsRecord[];
|
|
1282
|
-
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
1283
|
-
dnssecEnabled?: boolean | null;
|
|
1284
|
-
}
|
|
1285
|
-
interface UpdateDnsZoneResponse {
|
|
1286
|
-
/** Updated DNS zone. */
|
|
1287
|
-
dnsZone?: DnsZone;
|
|
1288
|
-
}
|
|
1289
|
-
interface DeleteDnsZoneRequest {
|
|
1290
|
-
/** Domain name to delete the DNS zone for. */
|
|
1291
|
-
domainName: string;
|
|
1292
|
-
}
|
|
1293
|
-
interface DeleteDnsZoneResponse {
|
|
1294
|
-
}
|
|
1295
|
-
interface PreviewDnsZoneRequest {
|
|
1296
|
-
/** Domain name to generate a DNS zone preview for. */
|
|
1297
|
-
domainName: string;
|
|
1298
|
-
}
|
|
1299
|
-
interface PreviewDnsZoneResponse {
|
|
1300
|
-
/**
|
|
1301
|
-
* DNS zone preview.
|
|
1302
|
-
*
|
|
1303
|
-
* Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
|
|
1304
|
-
*/
|
|
1305
|
-
dnsZone?: DnsZone;
|
|
1306
|
-
}
|
|
1307
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1308
|
-
createdEvent?: EntityCreatedEvent;
|
|
1309
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1310
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1311
|
-
actionEvent?: ActionEvent;
|
|
1312
|
-
/**
|
|
1313
|
-
* Unique event ID.
|
|
1314
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1315
|
-
*/
|
|
1316
|
-
_id?: string;
|
|
1317
|
-
/**
|
|
1318
|
-
* Assumes actions are also always typed to an entity_type
|
|
1319
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1320
|
-
*/
|
|
1321
|
-
entityFqdn?: string;
|
|
1322
|
-
/**
|
|
1323
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1324
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1325
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1326
|
-
*/
|
|
1327
|
-
slug?: string;
|
|
1328
|
-
/** ID of the entity associated with the event. */
|
|
1329
|
-
entityId?: string;
|
|
1330
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1331
|
-
eventTime?: Date | null;
|
|
1332
|
-
/**
|
|
1333
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1334
|
-
* (for example, GDPR).
|
|
1335
|
-
*/
|
|
1336
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1337
|
-
/** If present, indicates the action that triggered the event. */
|
|
1338
|
-
originatedFrom?: string | null;
|
|
1339
|
-
/**
|
|
1340
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1341
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1342
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1343
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1344
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1345
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1346
|
-
*/
|
|
1347
|
-
entityEventSequence?: string | null;
|
|
1348
|
-
}
|
|
1349
|
-
/** @oneof */
|
|
1350
|
-
interface DomainEventBodyOneOf {
|
|
1351
|
-
createdEvent?: EntityCreatedEvent;
|
|
1352
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1353
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1354
|
-
actionEvent?: ActionEvent;
|
|
1355
|
-
}
|
|
1356
|
-
interface EntityCreatedEvent {
|
|
1357
|
-
entity?: string;
|
|
1358
|
-
}
|
|
1359
|
-
interface RestoreInfo {
|
|
1360
|
-
deletedDate?: Date | null;
|
|
1361
|
-
}
|
|
1362
|
-
interface EntityUpdatedEvent {
|
|
1363
|
-
/**
|
|
1364
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1365
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1366
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1367
|
-
*/
|
|
1368
|
-
currentEntity?: string;
|
|
1369
|
-
}
|
|
1370
|
-
interface EntityDeletedEvent {
|
|
1371
|
-
/** Entity that was deleted */
|
|
1372
|
-
deletedEntity?: string | null;
|
|
1373
|
-
}
|
|
1374
|
-
interface ActionEvent {
|
|
1375
|
-
body?: string;
|
|
1376
|
-
}
|
|
1377
|
-
interface MessageEnvelope {
|
|
1378
|
-
/** App instance ID. */
|
|
1379
|
-
instanceId?: string | null;
|
|
1380
|
-
/** Event type. */
|
|
1381
|
-
eventType?: string;
|
|
1382
|
-
/** The identification type and identity data. */
|
|
1383
|
-
identity?: IdentificationData;
|
|
1384
|
-
/** Stringify payload. */
|
|
1385
|
-
data?: string;
|
|
1386
|
-
}
|
|
1387
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1388
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1389
|
-
anonymousVisitorId?: string;
|
|
1390
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1391
|
-
memberId?: string;
|
|
1392
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1393
|
-
wixUserId?: string;
|
|
1394
|
-
/** ID of an app. */
|
|
1395
|
-
appId?: string;
|
|
1396
|
-
/** @readonly */
|
|
1397
|
-
identityType?: WebhookIdentityType;
|
|
1398
|
-
}
|
|
1399
|
-
/** @oneof */
|
|
1400
|
-
interface IdentificationDataIdOneOf {
|
|
1401
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1402
|
-
anonymousVisitorId?: string;
|
|
1403
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1404
|
-
memberId?: string;
|
|
1405
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1406
|
-
wixUserId?: string;
|
|
1407
|
-
/** ID of an app. */
|
|
1408
|
-
appId?: string;
|
|
1409
|
-
}
|
|
1410
|
-
declare enum WebhookIdentityType {
|
|
1411
|
-
UNKNOWN = "UNKNOWN",
|
|
1412
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1413
|
-
MEMBER = "MEMBER",
|
|
1414
|
-
WIX_USER = "WIX_USER",
|
|
1415
|
-
APP = "APP"
|
|
1416
|
-
}
|
|
1417
|
-
interface DnsRecordNonNullableFields {
|
|
1418
|
-
type: RecordType;
|
|
1419
|
-
hostName: string;
|
|
1420
|
-
ttl: number;
|
|
1421
|
-
values: string[];
|
|
1422
|
-
}
|
|
1423
|
-
interface DnssecInfoNonNullableFields {
|
|
1424
|
-
keyTag: number;
|
|
1425
|
-
digest: string;
|
|
1426
|
-
}
|
|
1427
|
-
interface DnsZoneNonNullableFields {
|
|
1428
|
-
domainName: string;
|
|
1429
|
-
records: DnsRecordNonNullableFields[];
|
|
1430
|
-
_id: string;
|
|
1431
|
-
dnssecEnabled: boolean;
|
|
1432
|
-
dnssecInfo?: DnssecInfoNonNullableFields;
|
|
1433
|
-
}
|
|
1434
|
-
interface CreateDnsZoneResponseNonNullableFields {
|
|
1435
|
-
dnsZone?: DnsZoneNonNullableFields;
|
|
1436
|
-
}
|
|
1437
|
-
interface GetDnsZoneResponseNonNullableFields {
|
|
1438
|
-
dnsZone?: DnsZoneNonNullableFields;
|
|
1439
|
-
}
|
|
1440
|
-
interface UpdateDnsZoneResponseNonNullableFields {
|
|
1441
|
-
dnsZone?: DnsZoneNonNullableFields;
|
|
1442
|
-
}
|
|
1443
|
-
interface PreviewDnsZoneResponseNonNullableFields {
|
|
1444
|
-
dnsZone?: DnsZoneNonNullableFields;
|
|
1445
|
-
}
|
|
1446
|
-
interface UpdateDnsZoneOptions {
|
|
1447
|
-
/**
|
|
1448
|
-
* DNS records to add to the DNS zone.
|
|
1449
|
-
*
|
|
1450
|
-
* Max: 10 additions
|
|
1451
|
-
*/
|
|
1452
|
-
additions?: DnsRecord[];
|
|
1453
|
-
/**
|
|
1454
|
-
* DNS records to remove from the DNS zone.
|
|
1455
|
-
*
|
|
1456
|
-
* Max: 10 deletions
|
|
1457
|
-
*/
|
|
1458
|
-
deletions?: DnsRecord[];
|
|
1459
|
-
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
1460
|
-
dnssecEnabled?: boolean | null;
|
|
1461
|
-
}
|
|
1462
|
-
|
|
1463
|
-
declare function createDnsZone$1(httpClient: HttpClient): CreateDnsZoneSignature;
|
|
1464
|
-
interface CreateDnsZoneSignature {
|
|
1465
|
-
/**
|
|
1466
|
-
* Creates a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
* If there is an existing DNS zone for the domain, it's deleted before
|
|
1470
|
-
* the new zone is created.
|
|
1471
|
-
*
|
|
1472
|
-
* The call is synchronous, that means it fails in case of an error on
|
|
1473
|
-
* Google's side.
|
|
1474
|
-
*
|
|
1475
|
-
* You can only set up a single `record` object per DNS record
|
|
1476
|
-
* type. If you want to specify multiple values for the same record type, you
|
|
1477
|
-
* must save them in the `values` for the relevant type.
|
|
1478
|
-
*
|
|
1479
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1480
|
-
* @param - DNS zone to create.
|
|
1481
|
-
* @returns Created DNS zone.
|
|
1482
|
-
*/
|
|
1483
|
-
(dnsZone: DnsZone): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1484
|
-
}
|
|
1485
|
-
declare function getDnsZone$1(httpClient: HttpClient): GetDnsZoneSignature;
|
|
1486
|
-
interface GetDnsZoneSignature {
|
|
1487
|
-
/**
|
|
1488
|
-
* Retrieves the DNS zone belonging to the domain from
|
|
1489
|
-
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1490
|
-
*
|
|
1491
|
-
*
|
|
1492
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1493
|
-
* @param - Domain to retrieve the DNS zone for.
|
|
1494
|
-
* @returns Retrieved DNS zone.
|
|
1495
|
-
*/
|
|
1496
|
-
(domainName: string): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1497
|
-
}
|
|
1498
|
-
declare function updateDnsZone$1(httpClient: HttpClient): UpdateDnsZoneSignature;
|
|
1499
|
-
interface UpdateDnsZoneSignature {
|
|
1500
|
-
/**
|
|
1501
|
-
* Adds DNS records to and removes DNS records from a DNS zone in
|
|
1502
|
-
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1503
|
-
*
|
|
1504
|
-
* The call is synchronous, that means it fails in case of an error on
|
|
1505
|
-
* Google's side.
|
|
1506
|
-
*
|
|
1507
|
-
* You can only set up a single `record` object per DNS record
|
|
1508
|
-
* type. If you want to specify multiple values for the same record type, you
|
|
1509
|
-
* must save them in the `values` for the relevant type. This means, you must
|
|
1510
|
-
* delete the relevant record and add a new `addition` object for this type
|
|
1511
|
-
* to the request, in case you want to add values for an existing DNS record
|
|
1512
|
-
* type.
|
|
1513
|
-
*
|
|
1514
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1515
|
-
* @param - Domain to update the DNS zone for. Must include the TLD.
|
|
1516
|
-
*/
|
|
1517
|
-
(domainName: string, options?: UpdateDnsZoneOptions | undefined): Promise<UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields>;
|
|
1518
|
-
}
|
|
1519
|
-
declare function deleteDnsZone$1(httpClient: HttpClient): DeleteDnsZoneSignature;
|
|
1520
|
-
interface DeleteDnsZoneSignature {
|
|
1521
|
-
/**
|
|
1522
|
-
* Deletes a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1525
|
-
* The call is synchronous, that means it fails in case of an error on
|
|
1526
|
-
* Google's side.
|
|
1527
|
-
*
|
|
1528
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1529
|
-
* @param - Domain name to delete the DNS zone for.
|
|
1530
|
-
*/
|
|
1531
|
-
(domainName: string): Promise<void>;
|
|
1532
|
-
}
|
|
1533
|
-
declare function previewDnsZone$1(httpClient: HttpClient): PreviewDnsZoneSignature;
|
|
1534
|
-
interface PreviewDnsZoneSignature {
|
|
1535
|
-
/**
|
|
1536
|
-
* Generates a preview for a DNS zone based on
|
|
1537
|
-
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
* This includes calculating the `A`, `CNAME`, `NS` and `SOA` records.
|
|
1541
|
-
* You can use this information to configure a domain from an external
|
|
1542
|
-
* provider, before connecting it to a Wix site.
|
|
1543
|
-
*
|
|
1544
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1545
|
-
* @param - Domain name to generate a DNS zone preview for.
|
|
1546
|
-
*/
|
|
1547
|
-
(domainName: string): Promise<PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields>;
|
|
1548
|
-
}
|
|
1549
|
-
|
|
1550
|
-
declare const createDnsZone: MaybeContext<BuildRESTFunction<typeof createDnsZone$1> & typeof createDnsZone$1>;
|
|
1551
|
-
declare const getDnsZone: MaybeContext<BuildRESTFunction<typeof getDnsZone$1> & typeof getDnsZone$1>;
|
|
1552
|
-
declare const updateDnsZone: MaybeContext<BuildRESTFunction<typeof updateDnsZone$1> & typeof updateDnsZone$1>;
|
|
1553
|
-
declare const deleteDnsZone: MaybeContext<BuildRESTFunction<typeof deleteDnsZone$1> & typeof deleteDnsZone$1>;
|
|
1554
|
-
declare const previewDnsZone: MaybeContext<BuildRESTFunction<typeof previewDnsZone$1> & typeof previewDnsZone$1>;
|
|
1555
|
-
|
|
1556
|
-
type context$2_ActionEvent = ActionEvent;
|
|
1557
|
-
type context$2_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
1558
|
-
type context$2_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
1559
|
-
type context$2_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNonNullableFields;
|
|
1560
|
-
type context$2_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
|
|
1561
|
-
type context$2_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
|
|
1562
|
-
type context$2_DnsRecord = DnsRecord;
|
|
1563
|
-
type context$2_DnsRecordsChangedEvent = DnsRecordsChangedEvent;
|
|
1564
|
-
type context$2_DnsZone = DnsZone;
|
|
1565
|
-
type context$2_DnsZoneNonNullableFields = DnsZoneNonNullableFields;
|
|
1566
|
-
type context$2_DnssecInfo = DnssecInfo;
|
|
1567
|
-
type context$2_DomainEvent = DomainEvent;
|
|
1568
|
-
type context$2_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
1569
|
-
type context$2_DomainRemovedEvent = DomainRemovedEvent;
|
|
1570
|
-
type context$2_EntityCreatedEvent = EntityCreatedEvent;
|
|
1571
|
-
type context$2_EntityDeletedEvent = EntityDeletedEvent;
|
|
1572
|
-
type context$2_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
1573
|
-
type context$2_GetDnsZoneRequest = GetDnsZoneRequest;
|
|
1574
|
-
type context$2_GetDnsZoneResponse = GetDnsZoneResponse;
|
|
1575
|
-
type context$2_GetDnsZoneResponseNonNullableFields = GetDnsZoneResponseNonNullableFields;
|
|
1576
|
-
type context$2_IdentificationData = IdentificationData;
|
|
1577
|
-
type context$2_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
1578
|
-
type context$2_MessageEnvelope = MessageEnvelope;
|
|
1579
|
-
type context$2_PreviewDnsZoneRequest = PreviewDnsZoneRequest;
|
|
1580
|
-
type context$2_PreviewDnsZoneResponse = PreviewDnsZoneResponse;
|
|
1581
|
-
type context$2_PreviewDnsZoneResponseNonNullableFields = PreviewDnsZoneResponseNonNullableFields;
|
|
1582
|
-
type context$2_RecordType = RecordType;
|
|
1583
|
-
declare const context$2_RecordType: typeof RecordType;
|
|
1584
|
-
type context$2_RestoreInfo = RestoreInfo;
|
|
1585
|
-
type context$2_UpdateDnsZoneOptions = UpdateDnsZoneOptions;
|
|
1586
|
-
type context$2_UpdateDnsZoneRequest = UpdateDnsZoneRequest;
|
|
1587
|
-
type context$2_UpdateDnsZoneResponse = UpdateDnsZoneResponse;
|
|
1588
|
-
type context$2_UpdateDnsZoneResponseNonNullableFields = UpdateDnsZoneResponseNonNullableFields;
|
|
1589
|
-
type context$2_WebhookIdentityType = WebhookIdentityType;
|
|
1590
|
-
declare const context$2_WebhookIdentityType: typeof WebhookIdentityType;
|
|
1591
|
-
declare const context$2_createDnsZone: typeof createDnsZone;
|
|
1592
|
-
declare const context$2_deleteDnsZone: typeof deleteDnsZone;
|
|
1593
|
-
declare const context$2_getDnsZone: typeof getDnsZone;
|
|
1594
|
-
declare const context$2_previewDnsZone: typeof previewDnsZone;
|
|
1595
|
-
declare const context$2_updateDnsZone: typeof updateDnsZone;
|
|
1596
|
-
declare namespace context$2 {
|
|
1597
|
-
export { type context$2_ActionEvent as ActionEvent, type context$2_CreateDnsZoneRequest as CreateDnsZoneRequest, type context$2_CreateDnsZoneResponse as CreateDnsZoneResponse, type context$2_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type context$2_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type context$2_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type context$2_DnsRecord as DnsRecord, type context$2_DnsRecordsChangedEvent as DnsRecordsChangedEvent, type context$2_DnsZone as DnsZone, type context$2_DnsZoneNonNullableFields as DnsZoneNonNullableFields, type context$2_DnssecInfo as DnssecInfo, type context$2_DomainEvent as DomainEvent, type context$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type context$2_DomainRemovedEvent as DomainRemovedEvent, type context$2_EntityCreatedEvent as EntityCreatedEvent, type context$2_EntityDeletedEvent as EntityDeletedEvent, type context$2_EntityUpdatedEvent as EntityUpdatedEvent, type context$2_GetDnsZoneRequest as GetDnsZoneRequest, type context$2_GetDnsZoneResponse as GetDnsZoneResponse, type context$2_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type context$2_IdentificationData as IdentificationData, type context$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context$2_MessageEnvelope as MessageEnvelope, type context$2_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type context$2_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type context$2_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, context$2_RecordType as RecordType, type context$2_RestoreInfo as RestoreInfo, type context$2_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type context$2_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type context$2_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type context$2_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, context$2_WebhookIdentityType as WebhookIdentityType, context$2_createDnsZone as createDnsZone, context$2_deleteDnsZone as deleteDnsZone, context$2_getDnsZone as getDnsZone, context$2_previewDnsZone as previewDnsZone, context$2_updateDnsZone as updateDnsZone };
|
|
1598
|
-
}
|
|
1599
|
-
|
|
1600
|
-
interface DomainAvailability {
|
|
1601
|
-
/** Domain name including TLD. For example, `my-new-domain.com`. */
|
|
1602
|
-
domain?: string;
|
|
1603
|
-
/**
|
|
1604
|
-
* Whether the domain is available for purchase. You can purchase the
|
|
1605
|
-
* domain in case the boolean is `true`. The domain is already taken
|
|
1606
|
-
* when `false` is returned.
|
|
1607
|
-
*/
|
|
1608
|
-
available?: boolean;
|
|
1609
|
-
/** Whether the domain has a higher price due to its perceived value or demand. */
|
|
1610
|
-
premium?: boolean;
|
|
1611
|
-
}
|
|
1612
|
-
interface CheckDomainAvailabilityRequest {
|
|
1613
|
-
/**
|
|
1614
|
-
* Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
|
|
1615
|
-
* alphanumeric characters, hyphens, and dots are supported.
|
|
1616
|
-
*
|
|
1617
|
-
* Min: 3 characters
|
|
1618
|
-
* Max: 63 characters
|
|
1619
|
-
*/
|
|
1620
|
-
domain: string;
|
|
1621
|
-
}
|
|
1622
|
-
interface CheckDomainAvailabilityResponse {
|
|
1623
|
-
/** Information about the domain's availability. */
|
|
1624
|
-
availability?: DomainAvailability;
|
|
1625
|
-
}
|
|
1626
|
-
interface DomainAvailabilityNonNullableFields {
|
|
1627
|
-
domain: string;
|
|
1628
|
-
available: boolean;
|
|
1629
|
-
premium: boolean;
|
|
1630
|
-
}
|
|
1631
|
-
interface CheckDomainAvailabilityResponseNonNullableFields {
|
|
1632
|
-
availability?: DomainAvailabilityNonNullableFields;
|
|
1633
|
-
}
|
|
1634
|
-
|
|
1635
|
-
declare function checkDomainAvailability$1(httpClient: HttpClient): CheckDomainAvailabilitySignature;
|
|
1636
|
-
interface CheckDomainAvailabilitySignature {
|
|
1637
|
-
/**
|
|
1638
|
-
* Checks whether the given domain is available for purchase.
|
|
1639
|
-
*
|
|
1640
|
-
*
|
|
1641
|
-
* You can purchase the specified domain in case the returned
|
|
1642
|
-
* `availability.available` boolean is `true`. The domain is already taken
|
|
1643
|
-
* when `false` is returned.
|
|
1644
|
-
*
|
|
1645
|
-
* The `domain` field must include the TLD. For example, `my-new-domain.com`.
|
|
1646
|
-
*
|
|
1647
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1648
|
-
* @param - Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
|
|
1649
|
-
* alphanumeric characters, hyphens, and dots are supported.
|
|
1650
|
-
*
|
|
1651
|
-
* Min: 3 characters
|
|
1652
|
-
* Max: 63 characters
|
|
1653
|
-
*/
|
|
1654
|
-
(domain: string): Promise<CheckDomainAvailabilityResponse & CheckDomainAvailabilityResponseNonNullableFields>;
|
|
1655
|
-
}
|
|
1656
|
-
|
|
1657
|
-
declare const checkDomainAvailability: MaybeContext<BuildRESTFunction<typeof checkDomainAvailability$1> & typeof checkDomainAvailability$1>;
|
|
1658
|
-
|
|
1659
|
-
type context$1_CheckDomainAvailabilityRequest = CheckDomainAvailabilityRequest;
|
|
1660
|
-
type context$1_CheckDomainAvailabilityResponse = CheckDomainAvailabilityResponse;
|
|
1661
|
-
type context$1_CheckDomainAvailabilityResponseNonNullableFields = CheckDomainAvailabilityResponseNonNullableFields;
|
|
1662
|
-
type context$1_DomainAvailability = DomainAvailability;
|
|
1663
|
-
declare const context$1_checkDomainAvailability: typeof checkDomainAvailability;
|
|
1664
|
-
declare namespace context$1 {
|
|
1665
|
-
export { type context$1_CheckDomainAvailabilityRequest as CheckDomainAvailabilityRequest, type context$1_CheckDomainAvailabilityResponse as CheckDomainAvailabilityResponse, type context$1_CheckDomainAvailabilityResponseNonNullableFields as CheckDomainAvailabilityResponseNonNullableFields, type context$1_DomainAvailability as DomainAvailability, context$1_checkDomainAvailability as checkDomainAvailability };
|
|
1666
|
-
}
|
|
1667
|
-
|
|
1668
|
-
interface DomainSuggestion {
|
|
1669
|
-
/** Suggested domain name including TLD. */
|
|
1670
|
-
domain?: string;
|
|
1671
|
-
/** Whether the domain has a higher price due to its perceived value or demand. */
|
|
1672
|
-
premium?: boolean;
|
|
1673
|
-
}
|
|
1674
|
-
interface SuggestDomainsRequest {
|
|
1675
|
-
/**
|
|
1676
|
-
* Input to base your domain suggestions on. May include
|
|
1677
|
-
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
1678
|
-
*
|
|
1679
|
-
* Min: 3 characters
|
|
1680
|
-
* Max: 100 characters
|
|
1681
|
-
*/
|
|
1682
|
-
query: string;
|
|
1683
|
-
/**
|
|
1684
|
-
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
1685
|
-
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
1686
|
-
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
1687
|
-
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
1688
|
-
* information.
|
|
1689
|
-
*
|
|
1690
|
-
* Max: 10 TLDs
|
|
1691
|
-
*/
|
|
1692
|
-
tlds?: string[];
|
|
1693
|
-
/**
|
|
1694
|
-
* Number of domain suggestions to return. __Deprecated__: This field will be
|
|
1695
|
-
* removed on March 1, 2025. Use `paging.limit` instead.
|
|
1696
|
-
*
|
|
1697
|
-
* Min: `1`
|
|
1698
|
-
* Max: `20`
|
|
1699
|
-
* Default: `10`
|
|
1700
|
-
* @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
|
|
1701
|
-
* removed on March 1, 2025. Use `paging.limit` instead.
|
|
1702
|
-
*
|
|
1703
|
-
* Min: `1`
|
|
1704
|
-
* Max: `20`
|
|
1705
|
-
* Default: `10`
|
|
1706
|
-
* @replacedBy paging.limit
|
|
1707
|
-
* @targetRemovalDate 2025-03-01
|
|
1708
|
-
*/
|
|
1709
|
-
limit?: number | null;
|
|
1710
|
-
/** Cursor paging options. */
|
|
1711
|
-
paging?: CursorPaging;
|
|
1712
|
-
/**
|
|
1713
|
-
* Maximum number of characters for the domain name, excluding the TLD.
|
|
1714
|
-
*
|
|
1715
|
-
* Min: `3`
|
|
1716
|
-
* Max: `63`
|
|
1717
|
-
* Default: `63`
|
|
1718
|
-
*/
|
|
1719
|
-
maxLength?: number | null;
|
|
1720
|
-
}
|
|
1721
|
-
interface CursorPaging {
|
|
1722
|
-
/**
|
|
1723
|
-
* Maximum number of domains to return in the results.
|
|
1724
|
-
*
|
|
1725
|
-
* Min: `0`
|
|
1726
|
-
* Max: `20`
|
|
1727
|
-
*/
|
|
1728
|
-
limit?: number | null;
|
|
1729
|
-
/**
|
|
1730
|
-
* Pointer to the next or previous page in the list of results.
|
|
1731
|
-
*
|
|
1732
|
-
* You can get the relevant cursor token
|
|
1733
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1734
|
-
* Not relevant for the first request.
|
|
1735
|
-
*/
|
|
1736
|
-
cursor?: string | null;
|
|
1737
|
-
}
|
|
1738
|
-
interface SuggestDomainsResponse {
|
|
1739
|
-
/** List of suggested available domains. */
|
|
1740
|
-
suggestions?: DomainSuggestion[];
|
|
1741
|
-
/** Metadata about the returned list of suggested domains. */
|
|
1742
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1743
|
-
}
|
|
1744
|
-
interface CursorPagingMetadata {
|
|
1745
|
-
/** Number of domains returned in the response. */
|
|
1746
|
-
count?: number | null;
|
|
1747
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1748
|
-
cursors?: Cursors;
|
|
1749
|
-
/**
|
|
1750
|
-
* Indicates if there are more results after the current page.
|
|
1751
|
-
* If `true`, another page of results can be retrieved.
|
|
1752
|
-
* If `false`, this is the last page.
|
|
1753
|
-
*/
|
|
1754
|
-
hasNext?: boolean | null;
|
|
1755
|
-
}
|
|
1756
|
-
interface Cursors {
|
|
1757
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1758
|
-
next?: string | null;
|
|
1759
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1760
|
-
prev?: string | null;
|
|
1761
|
-
}
|
|
1762
|
-
interface DomainSuggestionNonNullableFields {
|
|
1763
|
-
domain: string;
|
|
1764
|
-
premium: boolean;
|
|
1765
|
-
}
|
|
1766
|
-
interface SuggestDomainsResponseNonNullableFields {
|
|
1767
|
-
suggestions: DomainSuggestionNonNullableFields[];
|
|
1768
|
-
}
|
|
1769
|
-
interface SuggestDomainsOptions {
|
|
1770
|
-
/**
|
|
1771
|
-
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
1772
|
-
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
1773
|
-
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
1774
|
-
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
1775
|
-
* information.
|
|
1776
|
-
*
|
|
1777
|
-
* Max: 10 TLDs
|
|
1778
|
-
*/
|
|
1779
|
-
tlds?: string[];
|
|
1780
|
-
/**
|
|
1781
|
-
* Number of domain suggestions to return. __Deprecated__: This field will be
|
|
1782
|
-
* removed on March 1, 2025. Use `paging.limit` instead.
|
|
1783
|
-
*
|
|
1784
|
-
* Min: `1`
|
|
1785
|
-
* Max: `20`
|
|
1786
|
-
* Default: `10`
|
|
1787
|
-
* @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
|
|
1788
|
-
* removed on March 1, 2025. Use `paging.limit` instead.
|
|
1789
|
-
*
|
|
1790
|
-
* Min: `1`
|
|
1791
|
-
* Max: `20`
|
|
1792
|
-
* Default: `10`
|
|
1793
|
-
* @replacedBy paging.limit
|
|
1794
|
-
* @targetRemovalDate 2025-03-01
|
|
1795
|
-
*/
|
|
1796
|
-
limit?: number | null;
|
|
1797
|
-
/** Cursor paging options. */
|
|
1798
|
-
paging?: CursorPaging;
|
|
1799
|
-
/**
|
|
1800
|
-
* Maximum number of characters for the domain name, excluding the TLD.
|
|
1801
|
-
*
|
|
1802
|
-
* Min: `3`
|
|
1803
|
-
* Max: `63`
|
|
1804
|
-
* Default: `63`
|
|
1805
|
-
*/
|
|
1806
|
-
maxLength?: number | null;
|
|
1807
|
-
}
|
|
1808
|
-
|
|
1809
|
-
declare function suggestDomains$1(httpClient: HttpClient): SuggestDomainsSignature;
|
|
1810
|
-
interface SuggestDomainsSignature {
|
|
1811
|
-
/**
|
|
1812
|
-
* Suggests domains that are available for purchase, based on the provided query input.
|
|
1813
|
-
*
|
|
1814
|
-
* You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchsase.
|
|
1815
|
-
*
|
|
1816
|
-
* The `tlds` must not include the dot. For example, `com` and not `.com`.
|
|
1817
|
-
*
|
|
1818
|
-
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1819
|
-
* @param - Input to base your domain suggestions on. May include
|
|
1820
|
-
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
1821
|
-
*
|
|
1822
|
-
* Min: 3 characters
|
|
1823
|
-
* Max: 100 characters
|
|
1824
|
-
*/
|
|
1825
|
-
(query: string, options?: SuggestDomainsOptions | undefined): Promise<SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields>;
|
|
1826
|
-
}
|
|
1827
|
-
|
|
1828
|
-
declare const suggestDomains: MaybeContext<BuildRESTFunction<typeof suggestDomains$1> & typeof suggestDomains$1>;
|
|
1829
|
-
|
|
1830
|
-
type context_CursorPaging = CursorPaging;
|
|
1831
|
-
type context_CursorPagingMetadata = CursorPagingMetadata;
|
|
1832
|
-
type context_Cursors = Cursors;
|
|
1833
|
-
type context_DomainSuggestion = DomainSuggestion;
|
|
1834
|
-
type context_SuggestDomainsOptions = SuggestDomainsOptions;
|
|
1835
|
-
type context_SuggestDomainsRequest = SuggestDomainsRequest;
|
|
1836
|
-
type context_SuggestDomainsResponse = SuggestDomainsResponse;
|
|
1837
|
-
type context_SuggestDomainsResponseNonNullableFields = SuggestDomainsResponseNonNullableFields;
|
|
1838
|
-
declare const context_suggestDomains: typeof suggestDomains;
|
|
1839
|
-
declare namespace context {
|
|
1840
|
-
export { type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DomainSuggestion as DomainSuggestion, type context_SuggestDomainsOptions as SuggestDomainsOptions, type context_SuggestDomainsRequest as SuggestDomainsRequest, type context_SuggestDomainsResponse as SuggestDomainsResponse, type context_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, context_suggestDomains as suggestDomains };
|
|
1841
|
-
}
|
|
1842
|
-
|
|
1843
|
-
export { context$3 as connectedDomainSetupInfo, context$4 as connectedDomains, context$1 as domainAvailability, context$2 as domainDns, context as domainSuggestions };
|