@wix/user-management 1.0.2 → 1.0.4
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/context.js.map +1 -0
- package/context.ts +5 -0
- package/index.js.map +1 -0
- package/index.ts +7 -0
- package/meta.js.map +1 -0
- package/meta.ts +5 -0
- package/package.json +27 -22
- package/build/cjs/context.js.map +0 -1
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/meta.js.map +0 -1
- package/context/package.json +0 -7
- package/meta/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -3523
- package/type-bundles/index.bundle.d.ts +0 -3523
- package/type-bundles/meta.bundle.d.ts +0 -1869
- /package/{build/cjs/context.d.ts → context.d.ts} +0 -0
- /package/{build/cjs/context.js → context.js} +0 -0
- /package/{build/cjs/index.d.ts → index.d.ts} +0 -0
- /package/{build/cjs/index.js → index.js} +0 -0
- /package/{build/cjs/meta.d.ts → meta.d.ts} +0 -0
- /package/{build/cjs/meta.js → meta.js} +0 -0
|
@@ -1,3523 +0,0 @@
|
|
|
1
|
-
type HostModule<T, H extends Host> = {
|
|
2
|
-
__type: 'host';
|
|
3
|
-
create(host: H): T;
|
|
4
|
-
};
|
|
5
|
-
type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
|
|
6
|
-
type Host<Environment = unknown> = {
|
|
7
|
-
channel: {
|
|
8
|
-
observeState(callback: (props: unknown, environment: Environment) => unknown): {
|
|
9
|
-
disconnect: () => void;
|
|
10
|
-
} | Promise<{
|
|
11
|
-
disconnect: () => void;
|
|
12
|
-
}>;
|
|
13
|
-
};
|
|
14
|
-
environment?: Environment;
|
|
15
|
-
/**
|
|
16
|
-
* Optional name of the environment, use for logging
|
|
17
|
-
*/
|
|
18
|
-
name?: string;
|
|
19
|
-
/**
|
|
20
|
-
* Optional bast url to use for API requests, for example `www.wixapis.com`
|
|
21
|
-
*/
|
|
22
|
-
apiBaseUrl?: string;
|
|
23
|
-
/**
|
|
24
|
-
* Possible data to be provided by every host, for cross cutting concerns
|
|
25
|
-
* like internationalization, billing, etc.
|
|
26
|
-
*/
|
|
27
|
-
essentials?: {
|
|
28
|
-
/**
|
|
29
|
-
* The language of the currently viewed session
|
|
30
|
-
*/
|
|
31
|
-
language?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The locale of the currently viewed session
|
|
34
|
-
*/
|
|
35
|
-
locale?: string;
|
|
36
|
-
/**
|
|
37
|
-
* Any headers that should be passed through to the API requests
|
|
38
|
-
*/
|
|
39
|
-
passThroughHeaders?: Record<string, string>;
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
44
|
-
interface HttpClient {
|
|
45
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
46
|
-
fetchWithAuth: typeof fetch;
|
|
47
|
-
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
48
|
-
getActiveToken?: () => string | undefined;
|
|
49
|
-
}
|
|
50
|
-
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
51
|
-
type HttpResponse<T = any> = {
|
|
52
|
-
data: T;
|
|
53
|
-
status: number;
|
|
54
|
-
statusText: string;
|
|
55
|
-
headers: any;
|
|
56
|
-
request?: any;
|
|
57
|
-
};
|
|
58
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
59
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
60
|
-
url: string;
|
|
61
|
-
data?: Data;
|
|
62
|
-
params?: URLSearchParams;
|
|
63
|
-
} & APIMetadata;
|
|
64
|
-
type APIMetadata = {
|
|
65
|
-
methodFqn?: string;
|
|
66
|
-
entityFqdn?: string;
|
|
67
|
-
packageName?: string;
|
|
68
|
-
};
|
|
69
|
-
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
70
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
71
|
-
__type: 'event-definition';
|
|
72
|
-
type: Type;
|
|
73
|
-
isDomainEvent?: boolean;
|
|
74
|
-
transformations?: (envelope: unknown) => Payload;
|
|
75
|
-
__payload: Payload;
|
|
76
|
-
};
|
|
77
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
78
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
79
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
80
|
-
|
|
81
|
-
type ServicePluginMethodInput = {
|
|
82
|
-
request: any;
|
|
83
|
-
metadata: any;
|
|
84
|
-
};
|
|
85
|
-
type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
|
|
86
|
-
type ServicePluginMethodMetadata = {
|
|
87
|
-
name: string;
|
|
88
|
-
primaryHttpMappingPath: string;
|
|
89
|
-
transformations: {
|
|
90
|
-
fromREST: (...args: unknown[]) => ServicePluginMethodInput;
|
|
91
|
-
toREST: (...args: unknown[]) => unknown;
|
|
92
|
-
};
|
|
93
|
-
};
|
|
94
|
-
type ServicePluginDefinition<Contract extends ServicePluginContract> = {
|
|
95
|
-
__type: 'service-plugin-definition';
|
|
96
|
-
componentType: string;
|
|
97
|
-
methods: ServicePluginMethodMetadata[];
|
|
98
|
-
__contract: Contract;
|
|
99
|
-
};
|
|
100
|
-
declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
|
|
101
|
-
type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
|
|
102
|
-
declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
|
|
103
|
-
|
|
104
|
-
type RequestContext = {
|
|
105
|
-
isSSR: boolean;
|
|
106
|
-
host: string;
|
|
107
|
-
protocol?: string;
|
|
108
|
-
};
|
|
109
|
-
type ResponseTransformer = (data: any, headers?: any) => any;
|
|
110
|
-
/**
|
|
111
|
-
* Ambassador request options types are copied mostly from AxiosRequestConfig.
|
|
112
|
-
* They are copied and not imported to reduce the amount of dependencies (to reduce install time).
|
|
113
|
-
* https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
|
|
114
|
-
*/
|
|
115
|
-
type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
|
|
116
|
-
type AmbassadorRequestOptions<T = any> = {
|
|
117
|
-
_?: T;
|
|
118
|
-
url?: string;
|
|
119
|
-
method?: Method;
|
|
120
|
-
params?: any;
|
|
121
|
-
data?: any;
|
|
122
|
-
transformResponse?: ResponseTransformer | ResponseTransformer[];
|
|
123
|
-
};
|
|
124
|
-
type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
|
|
125
|
-
__isAmbassador: boolean;
|
|
126
|
-
};
|
|
127
|
-
type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
|
|
128
|
-
type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
|
|
129
|
-
|
|
130
|
-
declare global {
|
|
131
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
132
|
-
interface SymbolConstructor {
|
|
133
|
-
readonly observable: symbol;
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
declare const emptyObjectSymbol: unique symbol;
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
Represents a strictly empty plain object, the `{}` value.
|
|
141
|
-
|
|
142
|
-
When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
|
|
143
|
-
|
|
144
|
-
@example
|
|
145
|
-
```
|
|
146
|
-
import type {EmptyObject} from 'type-fest';
|
|
147
|
-
|
|
148
|
-
// The following illustrates the problem with `{}`.
|
|
149
|
-
const foo1: {} = {}; // Pass
|
|
150
|
-
const foo2: {} = []; // Pass
|
|
151
|
-
const foo3: {} = 42; // Pass
|
|
152
|
-
const foo4: {} = {a: 1}; // Pass
|
|
153
|
-
|
|
154
|
-
// With `EmptyObject` only the first case is valid.
|
|
155
|
-
const bar1: EmptyObject = {}; // Pass
|
|
156
|
-
const bar2: EmptyObject = 42; // Fail
|
|
157
|
-
const bar3: EmptyObject = []; // Fail
|
|
158
|
-
const bar4: EmptyObject = {a: 1}; // Fail
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
|
|
162
|
-
|
|
163
|
-
@category Object
|
|
164
|
-
*/
|
|
165
|
-
type EmptyObject = {[emptyObjectSymbol]?: never};
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
Returns a boolean for whether the two given types are equal.
|
|
169
|
-
|
|
170
|
-
@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
|
|
171
|
-
@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
|
|
172
|
-
|
|
173
|
-
Use-cases:
|
|
174
|
-
- If you want to make a conditional branch based on the result of a comparison of two types.
|
|
175
|
-
|
|
176
|
-
@example
|
|
177
|
-
```
|
|
178
|
-
import type {IsEqual} from 'type-fest';
|
|
179
|
-
|
|
180
|
-
// This type returns a boolean for whether the given array includes the given item.
|
|
181
|
-
// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
|
|
182
|
-
type Includes<Value extends readonly any[], Item> =
|
|
183
|
-
Value extends readonly [Value[0], ...infer rest]
|
|
184
|
-
? IsEqual<Value[0], Item> extends true
|
|
185
|
-
? true
|
|
186
|
-
: Includes<rest, Item>
|
|
187
|
-
: false;
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
@category Type Guard
|
|
191
|
-
@category Utilities
|
|
192
|
-
*/
|
|
193
|
-
type IsEqual<A, B> =
|
|
194
|
-
(<G>() => G extends A ? 1 : 2) extends
|
|
195
|
-
(<G>() => G extends B ? 1 : 2)
|
|
196
|
-
? true
|
|
197
|
-
: false;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
Filter out keys from an object.
|
|
201
|
-
|
|
202
|
-
Returns `never` if `Exclude` is strictly equal to `Key`.
|
|
203
|
-
Returns `never` if `Key` extends `Exclude`.
|
|
204
|
-
Returns `Key` otherwise.
|
|
205
|
-
|
|
206
|
-
@example
|
|
207
|
-
```
|
|
208
|
-
type Filtered = Filter<'foo', 'foo'>;
|
|
209
|
-
//=> never
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
@example
|
|
213
|
-
```
|
|
214
|
-
type Filtered = Filter<'bar', string>;
|
|
215
|
-
//=> never
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
@example
|
|
219
|
-
```
|
|
220
|
-
type Filtered = Filter<'bar', 'foo'>;
|
|
221
|
-
//=> 'bar'
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
@see {Except}
|
|
225
|
-
*/
|
|
226
|
-
type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
|
|
227
|
-
|
|
228
|
-
type ExceptOptions = {
|
|
229
|
-
/**
|
|
230
|
-
Disallow assigning non-specified properties.
|
|
231
|
-
|
|
232
|
-
Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
|
|
233
|
-
|
|
234
|
-
@default false
|
|
235
|
-
*/
|
|
236
|
-
requireExactProps?: boolean;
|
|
237
|
-
};
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
Create a type from an object type without certain keys.
|
|
241
|
-
|
|
242
|
-
We recommend setting the `requireExactProps` option to `true`.
|
|
243
|
-
|
|
244
|
-
This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
|
|
245
|
-
|
|
246
|
-
This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
|
|
247
|
-
|
|
248
|
-
@example
|
|
249
|
-
```
|
|
250
|
-
import type {Except} from 'type-fest';
|
|
251
|
-
|
|
252
|
-
type Foo = {
|
|
253
|
-
a: number;
|
|
254
|
-
b: string;
|
|
255
|
-
};
|
|
256
|
-
|
|
257
|
-
type FooWithoutA = Except<Foo, 'a'>;
|
|
258
|
-
//=> {b: string}
|
|
259
|
-
|
|
260
|
-
const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
|
|
261
|
-
//=> errors: 'a' does not exist in type '{ b: string; }'
|
|
262
|
-
|
|
263
|
-
type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
|
|
264
|
-
//=> {a: number} & Partial<Record<"b", never>>
|
|
265
|
-
|
|
266
|
-
const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
|
|
267
|
-
//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
@category Object
|
|
271
|
-
*/
|
|
272
|
-
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
|
|
273
|
-
[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
|
|
274
|
-
} & (Options['requireExactProps'] extends true
|
|
275
|
-
? Partial<Record<KeysType, never>>
|
|
276
|
-
: {});
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
Returns a boolean for whether the given type is `never`.
|
|
280
|
-
|
|
281
|
-
@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
|
|
282
|
-
@link https://stackoverflow.com/a/53984913/10292952
|
|
283
|
-
@link https://www.zhenghao.io/posts/ts-never
|
|
284
|
-
|
|
285
|
-
Useful in type utilities, such as checking if something does not occur.
|
|
286
|
-
|
|
287
|
-
@example
|
|
288
|
-
```
|
|
289
|
-
import type {IsNever, And} from 'type-fest';
|
|
290
|
-
|
|
291
|
-
// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
|
|
292
|
-
type AreStringsEqual<A extends string, B extends string> =
|
|
293
|
-
And<
|
|
294
|
-
IsNever<Exclude<A, B>> extends true ? true : false,
|
|
295
|
-
IsNever<Exclude<B, A>> extends true ? true : false
|
|
296
|
-
>;
|
|
297
|
-
|
|
298
|
-
type EndIfEqual<I extends string, O extends string> =
|
|
299
|
-
AreStringsEqual<I, O> extends true
|
|
300
|
-
? never
|
|
301
|
-
: void;
|
|
302
|
-
|
|
303
|
-
function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
|
|
304
|
-
if (input === output) {
|
|
305
|
-
process.exit(0);
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
endIfEqual('abc', 'abc');
|
|
310
|
-
//=> never
|
|
311
|
-
|
|
312
|
-
endIfEqual('abc', '123');
|
|
313
|
-
//=> void
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
@category Type Guard
|
|
317
|
-
@category Utilities
|
|
318
|
-
*/
|
|
319
|
-
type IsNever<T> = [T] extends [never] ? true : false;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
An if-else-like type that resolves depending on whether the given type is `never`.
|
|
323
|
-
|
|
324
|
-
@see {@link IsNever}
|
|
325
|
-
|
|
326
|
-
@example
|
|
327
|
-
```
|
|
328
|
-
import type {IfNever} from 'type-fest';
|
|
329
|
-
|
|
330
|
-
type ShouldBeTrue = IfNever<never>;
|
|
331
|
-
//=> true
|
|
332
|
-
|
|
333
|
-
type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
|
|
334
|
-
//=> 'bar'
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
@category Type Guard
|
|
338
|
-
@category Utilities
|
|
339
|
-
*/
|
|
340
|
-
type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
|
|
341
|
-
IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
|
|
342
|
-
);
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
Extract the keys from a type where the value type of the key extends the given `Condition`.
|
|
346
|
-
|
|
347
|
-
Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
|
|
348
|
-
|
|
349
|
-
@example
|
|
350
|
-
```
|
|
351
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
352
|
-
|
|
353
|
-
interface Example {
|
|
354
|
-
a: string;
|
|
355
|
-
b: string | number;
|
|
356
|
-
c?: string;
|
|
357
|
-
d: {};
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
type StringKeysOnly = ConditionalKeys<Example, string>;
|
|
361
|
-
//=> 'a'
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
|
|
365
|
-
|
|
366
|
-
@example
|
|
367
|
-
```
|
|
368
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
369
|
-
|
|
370
|
-
type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
|
|
371
|
-
//=> 'a' | 'c'
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
@category Object
|
|
375
|
-
*/
|
|
376
|
-
type ConditionalKeys<Base, Condition> =
|
|
377
|
-
{
|
|
378
|
-
// Map through all the keys of the given base type.
|
|
379
|
-
[Key in keyof Base]-?:
|
|
380
|
-
// Pick only keys with types extending the given `Condition` type.
|
|
381
|
-
Base[Key] extends Condition
|
|
382
|
-
// Retain this key
|
|
383
|
-
// If the value for the key extends never, only include it if `Condition` also extends never
|
|
384
|
-
? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
|
|
385
|
-
// Discard this key since the condition fails.
|
|
386
|
-
: never;
|
|
387
|
-
// Convert the produced object into a union type of the keys which passed the conditional test.
|
|
388
|
-
}[keyof Base];
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
Exclude keys from a shape that matches the given `Condition`.
|
|
392
|
-
|
|
393
|
-
This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
|
|
394
|
-
|
|
395
|
-
@example
|
|
396
|
-
```
|
|
397
|
-
import type {Primitive, ConditionalExcept} from 'type-fest';
|
|
398
|
-
|
|
399
|
-
class Awesome {
|
|
400
|
-
name: string;
|
|
401
|
-
successes: number;
|
|
402
|
-
failures: bigint;
|
|
403
|
-
|
|
404
|
-
run() {}
|
|
405
|
-
}
|
|
406
|
-
|
|
407
|
-
type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
|
|
408
|
-
//=> {run: () => void}
|
|
409
|
-
```
|
|
410
|
-
|
|
411
|
-
@example
|
|
412
|
-
```
|
|
413
|
-
import type {ConditionalExcept} from 'type-fest';
|
|
414
|
-
|
|
415
|
-
interface Example {
|
|
416
|
-
a: string;
|
|
417
|
-
b: string | number;
|
|
418
|
-
c: () => void;
|
|
419
|
-
d: {};
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
type NonStringKeysOnly = ConditionalExcept<Example, string>;
|
|
423
|
-
//=> {b: string | number; c: () => void; d: {}}
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
@category Object
|
|
427
|
-
*/
|
|
428
|
-
type ConditionalExcept<Base, Condition> = Except<
|
|
429
|
-
Base,
|
|
430
|
-
ConditionalKeys<Base, Condition>
|
|
431
|
-
>;
|
|
432
|
-
|
|
433
|
-
/**
|
|
434
|
-
* Descriptors are objects that describe the API of a module, and the module
|
|
435
|
-
* can either be a REST module or a host module.
|
|
436
|
-
* This type is recursive, so it can describe nested modules.
|
|
437
|
-
*/
|
|
438
|
-
type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
|
|
439
|
-
[key: string]: Descriptors | PublicMetadata | any;
|
|
440
|
-
};
|
|
441
|
-
/**
|
|
442
|
-
* This type takes in a descriptors object of a certain Host (including an `unknown` host)
|
|
443
|
-
* and returns an object with the same structure, but with all descriptors replaced with their API.
|
|
444
|
-
* Any non-descriptor properties are removed from the returned object, including descriptors that
|
|
445
|
-
* do not match the given host (as they will not work with the given host).
|
|
446
|
-
*/
|
|
447
|
-
type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
|
|
448
|
-
done: T;
|
|
449
|
-
recurse: T extends {
|
|
450
|
-
__type: typeof SERVICE_PLUGIN_ERROR_TYPE;
|
|
451
|
-
} ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
|
|
452
|
-
[Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
|
|
453
|
-
-1,
|
|
454
|
-
0,
|
|
455
|
-
1,
|
|
456
|
-
2,
|
|
457
|
-
3,
|
|
458
|
-
4,
|
|
459
|
-
5
|
|
460
|
-
][Depth]> : never;
|
|
461
|
-
}, EmptyObject>;
|
|
462
|
-
}[Depth extends -1 ? 'done' : 'recurse'];
|
|
463
|
-
type PublicMetadata = {
|
|
464
|
-
PACKAGE_NAME?: string;
|
|
465
|
-
};
|
|
466
|
-
|
|
467
|
-
declare global {
|
|
468
|
-
interface ContextualClient {
|
|
469
|
-
}
|
|
470
|
-
}
|
|
471
|
-
/**
|
|
472
|
-
* A type used to create concerete types from SDK descriptors in
|
|
473
|
-
* case a contextual client is available.
|
|
474
|
-
*/
|
|
475
|
-
type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
476
|
-
host: Host;
|
|
477
|
-
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
478
|
-
|
|
479
|
-
interface AccountV2 {
|
|
480
|
-
/** Account ID. */
|
|
481
|
-
accountId?: string;
|
|
482
|
-
}
|
|
483
|
-
interface GetUserAccountRequest {
|
|
484
|
-
/** the user id that his account we query */
|
|
485
|
-
userId?: string;
|
|
486
|
-
}
|
|
487
|
-
interface Account {
|
|
488
|
-
/** Account ID. */
|
|
489
|
-
accountId?: string;
|
|
490
|
-
/** Account slug - used in the free URL prefix */
|
|
491
|
-
slug?: string;
|
|
492
|
-
/** Account name (display) */
|
|
493
|
-
accountName?: string | null;
|
|
494
|
-
/**
|
|
495
|
-
* DEPRECATED field of account image
|
|
496
|
-
* @deprecated
|
|
497
|
-
*/
|
|
498
|
-
accountImg?: string | null;
|
|
499
|
-
/** account status */
|
|
500
|
-
status?: AccountStatus;
|
|
501
|
-
/** account owner user id */
|
|
502
|
-
accountOwner?: string;
|
|
503
|
-
/** account extra properties */
|
|
504
|
-
accountProperties?: AccountProperties;
|
|
505
|
-
/** the account creation date */
|
|
506
|
-
dateCreated?: Date | null;
|
|
507
|
-
/** last time account was updated */
|
|
508
|
-
dateUpdated?: Date | null;
|
|
509
|
-
}
|
|
510
|
-
/** enum with all available statuses of account */
|
|
511
|
-
declare enum AccountStatus {
|
|
512
|
-
ACTIVE = "ACTIVE",
|
|
513
|
-
BLOCKED = "BLOCKED",
|
|
514
|
-
DELETED = "DELETED"
|
|
515
|
-
}
|
|
516
|
-
/** All relevant account properties */
|
|
517
|
-
interface AccountProperties {
|
|
518
|
-
/** Whether this account is a team account. */
|
|
519
|
-
isTeam?: boolean;
|
|
520
|
-
/**
|
|
521
|
-
* Account image (display)
|
|
522
|
-
* relevant mainly for CoBranded accounts
|
|
523
|
-
*/
|
|
524
|
-
accountImg?: string | null;
|
|
525
|
-
/**
|
|
526
|
-
* the account banner (display)
|
|
527
|
-
* relevant mainly for CoBranded accounts
|
|
528
|
-
*/
|
|
529
|
-
accountBanner?: string | null;
|
|
530
|
-
/**
|
|
531
|
-
* the account logo (display)
|
|
532
|
-
* wll be shown as the account logo in the UI (top right corner, contributor list etc..)
|
|
533
|
-
*/
|
|
534
|
-
accountLogo?: string | null;
|
|
535
|
-
/**
|
|
536
|
-
* account co branding flag (if exists)
|
|
537
|
-
* an enum for CoBranding flag contains 4 possible options:
|
|
538
|
-
* None - the account is not CoBranded
|
|
539
|
-
* CoBranded - the account has a CoBranding flag
|
|
540
|
-
* CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
|
|
541
|
-
* CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
|
|
542
|
-
*/
|
|
543
|
-
coBranding?: CoBranding;
|
|
544
|
-
/** account's website URL (shown on co branding customers sites) */
|
|
545
|
-
websiteUrl?: string | null;
|
|
546
|
-
/** the id of the parent account of this account, if it has a parent */
|
|
547
|
-
parentAccountId?: string | null;
|
|
548
|
-
}
|
|
549
|
-
/** co branding flag options for account */
|
|
550
|
-
declare enum CoBranding {
|
|
551
|
-
None = "None",
|
|
552
|
-
CoBranded = "CoBranded",
|
|
553
|
-
CoBranded_Customer_New = "CoBranded_Customer_New",
|
|
554
|
-
CoBranded_Customer_Existing = "CoBranded_Customer_Existing"
|
|
555
|
-
}
|
|
556
|
-
interface GetUserAccountsRequest {
|
|
557
|
-
/** the user id that his accounts we query */
|
|
558
|
-
userId?: string;
|
|
559
|
-
/** Limited to max 20 at a single request */
|
|
560
|
-
paging?: Paging$2;
|
|
561
|
-
}
|
|
562
|
-
interface Paging$2 {
|
|
563
|
-
/** Number of items to load. */
|
|
564
|
-
limit?: number | null;
|
|
565
|
-
/** Number of items to skip in the current sort order. */
|
|
566
|
-
offset?: number | null;
|
|
567
|
-
}
|
|
568
|
-
interface AccountsResponse {
|
|
569
|
-
accounts?: Account[];
|
|
570
|
-
}
|
|
571
|
-
interface GetMyUserAccountsRequest {
|
|
572
|
-
/** Limited to max 20 at a single request */
|
|
573
|
-
paging?: Paging$2;
|
|
574
|
-
}
|
|
575
|
-
interface GetAccountRequest {
|
|
576
|
-
/** the account id that it's data should be retrieved */
|
|
577
|
-
accountId?: string;
|
|
578
|
-
}
|
|
579
|
-
interface AccountResponse {
|
|
580
|
-
account?: Account;
|
|
581
|
-
}
|
|
582
|
-
interface GetMyAccountRequest {
|
|
583
|
-
}
|
|
584
|
-
interface GetAccountsRequest {
|
|
585
|
-
/** the account id to retrieve */
|
|
586
|
-
accountIds?: string[];
|
|
587
|
-
}
|
|
588
|
-
interface CreateAccountRequest {
|
|
589
|
-
/** The user to create under the new account, with the roles defined in `roles`. */
|
|
590
|
-
user: User$2;
|
|
591
|
-
/**
|
|
592
|
-
* Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
|
|
593
|
-
* Default: OWNER.
|
|
594
|
-
*/
|
|
595
|
-
roles?: string[] | null;
|
|
596
|
-
}
|
|
597
|
-
/** A User to be created under an implicitly provided accountId: must have a unique email. */
|
|
598
|
-
interface User$2 {
|
|
599
|
-
/** User's unique email address details. Required. */
|
|
600
|
-
email?: Email;
|
|
601
|
-
/** User's single sign on identity, when the user is identified via SSO authentication response token params, as specified by [OpenID Connect](https://openid.net/developers/how-connect-works/) (aka. OIDC) protocol. */
|
|
602
|
-
ssoIdentities?: SsoIdentity[];
|
|
603
|
-
/** Additional user details. */
|
|
604
|
-
userDetails?: UserDetails;
|
|
605
|
-
}
|
|
606
|
-
/** User's email address. */
|
|
607
|
-
interface Email {
|
|
608
|
-
/** User's email address. */
|
|
609
|
-
emailAddress?: string;
|
|
610
|
-
/** Whether the caller has verified the user's email address. */
|
|
611
|
-
isVerified?: boolean;
|
|
612
|
-
}
|
|
613
|
-
/** Single Sign On (aka. SSO) identity; user is identified via SSO authentication response token params, as specified by OpenID Connect (aka. OIDC) protocol */
|
|
614
|
-
interface SsoIdentity {
|
|
615
|
-
/** An SSO setting (URLs, clientId, secret, etc. as required by OIDC protocol) for a specific Identity-Provider (aka. IdP) for a specific Wix account. */
|
|
616
|
-
ssoId?: string;
|
|
617
|
-
/**
|
|
618
|
-
* User ID as stored in IdP. For example a "sub" claim of OIDC protocol,
|
|
619
|
-
* or any other alternative, specified by IdP (Identity Provider).
|
|
620
|
-
*/
|
|
621
|
-
userId?: string;
|
|
622
|
-
}
|
|
623
|
-
/** additional user details */
|
|
624
|
-
interface UserDetails {
|
|
625
|
-
/** User's first name. */
|
|
626
|
-
firstName?: string | null;
|
|
627
|
-
/** User's last name. */
|
|
628
|
-
lastName?: string | null;
|
|
629
|
-
/** URL to location of user's profile picture. */
|
|
630
|
-
profilePictureUrl?: string | null;
|
|
631
|
-
/** User's preferred language in [ISO 639-1:2002](https://en.wikipedia.org/wiki/ISO_639-1) format. For example, "en", "es". */
|
|
632
|
-
language?: string | null;
|
|
633
|
-
/**
|
|
634
|
-
* Original Client IP from which a request was made.
|
|
635
|
-
* This is useful in case where a createUser API is called by some server call, which, in turn, has been called by some client from another IP.
|
|
636
|
-
* Wix checks this IP against the [OFAC sanctioned countries](https://ofac.treasury.gov/sanctions-programs-and-country-information).
|
|
637
|
-
*/
|
|
638
|
-
clientIp?: string | null;
|
|
639
|
-
}
|
|
640
|
-
interface CreateAccountResponse {
|
|
641
|
-
/** The created account. */
|
|
642
|
-
account?: AccountV2;
|
|
643
|
-
}
|
|
644
|
-
interface CreateAccountForMyUserRequest {
|
|
645
|
-
/** the account name */
|
|
646
|
-
accountName?: string | null;
|
|
647
|
-
/** account image url */
|
|
648
|
-
accountImg?: string | null;
|
|
649
|
-
/** whether to mark the account as `studio` */
|
|
650
|
-
studio?: boolean;
|
|
651
|
-
}
|
|
652
|
-
interface CreateAccountTenantRequest {
|
|
653
|
-
slug?: string | null;
|
|
654
|
-
}
|
|
655
|
-
interface CreateAccountTenantResponse {
|
|
656
|
-
account?: AccountV2;
|
|
657
|
-
}
|
|
658
|
-
interface CreateAccountAndAssignUserRequest {
|
|
659
|
-
/** the user id for which we are creating the account */
|
|
660
|
-
userId?: string;
|
|
661
|
-
/** the user name of the user for which the account is created */
|
|
662
|
-
userName?: string;
|
|
663
|
-
/** the parent account of the created account */
|
|
664
|
-
parentAccountId?: string | null;
|
|
665
|
-
/** whether to mark the account as `studio` */
|
|
666
|
-
studio?: boolean;
|
|
667
|
-
}
|
|
668
|
-
interface UpdateAccountRequest {
|
|
669
|
-
/** the account id to update */
|
|
670
|
-
accountId?: string;
|
|
671
|
-
/**
|
|
672
|
-
* DEPRECATED field of image
|
|
673
|
-
* @deprecated
|
|
674
|
-
*/
|
|
675
|
-
accountImg?: string | null;
|
|
676
|
-
/** optional - new account name */
|
|
677
|
-
accountName?: string | null;
|
|
678
|
-
/**
|
|
679
|
-
* the new properties for the account.
|
|
680
|
-
* can be passed partially - and only relevant fields will be updated
|
|
681
|
-
*/
|
|
682
|
-
accountProperties?: AccountProperties;
|
|
683
|
-
}
|
|
684
|
-
interface UpdateParentAccountRequest extends UpdateParentAccountRequestUpdateOneOf {
|
|
685
|
-
/** Removes the parent account */
|
|
686
|
-
remove?: RemoveParent;
|
|
687
|
-
}
|
|
688
|
-
/** @oneof */
|
|
689
|
-
interface UpdateParentAccountRequestUpdateOneOf {
|
|
690
|
-
/** Removes the parent account */
|
|
691
|
-
remove?: RemoveParent;
|
|
692
|
-
}
|
|
693
|
-
interface RemoveParent {
|
|
694
|
-
}
|
|
695
|
-
interface UpdateParentAccountResponse {
|
|
696
|
-
newParentAccountId?: string | null;
|
|
697
|
-
}
|
|
698
|
-
interface DeleteAccountRequest {
|
|
699
|
-
/** the account id to delete */
|
|
700
|
-
accountId?: string;
|
|
701
|
-
/** will throw exception if trying to delete the account of the last user when the value is true */
|
|
702
|
-
shouldNotDeleteLastAccount?: boolean;
|
|
703
|
-
}
|
|
704
|
-
interface EmptyResponse {
|
|
705
|
-
}
|
|
706
|
-
interface UpdateSlugRequest {
|
|
707
|
-
/** account id */
|
|
708
|
-
accountId?: string;
|
|
709
|
-
/** new slug */
|
|
710
|
-
newSlugName?: string;
|
|
711
|
-
}
|
|
712
|
-
interface IsTeamRequest {
|
|
713
|
-
/** the account id to check if it's a team account */
|
|
714
|
-
accountId?: string;
|
|
715
|
-
}
|
|
716
|
-
interface IsTeamResponse {
|
|
717
|
-
/** true if the account is marked as a team account, false if not */
|
|
718
|
-
isTeamAccount?: boolean;
|
|
719
|
-
}
|
|
720
|
-
interface MarkAccountFlagRequest extends MarkAccountFlagRequestFlagOneOf {
|
|
721
|
-
/**
|
|
722
|
-
* account co branding flag (if exists)
|
|
723
|
-
* an enum for CoBranding flag contains 4 possible options:
|
|
724
|
-
* None - the account is not CoBranded
|
|
725
|
-
* CoBranded - the account has a CoBranding flag
|
|
726
|
-
* CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
|
|
727
|
-
* CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
|
|
728
|
-
*/
|
|
729
|
-
coBranding?: CoBranding;
|
|
730
|
-
/** the account id to mark */
|
|
731
|
-
accountId?: string;
|
|
732
|
-
/** the inviting account id in case the flag is given by an invite */
|
|
733
|
-
invitedByAccountId?: string | null;
|
|
734
|
-
}
|
|
735
|
-
/** @oneof */
|
|
736
|
-
interface MarkAccountFlagRequestFlagOneOf {
|
|
737
|
-
/**
|
|
738
|
-
* account co branding flag (if exists)
|
|
739
|
-
* an enum for CoBranding flag contains 4 possible options:
|
|
740
|
-
* None - the account is not CoBranded
|
|
741
|
-
* CoBranded - the account has a CoBranding flag
|
|
742
|
-
* CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
|
|
743
|
-
* CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
|
|
744
|
-
*/
|
|
745
|
-
coBranding?: CoBranding;
|
|
746
|
-
}
|
|
747
|
-
interface GetParentAccountInfoRequest {
|
|
748
|
-
}
|
|
749
|
-
interface GetParentAccountInfoResponse {
|
|
750
|
-
/** The info of the parent account, if the account has a parent */
|
|
751
|
-
parentAccountInfo?: AccountInfo$2;
|
|
752
|
-
}
|
|
753
|
-
interface AccountInfo$2 {
|
|
754
|
-
/** The name of the account */
|
|
755
|
-
name?: string | null;
|
|
756
|
-
/** The url of the image of the account */
|
|
757
|
-
image?: string | null;
|
|
758
|
-
}
|
|
759
|
-
interface GetSubAccountsRequest {
|
|
760
|
-
/** Offset-based pagination for the response. Default page size is 20, max page size is 50 */
|
|
761
|
-
paging?: Paging$2;
|
|
762
|
-
}
|
|
763
|
-
interface GetSubAccountsResponse {
|
|
764
|
-
/** The sub accounts of the target account */
|
|
765
|
-
subAccounts?: SubAccountInfo[];
|
|
766
|
-
/** Metadata of the response pagination */
|
|
767
|
-
pagingMetadata?: PagingMetadata;
|
|
768
|
-
}
|
|
769
|
-
interface SubAccountInfo {
|
|
770
|
-
/** The id of the sub account */
|
|
771
|
-
accountId?: string;
|
|
772
|
-
}
|
|
773
|
-
interface PagingMetadata {
|
|
774
|
-
/** Number of items returned in the response. */
|
|
775
|
-
count?: number | null;
|
|
776
|
-
/** Offset that was requested. */
|
|
777
|
-
offset?: number | null;
|
|
778
|
-
/** Total number of items that match the query. */
|
|
779
|
-
total?: number | null;
|
|
780
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
781
|
-
tooManyToCount?: boolean | null;
|
|
782
|
-
}
|
|
783
|
-
interface ListChildAccountsRequest {
|
|
784
|
-
/**
|
|
785
|
-
* Paging options to limit and offset the number of items.
|
|
786
|
-
* Default: 20. Max: 50.
|
|
787
|
-
*/
|
|
788
|
-
paging?: Paging$2;
|
|
789
|
-
}
|
|
790
|
-
interface ListChildAccountsResponse {
|
|
791
|
-
/** The requested child accounts. */
|
|
792
|
-
childAccounts?: AccountV2[];
|
|
793
|
-
/** Metadata of the response pagination. */
|
|
794
|
-
pagingMetadata?: PagingMetadata;
|
|
795
|
-
}
|
|
796
|
-
interface SetIsReadOnlyAccountRequest {
|
|
797
|
-
accountId?: string;
|
|
798
|
-
isReadOnly?: boolean;
|
|
799
|
-
}
|
|
800
|
-
interface AccountV2NonNullableFields {
|
|
801
|
-
accountId: string;
|
|
802
|
-
}
|
|
803
|
-
interface CreateAccountResponseNonNullableFields {
|
|
804
|
-
account?: AccountV2NonNullableFields;
|
|
805
|
-
}
|
|
806
|
-
interface ListChildAccountsResponseNonNullableFields {
|
|
807
|
-
childAccounts: AccountV2NonNullableFields[];
|
|
808
|
-
}
|
|
809
|
-
interface CreateAccountOptions {
|
|
810
|
-
/**
|
|
811
|
-
* Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
|
|
812
|
-
* Default: OWNER.
|
|
813
|
-
*/
|
|
814
|
-
roles?: string[] | null;
|
|
815
|
-
}
|
|
816
|
-
interface ListChildAccountsOptions {
|
|
817
|
-
/**
|
|
818
|
-
* Paging options to limit and offset the number of items.
|
|
819
|
-
* Default: 20. Max: 50.
|
|
820
|
-
*/
|
|
821
|
-
paging?: Paging$2;
|
|
822
|
-
}
|
|
823
|
-
|
|
824
|
-
declare function createAccount$1(httpClient: HttpClient): CreateAccountSignature;
|
|
825
|
-
interface CreateAccountSignature {
|
|
826
|
-
/**
|
|
827
|
-
* Creates a new Wix account, and creates a new Wix user as the account owner.
|
|
828
|
-
* The newly created account is a child account of the account used to create it, making that account its parent.
|
|
829
|
-
*
|
|
830
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
831
|
-
* @param - The user to create under the new account, with the roles defined in `roles`.
|
|
832
|
-
* @param - Filter options.
|
|
833
|
-
*/
|
|
834
|
-
(user: User$2, options?: CreateAccountOptions | undefined): Promise<CreateAccountResponse & CreateAccountResponseNonNullableFields>;
|
|
835
|
-
}
|
|
836
|
-
declare function listChildAccounts$1(httpClient: HttpClient): ListChildAccountsSignature;
|
|
837
|
-
interface ListChildAccountsSignature {
|
|
838
|
-
/**
|
|
839
|
-
* Retrieves a list of child account IDs for the requesting account.
|
|
840
|
-
* If no child accounts exist, an empty list will be returned.
|
|
841
|
-
*
|
|
842
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
843
|
-
* @param - Filter options.
|
|
844
|
-
*/
|
|
845
|
-
(options?: ListChildAccountsOptions | undefined): Promise<ListChildAccountsResponse & ListChildAccountsResponseNonNullableFields>;
|
|
846
|
-
}
|
|
847
|
-
|
|
848
|
-
declare const createAccount: MaybeContext<BuildRESTFunction<typeof createAccount$1> & typeof createAccount$1>;
|
|
849
|
-
declare const listChildAccounts: MaybeContext<BuildRESTFunction<typeof listChildAccounts$1> & typeof listChildAccounts$1>;
|
|
850
|
-
|
|
851
|
-
type context$4_Account = Account;
|
|
852
|
-
type context$4_AccountProperties = AccountProperties;
|
|
853
|
-
type context$4_AccountResponse = AccountResponse;
|
|
854
|
-
type context$4_AccountStatus = AccountStatus;
|
|
855
|
-
declare const context$4_AccountStatus: typeof AccountStatus;
|
|
856
|
-
type context$4_AccountV2 = AccountV2;
|
|
857
|
-
type context$4_AccountsResponse = AccountsResponse;
|
|
858
|
-
type context$4_CoBranding = CoBranding;
|
|
859
|
-
declare const context$4_CoBranding: typeof CoBranding;
|
|
860
|
-
type context$4_CreateAccountAndAssignUserRequest = CreateAccountAndAssignUserRequest;
|
|
861
|
-
type context$4_CreateAccountForMyUserRequest = CreateAccountForMyUserRequest;
|
|
862
|
-
type context$4_CreateAccountOptions = CreateAccountOptions;
|
|
863
|
-
type context$4_CreateAccountRequest = CreateAccountRequest;
|
|
864
|
-
type context$4_CreateAccountResponse = CreateAccountResponse;
|
|
865
|
-
type context$4_CreateAccountResponseNonNullableFields = CreateAccountResponseNonNullableFields;
|
|
866
|
-
type context$4_CreateAccountTenantRequest = CreateAccountTenantRequest;
|
|
867
|
-
type context$4_CreateAccountTenantResponse = CreateAccountTenantResponse;
|
|
868
|
-
type context$4_DeleteAccountRequest = DeleteAccountRequest;
|
|
869
|
-
type context$4_Email = Email;
|
|
870
|
-
type context$4_EmptyResponse = EmptyResponse;
|
|
871
|
-
type context$4_GetAccountRequest = GetAccountRequest;
|
|
872
|
-
type context$4_GetAccountsRequest = GetAccountsRequest;
|
|
873
|
-
type context$4_GetMyAccountRequest = GetMyAccountRequest;
|
|
874
|
-
type context$4_GetMyUserAccountsRequest = GetMyUserAccountsRequest;
|
|
875
|
-
type context$4_GetParentAccountInfoRequest = GetParentAccountInfoRequest;
|
|
876
|
-
type context$4_GetParentAccountInfoResponse = GetParentAccountInfoResponse;
|
|
877
|
-
type context$4_GetSubAccountsRequest = GetSubAccountsRequest;
|
|
878
|
-
type context$4_GetSubAccountsResponse = GetSubAccountsResponse;
|
|
879
|
-
type context$4_GetUserAccountRequest = GetUserAccountRequest;
|
|
880
|
-
type context$4_GetUserAccountsRequest = GetUserAccountsRequest;
|
|
881
|
-
type context$4_IsTeamRequest = IsTeamRequest;
|
|
882
|
-
type context$4_IsTeamResponse = IsTeamResponse;
|
|
883
|
-
type context$4_ListChildAccountsOptions = ListChildAccountsOptions;
|
|
884
|
-
type context$4_ListChildAccountsRequest = ListChildAccountsRequest;
|
|
885
|
-
type context$4_ListChildAccountsResponse = ListChildAccountsResponse;
|
|
886
|
-
type context$4_ListChildAccountsResponseNonNullableFields = ListChildAccountsResponseNonNullableFields;
|
|
887
|
-
type context$4_MarkAccountFlagRequest = MarkAccountFlagRequest;
|
|
888
|
-
type context$4_MarkAccountFlagRequestFlagOneOf = MarkAccountFlagRequestFlagOneOf;
|
|
889
|
-
type context$4_PagingMetadata = PagingMetadata;
|
|
890
|
-
type context$4_RemoveParent = RemoveParent;
|
|
891
|
-
type context$4_SetIsReadOnlyAccountRequest = SetIsReadOnlyAccountRequest;
|
|
892
|
-
type context$4_SsoIdentity = SsoIdentity;
|
|
893
|
-
type context$4_SubAccountInfo = SubAccountInfo;
|
|
894
|
-
type context$4_UpdateAccountRequest = UpdateAccountRequest;
|
|
895
|
-
type context$4_UpdateParentAccountRequest = UpdateParentAccountRequest;
|
|
896
|
-
type context$4_UpdateParentAccountRequestUpdateOneOf = UpdateParentAccountRequestUpdateOneOf;
|
|
897
|
-
type context$4_UpdateParentAccountResponse = UpdateParentAccountResponse;
|
|
898
|
-
type context$4_UpdateSlugRequest = UpdateSlugRequest;
|
|
899
|
-
type context$4_UserDetails = UserDetails;
|
|
900
|
-
declare const context$4_createAccount: typeof createAccount;
|
|
901
|
-
declare const context$4_listChildAccounts: typeof listChildAccounts;
|
|
902
|
-
declare namespace context$4 {
|
|
903
|
-
export { type context$4_Account as Account, type AccountInfo$2 as AccountInfo, type context$4_AccountProperties as AccountProperties, type context$4_AccountResponse as AccountResponse, context$4_AccountStatus as AccountStatus, type context$4_AccountV2 as AccountV2, type context$4_AccountsResponse as AccountsResponse, context$4_CoBranding as CoBranding, type context$4_CreateAccountAndAssignUserRequest as CreateAccountAndAssignUserRequest, type context$4_CreateAccountForMyUserRequest as CreateAccountForMyUserRequest, type context$4_CreateAccountOptions as CreateAccountOptions, type context$4_CreateAccountRequest as CreateAccountRequest, type context$4_CreateAccountResponse as CreateAccountResponse, type context$4_CreateAccountResponseNonNullableFields as CreateAccountResponseNonNullableFields, type context$4_CreateAccountTenantRequest as CreateAccountTenantRequest, type context$4_CreateAccountTenantResponse as CreateAccountTenantResponse, type context$4_DeleteAccountRequest as DeleteAccountRequest, type context$4_Email as Email, type context$4_EmptyResponse as EmptyResponse, type context$4_GetAccountRequest as GetAccountRequest, type context$4_GetAccountsRequest as GetAccountsRequest, type context$4_GetMyAccountRequest as GetMyAccountRequest, type context$4_GetMyUserAccountsRequest as GetMyUserAccountsRequest, type context$4_GetParentAccountInfoRequest as GetParentAccountInfoRequest, type context$4_GetParentAccountInfoResponse as GetParentAccountInfoResponse, type context$4_GetSubAccountsRequest as GetSubAccountsRequest, type context$4_GetSubAccountsResponse as GetSubAccountsResponse, type context$4_GetUserAccountRequest as GetUserAccountRequest, type context$4_GetUserAccountsRequest as GetUserAccountsRequest, type context$4_IsTeamRequest as IsTeamRequest, type context$4_IsTeamResponse as IsTeamResponse, type context$4_ListChildAccountsOptions as ListChildAccountsOptions, type context$4_ListChildAccountsRequest as ListChildAccountsRequest, type context$4_ListChildAccountsResponse as ListChildAccountsResponse, type context$4_ListChildAccountsResponseNonNullableFields as ListChildAccountsResponseNonNullableFields, type context$4_MarkAccountFlagRequest as MarkAccountFlagRequest, type context$4_MarkAccountFlagRequestFlagOneOf as MarkAccountFlagRequestFlagOneOf, type Paging$2 as Paging, type context$4_PagingMetadata as PagingMetadata, type context$4_RemoveParent as RemoveParent, type context$4_SetIsReadOnlyAccountRequest as SetIsReadOnlyAccountRequest, type context$4_SsoIdentity as SsoIdentity, type context$4_SubAccountInfo as SubAccountInfo, type context$4_UpdateAccountRequest as UpdateAccountRequest, type context$4_UpdateParentAccountRequest as UpdateParentAccountRequest, type context$4_UpdateParentAccountRequestUpdateOneOf as UpdateParentAccountRequestUpdateOneOf, type context$4_UpdateParentAccountResponse as UpdateParentAccountResponse, type context$4_UpdateSlugRequest as UpdateSlugRequest, type User$2 as User, type context$4_UserDetails as UserDetails, context$4_createAccount as createAccount, context$4_listChildAccounts as listChildAccounts };
|
|
904
|
-
}
|
|
905
|
-
|
|
906
|
-
interface AccountInvite$1 {
|
|
907
|
-
/**
|
|
908
|
-
* Invite ID.
|
|
909
|
-
* @readonly
|
|
910
|
-
*/
|
|
911
|
-
_id?: string;
|
|
912
|
-
/**
|
|
913
|
-
* Account ID.
|
|
914
|
-
* @readonly
|
|
915
|
-
*/
|
|
916
|
-
accountId?: string;
|
|
917
|
-
/** Email address where the invite was sent. */
|
|
918
|
-
email?: string;
|
|
919
|
-
/**
|
|
920
|
-
* Deprecated. Use `policyIds`.
|
|
921
|
-
* @deprecated
|
|
922
|
-
*/
|
|
923
|
-
role?: string;
|
|
924
|
-
/**
|
|
925
|
-
* Deprecated. Use `inviterAccountId`.
|
|
926
|
-
* @readonly
|
|
927
|
-
* @deprecated
|
|
928
|
-
*/
|
|
929
|
-
inviterId?: string;
|
|
930
|
-
/**
|
|
931
|
-
* Invite status.
|
|
932
|
-
*
|
|
933
|
-
* Supported values:
|
|
934
|
-
* - **Pending:** The invite has been sent and is valid, waiting for the user's response.
|
|
935
|
-
* - **Used:** The invite has been accepted.
|
|
936
|
-
* - **Deleted:** The invite has been deleted or revoked.
|
|
937
|
-
* - **Declined:** The user has declined the invite.
|
|
938
|
-
* - **Expired:** The invite has expired without being accepted.
|
|
939
|
-
*/
|
|
940
|
-
status?: InviteStatus$3;
|
|
941
|
-
/** Link to accept the invite. */
|
|
942
|
-
acceptLink?: string;
|
|
943
|
-
/**
|
|
944
|
-
* Inviting account ID.
|
|
945
|
-
* @readonly
|
|
946
|
-
*/
|
|
947
|
-
inviterAccountId?: string;
|
|
948
|
-
/**
|
|
949
|
-
* Account ID that accepted the invite. Populated only once the invite is accepted.
|
|
950
|
-
* @readonly
|
|
951
|
-
*/
|
|
952
|
-
acceptedByAccountId?: string | null;
|
|
953
|
-
/** Date the invite was created. */
|
|
954
|
-
dateCreated?: Date | null;
|
|
955
|
-
/** Role IDs included in the invite. */
|
|
956
|
-
policyIds?: string[];
|
|
957
|
-
/** Date the invite was last updated. */
|
|
958
|
-
dateUpdated?: Date | null;
|
|
959
|
-
/** Assets the users are invited to join. */
|
|
960
|
-
assignments?: InviteResourceAssignment$1[];
|
|
961
|
-
/** Invite expiration date. */
|
|
962
|
-
expirationDate?: Date | null;
|
|
963
|
-
}
|
|
964
|
-
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
965
|
-
declare enum InviteStatus$3 {
|
|
966
|
-
Pending = "Pending",
|
|
967
|
-
Used = "Used",
|
|
968
|
-
Deleted = "Deleted",
|
|
969
|
-
Declined = "Declined",
|
|
970
|
-
Expired = "Expired"
|
|
971
|
-
}
|
|
972
|
-
interface InviteResourceAssignment$1 {
|
|
973
|
-
/** Role ID. */
|
|
974
|
-
policyId?: string;
|
|
975
|
-
/** Resources the user will be able to access. */
|
|
976
|
-
assignments?: InviteAssignment$1[];
|
|
977
|
-
}
|
|
978
|
-
interface InviteAssignment$1 {
|
|
979
|
-
/** Full name of resource to be assigned. */
|
|
980
|
-
fullNameResource?: FullNameResource$1;
|
|
981
|
-
}
|
|
982
|
-
interface FullNameResource$1 extends FullNameResourceResourceContextOneOf$1 {
|
|
983
|
-
/** Specific site details. */
|
|
984
|
-
siteContext?: SiteResourceContext$1;
|
|
985
|
-
/** Specific account details. */
|
|
986
|
-
accountContext?: AccountResourceContext$1;
|
|
987
|
-
}
|
|
988
|
-
/** @oneof */
|
|
989
|
-
interface FullNameResourceResourceContextOneOf$1 {
|
|
990
|
-
/** Specific site details. */
|
|
991
|
-
siteContext?: SiteResourceContext$1;
|
|
992
|
-
/** Specific account details. */
|
|
993
|
-
accountContext?: AccountResourceContext$1;
|
|
994
|
-
}
|
|
995
|
-
/** Site resource context. It indicates that the resource is under a site (can be the site itself or some asset of a site, like a blog post) */
|
|
996
|
-
interface SiteResourceContext$1 {
|
|
997
|
-
/** Site ID. */
|
|
998
|
-
metasiteId?: string;
|
|
999
|
-
}
|
|
1000
|
-
/** Account resource contexts. It indicates that the resource is under the account (can be the account itself or some asset of an account, like a logo or a domain) */
|
|
1001
|
-
interface AccountResourceContext$1 {
|
|
1002
|
-
/** Account ID. */
|
|
1003
|
-
accountId?: string;
|
|
1004
|
-
}
|
|
1005
|
-
interface OrganizationResourceContext$1 {
|
|
1006
|
-
}
|
|
1007
|
-
/**
|
|
1008
|
-
* A custom resource. Is used to represent some asset that is not a direct resource context (site or account), but something custom.
|
|
1009
|
-
* For example: payment method, blog post, domain, logo.
|
|
1010
|
-
*/
|
|
1011
|
-
interface Resource$2 {
|
|
1012
|
-
/** The resource id. */
|
|
1013
|
-
_id?: string | null;
|
|
1014
|
-
/** The resource type */
|
|
1015
|
-
type?: string | null;
|
|
1016
|
-
}
|
|
1017
|
-
interface PolicyCondition$1 {
|
|
1018
|
-
/** The type of the condition */
|
|
1019
|
-
condition?: ConditionType$1;
|
|
1020
|
-
}
|
|
1021
|
-
interface ConditionType$1 extends ConditionTypeOfOneOf$1 {
|
|
1022
|
-
/** @deprecated */
|
|
1023
|
-
simpleCondition?: SimpleCondition$1;
|
|
1024
|
-
/** A logic combination between several conditions, with an operator between them */
|
|
1025
|
-
joinedConditions?: JoinedCondition$1;
|
|
1026
|
-
/** @deprecated */
|
|
1027
|
-
environmentCondition?: EnvironmentCondition$1;
|
|
1028
|
-
/** A single condition */
|
|
1029
|
-
condition?: Condition$2;
|
|
1030
|
-
}
|
|
1031
|
-
/** @oneof */
|
|
1032
|
-
interface ConditionTypeOfOneOf$1 {
|
|
1033
|
-
/** @deprecated */
|
|
1034
|
-
simpleCondition?: SimpleCondition$1;
|
|
1035
|
-
/** A logic combination between several conditions, with an operator between them */
|
|
1036
|
-
joinedConditions?: JoinedCondition$1;
|
|
1037
|
-
/** @deprecated */
|
|
1038
|
-
environmentCondition?: EnvironmentCondition$1;
|
|
1039
|
-
/** A single condition */
|
|
1040
|
-
condition?: Condition$2;
|
|
1041
|
-
}
|
|
1042
|
-
interface SimpleCondition$1 {
|
|
1043
|
-
attrName?: string;
|
|
1044
|
-
value?: SimpleConditionValue$1;
|
|
1045
|
-
op?: SimpleConditionOperator$1;
|
|
1046
|
-
conditionModelId?: string;
|
|
1047
|
-
}
|
|
1048
|
-
interface SimpleConditionValue$1 extends SimpleConditionValueValueOneOf$1 {
|
|
1049
|
-
attrName?: string;
|
|
1050
|
-
stringValue?: string;
|
|
1051
|
-
boolValue?: boolean;
|
|
1052
|
-
}
|
|
1053
|
-
/** @oneof */
|
|
1054
|
-
interface SimpleConditionValueValueOneOf$1 {
|
|
1055
|
-
attrName?: string;
|
|
1056
|
-
stringValue?: string;
|
|
1057
|
-
boolValue?: boolean;
|
|
1058
|
-
}
|
|
1059
|
-
declare enum SimpleConditionOperator$1 {
|
|
1060
|
-
UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP",
|
|
1061
|
-
EQUAL = "EQUAL"
|
|
1062
|
-
}
|
|
1063
|
-
interface JoinedCondition$1 {
|
|
1064
|
-
/** The operator that should be used when evaluating the condition */
|
|
1065
|
-
op?: JoinedConditionOperator$1;
|
|
1066
|
-
/** The conditions that should be evaluated, and then joined using the operator provided */
|
|
1067
|
-
conditions?: ConditionType$1[];
|
|
1068
|
-
}
|
|
1069
|
-
declare enum JoinedConditionOperator$1 {
|
|
1070
|
-
UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP",
|
|
1071
|
-
OR = "OR",
|
|
1072
|
-
AND = "AND"
|
|
1073
|
-
}
|
|
1074
|
-
interface EnvironmentCondition$1 extends EnvironmentConditionConditionOneOf$1 {
|
|
1075
|
-
experimentCondition?: ExperimentCondition$1;
|
|
1076
|
-
}
|
|
1077
|
-
/** @oneof */
|
|
1078
|
-
interface EnvironmentConditionConditionOneOf$1 {
|
|
1079
|
-
experimentCondition?: ExperimentCondition$1;
|
|
1080
|
-
}
|
|
1081
|
-
interface ExperimentCondition$1 {
|
|
1082
|
-
spec?: string;
|
|
1083
|
-
fallbackValue?: string;
|
|
1084
|
-
expectedValue?: string;
|
|
1085
|
-
}
|
|
1086
|
-
interface Condition$2 {
|
|
1087
|
-
/** The unique identifier of the condition model. Indicates which actions the condition is working on */
|
|
1088
|
-
conditionModelId?: string;
|
|
1089
|
-
/** The operator that should be evaluated */
|
|
1090
|
-
operator?: ConditionOperator$1;
|
|
1091
|
-
}
|
|
1092
|
-
interface ConditionOperator$1 extends ConditionOperatorOperatorsOneOf$1 {
|
|
1093
|
-
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
1094
|
-
equals?: EqualOperator$1;
|
|
1095
|
-
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
1096
|
-
like?: LikeOperator$1;
|
|
1097
|
-
/** Petri experiment - will be evaluated using petri. */
|
|
1098
|
-
experiment?: ExperimentOperator$1;
|
|
1099
|
-
/** Operator that indicates a dependency on another subject being allowed to perform something. */
|
|
1100
|
-
dependOn?: DependOnOperator$1;
|
|
1101
|
-
}
|
|
1102
|
-
/** @oneof */
|
|
1103
|
-
interface ConditionOperatorOperatorsOneOf$1 {
|
|
1104
|
-
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
1105
|
-
equals?: EqualOperator$1;
|
|
1106
|
-
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
1107
|
-
like?: LikeOperator$1;
|
|
1108
|
-
/** Petri experiment - will be evaluated using petri. */
|
|
1109
|
-
experiment?: ExperimentOperator$1;
|
|
1110
|
-
/** Operator that indicates a dependency on another subject being allowed to perform something. */
|
|
1111
|
-
dependOn?: DependOnOperator$1;
|
|
1112
|
-
}
|
|
1113
|
-
interface EqualOperator$1 {
|
|
1114
|
-
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the other side (attribute/value) */
|
|
1115
|
-
attrName?: string;
|
|
1116
|
-
/** The value to compare to. If the two parties are equal - we will return true. */
|
|
1117
|
-
value?: ConditionValue$1;
|
|
1118
|
-
}
|
|
1119
|
-
interface ConditionValue$1 extends ConditionValueValueOneOf$1 {
|
|
1120
|
-
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
1121
|
-
attrName?: string;
|
|
1122
|
-
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
1123
|
-
stringValue?: string;
|
|
1124
|
-
/** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
1125
|
-
boolValue?: boolean;
|
|
1126
|
-
}
|
|
1127
|
-
/** @oneof */
|
|
1128
|
-
interface ConditionValueValueOneOf$1 {
|
|
1129
|
-
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
1130
|
-
attrName?: string;
|
|
1131
|
-
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
1132
|
-
stringValue?: string;
|
|
1133
|
-
/** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
1134
|
-
boolValue?: boolean;
|
|
1135
|
-
}
|
|
1136
|
-
interface LikeOperator$1 {
|
|
1137
|
-
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the regex values provided. */
|
|
1138
|
-
attrName?: string;
|
|
1139
|
-
/** The regex values which the attribute value should be evaluated on. If the attribute value matches at least one of the regular expressions provided - we will return true */
|
|
1140
|
-
values?: string[];
|
|
1141
|
-
}
|
|
1142
|
-
interface ExperimentOperator$1 {
|
|
1143
|
-
/** The spec to conduct the experiment on. */
|
|
1144
|
-
spec?: string;
|
|
1145
|
-
/** The value to use if the experiment could not be conducted */
|
|
1146
|
-
fallbackValue?: string;
|
|
1147
|
-
/** The expected value of the experiment conduction. If it matches the actual value - true will be returned. Otherwise - false. */
|
|
1148
|
-
expectedValue?: string;
|
|
1149
|
-
}
|
|
1150
|
-
/** Implies that the policy takes affect only if the depend on subject is permitted as well. */
|
|
1151
|
-
interface DependOnOperator$1 {
|
|
1152
|
-
/** The subject on which the current entry depends on. If the subject is allowed to perform what the query was about - the condition will be evaluated to true. Otherwise - false */
|
|
1153
|
-
dependOnSubject?: Subject$2;
|
|
1154
|
-
}
|
|
1155
|
-
interface Subject$2 {
|
|
1156
|
-
/** ID of identity assigned to the asset. */
|
|
1157
|
-
_id?: string;
|
|
1158
|
-
/** Type of identity assigned to the asset. Supported subject types include user IDs, account IDs, and app IDs. */
|
|
1159
|
-
subjectType?: SubjectType$2;
|
|
1160
|
-
/** Context of identity assigned to the asset. For example, a `subjectType` = `USER` will have `context` = `ACCOUNT`. */
|
|
1161
|
-
context?: SubjectContext$2;
|
|
1162
|
-
}
|
|
1163
|
-
declare enum SubjectType$2 {
|
|
1164
|
-
UNKNOWN = "UNKNOWN",
|
|
1165
|
-
ACCOUNT = "ACCOUNT",
|
|
1166
|
-
USER = "USER",
|
|
1167
|
-
USER_GROUP = "USER_GROUP",
|
|
1168
|
-
MEMBER_GROUP = "MEMBER_GROUP",
|
|
1169
|
-
VISITOR_GROUP = "VISITOR_GROUP",
|
|
1170
|
-
EXTERNAL_APP = "EXTERNAL_APP",
|
|
1171
|
-
ACCOUNT_GROUP = "ACCOUNT_GROUP",
|
|
1172
|
-
WIX_APP = "WIX_APP"
|
|
1173
|
-
}
|
|
1174
|
-
interface SubjectContext$2 {
|
|
1175
|
-
_id?: string;
|
|
1176
|
-
contextType?: SubjectContextType$2;
|
|
1177
|
-
}
|
|
1178
|
-
declare enum SubjectContextType$2 {
|
|
1179
|
-
UNKNOWN_CTX = "UNKNOWN_CTX",
|
|
1180
|
-
ORG_CTX = "ORG_CTX",
|
|
1181
|
-
ACCOUNT_CTX = "ACCOUNT_CTX"
|
|
1182
|
-
}
|
|
1183
|
-
interface GetAccountInvitesRequest {
|
|
1184
|
-
}
|
|
1185
|
-
interface GetAccountInvitesResponse {
|
|
1186
|
-
invites?: AccountInvite$1[];
|
|
1187
|
-
}
|
|
1188
|
-
interface GetAccountInviteRequest {
|
|
1189
|
-
_id?: string;
|
|
1190
|
-
}
|
|
1191
|
-
interface GetAccountInviteResponse {
|
|
1192
|
-
invite?: AccountInvite$1;
|
|
1193
|
-
}
|
|
1194
|
-
interface AccountInviteRequest {
|
|
1195
|
-
role?: string;
|
|
1196
|
-
email?: string;
|
|
1197
|
-
policyIds?: string[];
|
|
1198
|
-
}
|
|
1199
|
-
interface AccountInviteResponse {
|
|
1200
|
-
invite?: AccountInvite$1;
|
|
1201
|
-
}
|
|
1202
|
-
interface CreateInviteRequest {
|
|
1203
|
-
/** Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite). */
|
|
1204
|
-
subjectsAssignments: SubjectInviteAssignments[];
|
|
1205
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1206
|
-
defaultEmailLanguage?: string | null;
|
|
1207
|
-
}
|
|
1208
|
-
interface SubjectInviteAssignments {
|
|
1209
|
-
/** Invitee's email address. */
|
|
1210
|
-
subjectEmail?: string;
|
|
1211
|
-
/** Mapping of roles (referred to here as policies) and assets (referred to here as resources) that will be assigned to the invitee when they accept the invite. When no resources are specified, the invitee will be given access to everything within the account. */
|
|
1212
|
-
assignments?: InviteResourceAssignment$1[];
|
|
1213
|
-
}
|
|
1214
|
-
interface CreateInviteResponse {
|
|
1215
|
-
/** Invites that were sent successfully. */
|
|
1216
|
-
successfulInvites?: AccountInvite$1[];
|
|
1217
|
-
/** Invites that failed. */
|
|
1218
|
-
failedInvites?: InviteFailure[];
|
|
1219
|
-
}
|
|
1220
|
-
interface InviteFailure {
|
|
1221
|
-
/** Email address of the failed invite. */
|
|
1222
|
-
subjectEmail?: string;
|
|
1223
|
-
/** Error description. */
|
|
1224
|
-
errorMessage?: string;
|
|
1225
|
-
}
|
|
1226
|
-
interface BulkAccountInviteRequest {
|
|
1227
|
-
role?: string;
|
|
1228
|
-
emails?: string[];
|
|
1229
|
-
policyIds?: string[];
|
|
1230
|
-
}
|
|
1231
|
-
interface BulkAccountInviteResponse {
|
|
1232
|
-
invites?: AccountInvite$1[];
|
|
1233
|
-
failedEmails?: string[];
|
|
1234
|
-
}
|
|
1235
|
-
interface ResendAccountInviteRequest {
|
|
1236
|
-
inviteId?: string;
|
|
1237
|
-
/** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */
|
|
1238
|
-
defaultEmailLanguage?: string | null;
|
|
1239
|
-
}
|
|
1240
|
-
interface AcceptAccountInviteRequest {
|
|
1241
|
-
inviteToken?: string;
|
|
1242
|
-
}
|
|
1243
|
-
interface AcceptAccountInviteResponse {
|
|
1244
|
-
}
|
|
1245
|
-
interface RevokeAccountInviteRequest {
|
|
1246
|
-
inviteId?: string;
|
|
1247
|
-
}
|
|
1248
|
-
interface RevokeAccountInviteResponse {
|
|
1249
|
-
}
|
|
1250
|
-
interface UpdateAccountInviteRequest {
|
|
1251
|
-
inviteId?: string;
|
|
1252
|
-
role?: string;
|
|
1253
|
-
policyIds?: string[];
|
|
1254
|
-
}
|
|
1255
|
-
interface UpdateAccountInviteResponse {
|
|
1256
|
-
}
|
|
1257
|
-
interface UpdateAccountInviteAssignmentsRequest {
|
|
1258
|
-
inviteId?: string;
|
|
1259
|
-
assignments?: InviteResourceAssignment$1[];
|
|
1260
|
-
}
|
|
1261
|
-
interface UpdateAccountInviteAssignmentsResponse {
|
|
1262
|
-
}
|
|
1263
|
-
interface ParseAccountInviteTokenRequest {
|
|
1264
|
-
inviteToken?: string;
|
|
1265
|
-
}
|
|
1266
|
-
interface ParseAccountInviteTokenResponse {
|
|
1267
|
-
inviteId?: string;
|
|
1268
|
-
accountId?: string;
|
|
1269
|
-
status?: InviteStatus$3;
|
|
1270
|
-
}
|
|
1271
|
-
interface SiteResourceContextNonNullableFields {
|
|
1272
|
-
metasiteId: string;
|
|
1273
|
-
}
|
|
1274
|
-
interface AccountResourceContextNonNullableFields {
|
|
1275
|
-
accountId: string;
|
|
1276
|
-
}
|
|
1277
|
-
interface FullNameResourceNonNullableFields {
|
|
1278
|
-
siteContext?: SiteResourceContextNonNullableFields;
|
|
1279
|
-
accountContext?: AccountResourceContextNonNullableFields;
|
|
1280
|
-
}
|
|
1281
|
-
interface SimpleConditionValueNonNullableFields {
|
|
1282
|
-
attrName: string;
|
|
1283
|
-
stringValue: string;
|
|
1284
|
-
boolValue: boolean;
|
|
1285
|
-
}
|
|
1286
|
-
interface SimpleConditionNonNullableFields {
|
|
1287
|
-
attrName: string;
|
|
1288
|
-
value?: SimpleConditionValueNonNullableFields;
|
|
1289
|
-
op: SimpleConditionOperator$1;
|
|
1290
|
-
conditionModelId: string;
|
|
1291
|
-
}
|
|
1292
|
-
interface JoinedConditionNonNullableFields {
|
|
1293
|
-
op: JoinedConditionOperator$1;
|
|
1294
|
-
conditions: ConditionTypeNonNullableFields[];
|
|
1295
|
-
}
|
|
1296
|
-
interface ExperimentConditionNonNullableFields {
|
|
1297
|
-
spec: string;
|
|
1298
|
-
fallbackValue: string;
|
|
1299
|
-
expectedValue: string;
|
|
1300
|
-
}
|
|
1301
|
-
interface EnvironmentConditionNonNullableFields {
|
|
1302
|
-
experimentCondition?: ExperimentConditionNonNullableFields;
|
|
1303
|
-
}
|
|
1304
|
-
interface ConditionValueNonNullableFields {
|
|
1305
|
-
attrName: string;
|
|
1306
|
-
stringValue: string;
|
|
1307
|
-
boolValue: boolean;
|
|
1308
|
-
}
|
|
1309
|
-
interface EqualOperatorNonNullableFields {
|
|
1310
|
-
attrName: string;
|
|
1311
|
-
value?: ConditionValueNonNullableFields;
|
|
1312
|
-
}
|
|
1313
|
-
interface LikeOperatorNonNullableFields {
|
|
1314
|
-
attrName: string;
|
|
1315
|
-
values: string[];
|
|
1316
|
-
}
|
|
1317
|
-
interface ExperimentOperatorNonNullableFields {
|
|
1318
|
-
spec: string;
|
|
1319
|
-
fallbackValue: string;
|
|
1320
|
-
expectedValue: string;
|
|
1321
|
-
}
|
|
1322
|
-
interface SubjectContextNonNullableFields {
|
|
1323
|
-
_id: string;
|
|
1324
|
-
contextType: SubjectContextType$2;
|
|
1325
|
-
}
|
|
1326
|
-
interface SubjectNonNullableFields {
|
|
1327
|
-
_id: string;
|
|
1328
|
-
subjectType: SubjectType$2;
|
|
1329
|
-
context?: SubjectContextNonNullableFields;
|
|
1330
|
-
}
|
|
1331
|
-
interface DependOnOperatorNonNullableFields {
|
|
1332
|
-
dependOnSubject?: SubjectNonNullableFields;
|
|
1333
|
-
}
|
|
1334
|
-
interface ConditionOperatorNonNullableFields {
|
|
1335
|
-
equals?: EqualOperatorNonNullableFields;
|
|
1336
|
-
like?: LikeOperatorNonNullableFields;
|
|
1337
|
-
experiment?: ExperimentOperatorNonNullableFields;
|
|
1338
|
-
dependOn?: DependOnOperatorNonNullableFields;
|
|
1339
|
-
}
|
|
1340
|
-
interface ConditionNonNullableFields {
|
|
1341
|
-
conditionModelId: string;
|
|
1342
|
-
operator?: ConditionOperatorNonNullableFields;
|
|
1343
|
-
}
|
|
1344
|
-
interface ConditionTypeNonNullableFields {
|
|
1345
|
-
simpleCondition?: SimpleConditionNonNullableFields;
|
|
1346
|
-
joinedConditions?: JoinedConditionNonNullableFields;
|
|
1347
|
-
environmentCondition?: EnvironmentConditionNonNullableFields;
|
|
1348
|
-
condition?: ConditionNonNullableFields;
|
|
1349
|
-
}
|
|
1350
|
-
interface PolicyConditionNonNullableFields {
|
|
1351
|
-
condition?: ConditionTypeNonNullableFields;
|
|
1352
|
-
}
|
|
1353
|
-
interface InviteAssignmentNonNullableFields {
|
|
1354
|
-
fullNameResource?: FullNameResourceNonNullableFields;
|
|
1355
|
-
condition?: PolicyConditionNonNullableFields;
|
|
1356
|
-
}
|
|
1357
|
-
interface InviteResourceAssignmentNonNullableFields {
|
|
1358
|
-
policyId: string;
|
|
1359
|
-
assignments: InviteAssignmentNonNullableFields[];
|
|
1360
|
-
}
|
|
1361
|
-
interface AccountInviteNonNullableFields {
|
|
1362
|
-
_id: string;
|
|
1363
|
-
accountId: string;
|
|
1364
|
-
email: string;
|
|
1365
|
-
role: string;
|
|
1366
|
-
inviterId: string;
|
|
1367
|
-
status: InviteStatus$3;
|
|
1368
|
-
acceptLink: string;
|
|
1369
|
-
inviterAccountId: string;
|
|
1370
|
-
policyIds: string[];
|
|
1371
|
-
assignments: InviteResourceAssignmentNonNullableFields[];
|
|
1372
|
-
}
|
|
1373
|
-
interface InviteFailureNonNullableFields {
|
|
1374
|
-
subjectEmail: string;
|
|
1375
|
-
errorMessage: string;
|
|
1376
|
-
}
|
|
1377
|
-
interface CreateInviteResponseNonNullableFields {
|
|
1378
|
-
successfulInvites: AccountInviteNonNullableFields[];
|
|
1379
|
-
failedInvites: InviteFailureNonNullableFields[];
|
|
1380
|
-
}
|
|
1381
|
-
interface CreateInviteOptions {
|
|
1382
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1383
|
-
defaultEmailLanguage?: string | null;
|
|
1384
|
-
}
|
|
1385
|
-
|
|
1386
|
-
declare function createInvite$1(httpClient: HttpClient): CreateInviteSignature;
|
|
1387
|
-
interface CreateInviteSignature {
|
|
1388
|
-
/**
|
|
1389
|
-
* Creates and sends invite emails to a list of potential team members, inviting them to become team members of the requesting account.
|
|
1390
|
-
* The invites may be limited to a specific resource (site or other asset).
|
|
1391
|
-
* Maximum 50 invitees can be specified per call.
|
|
1392
|
-
*
|
|
1393
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1394
|
-
* @param - Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite).
|
|
1395
|
-
* @param - Filter options.
|
|
1396
|
-
*/
|
|
1397
|
-
(subjectsAssignments: SubjectInviteAssignments[], options?: CreateInviteOptions | undefined): Promise<CreateInviteResponse & CreateInviteResponseNonNullableFields>;
|
|
1398
|
-
}
|
|
1399
|
-
|
|
1400
|
-
declare const createInvite: MaybeContext<BuildRESTFunction<typeof createInvite$1> & typeof createInvite$1>;
|
|
1401
|
-
|
|
1402
|
-
type context$3_AcceptAccountInviteRequest = AcceptAccountInviteRequest;
|
|
1403
|
-
type context$3_AcceptAccountInviteResponse = AcceptAccountInviteResponse;
|
|
1404
|
-
type context$3_AccountInviteRequest = AccountInviteRequest;
|
|
1405
|
-
type context$3_AccountInviteResponse = AccountInviteResponse;
|
|
1406
|
-
type context$3_BulkAccountInviteRequest = BulkAccountInviteRequest;
|
|
1407
|
-
type context$3_BulkAccountInviteResponse = BulkAccountInviteResponse;
|
|
1408
|
-
type context$3_CreateInviteOptions = CreateInviteOptions;
|
|
1409
|
-
type context$3_CreateInviteRequest = CreateInviteRequest;
|
|
1410
|
-
type context$3_CreateInviteResponse = CreateInviteResponse;
|
|
1411
|
-
type context$3_CreateInviteResponseNonNullableFields = CreateInviteResponseNonNullableFields;
|
|
1412
|
-
type context$3_GetAccountInviteRequest = GetAccountInviteRequest;
|
|
1413
|
-
type context$3_GetAccountInviteResponse = GetAccountInviteResponse;
|
|
1414
|
-
type context$3_GetAccountInvitesRequest = GetAccountInvitesRequest;
|
|
1415
|
-
type context$3_GetAccountInvitesResponse = GetAccountInvitesResponse;
|
|
1416
|
-
type context$3_InviteFailure = InviteFailure;
|
|
1417
|
-
type context$3_ParseAccountInviteTokenRequest = ParseAccountInviteTokenRequest;
|
|
1418
|
-
type context$3_ParseAccountInviteTokenResponse = ParseAccountInviteTokenResponse;
|
|
1419
|
-
type context$3_ResendAccountInviteRequest = ResendAccountInviteRequest;
|
|
1420
|
-
type context$3_RevokeAccountInviteRequest = RevokeAccountInviteRequest;
|
|
1421
|
-
type context$3_RevokeAccountInviteResponse = RevokeAccountInviteResponse;
|
|
1422
|
-
type context$3_SubjectInviteAssignments = SubjectInviteAssignments;
|
|
1423
|
-
type context$3_UpdateAccountInviteAssignmentsRequest = UpdateAccountInviteAssignmentsRequest;
|
|
1424
|
-
type context$3_UpdateAccountInviteAssignmentsResponse = UpdateAccountInviteAssignmentsResponse;
|
|
1425
|
-
type context$3_UpdateAccountInviteRequest = UpdateAccountInviteRequest;
|
|
1426
|
-
type context$3_UpdateAccountInviteResponse = UpdateAccountInviteResponse;
|
|
1427
|
-
declare const context$3_createInvite: typeof createInvite;
|
|
1428
|
-
declare namespace context$3 {
|
|
1429
|
-
export { type context$3_AcceptAccountInviteRequest as AcceptAccountInviteRequest, type context$3_AcceptAccountInviteResponse as AcceptAccountInviteResponse, type AccountInvite$1 as AccountInvite, type context$3_AccountInviteRequest as AccountInviteRequest, type context$3_AccountInviteResponse as AccountInviteResponse, type AccountResourceContext$1 as AccountResourceContext, type context$3_BulkAccountInviteRequest as BulkAccountInviteRequest, type context$3_BulkAccountInviteResponse as BulkAccountInviteResponse, type Condition$2 as Condition, type ConditionOperator$1 as ConditionOperator, type ConditionOperatorOperatorsOneOf$1 as ConditionOperatorOperatorsOneOf, type ConditionType$1 as ConditionType, type ConditionTypeOfOneOf$1 as ConditionTypeOfOneOf, type ConditionValue$1 as ConditionValue, type ConditionValueValueOneOf$1 as ConditionValueValueOneOf, type context$3_CreateInviteOptions as CreateInviteOptions, type context$3_CreateInviteRequest as CreateInviteRequest, type context$3_CreateInviteResponse as CreateInviteResponse, type context$3_CreateInviteResponseNonNullableFields as CreateInviteResponseNonNullableFields, type DependOnOperator$1 as DependOnOperator, type EnvironmentCondition$1 as EnvironmentCondition, type EnvironmentConditionConditionOneOf$1 as EnvironmentConditionConditionOneOf, type EqualOperator$1 as EqualOperator, type ExperimentCondition$1 as ExperimentCondition, type ExperimentOperator$1 as ExperimentOperator, type FullNameResource$1 as FullNameResource, type FullNameResourceResourceContextOneOf$1 as FullNameResourceResourceContextOneOf, type context$3_GetAccountInviteRequest as GetAccountInviteRequest, type context$3_GetAccountInviteResponse as GetAccountInviteResponse, type context$3_GetAccountInvitesRequest as GetAccountInvitesRequest, type context$3_GetAccountInvitesResponse as GetAccountInvitesResponse, type InviteAssignment$1 as InviteAssignment, type context$3_InviteFailure as InviteFailure, type InviteResourceAssignment$1 as InviteResourceAssignment, InviteStatus$3 as InviteStatus, type JoinedCondition$1 as JoinedCondition, JoinedConditionOperator$1 as JoinedConditionOperator, type LikeOperator$1 as LikeOperator, type OrganizationResourceContext$1 as OrganizationResourceContext, type context$3_ParseAccountInviteTokenRequest as ParseAccountInviteTokenRequest, type context$3_ParseAccountInviteTokenResponse as ParseAccountInviteTokenResponse, type PolicyCondition$1 as PolicyCondition, type context$3_ResendAccountInviteRequest as ResendAccountInviteRequest, type Resource$2 as Resource, type context$3_RevokeAccountInviteRequest as RevokeAccountInviteRequest, type context$3_RevokeAccountInviteResponse as RevokeAccountInviteResponse, type SimpleCondition$1 as SimpleCondition, SimpleConditionOperator$1 as SimpleConditionOperator, type SimpleConditionValue$1 as SimpleConditionValue, type SimpleConditionValueValueOneOf$1 as SimpleConditionValueValueOneOf, type SiteResourceContext$1 as SiteResourceContext, type Subject$2 as Subject, type SubjectContext$2 as SubjectContext, SubjectContextType$2 as SubjectContextType, type context$3_SubjectInviteAssignments as SubjectInviteAssignments, SubjectType$2 as SubjectType, type context$3_UpdateAccountInviteAssignmentsRequest as UpdateAccountInviteAssignmentsRequest, type context$3_UpdateAccountInviteAssignmentsResponse as UpdateAccountInviteAssignmentsResponse, type context$3_UpdateAccountInviteRequest as UpdateAccountInviteRequest, type context$3_UpdateAccountInviteResponse as UpdateAccountInviteResponse, context$3_createInvite as createInvite };
|
|
1430
|
-
}
|
|
1431
|
-
|
|
1432
|
-
interface SiteInvite$1 {
|
|
1433
|
-
/**
|
|
1434
|
-
* Invite ID.
|
|
1435
|
-
* @readonly
|
|
1436
|
-
*/
|
|
1437
|
-
_id?: string;
|
|
1438
|
-
/**
|
|
1439
|
-
* Site ID the user is invited to as a collaborator.
|
|
1440
|
-
* @readonly
|
|
1441
|
-
*/
|
|
1442
|
-
siteId?: string;
|
|
1443
|
-
/** Email address where the invite was sent. */
|
|
1444
|
-
email?: string;
|
|
1445
|
-
/** Role IDs included in the invite. */
|
|
1446
|
-
policyIds?: string[];
|
|
1447
|
-
/**
|
|
1448
|
-
* Deprecated. Use `inviterAccountId`.
|
|
1449
|
-
* @readonly
|
|
1450
|
-
* @deprecated
|
|
1451
|
-
*/
|
|
1452
|
-
inviterId?: string;
|
|
1453
|
-
/**
|
|
1454
|
-
* Invite Status.
|
|
1455
|
-
*
|
|
1456
|
-
* Supported values:
|
|
1457
|
-
* - **Pending:** The invite has been sent and is valid, waiting for the user's response.
|
|
1458
|
-
* - **Used:** The invite has been accepted.
|
|
1459
|
-
* - **Deleted:** The invite has been deleted or revoked.
|
|
1460
|
-
* - **Declined:** The user declined the invite.
|
|
1461
|
-
* - **Expired:** The invite has expired without being accepted.
|
|
1462
|
-
*/
|
|
1463
|
-
status?: InviteStatus$2;
|
|
1464
|
-
/** Link to accept the invite. */
|
|
1465
|
-
acceptLink?: string;
|
|
1466
|
-
/**
|
|
1467
|
-
* Inviting account ID.
|
|
1468
|
-
* @readonly
|
|
1469
|
-
*/
|
|
1470
|
-
inviterAccountId?: string;
|
|
1471
|
-
/**
|
|
1472
|
-
* Account ID that accepted the invite. Populated only once the invite is accepted.
|
|
1473
|
-
* @readonly
|
|
1474
|
-
*/
|
|
1475
|
-
acceptedByAccountId?: string | null;
|
|
1476
|
-
/** Date the invite was created. */
|
|
1477
|
-
dateCreated?: Date | null;
|
|
1478
|
-
/** User's Wix Bookings staff ID, if relevant. */
|
|
1479
|
-
staffId?: string | null;
|
|
1480
|
-
/** Invite expiration date */
|
|
1481
|
-
expirationDate?: Date | null;
|
|
1482
|
-
}
|
|
1483
|
-
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
1484
|
-
declare enum InviteStatus$2 {
|
|
1485
|
-
Pending = "Pending",
|
|
1486
|
-
Used = "Used",
|
|
1487
|
-
Deleted = "Deleted",
|
|
1488
|
-
Declined = "Declined",
|
|
1489
|
-
Expired = "Expired"
|
|
1490
|
-
}
|
|
1491
|
-
interface GetSiteInvitesRequest {
|
|
1492
|
-
}
|
|
1493
|
-
interface GetSiteInvitesResponse {
|
|
1494
|
-
invites?: SiteInvite$1[];
|
|
1495
|
-
}
|
|
1496
|
-
interface QuerySiteInvitesRequest {
|
|
1497
|
-
/**
|
|
1498
|
-
* Supports only `filter` field with
|
|
1499
|
-
* `"filter" : {
|
|
1500
|
-
* "acceptedByAccountId":{"$in": [<id1>, <id2>, ...]}
|
|
1501
|
-
* }`
|
|
1502
|
-
*/
|
|
1503
|
-
query?: QueryV2;
|
|
1504
|
-
}
|
|
1505
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1506
|
-
/** Paging options to limit and skip the number of items. */
|
|
1507
|
-
paging?: Paging$1;
|
|
1508
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1509
|
-
cursorPaging?: CursorPaging;
|
|
1510
|
-
/**
|
|
1511
|
-
* Filter object.
|
|
1512
|
-
*
|
|
1513
|
-
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
1514
|
-
*/
|
|
1515
|
-
filter?: Record<string, any> | null;
|
|
1516
|
-
/**
|
|
1517
|
-
* Sort object.
|
|
1518
|
-
*
|
|
1519
|
-
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
1520
|
-
*/
|
|
1521
|
-
sort?: Sorting[];
|
|
1522
|
-
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1523
|
-
fields?: string[];
|
|
1524
|
-
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1525
|
-
fieldsets?: string[];
|
|
1526
|
-
}
|
|
1527
|
-
/** @oneof */
|
|
1528
|
-
interface QueryV2PagingMethodOneOf {
|
|
1529
|
-
/** Paging options to limit and skip the number of items. */
|
|
1530
|
-
paging?: Paging$1;
|
|
1531
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1532
|
-
cursorPaging?: CursorPaging;
|
|
1533
|
-
}
|
|
1534
|
-
interface Sorting {
|
|
1535
|
-
/** Name of the field to sort by. */
|
|
1536
|
-
fieldName?: string;
|
|
1537
|
-
/** Sort order. */
|
|
1538
|
-
order?: SortOrder;
|
|
1539
|
-
}
|
|
1540
|
-
declare enum SortOrder {
|
|
1541
|
-
ASC = "ASC",
|
|
1542
|
-
DESC = "DESC"
|
|
1543
|
-
}
|
|
1544
|
-
interface Paging$1 {
|
|
1545
|
-
/** Number of items to load. */
|
|
1546
|
-
limit?: number | null;
|
|
1547
|
-
/** Number of items to skip in the current sort order. */
|
|
1548
|
-
offset?: number | null;
|
|
1549
|
-
}
|
|
1550
|
-
interface CursorPaging {
|
|
1551
|
-
/** Maximum number of items to return in the results. */
|
|
1552
|
-
limit?: number | null;
|
|
1553
|
-
/**
|
|
1554
|
-
* Pointer to the next or previous page in the list of results.
|
|
1555
|
-
*
|
|
1556
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1557
|
-
* Not relevant for the first request.
|
|
1558
|
-
*/
|
|
1559
|
-
cursor?: string | null;
|
|
1560
|
-
}
|
|
1561
|
-
interface QuerySiteInvitesResponse {
|
|
1562
|
-
invites?: SiteInvite$1[];
|
|
1563
|
-
}
|
|
1564
|
-
interface GetSiteInviteRequest {
|
|
1565
|
-
_id?: string;
|
|
1566
|
-
}
|
|
1567
|
-
interface GetSiteInviteResponse {
|
|
1568
|
-
invite?: SiteInvite$1;
|
|
1569
|
-
}
|
|
1570
|
-
interface SiteInviteRequest {
|
|
1571
|
-
/** The role ids to be assigned */
|
|
1572
|
-
policyIds?: string[];
|
|
1573
|
-
/** Invitee email */
|
|
1574
|
-
email?: string;
|
|
1575
|
-
/** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */
|
|
1576
|
-
defaultEmailLanguage?: string | null;
|
|
1577
|
-
}
|
|
1578
|
-
interface SiteInviteResponse {
|
|
1579
|
-
/** Invites that were sent. */
|
|
1580
|
-
invite?: SiteInvite$1;
|
|
1581
|
-
}
|
|
1582
|
-
interface BulkSiteInviteRequest {
|
|
1583
|
-
/** Role IDs, referred to as policy IDs, to assign to the contributors. */
|
|
1584
|
-
policyIds: string[];
|
|
1585
|
-
/** Email addresses to which the invites should be sent. */
|
|
1586
|
-
emails: string[];
|
|
1587
|
-
/** Details explaining the purpose of the invite. */
|
|
1588
|
-
invitePurpose?: string | null;
|
|
1589
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1590
|
-
defaultEmailLanguage?: string | null;
|
|
1591
|
-
}
|
|
1592
|
-
interface BulkSiteInviteResponse {
|
|
1593
|
-
/** Invites that were sent successfully. */
|
|
1594
|
-
invites?: SiteInvite$1[];
|
|
1595
|
-
/** Invites that failed. */
|
|
1596
|
-
failedEmails?: string[];
|
|
1597
|
-
}
|
|
1598
|
-
interface ResendSiteInviteRequest {
|
|
1599
|
-
/** Invite ID. */
|
|
1600
|
-
inviteId: string;
|
|
1601
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1602
|
-
defaultEmailLanguage?: string | null;
|
|
1603
|
-
}
|
|
1604
|
-
interface AcceptSiteInviteRequest {
|
|
1605
|
-
inviteToken?: string;
|
|
1606
|
-
}
|
|
1607
|
-
interface AcceptSiteInviteResponse {
|
|
1608
|
-
}
|
|
1609
|
-
interface RevokeSiteInviteRequest {
|
|
1610
|
-
/** Invite ID. */
|
|
1611
|
-
inviteId: string;
|
|
1612
|
-
}
|
|
1613
|
-
interface RevokeSiteInviteResponse {
|
|
1614
|
-
}
|
|
1615
|
-
interface UpdateSiteInviteRequest {
|
|
1616
|
-
inviteId?: string;
|
|
1617
|
-
policyIds?: string[];
|
|
1618
|
-
staffId?: string | null;
|
|
1619
|
-
}
|
|
1620
|
-
interface UpdateSiteInviteResponse {
|
|
1621
|
-
}
|
|
1622
|
-
interface GetContributorLimitRequest {
|
|
1623
|
-
}
|
|
1624
|
-
interface GetContributorLimitResponse {
|
|
1625
|
-
contributorLimitation?: ContributorLimitation;
|
|
1626
|
-
}
|
|
1627
|
-
interface ContributorLimitation {
|
|
1628
|
-
contributorLimit?: number;
|
|
1629
|
-
leftInvites?: number;
|
|
1630
|
-
}
|
|
1631
|
-
interface ParseSiteInviteTokenRequest {
|
|
1632
|
-
inviteToken?: string;
|
|
1633
|
-
}
|
|
1634
|
-
interface ParseSiteInviteTokenResponse {
|
|
1635
|
-
inviteId?: string;
|
|
1636
|
-
siteId?: string;
|
|
1637
|
-
status?: InviteStatus$2;
|
|
1638
|
-
}
|
|
1639
|
-
interface SiteInviteNonNullableFields {
|
|
1640
|
-
_id: string;
|
|
1641
|
-
siteId: string;
|
|
1642
|
-
email: string;
|
|
1643
|
-
policyIds: string[];
|
|
1644
|
-
inviterId: string;
|
|
1645
|
-
status: InviteStatus$2;
|
|
1646
|
-
acceptLink: string;
|
|
1647
|
-
inviterAccountId: string;
|
|
1648
|
-
}
|
|
1649
|
-
interface BulkSiteInviteResponseNonNullableFields {
|
|
1650
|
-
invites: SiteInviteNonNullableFields[];
|
|
1651
|
-
failedEmails: string[];
|
|
1652
|
-
}
|
|
1653
|
-
interface SiteInviteResponseNonNullableFields {
|
|
1654
|
-
invite?: SiteInviteNonNullableFields;
|
|
1655
|
-
}
|
|
1656
|
-
interface BulkInviteOptions {
|
|
1657
|
-
/** Email addresses to which the invites should be sent. */
|
|
1658
|
-
emails: string[];
|
|
1659
|
-
/** Details explaining the purpose of the invite. */
|
|
1660
|
-
invitePurpose?: string | null;
|
|
1661
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1662
|
-
defaultEmailLanguage?: string | null;
|
|
1663
|
-
}
|
|
1664
|
-
interface ResendInviteOptions {
|
|
1665
|
-
/** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
|
|
1666
|
-
defaultEmailLanguage?: string | null;
|
|
1667
|
-
}
|
|
1668
|
-
|
|
1669
|
-
declare function bulkInvite$1(httpClient: HttpClient): BulkInviteSignature;
|
|
1670
|
-
interface BulkInviteSignature {
|
|
1671
|
-
/**
|
|
1672
|
-
* Creates and sends emails inviting potential site contributors to become contributors in the requesting site.
|
|
1673
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1674
|
-
* @param - Role IDs, referred to as policy IDs, to assign to the contributors.
|
|
1675
|
-
* @param - Filter options.
|
|
1676
|
-
*/
|
|
1677
|
-
(policyIds: string[], options?: BulkInviteOptions | undefined): Promise<BulkSiteInviteResponse & BulkSiteInviteResponseNonNullableFields>;
|
|
1678
|
-
}
|
|
1679
|
-
declare function resendInvite$1(httpClient: HttpClient): ResendInviteSignature;
|
|
1680
|
-
interface ResendInviteSignature {
|
|
1681
|
-
/**
|
|
1682
|
-
* Resends the email invitation to a potential site contributor.
|
|
1683
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1684
|
-
* @param - Invite ID.
|
|
1685
|
-
* @param - Filter options.
|
|
1686
|
-
*/
|
|
1687
|
-
(inviteId: string, options?: ResendInviteOptions | undefined): Promise<SiteInviteResponse & SiteInviteResponseNonNullableFields>;
|
|
1688
|
-
}
|
|
1689
|
-
declare function revokeInvite$1(httpClient: HttpClient): RevokeInviteSignature;
|
|
1690
|
-
interface RevokeInviteSignature {
|
|
1691
|
-
/**
|
|
1692
|
-
* Revokes a pending site contributor invite.
|
|
1693
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1694
|
-
* @param - Invite ID.
|
|
1695
|
-
*/
|
|
1696
|
-
(inviteId: string): Promise<void>;
|
|
1697
|
-
}
|
|
1698
|
-
|
|
1699
|
-
declare const bulkInvite: MaybeContext<BuildRESTFunction<typeof bulkInvite$1> & typeof bulkInvite$1>;
|
|
1700
|
-
declare const resendInvite: MaybeContext<BuildRESTFunction<typeof resendInvite$1> & typeof resendInvite$1>;
|
|
1701
|
-
declare const revokeInvite: MaybeContext<BuildRESTFunction<typeof revokeInvite$1> & typeof revokeInvite$1>;
|
|
1702
|
-
|
|
1703
|
-
type context$2_AcceptSiteInviteRequest = AcceptSiteInviteRequest;
|
|
1704
|
-
type context$2_AcceptSiteInviteResponse = AcceptSiteInviteResponse;
|
|
1705
|
-
type context$2_BulkInviteOptions = BulkInviteOptions;
|
|
1706
|
-
type context$2_BulkSiteInviteRequest = BulkSiteInviteRequest;
|
|
1707
|
-
type context$2_BulkSiteInviteResponse = BulkSiteInviteResponse;
|
|
1708
|
-
type context$2_BulkSiteInviteResponseNonNullableFields = BulkSiteInviteResponseNonNullableFields;
|
|
1709
|
-
type context$2_ContributorLimitation = ContributorLimitation;
|
|
1710
|
-
type context$2_CursorPaging = CursorPaging;
|
|
1711
|
-
type context$2_GetContributorLimitRequest = GetContributorLimitRequest;
|
|
1712
|
-
type context$2_GetContributorLimitResponse = GetContributorLimitResponse;
|
|
1713
|
-
type context$2_GetSiteInviteRequest = GetSiteInviteRequest;
|
|
1714
|
-
type context$2_GetSiteInviteResponse = GetSiteInviteResponse;
|
|
1715
|
-
type context$2_GetSiteInvitesRequest = GetSiteInvitesRequest;
|
|
1716
|
-
type context$2_GetSiteInvitesResponse = GetSiteInvitesResponse;
|
|
1717
|
-
type context$2_ParseSiteInviteTokenRequest = ParseSiteInviteTokenRequest;
|
|
1718
|
-
type context$2_ParseSiteInviteTokenResponse = ParseSiteInviteTokenResponse;
|
|
1719
|
-
type context$2_QuerySiteInvitesRequest = QuerySiteInvitesRequest;
|
|
1720
|
-
type context$2_QuerySiteInvitesResponse = QuerySiteInvitesResponse;
|
|
1721
|
-
type context$2_QueryV2 = QueryV2;
|
|
1722
|
-
type context$2_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
|
|
1723
|
-
type context$2_ResendInviteOptions = ResendInviteOptions;
|
|
1724
|
-
type context$2_ResendSiteInviteRequest = ResendSiteInviteRequest;
|
|
1725
|
-
type context$2_RevokeSiteInviteRequest = RevokeSiteInviteRequest;
|
|
1726
|
-
type context$2_RevokeSiteInviteResponse = RevokeSiteInviteResponse;
|
|
1727
|
-
type context$2_SiteInviteRequest = SiteInviteRequest;
|
|
1728
|
-
type context$2_SiteInviteResponse = SiteInviteResponse;
|
|
1729
|
-
type context$2_SiteInviteResponseNonNullableFields = SiteInviteResponseNonNullableFields;
|
|
1730
|
-
type context$2_SortOrder = SortOrder;
|
|
1731
|
-
declare const context$2_SortOrder: typeof SortOrder;
|
|
1732
|
-
type context$2_Sorting = Sorting;
|
|
1733
|
-
type context$2_UpdateSiteInviteRequest = UpdateSiteInviteRequest;
|
|
1734
|
-
type context$2_UpdateSiteInviteResponse = UpdateSiteInviteResponse;
|
|
1735
|
-
declare const context$2_bulkInvite: typeof bulkInvite;
|
|
1736
|
-
declare const context$2_resendInvite: typeof resendInvite;
|
|
1737
|
-
declare const context$2_revokeInvite: typeof revokeInvite;
|
|
1738
|
-
declare namespace context$2 {
|
|
1739
|
-
export { type context$2_AcceptSiteInviteRequest as AcceptSiteInviteRequest, type context$2_AcceptSiteInviteResponse as AcceptSiteInviteResponse, type context$2_BulkInviteOptions as BulkInviteOptions, type context$2_BulkSiteInviteRequest as BulkSiteInviteRequest, type context$2_BulkSiteInviteResponse as BulkSiteInviteResponse, type context$2_BulkSiteInviteResponseNonNullableFields as BulkSiteInviteResponseNonNullableFields, type context$2_ContributorLimitation as ContributorLimitation, type context$2_CursorPaging as CursorPaging, type context$2_GetContributorLimitRequest as GetContributorLimitRequest, type context$2_GetContributorLimitResponse as GetContributorLimitResponse, type context$2_GetSiteInviteRequest as GetSiteInviteRequest, type context$2_GetSiteInviteResponse as GetSiteInviteResponse, type context$2_GetSiteInvitesRequest as GetSiteInvitesRequest, type context$2_GetSiteInvitesResponse as GetSiteInvitesResponse, InviteStatus$2 as InviteStatus, type Paging$1 as Paging, type context$2_ParseSiteInviteTokenRequest as ParseSiteInviteTokenRequest, type context$2_ParseSiteInviteTokenResponse as ParseSiteInviteTokenResponse, type context$2_QuerySiteInvitesRequest as QuerySiteInvitesRequest, type context$2_QuerySiteInvitesResponse as QuerySiteInvitesResponse, type context$2_QueryV2 as QueryV2, type context$2_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context$2_ResendInviteOptions as ResendInviteOptions, type context$2_ResendSiteInviteRequest as ResendSiteInviteRequest, type context$2_RevokeSiteInviteRequest as RevokeSiteInviteRequest, type context$2_RevokeSiteInviteResponse as RevokeSiteInviteResponse, type SiteInvite$1 as SiteInvite, type context$2_SiteInviteRequest as SiteInviteRequest, type context$2_SiteInviteResponse as SiteInviteResponse, type context$2_SiteInviteResponseNonNullableFields as SiteInviteResponseNonNullableFields, context$2_SortOrder as SortOrder, type context$2_Sorting as Sorting, type context$2_UpdateSiteInviteRequest as UpdateSiteInviteRequest, type context$2_UpdateSiteInviteResponse as UpdateSiteInviteResponse, context$2_bulkInvite as bulkInvite, context$2_resendInvite as resendInvite, context$2_revokeInvite as revokeInvite };
|
|
1740
|
-
}
|
|
1741
|
-
|
|
1742
|
-
interface User$1 {
|
|
1743
|
-
/** User ID. */
|
|
1744
|
-
_id?: string;
|
|
1745
|
-
/**
|
|
1746
|
-
* Deprecated.
|
|
1747
|
-
* @deprecated
|
|
1748
|
-
*/
|
|
1749
|
-
roles?: string[];
|
|
1750
|
-
/** User's email address. */
|
|
1751
|
-
email?: string;
|
|
1752
|
-
/** User's name. */
|
|
1753
|
-
name?: Name$1;
|
|
1754
|
-
/** URL to user's profile image, when provided. */
|
|
1755
|
-
profileImage?: string | null;
|
|
1756
|
-
/** Date the user joined the team. */
|
|
1757
|
-
joinedTeamAt?: Date | null;
|
|
1758
|
-
/**
|
|
1759
|
-
* Deprecated.
|
|
1760
|
-
* @deprecated
|
|
1761
|
-
*/
|
|
1762
|
-
policyIds?: string[];
|
|
1763
|
-
/** Resources the user can access. */
|
|
1764
|
-
assignments?: Assignment$1[];
|
|
1765
|
-
}
|
|
1766
|
-
interface Name$1 {
|
|
1767
|
-
/** User's first name. */
|
|
1768
|
-
firstName?: string;
|
|
1769
|
-
/** User's last name. */
|
|
1770
|
-
lastName?: string;
|
|
1771
|
-
}
|
|
1772
|
-
interface Assignment$1 {
|
|
1773
|
-
/** Role assigned to the user. */
|
|
1774
|
-
policy?: AssignedPolicy$1;
|
|
1775
|
-
/** Unique ID for this specific assignment. */
|
|
1776
|
-
assignmentId?: string;
|
|
1777
|
-
/** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
|
|
1778
|
-
subject?: Subject$1;
|
|
1779
|
-
}
|
|
1780
|
-
interface AssignedPolicy$1 {
|
|
1781
|
-
/** Role ID. */
|
|
1782
|
-
policyId?: string;
|
|
1783
|
-
/** Role title. */
|
|
1784
|
-
title?: string | null;
|
|
1785
|
-
/** Role description. */
|
|
1786
|
-
description?: string | null;
|
|
1787
|
-
}
|
|
1788
|
-
interface Restriction$1 extends RestrictionRestrictionsOneOf$1 {
|
|
1789
|
-
/**
|
|
1790
|
-
* Deprecated.
|
|
1791
|
-
* @deprecated
|
|
1792
|
-
*/
|
|
1793
|
-
resource?: ApiResource;
|
|
1794
|
-
/** List of conditions restricting the user's access. Currently only folder conditions are supported. */
|
|
1795
|
-
conditions?: Conditions$1;
|
|
1796
|
-
/** Site where the assignment restrictions apply. */
|
|
1797
|
-
site?: SiteRestriction$1;
|
|
1798
|
-
}
|
|
1799
|
-
/** @oneof */
|
|
1800
|
-
interface RestrictionRestrictionsOneOf$1 {
|
|
1801
|
-
/**
|
|
1802
|
-
* Deprecated.
|
|
1803
|
-
* @deprecated
|
|
1804
|
-
*/
|
|
1805
|
-
resource?: ApiResource;
|
|
1806
|
-
/** List of conditions restricting the user's access. Currently only folder conditions are supported. */
|
|
1807
|
-
conditions?: Conditions$1;
|
|
1808
|
-
/** Site where the assignment restrictions apply. */
|
|
1809
|
-
site?: SiteRestriction$1;
|
|
1810
|
-
}
|
|
1811
|
-
interface ApiResource {
|
|
1812
|
-
/** Resource type. */
|
|
1813
|
-
resourceType?: ResourceType$1;
|
|
1814
|
-
/** Resource ID. */
|
|
1815
|
-
_id?: string;
|
|
1816
|
-
value?: string | null;
|
|
1817
|
-
}
|
|
1818
|
-
declare enum ResourceType$1 {
|
|
1819
|
-
UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
|
|
1820
|
-
SITE = "SITE"
|
|
1821
|
-
}
|
|
1822
|
-
interface Conditions$1 {
|
|
1823
|
-
/** List of conditions. */
|
|
1824
|
-
conditions?: ApiCondition[];
|
|
1825
|
-
}
|
|
1826
|
-
interface ApiCondition {
|
|
1827
|
-
/** Condition type. */
|
|
1828
|
-
conditionType?: ConditionAttributeType$1;
|
|
1829
|
-
/** Condition ID. */
|
|
1830
|
-
_id?: string;
|
|
1831
|
-
/** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
|
|
1832
|
-
value?: string | null;
|
|
1833
|
-
}
|
|
1834
|
-
declare enum ConditionAttributeType$1 {
|
|
1835
|
-
UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
|
|
1836
|
-
FOLDER = "FOLDER"
|
|
1837
|
-
}
|
|
1838
|
-
interface SiteRestriction$1 {
|
|
1839
|
-
/** Site ID. */
|
|
1840
|
-
_id?: string;
|
|
1841
|
-
/** Site name. */
|
|
1842
|
-
value?: string | null;
|
|
1843
|
-
}
|
|
1844
|
-
interface CompanionResource$1 {
|
|
1845
|
-
/** Asset ID (referred to here as resource ID). */
|
|
1846
|
-
_id?: string;
|
|
1847
|
-
/** Asset type (referred to here as resource type). as predefined in the authorization system */
|
|
1848
|
-
resourceType?: string;
|
|
1849
|
-
}
|
|
1850
|
-
interface Subject$1 {
|
|
1851
|
-
/** ID of identity assigned to the asset. */
|
|
1852
|
-
_id?: string;
|
|
1853
|
-
/** Type of identity assigned to the asset. Supported subject types include user IDs, account IDs, and app IDs. */
|
|
1854
|
-
subjectType?: SubjectType$1;
|
|
1855
|
-
/** Context of identity assigned to the asset. For example, a `subjectType` = `USER` will have `context` = `ACCOUNT`. */
|
|
1856
|
-
context?: SubjectContext$1;
|
|
1857
|
-
}
|
|
1858
|
-
declare enum SubjectType$1 {
|
|
1859
|
-
UNKNOWN = "UNKNOWN",
|
|
1860
|
-
ACCOUNT = "ACCOUNT",
|
|
1861
|
-
USER = "USER",
|
|
1862
|
-
USER_GROUP = "USER_GROUP",
|
|
1863
|
-
MEMBER_GROUP = "MEMBER_GROUP",
|
|
1864
|
-
VISITOR_GROUP = "VISITOR_GROUP",
|
|
1865
|
-
EXTERNAL_APP = "EXTERNAL_APP",
|
|
1866
|
-
ACCOUNT_GROUP = "ACCOUNT_GROUP",
|
|
1867
|
-
WIX_APP = "WIX_APP"
|
|
1868
|
-
}
|
|
1869
|
-
interface SubjectContext$1 {
|
|
1870
|
-
_id?: string;
|
|
1871
|
-
contextType?: SubjectContextType$1;
|
|
1872
|
-
}
|
|
1873
|
-
declare enum SubjectContextType$1 {
|
|
1874
|
-
UNKNOWN_CTX = "UNKNOWN_CTX",
|
|
1875
|
-
ORG_CTX = "ORG_CTX",
|
|
1876
|
-
ACCOUNT_CTX = "ACCOUNT_CTX"
|
|
1877
|
-
}
|
|
1878
|
-
interface GetTeamRequest {
|
|
1879
|
-
/** @deprecated */
|
|
1880
|
-
usersLimit?: number | null;
|
|
1881
|
-
/** The locale of the request. Defaults to en */
|
|
1882
|
-
locale?: string | null;
|
|
1883
|
-
paging?: Paging;
|
|
1884
|
-
}
|
|
1885
|
-
interface Paging {
|
|
1886
|
-
/** Number of items to load. */
|
|
1887
|
-
limit?: number | null;
|
|
1888
|
-
/** Number of items to skip in the current sort order. */
|
|
1889
|
-
offset?: number | null;
|
|
1890
|
-
}
|
|
1891
|
-
interface GetTeamResponse {
|
|
1892
|
-
users?: User$1[];
|
|
1893
|
-
invites?: AccountInvite[];
|
|
1894
|
-
accountInfo?: AccountInfo$1;
|
|
1895
|
-
permissions?: string[];
|
|
1896
|
-
userId?: string;
|
|
1897
|
-
targetAccountId?: string;
|
|
1898
|
-
policies?: ApiPolicy[];
|
|
1899
|
-
totalUsersInAccount?: string;
|
|
1900
|
-
predefinedRoles?: PredefinedRoles$1;
|
|
1901
|
-
}
|
|
1902
|
-
interface AccountInvite {
|
|
1903
|
-
/**
|
|
1904
|
-
* Invite ID.
|
|
1905
|
-
* @readonly
|
|
1906
|
-
*/
|
|
1907
|
-
_id?: string;
|
|
1908
|
-
/**
|
|
1909
|
-
* Account ID.
|
|
1910
|
-
* @readonly
|
|
1911
|
-
*/
|
|
1912
|
-
accountId?: string;
|
|
1913
|
-
/** Email address where the invite was sent. */
|
|
1914
|
-
email?: string;
|
|
1915
|
-
/**
|
|
1916
|
-
* Deprecated. Use `policyIds`.
|
|
1917
|
-
* @deprecated
|
|
1918
|
-
*/
|
|
1919
|
-
role?: string;
|
|
1920
|
-
/**
|
|
1921
|
-
* Deprecated. Use `inviterAccountId`.
|
|
1922
|
-
* @readonly
|
|
1923
|
-
* @deprecated
|
|
1924
|
-
*/
|
|
1925
|
-
inviterId?: string;
|
|
1926
|
-
/**
|
|
1927
|
-
* Invite status.
|
|
1928
|
-
*
|
|
1929
|
-
* Supported values:
|
|
1930
|
-
* - **Pending:** The invite has been sent and is valid, waiting for the user's response.
|
|
1931
|
-
* - **Used:** The invite has been accepted.
|
|
1932
|
-
* - **Deleted:** The invite has been deleted or revoked.
|
|
1933
|
-
* - **Declined:** The user has declined the invite.
|
|
1934
|
-
* - **Expired:** The invite has expired without being accepted.
|
|
1935
|
-
*/
|
|
1936
|
-
status?: InviteStatus$1;
|
|
1937
|
-
/** Link to accept the invite. */
|
|
1938
|
-
acceptLink?: string;
|
|
1939
|
-
/**
|
|
1940
|
-
* Inviting account ID.
|
|
1941
|
-
* @readonly
|
|
1942
|
-
*/
|
|
1943
|
-
inviterAccountId?: string;
|
|
1944
|
-
/**
|
|
1945
|
-
* Account ID that accepted the invite. Populated only once the invite is accepted.
|
|
1946
|
-
* @readonly
|
|
1947
|
-
*/
|
|
1948
|
-
acceptedByAccountId?: string | null;
|
|
1949
|
-
/** Date the invite was created. */
|
|
1950
|
-
dateCreated?: Date | null;
|
|
1951
|
-
/** Role IDs included in the invite. */
|
|
1952
|
-
policyIds?: string[];
|
|
1953
|
-
/** Date the invite was last updated. */
|
|
1954
|
-
dateUpdated?: Date | null;
|
|
1955
|
-
/** Assets the users are invited to join. */
|
|
1956
|
-
assignments?: InviteResourceAssignment[];
|
|
1957
|
-
/** Invite expiration date. */
|
|
1958
|
-
expirationDate?: Date | null;
|
|
1959
|
-
}
|
|
1960
|
-
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
1961
|
-
declare enum InviteStatus$1 {
|
|
1962
|
-
Pending = "Pending",
|
|
1963
|
-
Used = "Used",
|
|
1964
|
-
Deleted = "Deleted",
|
|
1965
|
-
Declined = "Declined",
|
|
1966
|
-
Expired = "Expired"
|
|
1967
|
-
}
|
|
1968
|
-
interface InviteResourceAssignment {
|
|
1969
|
-
/** Role ID. */
|
|
1970
|
-
policyId?: string;
|
|
1971
|
-
/** Resources the user will be able to access. */
|
|
1972
|
-
assignments?: InviteAssignment[];
|
|
1973
|
-
}
|
|
1974
|
-
interface InviteAssignment {
|
|
1975
|
-
/** Full name of resource to be assigned. */
|
|
1976
|
-
fullNameResource?: FullNameResource;
|
|
1977
|
-
}
|
|
1978
|
-
interface FullNameResource extends FullNameResourceResourceContextOneOf {
|
|
1979
|
-
/** Specific site details. */
|
|
1980
|
-
siteContext?: SiteResourceContext;
|
|
1981
|
-
/** Specific account details. */
|
|
1982
|
-
accountContext?: AccountResourceContext;
|
|
1983
|
-
}
|
|
1984
|
-
/** @oneof */
|
|
1985
|
-
interface FullNameResourceResourceContextOneOf {
|
|
1986
|
-
/** Specific site details. */
|
|
1987
|
-
siteContext?: SiteResourceContext;
|
|
1988
|
-
/** Specific account details. */
|
|
1989
|
-
accountContext?: AccountResourceContext;
|
|
1990
|
-
}
|
|
1991
|
-
/** Site resource context. It indicates that the resource is under a site (can be the site itself or some asset of a site, like a blog post) */
|
|
1992
|
-
interface SiteResourceContext {
|
|
1993
|
-
/** Site ID. */
|
|
1994
|
-
metasiteId?: string;
|
|
1995
|
-
}
|
|
1996
|
-
/** Account resource contexts. It indicates that the resource is under the account (can be the account itself or some asset of an account, like a logo or a domain) */
|
|
1997
|
-
interface AccountResourceContext {
|
|
1998
|
-
/** Account ID. */
|
|
1999
|
-
accountId?: string;
|
|
2000
|
-
}
|
|
2001
|
-
interface OrganizationResourceContext {
|
|
2002
|
-
}
|
|
2003
|
-
/**
|
|
2004
|
-
* A custom resource. Is used to represent some asset that is not a direct resource context (site or account), but something custom.
|
|
2005
|
-
* For example: payment method, blog post, domain, logo.
|
|
2006
|
-
*/
|
|
2007
|
-
interface Resource$1 {
|
|
2008
|
-
/** The resource id. */
|
|
2009
|
-
_id?: string | null;
|
|
2010
|
-
/** The resource type */
|
|
2011
|
-
type?: string | null;
|
|
2012
|
-
}
|
|
2013
|
-
interface PolicyCondition {
|
|
2014
|
-
/** The type of the condition */
|
|
2015
|
-
condition?: ConditionType;
|
|
2016
|
-
}
|
|
2017
|
-
interface ConditionType extends ConditionTypeOfOneOf {
|
|
2018
|
-
/** @deprecated */
|
|
2019
|
-
simpleCondition?: SimpleCondition;
|
|
2020
|
-
/** A logic combination between several conditions, with an operator between them */
|
|
2021
|
-
joinedConditions?: JoinedCondition;
|
|
2022
|
-
/** @deprecated */
|
|
2023
|
-
environmentCondition?: EnvironmentCondition;
|
|
2024
|
-
/** A single condition */
|
|
2025
|
-
condition?: Condition$1;
|
|
2026
|
-
}
|
|
2027
|
-
/** @oneof */
|
|
2028
|
-
interface ConditionTypeOfOneOf {
|
|
2029
|
-
/** @deprecated */
|
|
2030
|
-
simpleCondition?: SimpleCondition;
|
|
2031
|
-
/** A logic combination between several conditions, with an operator between them */
|
|
2032
|
-
joinedConditions?: JoinedCondition;
|
|
2033
|
-
/** @deprecated */
|
|
2034
|
-
environmentCondition?: EnvironmentCondition;
|
|
2035
|
-
/** A single condition */
|
|
2036
|
-
condition?: Condition$1;
|
|
2037
|
-
}
|
|
2038
|
-
interface SimpleCondition {
|
|
2039
|
-
attrName?: string;
|
|
2040
|
-
value?: SimpleConditionValue;
|
|
2041
|
-
op?: SimpleConditionOperator;
|
|
2042
|
-
conditionModelId?: string;
|
|
2043
|
-
}
|
|
2044
|
-
interface SimpleConditionValue extends SimpleConditionValueValueOneOf {
|
|
2045
|
-
attrName?: string;
|
|
2046
|
-
stringValue?: string;
|
|
2047
|
-
boolValue?: boolean;
|
|
2048
|
-
}
|
|
2049
|
-
/** @oneof */
|
|
2050
|
-
interface SimpleConditionValueValueOneOf {
|
|
2051
|
-
attrName?: string;
|
|
2052
|
-
stringValue?: string;
|
|
2053
|
-
boolValue?: boolean;
|
|
2054
|
-
}
|
|
2055
|
-
declare enum SimpleConditionOperator {
|
|
2056
|
-
UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP",
|
|
2057
|
-
EQUAL = "EQUAL"
|
|
2058
|
-
}
|
|
2059
|
-
interface JoinedCondition {
|
|
2060
|
-
/** The operator that should be used when evaluating the condition */
|
|
2061
|
-
op?: JoinedConditionOperator;
|
|
2062
|
-
/** The conditions that should be evaluated, and then joined using the operator provided */
|
|
2063
|
-
conditions?: ConditionType[];
|
|
2064
|
-
}
|
|
2065
|
-
declare enum JoinedConditionOperator {
|
|
2066
|
-
UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP",
|
|
2067
|
-
OR = "OR",
|
|
2068
|
-
AND = "AND"
|
|
2069
|
-
}
|
|
2070
|
-
interface EnvironmentCondition extends EnvironmentConditionConditionOneOf {
|
|
2071
|
-
experimentCondition?: ExperimentCondition;
|
|
2072
|
-
}
|
|
2073
|
-
/** @oneof */
|
|
2074
|
-
interface EnvironmentConditionConditionOneOf {
|
|
2075
|
-
experimentCondition?: ExperimentCondition;
|
|
2076
|
-
}
|
|
2077
|
-
interface ExperimentCondition {
|
|
2078
|
-
spec?: string;
|
|
2079
|
-
fallbackValue?: string;
|
|
2080
|
-
expectedValue?: string;
|
|
2081
|
-
}
|
|
2082
|
-
interface Condition$1 {
|
|
2083
|
-
/** The unique identifier of the condition model. Indicates which actions the condition is working on */
|
|
2084
|
-
conditionModelId?: string;
|
|
2085
|
-
/** The operator that should be evaluated */
|
|
2086
|
-
operator?: ConditionOperator;
|
|
2087
|
-
}
|
|
2088
|
-
interface ConditionOperator extends ConditionOperatorOperatorsOneOf {
|
|
2089
|
-
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
2090
|
-
equals?: EqualOperator;
|
|
2091
|
-
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
2092
|
-
like?: LikeOperator;
|
|
2093
|
-
/** Petri experiment - will be evaluated using petri. */
|
|
2094
|
-
experiment?: ExperimentOperator;
|
|
2095
|
-
/** Operator that indicates a dependency on another subject being allowed to perform something. */
|
|
2096
|
-
dependOn?: DependOnOperator;
|
|
2097
|
-
}
|
|
2098
|
-
/** @oneof */
|
|
2099
|
-
interface ConditionOperatorOperatorsOneOf {
|
|
2100
|
-
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
2101
|
-
equals?: EqualOperator;
|
|
2102
|
-
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
2103
|
-
like?: LikeOperator;
|
|
2104
|
-
/** Petri experiment - will be evaluated using petri. */
|
|
2105
|
-
experiment?: ExperimentOperator;
|
|
2106
|
-
/** Operator that indicates a dependency on another subject being allowed to perform something. */
|
|
2107
|
-
dependOn?: DependOnOperator;
|
|
2108
|
-
}
|
|
2109
|
-
interface EqualOperator {
|
|
2110
|
-
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the other side (attribute/value) */
|
|
2111
|
-
attrName?: string;
|
|
2112
|
-
/** The value to compare to. If the two parties are equal - we will return true. */
|
|
2113
|
-
value?: ConditionValue;
|
|
2114
|
-
}
|
|
2115
|
-
interface ConditionValue extends ConditionValueValueOneOf {
|
|
2116
|
-
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
2117
|
-
attrName?: string;
|
|
2118
|
-
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
2119
|
-
stringValue?: string;
|
|
2120
|
-
/** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
2121
|
-
boolValue?: boolean;
|
|
2122
|
-
}
|
|
2123
|
-
/** @oneof */
|
|
2124
|
-
interface ConditionValueValueOneOf {
|
|
2125
|
-
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
2126
|
-
attrName?: string;
|
|
2127
|
-
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
2128
|
-
stringValue?: string;
|
|
2129
|
-
/** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
2130
|
-
boolValue?: boolean;
|
|
2131
|
-
}
|
|
2132
|
-
interface LikeOperator {
|
|
2133
|
-
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the regex values provided. */
|
|
2134
|
-
attrName?: string;
|
|
2135
|
-
/** The regex values which the attribute value should be evaluated on. If the attribute value matches at least one of the regular expressions provided - we will return true */
|
|
2136
|
-
values?: string[];
|
|
2137
|
-
}
|
|
2138
|
-
interface ExperimentOperator {
|
|
2139
|
-
/** The spec to conduct the experiment on. */
|
|
2140
|
-
spec?: string;
|
|
2141
|
-
/** The value to use if the experiment could not be conducted */
|
|
2142
|
-
fallbackValue?: string;
|
|
2143
|
-
/** The expected value of the experiment conduction. If it matches the actual value - true will be returned. Otherwise - false. */
|
|
2144
|
-
expectedValue?: string;
|
|
2145
|
-
}
|
|
2146
|
-
/** Implies that the policy takes affect only if the depend on subject is permitted as well. */
|
|
2147
|
-
interface DependOnOperator {
|
|
2148
|
-
/** The subject on which the current entry depends on. If the subject is allowed to perform what the query was about - the condition will be evaluated to true. Otherwise - false */
|
|
2149
|
-
dependOnSubject?: Subject$1;
|
|
2150
|
-
}
|
|
2151
|
-
interface AccountInfo$1 {
|
|
2152
|
-
accountName?: string;
|
|
2153
|
-
accountImage?: string;
|
|
2154
|
-
isTeam?: boolean;
|
|
2155
|
-
}
|
|
2156
|
-
interface ApiPolicy {
|
|
2157
|
-
_id?: string;
|
|
2158
|
-
description?: string | null;
|
|
2159
|
-
name?: string | null;
|
|
2160
|
-
isCustom?: boolean;
|
|
2161
|
-
scopes?: string[];
|
|
2162
|
-
}
|
|
2163
|
-
interface PredefinedRoles$1 {
|
|
2164
|
-
roles?: PredefinedRole$1[];
|
|
2165
|
-
}
|
|
2166
|
-
interface PredefinedRole$1 {
|
|
2167
|
-
titleKey?: string;
|
|
2168
|
-
roles?: Role$1[];
|
|
2169
|
-
title?: string | null;
|
|
2170
|
-
areaId?: string;
|
|
2171
|
-
}
|
|
2172
|
-
interface Role$1 {
|
|
2173
|
-
_id?: string;
|
|
2174
|
-
deprecatedKey?: string;
|
|
2175
|
-
/** @deprecated */
|
|
2176
|
-
titleKey?: string;
|
|
2177
|
-
/** @deprecated */
|
|
2178
|
-
descriptionKey?: string;
|
|
2179
|
-
deprecated?: boolean;
|
|
2180
|
-
restrictFromLevel?: string;
|
|
2181
|
-
experiments?: string[];
|
|
2182
|
-
appDefIds?: string[];
|
|
2183
|
-
title?: string | null;
|
|
2184
|
-
description?: string | null;
|
|
2185
|
-
isCustom?: boolean;
|
|
2186
|
-
scopes?: string[];
|
|
2187
|
-
availableResourceTypes?: ResourceType$1[];
|
|
2188
|
-
availableConditions?: ConditionAttributeType$1[];
|
|
2189
|
-
limitToEditorTypes?: string[];
|
|
2190
|
-
}
|
|
2191
|
-
interface ChangeRoleRequest {
|
|
2192
|
-
/** User ID. */
|
|
2193
|
-
_id?: string;
|
|
2194
|
-
/**
|
|
2195
|
-
* Deprecated. Use `policyIds`.
|
|
2196
|
-
* @deprecated
|
|
2197
|
-
*/
|
|
2198
|
-
role?: string;
|
|
2199
|
-
/** Role IDs to be assigned. */
|
|
2200
|
-
policyIds?: string[];
|
|
2201
|
-
}
|
|
2202
|
-
interface ChangeRoleResponse {
|
|
2203
|
-
}
|
|
2204
|
-
interface RemoveMemberRequest {
|
|
2205
|
-
/** User ID of the team member to remove. */
|
|
2206
|
-
userId: string;
|
|
2207
|
-
}
|
|
2208
|
-
interface RemoveMemberResponse {
|
|
2209
|
-
}
|
|
2210
|
-
interface GetUsersRequest {
|
|
2211
|
-
/** The number of items to load */
|
|
2212
|
-
limit?: number | null;
|
|
2213
|
-
/** number of items to skip in the current sort order */
|
|
2214
|
-
offset?: number | null;
|
|
2215
|
-
}
|
|
2216
|
-
interface GetUsersResponse {
|
|
2217
|
-
users?: User$1[];
|
|
2218
|
-
}
|
|
2219
|
-
interface GetScopesRequest {
|
|
2220
|
-
/** The locale of the request. Defaults to en */
|
|
2221
|
-
locale?: string | null;
|
|
2222
|
-
}
|
|
2223
|
-
interface GetScopesResponse {
|
|
2224
|
-
scopeAreas?: ScopeArea[];
|
|
2225
|
-
}
|
|
2226
|
-
interface ScopeArea {
|
|
2227
|
-
title?: string;
|
|
2228
|
-
appDefIds?: string[];
|
|
2229
|
-
scopes?: PermissionScope[];
|
|
2230
|
-
restrictFromLevel?: ScopeLevel;
|
|
2231
|
-
}
|
|
2232
|
-
interface PermissionScope {
|
|
2233
|
-
_id?: string;
|
|
2234
|
-
title?: string;
|
|
2235
|
-
description?: string;
|
|
2236
|
-
level?: ScopeLevel;
|
|
2237
|
-
experiments?: string[];
|
|
2238
|
-
dependantScopes?: string[];
|
|
2239
|
-
restrictFromLevel?: ScopeLevel;
|
|
2240
|
-
deprecated?: boolean | null;
|
|
2241
|
-
/** The visibility of the scope for the caller */
|
|
2242
|
-
visibility?: Visibility;
|
|
2243
|
-
appDefIds?: string[];
|
|
2244
|
-
}
|
|
2245
|
-
declare enum ScopeLevel {
|
|
2246
|
-
None = "None",
|
|
2247
|
-
SITE = "SITE",
|
|
2248
|
-
ACCOUNT = "ACCOUNT"
|
|
2249
|
-
}
|
|
2250
|
-
declare enum Visibility {
|
|
2251
|
-
/** The scope should be visible to the caller */
|
|
2252
|
-
VISIBLE = "VISIBLE",
|
|
2253
|
-
/** The scope shouldn't be visible for the caller, because the capability that blocks it is turned on for the caller */
|
|
2254
|
-
BLOCKED_BY_CAPABILITY = "BLOCKED_BY_CAPABILITY"
|
|
2255
|
-
}
|
|
2256
|
-
interface GetPeopleRequest {
|
|
2257
|
-
resource?: PeopleResource;
|
|
2258
|
-
peopleType?: PeopleType;
|
|
2259
|
-
paging?: Paging;
|
|
2260
|
-
/** The locale of the request. Defaults to en */
|
|
2261
|
-
locale?: string | null;
|
|
2262
|
-
}
|
|
2263
|
-
interface PeopleResource extends PeopleResourceResourceTypeOneOf {
|
|
2264
|
-
site?: string;
|
|
2265
|
-
folder?: FolderResource;
|
|
2266
|
-
}
|
|
2267
|
-
/** @oneof */
|
|
2268
|
-
interface PeopleResourceResourceTypeOneOf {
|
|
2269
|
-
site?: string;
|
|
2270
|
-
folder?: FolderResource;
|
|
2271
|
-
}
|
|
2272
|
-
interface FolderResource {
|
|
2273
|
-
folderId?: string;
|
|
2274
|
-
folderFullPath?: string;
|
|
2275
|
-
}
|
|
2276
|
-
declare enum PeopleType {
|
|
2277
|
-
UNDEF_PEOPLE_TYPE = "UNDEF_PEOPLE_TYPE",
|
|
2278
|
-
CONTRIBUTOR = "CONTRIBUTOR",
|
|
2279
|
-
TEAM_MEMBER = "TEAM_MEMBER"
|
|
2280
|
-
}
|
|
2281
|
-
interface GetPeopleResponse {
|
|
2282
|
-
people?: People;
|
|
2283
|
-
}
|
|
2284
|
-
interface People {
|
|
2285
|
-
people?: Person[];
|
|
2286
|
-
totalPeople?: number;
|
|
2287
|
-
}
|
|
2288
|
-
interface Person extends PersonPersonOneOf {
|
|
2289
|
-
contributor?: Contributor$1;
|
|
2290
|
-
teamMember?: TeamMember;
|
|
2291
|
-
}
|
|
2292
|
-
/** @oneof */
|
|
2293
|
-
interface PersonPersonOneOf {
|
|
2294
|
-
contributor?: Contributor$1;
|
|
2295
|
-
teamMember?: TeamMember;
|
|
2296
|
-
}
|
|
2297
|
-
interface Contributor$1 {
|
|
2298
|
-
/** Contributor's metadata. */
|
|
2299
|
-
metaData?: PersonMetaData$1;
|
|
2300
|
-
/** Whether the contributor account is a team account. */
|
|
2301
|
-
isTeam?: boolean | null;
|
|
2302
|
-
/** Date that the contributor joined the site. */
|
|
2303
|
-
joinedAt?: Date | null;
|
|
2304
|
-
/** Email address that received the invite. */
|
|
2305
|
-
invitedEmail?: string | null;
|
|
2306
|
-
/** Whether the contributor account is a client account. */
|
|
2307
|
-
isClient?: boolean | null;
|
|
2308
|
-
/**
|
|
2309
|
-
* Contributor's user ID.
|
|
2310
|
-
* @readonly
|
|
2311
|
-
*/
|
|
2312
|
-
_id?: string;
|
|
2313
|
-
}
|
|
2314
|
-
interface PersonMetaData$1 {
|
|
2315
|
-
/** Contributor's account ID. */
|
|
2316
|
-
_id?: string;
|
|
2317
|
-
/** Contributor's full name. */
|
|
2318
|
-
fullName?: string | null;
|
|
2319
|
-
/** URL for contributor's profile image. */
|
|
2320
|
-
imageUrl?: string | null;
|
|
2321
|
-
/** Contributor's email address. */
|
|
2322
|
-
email?: string | null;
|
|
2323
|
-
/** Contributor's access to assets and their assigned role (`policy`) for that asset. */
|
|
2324
|
-
assignments?: Assignment$1[];
|
|
2325
|
-
}
|
|
2326
|
-
interface TeamMember {
|
|
2327
|
-
metaData?: PersonMetaData$1;
|
|
2328
|
-
}
|
|
2329
|
-
interface GetTeamV2Response {
|
|
2330
|
-
users?: User$1[];
|
|
2331
|
-
totalUsersInAccount?: string;
|
|
2332
|
-
}
|
|
2333
|
-
interface GetTeamInvitesRequest {
|
|
2334
|
-
/** The locale of the request. Defaults to en */
|
|
2335
|
-
locale?: string | null;
|
|
2336
|
-
}
|
|
2337
|
-
interface GetTeamInvitesResponse {
|
|
2338
|
-
invites?: Invite[];
|
|
2339
|
-
}
|
|
2340
|
-
interface Invite {
|
|
2341
|
-
/** @readonly */
|
|
2342
|
-
_id?: string;
|
|
2343
|
-
/** @readonly */
|
|
2344
|
-
accountId?: string;
|
|
2345
|
-
email?: string;
|
|
2346
|
-
status?: InviteStatus$1;
|
|
2347
|
-
acceptLink?: string;
|
|
2348
|
-
dateCreated?: Date | null;
|
|
2349
|
-
dateUpdated?: Date | null;
|
|
2350
|
-
assignments?: ApiInviteAssignment[];
|
|
2351
|
-
/** Invite expiration date */
|
|
2352
|
-
expirationDate?: Date | null;
|
|
2353
|
-
}
|
|
2354
|
-
interface ApiInviteAssignment {
|
|
2355
|
-
policy?: AssignedPolicy$1;
|
|
2356
|
-
restrictions?: Restriction$1;
|
|
2357
|
-
}
|
|
2358
|
-
interface GetPoliciesRequest {
|
|
2359
|
-
/** The locale of the request. Defaults to en */
|
|
2360
|
-
locale?: string | null;
|
|
2361
|
-
/** Areas filter to include only roles from areas that pass this filter. When not provided, roles from all areas will be returned */
|
|
2362
|
-
areasFilter?: AreasFilter;
|
|
2363
|
-
/** Role level filter to include only roles that are not restricted from the requested resource level (site/account). When set to ALL, all levels are returned */
|
|
2364
|
-
roleLevel?: RoleLevel;
|
|
2365
|
-
}
|
|
2366
|
-
interface AreasFilter {
|
|
2367
|
-
/** A list of role area ids, to filter only roles belonging to these areas */
|
|
2368
|
-
areaIds?: string[];
|
|
2369
|
-
}
|
|
2370
|
-
declare enum RoleLevel {
|
|
2371
|
-
ALL = "ALL",
|
|
2372
|
-
SITE_LEVEL = "SITE_LEVEL",
|
|
2373
|
-
ACCOUNT_LEVEL = "ACCOUNT_LEVEL"
|
|
2374
|
-
}
|
|
2375
|
-
interface GetPoliciesResponse {
|
|
2376
|
-
policies?: PredefinedRoles$1;
|
|
2377
|
-
}
|
|
2378
|
-
interface SearchTeamRequest {
|
|
2379
|
-
/** Free text to search for within team member name and email address fields. */
|
|
2380
|
-
query?: string | null;
|
|
2381
|
-
/** Sort data. */
|
|
2382
|
-
orderBy?: Ordering[];
|
|
2383
|
-
/**
|
|
2384
|
-
* Filter object. Supported values: `inviteType` and `roleId`. For example, `{'inviteType': {'$eq': 'Expired'}}`.
|
|
2385
|
-
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
|
|
2386
|
-
*/
|
|
2387
|
-
filter?: Record<string, any> | null;
|
|
2388
|
-
/**
|
|
2389
|
-
* A list of facets to return in the response. Facets count the items within logical groupings.
|
|
2390
|
-
* See [Filters and Facets: An Explainer](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) for more information.
|
|
2391
|
-
*/
|
|
2392
|
-
facets?: FacetType[];
|
|
2393
|
-
/** Pagination. */
|
|
2394
|
-
paging?: Paging;
|
|
2395
|
-
}
|
|
2396
|
-
interface Ordering {
|
|
2397
|
-
/** Field to sort by. */
|
|
2398
|
-
fieldName?: OrderField;
|
|
2399
|
-
/** Sort order. */
|
|
2400
|
-
direction?: Direction;
|
|
2401
|
-
}
|
|
2402
|
-
declare enum OrderField {
|
|
2403
|
-
/** For internal use. */
|
|
2404
|
-
Undefined = "Undefined",
|
|
2405
|
-
/** Team member name. */
|
|
2406
|
-
Name = "Name",
|
|
2407
|
-
/** Date team member joined the account. */
|
|
2408
|
-
JoinedAt = "JoinedAt"
|
|
2409
|
-
}
|
|
2410
|
-
declare enum Direction {
|
|
2411
|
-
/** For internal use. */
|
|
2412
|
-
UninitializedDirection = "UninitializedDirection",
|
|
2413
|
-
/** Ascending. */
|
|
2414
|
-
ASC = "ASC",
|
|
2415
|
-
/** Descending. */
|
|
2416
|
-
DESC = "DESC"
|
|
2417
|
-
}
|
|
2418
|
-
declare enum FacetType {
|
|
2419
|
-
Undefined = "Undefined",
|
|
2420
|
-
/** How many team members with each role */
|
|
2421
|
-
Roles = "Roles",
|
|
2422
|
-
/** How many team members by invite status */
|
|
2423
|
-
InviteStatus = "InviteStatus",
|
|
2424
|
-
/** How many team members in total in the account */
|
|
2425
|
-
Users = "Users"
|
|
2426
|
-
}
|
|
2427
|
-
interface SearchTeamResponse {
|
|
2428
|
-
/** List of facets, as requested. */
|
|
2429
|
-
facets?: Facet[];
|
|
2430
|
-
/** Existing team members and invites sent to join the account. */
|
|
2431
|
-
teamMembers?: TeamMemberV3[];
|
|
2432
|
-
}
|
|
2433
|
-
interface Facet {
|
|
2434
|
-
/** Facet type. */
|
|
2435
|
-
facetType?: FacetType;
|
|
2436
|
-
/** Values and their counters. Values with count = 0 are not returned. */
|
|
2437
|
-
values?: FacetValue[];
|
|
2438
|
-
}
|
|
2439
|
-
interface FacetValue {
|
|
2440
|
-
/** Supported values: `Roles`, `InviteStatus`, `Users`. */
|
|
2441
|
-
value?: string;
|
|
2442
|
-
/** Number of existing items for the value. */
|
|
2443
|
-
count?: number;
|
|
2444
|
-
}
|
|
2445
|
-
interface TeamMemberV3 extends TeamMemberV3MembersOneOf {
|
|
2446
|
-
/** Existing team member data. */
|
|
2447
|
-
user?: UserV3;
|
|
2448
|
-
/** Invited team member data. */
|
|
2449
|
-
invite?: InviteV3;
|
|
2450
|
-
}
|
|
2451
|
-
/** @oneof */
|
|
2452
|
-
interface TeamMemberV3MembersOneOf {
|
|
2453
|
-
/** Existing team member data. */
|
|
2454
|
-
user?: UserV3;
|
|
2455
|
-
/** Invited team member data. */
|
|
2456
|
-
invite?: InviteV3;
|
|
2457
|
-
}
|
|
2458
|
-
interface UserV3 {
|
|
2459
|
-
/** User ID. */
|
|
2460
|
-
_id?: string;
|
|
2461
|
-
/** User's email address. */
|
|
2462
|
-
email?: string | null;
|
|
2463
|
-
/** User's name, when provided. */
|
|
2464
|
-
name?: Name$1;
|
|
2465
|
-
/** URL to user's profile image, when provided. */
|
|
2466
|
-
profileImage?: string | null;
|
|
2467
|
-
/** Date the user joined the team. */
|
|
2468
|
-
joinedTeamAt?: Date | null;
|
|
2469
|
-
/** Mapping of the user's access to an asset and their assigned role. */
|
|
2470
|
-
assignments?: AssignmentV3[];
|
|
2471
|
-
}
|
|
2472
|
-
interface AssignmentV3 {
|
|
2473
|
-
/** Role assigned to the user. To retrieve all available roles, call Get Roles Info. */
|
|
2474
|
-
policyId?: string | null;
|
|
2475
|
-
/**
|
|
2476
|
-
* Unique ID for this specific assignment.
|
|
2477
|
-
* @readonly
|
|
2478
|
-
*/
|
|
2479
|
-
assignmentId?: string | null;
|
|
2480
|
-
/** The asset where a user is assigned access in an assignment. When empty, the role covers all assets, with no restrictions to specific sites or folders. */
|
|
2481
|
-
restrictions?: Restriction$1;
|
|
2482
|
-
/** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
|
|
2483
|
-
subject?: AssignedSubject;
|
|
2484
|
-
}
|
|
2485
|
-
interface AssignedSubject {
|
|
2486
|
-
/**
|
|
2487
|
-
* Identity ID.
|
|
2488
|
-
* @readonly
|
|
2489
|
-
*/
|
|
2490
|
-
_id?: string;
|
|
2491
|
-
/** Identity type. */
|
|
2492
|
-
subjectType?: SubjectType$1;
|
|
2493
|
-
}
|
|
2494
|
-
interface InviteV3 {
|
|
2495
|
-
/**
|
|
2496
|
-
* Invite ID.
|
|
2497
|
-
* @readonly
|
|
2498
|
-
*/
|
|
2499
|
-
_id?: string;
|
|
2500
|
-
/** Invitee's email address. */
|
|
2501
|
-
email?: string | null;
|
|
2502
|
-
/** Invite status. */
|
|
2503
|
-
status?: InviteStatus$1;
|
|
2504
|
-
/** URL of direct link to accept the invite. */
|
|
2505
|
-
acceptLink?: string | null;
|
|
2506
|
-
/** Date the invite was created. */
|
|
2507
|
-
dateCreated?: Date | null;
|
|
2508
|
-
/** Date the invite was last updated. */
|
|
2509
|
-
dateUpdated?: Date | null;
|
|
2510
|
-
/** A list of assignments that will be applied to the invitees when they accept the invite. */
|
|
2511
|
-
assignments?: InviteAssignmentV3[];
|
|
2512
|
-
/** Invite expiration date. */
|
|
2513
|
-
expirationDate?: Date | null;
|
|
2514
|
-
}
|
|
2515
|
-
interface InviteAssignmentV3 {
|
|
2516
|
-
/** Role ID that will be assigned once the invite is accepted. */
|
|
2517
|
-
policyId?: string | null;
|
|
2518
|
-
/** Assets where the user will be assigned access. When empty, the role covers all assets, with no restrictions to specific sites or folders. */
|
|
2519
|
-
restrictions?: Restriction$1;
|
|
2520
|
-
}
|
|
2521
|
-
interface GetRolesRequest {
|
|
2522
|
-
/** The locale of the predefined roles names and descriptions. Defaults to English */
|
|
2523
|
-
locale?: string | null;
|
|
2524
|
-
}
|
|
2525
|
-
interface GetRolesResponse {
|
|
2526
|
-
/** The predefined roles (by areas) */
|
|
2527
|
-
predefinedRolesAreas?: PredefinedRolesArea[];
|
|
2528
|
-
/** The custom roles */
|
|
2529
|
-
customRoles?: CustomRole[];
|
|
2530
|
-
}
|
|
2531
|
-
interface PredefinedRolesArea {
|
|
2532
|
-
/** The id of the area (e.g "Blog") */
|
|
2533
|
-
areaId?: string;
|
|
2534
|
-
/** The translated area title, according to the request locale, or the original title if translation failed */
|
|
2535
|
-
title?: string;
|
|
2536
|
-
/** The predefined roles belonging to this area */
|
|
2537
|
-
roles?: PredefinedRoleV2[];
|
|
2538
|
-
}
|
|
2539
|
-
interface PredefinedRoleV2 {
|
|
2540
|
-
/** The policy id of this role */
|
|
2541
|
-
_id?: string;
|
|
2542
|
-
/** The title of this role, translated according to the request locale, or the original title if translation failed */
|
|
2543
|
-
title?: string;
|
|
2544
|
-
/** The description of this role, translated according to the request locale, or the original description if translation failed */
|
|
2545
|
-
description?: string;
|
|
2546
|
-
/** The permission-scopes this role's policy contains */
|
|
2547
|
-
scopes?: string[];
|
|
2548
|
-
/** Indicates if the role is deprecated (shouldn't be granted, and only exists for backward compatability) */
|
|
2549
|
-
deprecated?: boolean;
|
|
2550
|
-
/** Indicates if this role should be restricted from assignments of a specific resource type (if RoleLevelRestriction = None, there is no restriction) */
|
|
2551
|
-
restrictFromLevel?: RoleLevelRestriction;
|
|
2552
|
-
/** Experiments that should be open for this role to be visible */
|
|
2553
|
-
experiments?: string[];
|
|
2554
|
-
/** Applications that should be installed for this role to be visible */
|
|
2555
|
-
appDefIds?: string[];
|
|
2556
|
-
/** Editor types this role should be limited to (if empty, available in all editors) */
|
|
2557
|
-
limitToEditorTypes?: EditorType[];
|
|
2558
|
-
/** The visibility of the role */
|
|
2559
|
-
visibility?: RoleVisibility;
|
|
2560
|
-
}
|
|
2561
|
-
declare enum RoleLevelRestriction {
|
|
2562
|
-
NoRestriction = "NoRestriction",
|
|
2563
|
-
Site = "Site",
|
|
2564
|
-
Account = "Account"
|
|
2565
|
-
}
|
|
2566
|
-
declare enum EditorType {
|
|
2567
|
-
UNINITIALIZED = "UNINITIALIZED",
|
|
2568
|
-
EDITORX = "EDITORX",
|
|
2569
|
-
BLOCKS = "BLOCKS",
|
|
2570
|
-
STUDIO = "STUDIO"
|
|
2571
|
-
}
|
|
2572
|
-
declare enum RoleVisibility {
|
|
2573
|
-
/** the role should be visible to the caller */
|
|
2574
|
-
Visible = "Visible",
|
|
2575
|
-
/** the role should be disabled for the caller, because it contains permissions the caller wasn't granted on the call context (site/account) */
|
|
2576
|
-
Disabled_Dependency = "Disabled_Dependency",
|
|
2577
|
-
/** the role should be disabled for the caller, because the role's capability is disabled for the caller */
|
|
2578
|
-
Disabled_Capability = "Disabled_Capability"
|
|
2579
|
-
}
|
|
2580
|
-
interface CustomRole {
|
|
2581
|
-
/** The policy this role grants */
|
|
2582
|
-
policy?: ApiPolicy;
|
|
2583
|
-
/** The visibility of the role */
|
|
2584
|
-
visibility?: RoleVisibility;
|
|
2585
|
-
}
|
|
2586
|
-
interface GetRolesInfoRequest {
|
|
2587
|
-
/** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
|
|
2588
|
-
locale?: string | null;
|
|
2589
|
-
/** Roles to return. */
|
|
2590
|
-
filter?: RolesInfoFilter;
|
|
2591
|
-
}
|
|
2592
|
-
interface RolesInfoFilter {
|
|
2593
|
-
/** Role level to return. Default: ALL. */
|
|
2594
|
-
roleLevel?: RoleLevel;
|
|
2595
|
-
/** Filter for editor-specific roles. Default: ALL. */
|
|
2596
|
-
editorTypes?: EditorType[];
|
|
2597
|
-
}
|
|
2598
|
-
interface GetRolesInfoResponse {
|
|
2599
|
-
/** Predefined roles. */
|
|
2600
|
-
predefinedRoles?: RoleInfo[];
|
|
2601
|
-
/** Custom roles. */
|
|
2602
|
-
customRoles?: RoleInfo[];
|
|
2603
|
-
}
|
|
2604
|
-
interface RoleInfo {
|
|
2605
|
-
/** Role ID. */
|
|
2606
|
-
_id?: string;
|
|
2607
|
-
/** Role title, translated according to the request locale. If translation fails, the original title is returned. */
|
|
2608
|
-
title?: string;
|
|
2609
|
-
/** Role description, translated according to the request locale. If translation fails, the original description is returned. */
|
|
2610
|
-
description?: string;
|
|
2611
|
-
/** Whether this role is restricted from accessing a specific resource type. Default: `NoRestriction`. */
|
|
2612
|
-
restrictFromLevel?: RoleLevelRestriction;
|
|
2613
|
-
}
|
|
2614
|
-
interface CreateCustomRoleRequest {
|
|
2615
|
-
/** The custom role to create */
|
|
2616
|
-
role?: Policy$1;
|
|
2617
|
-
}
|
|
2618
|
-
interface Policy$1 {
|
|
2619
|
-
/** @readonly */
|
|
2620
|
-
_id?: string | null;
|
|
2621
|
-
name?: string | null;
|
|
2622
|
-
description?: string | null;
|
|
2623
|
-
/** @readonly */
|
|
2624
|
-
status?: string;
|
|
2625
|
-
policyType?: PolicyType;
|
|
2626
|
-
statements?: PolicyStatement[];
|
|
2627
|
-
}
|
|
2628
|
-
declare enum PolicyType {
|
|
2629
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2630
|
-
PREDEFINED = "PREDEFINED",
|
|
2631
|
-
CUSTOM = "CUSTOM",
|
|
2632
|
-
INLINE_CUSTOM = "INLINE_CUSTOM"
|
|
2633
|
-
}
|
|
2634
|
-
interface PolicyStatement {
|
|
2635
|
-
/** @readonly */
|
|
2636
|
-
_id?: string | null;
|
|
2637
|
-
permissions?: string[];
|
|
2638
|
-
scopes?: string[];
|
|
2639
|
-
effect?: Effect;
|
|
2640
|
-
condition?: PolicyCondition;
|
|
2641
|
-
}
|
|
2642
|
-
declare enum Effect {
|
|
2643
|
-
UNKNOWN_EFFECT = "UNKNOWN_EFFECT",
|
|
2644
|
-
ALLOW = "ALLOW",
|
|
2645
|
-
DENY = "DENY"
|
|
2646
|
-
}
|
|
2647
|
-
interface CreateCustomRoleResponse {
|
|
2648
|
-
/** The newly created custom role */
|
|
2649
|
-
roleCreated?: Policy$1;
|
|
2650
|
-
}
|
|
2651
|
-
interface ChangeRoleV2Request {
|
|
2652
|
-
/** ID of team member being affected. */
|
|
2653
|
-
userId?: string;
|
|
2654
|
-
/** New assignments, including roles, to apply to the team member in this account. To retrieve all available roles, call Get Roles Info. */
|
|
2655
|
-
roles?: AssignmentV3[];
|
|
2656
|
-
/** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
|
|
2657
|
-
assignmentIdsToReplace?: string[];
|
|
2658
|
-
}
|
|
2659
|
-
interface ChangeRoleV2Response {
|
|
2660
|
-
/** New roles assigned to the given team member. */
|
|
2661
|
-
roles?: AssignmentV3[];
|
|
2662
|
-
}
|
|
2663
|
-
interface UpdateTeamMemberAssignmentsRequest {
|
|
2664
|
-
/** ID of team member being affected. */
|
|
2665
|
-
userId: string;
|
|
2666
|
-
/** New assignments to apply to the team member in this account. */
|
|
2667
|
-
newAssignments: AssignmentV3[];
|
|
2668
|
-
/** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
|
|
2669
|
-
assignmentIdsToRemove: string[];
|
|
2670
|
-
}
|
|
2671
|
-
interface UpdateTeamMemberAssignmentsResponse {
|
|
2672
|
-
/** The new assignments, assigned to the given team member. */
|
|
2673
|
-
assignments?: AssignmentV3[];
|
|
2674
|
-
}
|
|
2675
|
-
interface GetSubjectsAssignmentsRequest {
|
|
2676
|
-
/** The locale of the request. Defaults to en */
|
|
2677
|
-
locale?: string | null;
|
|
2678
|
-
/** list of subjects */
|
|
2679
|
-
subjects?: Subject$1[];
|
|
2680
|
-
}
|
|
2681
|
-
interface GetSubjectsAssignmentsResponse {
|
|
2682
|
-
/** list of subjects with assignments */
|
|
2683
|
-
subjectsAssignments?: SubjectAssignments[];
|
|
2684
|
-
}
|
|
2685
|
-
interface SubjectAssignments {
|
|
2686
|
-
subject?: Subject$1;
|
|
2687
|
-
assignments?: Assignment$1[];
|
|
2688
|
-
}
|
|
2689
|
-
interface FacetValueNonNullableFields {
|
|
2690
|
-
value: string;
|
|
2691
|
-
count: number;
|
|
2692
|
-
}
|
|
2693
|
-
interface FacetNonNullableFields {
|
|
2694
|
-
facetType: FacetType;
|
|
2695
|
-
values: FacetValueNonNullableFields[];
|
|
2696
|
-
}
|
|
2697
|
-
interface NameNonNullableFields {
|
|
2698
|
-
firstName: string;
|
|
2699
|
-
lastName: string;
|
|
2700
|
-
}
|
|
2701
|
-
interface ApiResourceNonNullableFields {
|
|
2702
|
-
resourceType: ResourceType$1;
|
|
2703
|
-
_id: string;
|
|
2704
|
-
}
|
|
2705
|
-
interface ApiConditionNonNullableFields {
|
|
2706
|
-
conditionType: ConditionAttributeType$1;
|
|
2707
|
-
_id: string;
|
|
2708
|
-
}
|
|
2709
|
-
interface ConditionsNonNullableFields {
|
|
2710
|
-
conditions: ApiConditionNonNullableFields[];
|
|
2711
|
-
}
|
|
2712
|
-
interface CompanionResourceNonNullableFields {
|
|
2713
|
-
_id: string;
|
|
2714
|
-
resourceType: string;
|
|
2715
|
-
}
|
|
2716
|
-
interface SiteRestrictionNonNullableFields {
|
|
2717
|
-
_id: string;
|
|
2718
|
-
resource?: CompanionResourceNonNullableFields;
|
|
2719
|
-
}
|
|
2720
|
-
interface RestrictionNonNullableFields {
|
|
2721
|
-
resource?: ApiResourceNonNullableFields;
|
|
2722
|
-
conditions?: ConditionsNonNullableFields;
|
|
2723
|
-
site?: SiteRestrictionNonNullableFields;
|
|
2724
|
-
}
|
|
2725
|
-
interface AssignedSubjectNonNullableFields {
|
|
2726
|
-
_id: string;
|
|
2727
|
-
subjectType: SubjectType$1;
|
|
2728
|
-
}
|
|
2729
|
-
interface AssignmentV3NonNullableFields {
|
|
2730
|
-
restrictions?: RestrictionNonNullableFields;
|
|
2731
|
-
subject?: AssignedSubjectNonNullableFields;
|
|
2732
|
-
}
|
|
2733
|
-
interface UserV3NonNullableFields {
|
|
2734
|
-
_id: string;
|
|
2735
|
-
name?: NameNonNullableFields;
|
|
2736
|
-
assignments: AssignmentV3NonNullableFields[];
|
|
2737
|
-
}
|
|
2738
|
-
interface InviteAssignmentV3NonNullableFields {
|
|
2739
|
-
restrictions?: RestrictionNonNullableFields;
|
|
2740
|
-
}
|
|
2741
|
-
interface InviteV3NonNullableFields {
|
|
2742
|
-
_id: string;
|
|
2743
|
-
status: InviteStatus$1;
|
|
2744
|
-
assignments: InviteAssignmentV3NonNullableFields[];
|
|
2745
|
-
}
|
|
2746
|
-
interface TeamMemberV3NonNullableFields {
|
|
2747
|
-
user?: UserV3NonNullableFields;
|
|
2748
|
-
invite?: InviteV3NonNullableFields;
|
|
2749
|
-
}
|
|
2750
|
-
interface SearchTeamResponseNonNullableFields {
|
|
2751
|
-
facets: FacetNonNullableFields[];
|
|
2752
|
-
teamMembers: TeamMemberV3NonNullableFields[];
|
|
2753
|
-
}
|
|
2754
|
-
interface RoleInfoNonNullableFields {
|
|
2755
|
-
_id: string;
|
|
2756
|
-
title: string;
|
|
2757
|
-
description: string;
|
|
2758
|
-
restrictFromLevel: RoleLevelRestriction;
|
|
2759
|
-
}
|
|
2760
|
-
interface GetRolesInfoResponseNonNullableFields {
|
|
2761
|
-
predefinedRoles: RoleInfoNonNullableFields[];
|
|
2762
|
-
customRoles: RoleInfoNonNullableFields[];
|
|
2763
|
-
}
|
|
2764
|
-
interface UpdateTeamMemberAssignmentsResponseNonNullableFields {
|
|
2765
|
-
assignments: AssignmentV3NonNullableFields[];
|
|
2766
|
-
}
|
|
2767
|
-
interface SearchTeamOptions {
|
|
2768
|
-
/** Free text to search for within team member name and email address fields. */
|
|
2769
|
-
query?: string | null;
|
|
2770
|
-
/** Sort data. */
|
|
2771
|
-
orderBy?: Ordering[];
|
|
2772
|
-
/**
|
|
2773
|
-
* Filter object. Supported values: `inviteType` and `roleId`. For example, `{'inviteType': {'$eq': 'Expired'}}`.
|
|
2774
|
-
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
|
|
2775
|
-
*/
|
|
2776
|
-
filter?: Record<string, any> | null;
|
|
2777
|
-
/**
|
|
2778
|
-
* A list of facets to return in the response. Facets count the items within logical groupings.
|
|
2779
|
-
* See [Filters and Facets: An Explainer](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) for more information.
|
|
2780
|
-
*/
|
|
2781
|
-
facets?: FacetType[];
|
|
2782
|
-
/** Pagination. */
|
|
2783
|
-
paging?: Paging;
|
|
2784
|
-
}
|
|
2785
|
-
interface GetRolesInfoOptions {
|
|
2786
|
-
/** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
|
|
2787
|
-
locale?: string | null;
|
|
2788
|
-
/** Roles to return. */
|
|
2789
|
-
filter?: RolesInfoFilter;
|
|
2790
|
-
}
|
|
2791
|
-
interface UpdateTeamMemberAssignmentsOptions {
|
|
2792
|
-
/** New assignments to apply to the team member in this account. */
|
|
2793
|
-
newAssignments: AssignmentV3[];
|
|
2794
|
-
/** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
|
|
2795
|
-
assignmentIdsToRemove: string[];
|
|
2796
|
-
}
|
|
2797
|
-
|
|
2798
|
-
declare function removeMember$1(httpClient: HttpClient): RemoveMemberSignature;
|
|
2799
|
-
interface RemoveMemberSignature {
|
|
2800
|
-
/**
|
|
2801
|
-
* Removes a team member from the requesting account.
|
|
2802
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
2803
|
-
* @param - User ID of the team member to remove.
|
|
2804
|
-
*/
|
|
2805
|
-
(userId: string): Promise<void>;
|
|
2806
|
-
}
|
|
2807
|
-
declare function searchTeam$1(httpClient: HttpClient): SearchTeamSignature;
|
|
2808
|
-
interface SearchTeamSignature {
|
|
2809
|
-
/**
|
|
2810
|
-
* Retrieves all team members of the requesting account, based on the provided filters and free text queries.
|
|
2811
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
2812
|
-
* @param - Filter options.
|
|
2813
|
-
*/
|
|
2814
|
-
(options?: SearchTeamOptions | undefined): Promise<SearchTeamResponse & SearchTeamResponseNonNullableFields>;
|
|
2815
|
-
}
|
|
2816
|
-
declare function getRolesInfo$1(httpClient: HttpClient): GetRolesInfoSignature;
|
|
2817
|
-
interface GetRolesInfoSignature {
|
|
2818
|
-
/**
|
|
2819
|
-
* Retrieves all available roles in the requesting account, including predefined and custom roles.
|
|
2820
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
2821
|
-
* @param - Filter options.
|
|
2822
|
-
*/
|
|
2823
|
-
(options?: GetRolesInfoOptions | undefined): Promise<GetRolesInfoResponse & GetRolesInfoResponseNonNullableFields>;
|
|
2824
|
-
}
|
|
2825
|
-
declare function updateTeamMemberAssignments$1(httpClient: HttpClient): UpdateTeamMemberAssignmentsSignature;
|
|
2826
|
-
interface UpdateTeamMemberAssignmentsSignature {
|
|
2827
|
-
/**
|
|
2828
|
-
* Updates the assignments of roles and conditions for an existing team member. Changing assignments changes the team member’s access to account assets.
|
|
2829
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
2830
|
-
* @param - ID of team member being affected.
|
|
2831
|
-
* @param - Filter options. The `assignmentIdsToRemove` and `newAssignments` fields **must** be passed.
|
|
2832
|
-
*/
|
|
2833
|
-
(userId: string, options: UpdateTeamMemberAssignmentsOptions): Promise<UpdateTeamMemberAssignmentsResponse & UpdateTeamMemberAssignmentsResponseNonNullableFields>;
|
|
2834
|
-
}
|
|
2835
|
-
|
|
2836
|
-
declare const removeMember: MaybeContext<BuildRESTFunction<typeof removeMember$1> & typeof removeMember$1>;
|
|
2837
|
-
declare const searchTeam: MaybeContext<BuildRESTFunction<typeof searchTeam$1> & typeof searchTeam$1>;
|
|
2838
|
-
declare const getRolesInfo: MaybeContext<BuildRESTFunction<typeof getRolesInfo$1> & typeof getRolesInfo$1>;
|
|
2839
|
-
declare const updateTeamMemberAssignments: MaybeContext<BuildRESTFunction<typeof updateTeamMemberAssignments$1> & typeof updateTeamMemberAssignments$1>;
|
|
2840
|
-
|
|
2841
|
-
type context$1_AccountInvite = AccountInvite;
|
|
2842
|
-
type context$1_AccountResourceContext = AccountResourceContext;
|
|
2843
|
-
type context$1_ApiCondition = ApiCondition;
|
|
2844
|
-
type context$1_ApiInviteAssignment = ApiInviteAssignment;
|
|
2845
|
-
type context$1_ApiPolicy = ApiPolicy;
|
|
2846
|
-
type context$1_ApiResource = ApiResource;
|
|
2847
|
-
type context$1_AreasFilter = AreasFilter;
|
|
2848
|
-
type context$1_AssignedSubject = AssignedSubject;
|
|
2849
|
-
type context$1_AssignmentV3 = AssignmentV3;
|
|
2850
|
-
type context$1_ChangeRoleRequest = ChangeRoleRequest;
|
|
2851
|
-
type context$1_ChangeRoleResponse = ChangeRoleResponse;
|
|
2852
|
-
type context$1_ChangeRoleV2Request = ChangeRoleV2Request;
|
|
2853
|
-
type context$1_ChangeRoleV2Response = ChangeRoleV2Response;
|
|
2854
|
-
type context$1_ConditionOperator = ConditionOperator;
|
|
2855
|
-
type context$1_ConditionOperatorOperatorsOneOf = ConditionOperatorOperatorsOneOf;
|
|
2856
|
-
type context$1_ConditionType = ConditionType;
|
|
2857
|
-
type context$1_ConditionTypeOfOneOf = ConditionTypeOfOneOf;
|
|
2858
|
-
type context$1_ConditionValue = ConditionValue;
|
|
2859
|
-
type context$1_ConditionValueValueOneOf = ConditionValueValueOneOf;
|
|
2860
|
-
type context$1_CreateCustomRoleRequest = CreateCustomRoleRequest;
|
|
2861
|
-
type context$1_CreateCustomRoleResponse = CreateCustomRoleResponse;
|
|
2862
|
-
type context$1_CustomRole = CustomRole;
|
|
2863
|
-
type context$1_DependOnOperator = DependOnOperator;
|
|
2864
|
-
type context$1_Direction = Direction;
|
|
2865
|
-
declare const context$1_Direction: typeof Direction;
|
|
2866
|
-
type context$1_EditorType = EditorType;
|
|
2867
|
-
declare const context$1_EditorType: typeof EditorType;
|
|
2868
|
-
type context$1_Effect = Effect;
|
|
2869
|
-
declare const context$1_Effect: typeof Effect;
|
|
2870
|
-
type context$1_EnvironmentCondition = EnvironmentCondition;
|
|
2871
|
-
type context$1_EnvironmentConditionConditionOneOf = EnvironmentConditionConditionOneOf;
|
|
2872
|
-
type context$1_EqualOperator = EqualOperator;
|
|
2873
|
-
type context$1_ExperimentCondition = ExperimentCondition;
|
|
2874
|
-
type context$1_ExperimentOperator = ExperimentOperator;
|
|
2875
|
-
type context$1_Facet = Facet;
|
|
2876
|
-
type context$1_FacetType = FacetType;
|
|
2877
|
-
declare const context$1_FacetType: typeof FacetType;
|
|
2878
|
-
type context$1_FacetValue = FacetValue;
|
|
2879
|
-
type context$1_FolderResource = FolderResource;
|
|
2880
|
-
type context$1_FullNameResource = FullNameResource;
|
|
2881
|
-
type context$1_FullNameResourceResourceContextOneOf = FullNameResourceResourceContextOneOf;
|
|
2882
|
-
type context$1_GetPeopleRequest = GetPeopleRequest;
|
|
2883
|
-
type context$1_GetPeopleResponse = GetPeopleResponse;
|
|
2884
|
-
type context$1_GetPoliciesRequest = GetPoliciesRequest;
|
|
2885
|
-
type context$1_GetPoliciesResponse = GetPoliciesResponse;
|
|
2886
|
-
type context$1_GetRolesInfoOptions = GetRolesInfoOptions;
|
|
2887
|
-
type context$1_GetRolesInfoRequest = GetRolesInfoRequest;
|
|
2888
|
-
type context$1_GetRolesInfoResponse = GetRolesInfoResponse;
|
|
2889
|
-
type context$1_GetRolesInfoResponseNonNullableFields = GetRolesInfoResponseNonNullableFields;
|
|
2890
|
-
type context$1_GetRolesRequest = GetRolesRequest;
|
|
2891
|
-
type context$1_GetRolesResponse = GetRolesResponse;
|
|
2892
|
-
type context$1_GetScopesRequest = GetScopesRequest;
|
|
2893
|
-
type context$1_GetScopesResponse = GetScopesResponse;
|
|
2894
|
-
type context$1_GetSubjectsAssignmentsRequest = GetSubjectsAssignmentsRequest;
|
|
2895
|
-
type context$1_GetSubjectsAssignmentsResponse = GetSubjectsAssignmentsResponse;
|
|
2896
|
-
type context$1_GetTeamInvitesRequest = GetTeamInvitesRequest;
|
|
2897
|
-
type context$1_GetTeamInvitesResponse = GetTeamInvitesResponse;
|
|
2898
|
-
type context$1_GetTeamRequest = GetTeamRequest;
|
|
2899
|
-
type context$1_GetTeamResponse = GetTeamResponse;
|
|
2900
|
-
type context$1_GetTeamV2Response = GetTeamV2Response;
|
|
2901
|
-
type context$1_GetUsersRequest = GetUsersRequest;
|
|
2902
|
-
type context$1_GetUsersResponse = GetUsersResponse;
|
|
2903
|
-
type context$1_Invite = Invite;
|
|
2904
|
-
type context$1_InviteAssignment = InviteAssignment;
|
|
2905
|
-
type context$1_InviteAssignmentV3 = InviteAssignmentV3;
|
|
2906
|
-
type context$1_InviteResourceAssignment = InviteResourceAssignment;
|
|
2907
|
-
type context$1_InviteV3 = InviteV3;
|
|
2908
|
-
type context$1_JoinedCondition = JoinedCondition;
|
|
2909
|
-
type context$1_JoinedConditionOperator = JoinedConditionOperator;
|
|
2910
|
-
declare const context$1_JoinedConditionOperator: typeof JoinedConditionOperator;
|
|
2911
|
-
type context$1_LikeOperator = LikeOperator;
|
|
2912
|
-
type context$1_OrderField = OrderField;
|
|
2913
|
-
declare const context$1_OrderField: typeof OrderField;
|
|
2914
|
-
type context$1_Ordering = Ordering;
|
|
2915
|
-
type context$1_OrganizationResourceContext = OrganizationResourceContext;
|
|
2916
|
-
type context$1_Paging = Paging;
|
|
2917
|
-
type context$1_People = People;
|
|
2918
|
-
type context$1_PeopleResource = PeopleResource;
|
|
2919
|
-
type context$1_PeopleResourceResourceTypeOneOf = PeopleResourceResourceTypeOneOf;
|
|
2920
|
-
type context$1_PeopleType = PeopleType;
|
|
2921
|
-
declare const context$1_PeopleType: typeof PeopleType;
|
|
2922
|
-
type context$1_PermissionScope = PermissionScope;
|
|
2923
|
-
type context$1_Person = Person;
|
|
2924
|
-
type context$1_PersonPersonOneOf = PersonPersonOneOf;
|
|
2925
|
-
type context$1_PolicyCondition = PolicyCondition;
|
|
2926
|
-
type context$1_PolicyStatement = PolicyStatement;
|
|
2927
|
-
type context$1_PolicyType = PolicyType;
|
|
2928
|
-
declare const context$1_PolicyType: typeof PolicyType;
|
|
2929
|
-
type context$1_PredefinedRoleV2 = PredefinedRoleV2;
|
|
2930
|
-
type context$1_PredefinedRolesArea = PredefinedRolesArea;
|
|
2931
|
-
type context$1_RemoveMemberRequest = RemoveMemberRequest;
|
|
2932
|
-
type context$1_RemoveMemberResponse = RemoveMemberResponse;
|
|
2933
|
-
type context$1_RoleInfo = RoleInfo;
|
|
2934
|
-
type context$1_RoleLevel = RoleLevel;
|
|
2935
|
-
declare const context$1_RoleLevel: typeof RoleLevel;
|
|
2936
|
-
type context$1_RoleLevelRestriction = RoleLevelRestriction;
|
|
2937
|
-
declare const context$1_RoleLevelRestriction: typeof RoleLevelRestriction;
|
|
2938
|
-
type context$1_RoleVisibility = RoleVisibility;
|
|
2939
|
-
declare const context$1_RoleVisibility: typeof RoleVisibility;
|
|
2940
|
-
type context$1_RolesInfoFilter = RolesInfoFilter;
|
|
2941
|
-
type context$1_ScopeArea = ScopeArea;
|
|
2942
|
-
type context$1_ScopeLevel = ScopeLevel;
|
|
2943
|
-
declare const context$1_ScopeLevel: typeof ScopeLevel;
|
|
2944
|
-
type context$1_SearchTeamOptions = SearchTeamOptions;
|
|
2945
|
-
type context$1_SearchTeamRequest = SearchTeamRequest;
|
|
2946
|
-
type context$1_SearchTeamResponse = SearchTeamResponse;
|
|
2947
|
-
type context$1_SearchTeamResponseNonNullableFields = SearchTeamResponseNonNullableFields;
|
|
2948
|
-
type context$1_SimpleCondition = SimpleCondition;
|
|
2949
|
-
type context$1_SimpleConditionOperator = SimpleConditionOperator;
|
|
2950
|
-
declare const context$1_SimpleConditionOperator: typeof SimpleConditionOperator;
|
|
2951
|
-
type context$1_SimpleConditionValue = SimpleConditionValue;
|
|
2952
|
-
type context$1_SimpleConditionValueValueOneOf = SimpleConditionValueValueOneOf;
|
|
2953
|
-
type context$1_SiteResourceContext = SiteResourceContext;
|
|
2954
|
-
type context$1_SubjectAssignments = SubjectAssignments;
|
|
2955
|
-
type context$1_TeamMember = TeamMember;
|
|
2956
|
-
type context$1_TeamMemberV3 = TeamMemberV3;
|
|
2957
|
-
type context$1_TeamMemberV3MembersOneOf = TeamMemberV3MembersOneOf;
|
|
2958
|
-
type context$1_UpdateTeamMemberAssignmentsOptions = UpdateTeamMemberAssignmentsOptions;
|
|
2959
|
-
type context$1_UpdateTeamMemberAssignmentsRequest = UpdateTeamMemberAssignmentsRequest;
|
|
2960
|
-
type context$1_UpdateTeamMemberAssignmentsResponse = UpdateTeamMemberAssignmentsResponse;
|
|
2961
|
-
type context$1_UpdateTeamMemberAssignmentsResponseNonNullableFields = UpdateTeamMemberAssignmentsResponseNonNullableFields;
|
|
2962
|
-
type context$1_UserV3 = UserV3;
|
|
2963
|
-
type context$1_Visibility = Visibility;
|
|
2964
|
-
declare const context$1_Visibility: typeof Visibility;
|
|
2965
|
-
declare const context$1_getRolesInfo: typeof getRolesInfo;
|
|
2966
|
-
declare const context$1_removeMember: typeof removeMember;
|
|
2967
|
-
declare const context$1_searchTeam: typeof searchTeam;
|
|
2968
|
-
declare const context$1_updateTeamMemberAssignments: typeof updateTeamMemberAssignments;
|
|
2969
|
-
declare namespace context$1 {
|
|
2970
|
-
export { type AccountInfo$1 as AccountInfo, type context$1_AccountInvite as AccountInvite, type context$1_AccountResourceContext as AccountResourceContext, type context$1_ApiCondition as ApiCondition, type context$1_ApiInviteAssignment as ApiInviteAssignment, type context$1_ApiPolicy as ApiPolicy, type context$1_ApiResource as ApiResource, type context$1_AreasFilter as AreasFilter, type AssignedPolicy$1 as AssignedPolicy, type context$1_AssignedSubject as AssignedSubject, type Assignment$1 as Assignment, type context$1_AssignmentV3 as AssignmentV3, type context$1_ChangeRoleRequest as ChangeRoleRequest, type context$1_ChangeRoleResponse as ChangeRoleResponse, type context$1_ChangeRoleV2Request as ChangeRoleV2Request, type context$1_ChangeRoleV2Response as ChangeRoleV2Response, type CompanionResource$1 as CompanionResource, type Condition$1 as Condition, ConditionAttributeType$1 as ConditionAttributeType, type context$1_ConditionOperator as ConditionOperator, type context$1_ConditionOperatorOperatorsOneOf as ConditionOperatorOperatorsOneOf, type context$1_ConditionType as ConditionType, type context$1_ConditionTypeOfOneOf as ConditionTypeOfOneOf, type context$1_ConditionValue as ConditionValue, type context$1_ConditionValueValueOneOf as ConditionValueValueOneOf, type Conditions$1 as Conditions, type Contributor$1 as Contributor, type context$1_CreateCustomRoleRequest as CreateCustomRoleRequest, type context$1_CreateCustomRoleResponse as CreateCustomRoleResponse, type context$1_CustomRole as CustomRole, type context$1_DependOnOperator as DependOnOperator, context$1_Direction as Direction, context$1_EditorType as EditorType, context$1_Effect as Effect, type context$1_EnvironmentCondition as EnvironmentCondition, type context$1_EnvironmentConditionConditionOneOf as EnvironmentConditionConditionOneOf, type context$1_EqualOperator as EqualOperator, type context$1_ExperimentCondition as ExperimentCondition, type context$1_ExperimentOperator as ExperimentOperator, type context$1_Facet as Facet, context$1_FacetType as FacetType, type context$1_FacetValue as FacetValue, type context$1_FolderResource as FolderResource, type context$1_FullNameResource as FullNameResource, type context$1_FullNameResourceResourceContextOneOf as FullNameResourceResourceContextOneOf, type context$1_GetPeopleRequest as GetPeopleRequest, type context$1_GetPeopleResponse as GetPeopleResponse, type context$1_GetPoliciesRequest as GetPoliciesRequest, type context$1_GetPoliciesResponse as GetPoliciesResponse, type context$1_GetRolesInfoOptions as GetRolesInfoOptions, type context$1_GetRolesInfoRequest as GetRolesInfoRequest, type context$1_GetRolesInfoResponse as GetRolesInfoResponse, type context$1_GetRolesInfoResponseNonNullableFields as GetRolesInfoResponseNonNullableFields, type context$1_GetRolesRequest as GetRolesRequest, type context$1_GetRolesResponse as GetRolesResponse, type context$1_GetScopesRequest as GetScopesRequest, type context$1_GetScopesResponse as GetScopesResponse, type context$1_GetSubjectsAssignmentsRequest as GetSubjectsAssignmentsRequest, type context$1_GetSubjectsAssignmentsResponse as GetSubjectsAssignmentsResponse, type context$1_GetTeamInvitesRequest as GetTeamInvitesRequest, type context$1_GetTeamInvitesResponse as GetTeamInvitesResponse, type context$1_GetTeamRequest as GetTeamRequest, type context$1_GetTeamResponse as GetTeamResponse, type context$1_GetTeamV2Response as GetTeamV2Response, type context$1_GetUsersRequest as GetUsersRequest, type context$1_GetUsersResponse as GetUsersResponse, type context$1_Invite as Invite, type context$1_InviteAssignment as InviteAssignment, type context$1_InviteAssignmentV3 as InviteAssignmentV3, type context$1_InviteResourceAssignment as InviteResourceAssignment, InviteStatus$1 as InviteStatus, type context$1_InviteV3 as InviteV3, type context$1_JoinedCondition as JoinedCondition, context$1_JoinedConditionOperator as JoinedConditionOperator, type context$1_LikeOperator as LikeOperator, type Name$1 as Name, context$1_OrderField as OrderField, type context$1_Ordering as Ordering, type context$1_OrganizationResourceContext as OrganizationResourceContext, type context$1_Paging as Paging, type context$1_People as People, type context$1_PeopleResource as PeopleResource, type context$1_PeopleResourceResourceTypeOneOf as PeopleResourceResourceTypeOneOf, context$1_PeopleType as PeopleType, type context$1_PermissionScope as PermissionScope, type context$1_Person as Person, type PersonMetaData$1 as PersonMetaData, type context$1_PersonPersonOneOf as PersonPersonOneOf, type Policy$1 as Policy, type context$1_PolicyCondition as PolicyCondition, type context$1_PolicyStatement as PolicyStatement, context$1_PolicyType as PolicyType, type PredefinedRole$1 as PredefinedRole, type context$1_PredefinedRoleV2 as PredefinedRoleV2, type PredefinedRoles$1 as PredefinedRoles, type context$1_PredefinedRolesArea as PredefinedRolesArea, type context$1_RemoveMemberRequest as RemoveMemberRequest, type context$1_RemoveMemberResponse as RemoveMemberResponse, type Resource$1 as Resource, ResourceType$1 as ResourceType, type Restriction$1 as Restriction, type RestrictionRestrictionsOneOf$1 as RestrictionRestrictionsOneOf, type Role$1 as Role, type context$1_RoleInfo as RoleInfo, context$1_RoleLevel as RoleLevel, context$1_RoleLevelRestriction as RoleLevelRestriction, context$1_RoleVisibility as RoleVisibility, type context$1_RolesInfoFilter as RolesInfoFilter, type context$1_ScopeArea as ScopeArea, context$1_ScopeLevel as ScopeLevel, type context$1_SearchTeamOptions as SearchTeamOptions, type context$1_SearchTeamRequest as SearchTeamRequest, type context$1_SearchTeamResponse as SearchTeamResponse, type context$1_SearchTeamResponseNonNullableFields as SearchTeamResponseNonNullableFields, type context$1_SimpleCondition as SimpleCondition, context$1_SimpleConditionOperator as SimpleConditionOperator, type context$1_SimpleConditionValue as SimpleConditionValue, type context$1_SimpleConditionValueValueOneOf as SimpleConditionValueValueOneOf, type context$1_SiteResourceContext as SiteResourceContext, type SiteRestriction$1 as SiteRestriction, type Subject$1 as Subject, type context$1_SubjectAssignments as SubjectAssignments, type SubjectContext$1 as SubjectContext, SubjectContextType$1 as SubjectContextType, SubjectType$1 as SubjectType, type context$1_TeamMember as TeamMember, type context$1_TeamMemberV3 as TeamMemberV3, type context$1_TeamMemberV3MembersOneOf as TeamMemberV3MembersOneOf, type context$1_UpdateTeamMemberAssignmentsOptions as UpdateTeamMemberAssignmentsOptions, type context$1_UpdateTeamMemberAssignmentsRequest as UpdateTeamMemberAssignmentsRequest, type context$1_UpdateTeamMemberAssignmentsResponse as UpdateTeamMemberAssignmentsResponse, type context$1_UpdateTeamMemberAssignmentsResponseNonNullableFields as UpdateTeamMemberAssignmentsResponseNonNullableFields, type User$1 as User, type context$1_UserV3 as UserV3, context$1_Visibility as Visibility, context$1_getRolesInfo as getRolesInfo, context$1_removeMember as removeMember, context$1_searchTeam as searchTeam, context$1_updateTeamMemberAssignments as updateTeamMemberAssignments };
|
|
2971
|
-
}
|
|
2972
|
-
|
|
2973
|
-
interface Contributor {
|
|
2974
|
-
/** Contributor's metadata. */
|
|
2975
|
-
metaData?: PersonMetaData;
|
|
2976
|
-
/** Whether the contributor account is a team account. */
|
|
2977
|
-
isTeam?: boolean | null;
|
|
2978
|
-
/** Date that the contributor joined the site. */
|
|
2979
|
-
joinedAt?: Date | null;
|
|
2980
|
-
/** Email address that received the invite. */
|
|
2981
|
-
invitedEmail?: string | null;
|
|
2982
|
-
/** Whether the contributor account is a client account. */
|
|
2983
|
-
isClient?: boolean | null;
|
|
2984
|
-
/**
|
|
2985
|
-
* Contributor's user ID.
|
|
2986
|
-
* @readonly
|
|
2987
|
-
*/
|
|
2988
|
-
_id?: string;
|
|
2989
|
-
}
|
|
2990
|
-
interface PersonMetaData {
|
|
2991
|
-
/** Contributor's account ID. */
|
|
2992
|
-
_id?: string;
|
|
2993
|
-
/** Contributor's full name. */
|
|
2994
|
-
fullName?: string | null;
|
|
2995
|
-
/** URL for contributor's profile image. */
|
|
2996
|
-
imageUrl?: string | null;
|
|
2997
|
-
/** Contributor's email address. */
|
|
2998
|
-
email?: string | null;
|
|
2999
|
-
/** Contributor's access to assets and their assigned role (`policy`) for that asset. */
|
|
3000
|
-
assignments?: Assignment[];
|
|
3001
|
-
}
|
|
3002
|
-
interface Assignment {
|
|
3003
|
-
/** Role assigned to the user. */
|
|
3004
|
-
policy?: AssignedPolicy;
|
|
3005
|
-
/** Unique ID for this specific assignment. */
|
|
3006
|
-
assignmentId?: string;
|
|
3007
|
-
/** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
|
|
3008
|
-
subject?: Subject;
|
|
3009
|
-
}
|
|
3010
|
-
interface AssignedPolicy {
|
|
3011
|
-
/** Role ID. */
|
|
3012
|
-
policyId?: string;
|
|
3013
|
-
/** Role title. */
|
|
3014
|
-
title?: string | null;
|
|
3015
|
-
/** Role description. */
|
|
3016
|
-
description?: string | null;
|
|
3017
|
-
}
|
|
3018
|
-
interface Restriction extends RestrictionRestrictionsOneOf {
|
|
3019
|
-
/**
|
|
3020
|
-
* Deprecated.
|
|
3021
|
-
* @deprecated
|
|
3022
|
-
*/
|
|
3023
|
-
resource?: Resource;
|
|
3024
|
-
/** List of conditions restricting the user's access. Currently only folder conditions are supported. */
|
|
3025
|
-
conditions?: Conditions;
|
|
3026
|
-
/** Site where the assignment restrictions apply. */
|
|
3027
|
-
site?: SiteRestriction;
|
|
3028
|
-
}
|
|
3029
|
-
/** @oneof */
|
|
3030
|
-
interface RestrictionRestrictionsOneOf {
|
|
3031
|
-
/**
|
|
3032
|
-
* Deprecated.
|
|
3033
|
-
* @deprecated
|
|
3034
|
-
*/
|
|
3035
|
-
resource?: Resource;
|
|
3036
|
-
/** List of conditions restricting the user's access. Currently only folder conditions are supported. */
|
|
3037
|
-
conditions?: Conditions;
|
|
3038
|
-
/** Site where the assignment restrictions apply. */
|
|
3039
|
-
site?: SiteRestriction;
|
|
3040
|
-
}
|
|
3041
|
-
interface Resource {
|
|
3042
|
-
/** Resource type. */
|
|
3043
|
-
resourceType?: ResourceType;
|
|
3044
|
-
/** Resource ID. */
|
|
3045
|
-
_id?: string;
|
|
3046
|
-
value?: string | null;
|
|
3047
|
-
}
|
|
3048
|
-
declare enum ResourceType {
|
|
3049
|
-
UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
|
|
3050
|
-
SITE = "SITE"
|
|
3051
|
-
}
|
|
3052
|
-
interface Conditions {
|
|
3053
|
-
/** List of conditions. */
|
|
3054
|
-
conditions?: Condition[];
|
|
3055
|
-
}
|
|
3056
|
-
interface Condition {
|
|
3057
|
-
/** Condition type. */
|
|
3058
|
-
conditionType?: ConditionAttributeType;
|
|
3059
|
-
/** Condition ID. */
|
|
3060
|
-
_id?: string;
|
|
3061
|
-
/** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
|
|
3062
|
-
value?: string | null;
|
|
3063
|
-
}
|
|
3064
|
-
declare enum ConditionAttributeType {
|
|
3065
|
-
UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
|
|
3066
|
-
FOLDER = "FOLDER"
|
|
3067
|
-
}
|
|
3068
|
-
interface SiteRestriction {
|
|
3069
|
-
/** Site ID. */
|
|
3070
|
-
_id?: string;
|
|
3071
|
-
/** Site name. */
|
|
3072
|
-
value?: string | null;
|
|
3073
|
-
}
|
|
3074
|
-
interface CompanionResource {
|
|
3075
|
-
/** Asset ID (referred to here as resource ID). */
|
|
3076
|
-
_id?: string;
|
|
3077
|
-
/** Asset type (referred to here as resource type). as predefined in the authorization system */
|
|
3078
|
-
resourceType?: string;
|
|
3079
|
-
}
|
|
3080
|
-
interface Subject {
|
|
3081
|
-
/** ID of identity assigned to the asset. */
|
|
3082
|
-
_id?: string;
|
|
3083
|
-
/** Type of identity assigned to the asset. Supported subject types include user IDs, account IDs, and app IDs. */
|
|
3084
|
-
subjectType?: SubjectType;
|
|
3085
|
-
/** Context of identity assigned to the asset. For example, a `subjectType` = `USER` will have `context` = `ACCOUNT`. */
|
|
3086
|
-
context?: SubjectContext;
|
|
3087
|
-
}
|
|
3088
|
-
declare enum SubjectType {
|
|
3089
|
-
UNKNOWN = "UNKNOWN",
|
|
3090
|
-
ACCOUNT = "ACCOUNT",
|
|
3091
|
-
USER = "USER",
|
|
3092
|
-
USER_GROUP = "USER_GROUP",
|
|
3093
|
-
MEMBER_GROUP = "MEMBER_GROUP",
|
|
3094
|
-
VISITOR_GROUP = "VISITOR_GROUP",
|
|
3095
|
-
EXTERNAL_APP = "EXTERNAL_APP",
|
|
3096
|
-
ACCOUNT_GROUP = "ACCOUNT_GROUP",
|
|
3097
|
-
WIX_APP = "WIX_APP"
|
|
3098
|
-
}
|
|
3099
|
-
interface SubjectContext {
|
|
3100
|
-
_id?: string;
|
|
3101
|
-
contextType?: SubjectContextType;
|
|
3102
|
-
}
|
|
3103
|
-
declare enum SubjectContextType {
|
|
3104
|
-
UNKNOWN_CTX = "UNKNOWN_CTX",
|
|
3105
|
-
ORG_CTX = "ORG_CTX",
|
|
3106
|
-
ACCOUNT_CTX = "ACCOUNT_CTX"
|
|
3107
|
-
}
|
|
3108
|
-
interface GetAppContributorsRequest {
|
|
3109
|
-
appId?: string;
|
|
3110
|
-
/** The locale of the request. Defaults to en-us. */
|
|
3111
|
-
locale?: string | null;
|
|
3112
|
-
}
|
|
3113
|
-
interface GetAppContributorsResponse {
|
|
3114
|
-
contributors?: Contributor[];
|
|
3115
|
-
invites?: AppInvite[];
|
|
3116
|
-
}
|
|
3117
|
-
interface AppInvite {
|
|
3118
|
-
/** @readonly */
|
|
3119
|
-
_id?: string;
|
|
3120
|
-
/** TODO: amitis - remove this comment after the next merge */
|
|
3121
|
-
destEmail?: string;
|
|
3122
|
-
/** @readonly */
|
|
3123
|
-
status?: string;
|
|
3124
|
-
/** @readonly */
|
|
3125
|
-
acceptLink?: string;
|
|
3126
|
-
invitePurpose?: string | null;
|
|
3127
|
-
policies?: AssignedPolicy[];
|
|
3128
|
-
/** @readonly */
|
|
3129
|
-
expirationDate?: Date | null;
|
|
3130
|
-
/** @readonly */
|
|
3131
|
-
dateCreated?: Date | null;
|
|
3132
|
-
/** @readonly */
|
|
3133
|
-
dateUpdated?: Date | null;
|
|
3134
|
-
}
|
|
3135
|
-
interface GetSiteContributorsRequest {
|
|
3136
|
-
/** The locale of the request. Defaults to en-us */
|
|
3137
|
-
locale?: string | null;
|
|
3138
|
-
}
|
|
3139
|
-
interface GetSiteContributorsResponse {
|
|
3140
|
-
users?: User[];
|
|
3141
|
-
teams?: Team[];
|
|
3142
|
-
invites?: SiteInvite[];
|
|
3143
|
-
policies?: Policy[];
|
|
3144
|
-
permissions?: string[];
|
|
3145
|
-
userId?: string;
|
|
3146
|
-
loggedInAccountId?: string;
|
|
3147
|
-
pendingOwner?: PendingOwner;
|
|
3148
|
-
contributorLimit?: ContributorLimit;
|
|
3149
|
-
predefinedRoles?: PredefinedRoles;
|
|
3150
|
-
}
|
|
3151
|
-
interface User {
|
|
3152
|
-
/** User ID. */
|
|
3153
|
-
_id?: string;
|
|
3154
|
-
/**
|
|
3155
|
-
* Deprecated.
|
|
3156
|
-
* @deprecated
|
|
3157
|
-
*/
|
|
3158
|
-
roles?: string[];
|
|
3159
|
-
/** User's email address. */
|
|
3160
|
-
email?: string;
|
|
3161
|
-
/** User's name. */
|
|
3162
|
-
name?: Name;
|
|
3163
|
-
/** URL to user's profile image, when provided. */
|
|
3164
|
-
profileImage?: string | null;
|
|
3165
|
-
/** Date the user joined the team. */
|
|
3166
|
-
joinedTeamAt?: Date | null;
|
|
3167
|
-
/**
|
|
3168
|
-
* Deprecated.
|
|
3169
|
-
* @deprecated
|
|
3170
|
-
*/
|
|
3171
|
-
policyIds?: string[];
|
|
3172
|
-
/** Resources the user can access. */
|
|
3173
|
-
assignments?: Assignment[];
|
|
3174
|
-
}
|
|
3175
|
-
interface Name {
|
|
3176
|
-
/** User's first name. */
|
|
3177
|
-
firstName?: string;
|
|
3178
|
-
/** User's last name. */
|
|
3179
|
-
lastName?: string;
|
|
3180
|
-
}
|
|
3181
|
-
interface Team {
|
|
3182
|
-
accountId?: string;
|
|
3183
|
-
accountInfo?: AccountInfo;
|
|
3184
|
-
policyIds?: string[];
|
|
3185
|
-
joinedAt?: Date | null;
|
|
3186
|
-
}
|
|
3187
|
-
interface AccountInfo {
|
|
3188
|
-
accountName?: string;
|
|
3189
|
-
accountImage?: string;
|
|
3190
|
-
isTeam?: boolean;
|
|
3191
|
-
}
|
|
3192
|
-
interface SiteInvite {
|
|
3193
|
-
/**
|
|
3194
|
-
* Invite ID.
|
|
3195
|
-
* @readonly
|
|
3196
|
-
*/
|
|
3197
|
-
_id?: string;
|
|
3198
|
-
/**
|
|
3199
|
-
* Site ID the user is invited to as a collaborator.
|
|
3200
|
-
* @readonly
|
|
3201
|
-
*/
|
|
3202
|
-
siteId?: string;
|
|
3203
|
-
/** Email address where the invite was sent. */
|
|
3204
|
-
email?: string;
|
|
3205
|
-
/** Role IDs included in the invite. */
|
|
3206
|
-
policyIds?: string[];
|
|
3207
|
-
/**
|
|
3208
|
-
* Deprecated. Use `inviterAccountId`.
|
|
3209
|
-
* @readonly
|
|
3210
|
-
* @deprecated
|
|
3211
|
-
*/
|
|
3212
|
-
inviterId?: string;
|
|
3213
|
-
/**
|
|
3214
|
-
* Invite Status.
|
|
3215
|
-
*
|
|
3216
|
-
* Supported values:
|
|
3217
|
-
* - **Pending:** The invite has been sent and is valid, waiting for the user's response.
|
|
3218
|
-
* - **Used:** The invite has been accepted.
|
|
3219
|
-
* - **Deleted:** The invite has been deleted or revoked.
|
|
3220
|
-
* - **Declined:** The user declined the invite.
|
|
3221
|
-
* - **Expired:** The invite has expired without being accepted.
|
|
3222
|
-
*/
|
|
3223
|
-
status?: InviteStatus;
|
|
3224
|
-
/** Link to accept the invite. */
|
|
3225
|
-
acceptLink?: string;
|
|
3226
|
-
/**
|
|
3227
|
-
* Inviting account ID.
|
|
3228
|
-
* @readonly
|
|
3229
|
-
*/
|
|
3230
|
-
inviterAccountId?: string;
|
|
3231
|
-
/**
|
|
3232
|
-
* Account ID that accepted the invite. Populated only once the invite is accepted.
|
|
3233
|
-
* @readonly
|
|
3234
|
-
*/
|
|
3235
|
-
acceptedByAccountId?: string | null;
|
|
3236
|
-
/** Date the invite was created. */
|
|
3237
|
-
dateCreated?: Date | null;
|
|
3238
|
-
/** User's Wix Bookings staff ID, if relevant. */
|
|
3239
|
-
staffId?: string | null;
|
|
3240
|
-
/** Invite expiration date */
|
|
3241
|
-
expirationDate?: Date | null;
|
|
3242
|
-
}
|
|
3243
|
-
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
3244
|
-
declare enum InviteStatus {
|
|
3245
|
-
Pending = "Pending",
|
|
3246
|
-
Used = "Used",
|
|
3247
|
-
Deleted = "Deleted",
|
|
3248
|
-
Declined = "Declined",
|
|
3249
|
-
Expired = "Expired"
|
|
3250
|
-
}
|
|
3251
|
-
interface Policy {
|
|
3252
|
-
_id?: string;
|
|
3253
|
-
description?: string | null;
|
|
3254
|
-
name?: string | null;
|
|
3255
|
-
isCustom?: boolean;
|
|
3256
|
-
scopes?: string[];
|
|
3257
|
-
}
|
|
3258
|
-
interface PendingOwner {
|
|
3259
|
-
email?: string;
|
|
3260
|
-
expirationDate?: Date | null;
|
|
3261
|
-
acceptLink?: string;
|
|
3262
|
-
}
|
|
3263
|
-
interface ContributorLimit {
|
|
3264
|
-
contributorLimit?: number;
|
|
3265
|
-
}
|
|
3266
|
-
interface PredefinedRoles {
|
|
3267
|
-
roles?: PredefinedRole[];
|
|
3268
|
-
}
|
|
3269
|
-
interface PredefinedRole {
|
|
3270
|
-
titleKey?: string;
|
|
3271
|
-
roles?: Role[];
|
|
3272
|
-
title?: string | null;
|
|
3273
|
-
areaId?: string;
|
|
3274
|
-
}
|
|
3275
|
-
interface Role {
|
|
3276
|
-
_id?: string;
|
|
3277
|
-
deprecatedKey?: string;
|
|
3278
|
-
/** @deprecated */
|
|
3279
|
-
titleKey?: string;
|
|
3280
|
-
/** @deprecated */
|
|
3281
|
-
descriptionKey?: string;
|
|
3282
|
-
deprecated?: boolean;
|
|
3283
|
-
restrictFromLevel?: string;
|
|
3284
|
-
experiments?: string[];
|
|
3285
|
-
appDefIds?: string[];
|
|
3286
|
-
title?: string | null;
|
|
3287
|
-
description?: string | null;
|
|
3288
|
-
isCustom?: boolean;
|
|
3289
|
-
scopes?: string[];
|
|
3290
|
-
availableResourceTypes?: ResourceType[];
|
|
3291
|
-
availableConditions?: ConditionAttributeType[];
|
|
3292
|
-
limitToEditorTypes?: string[];
|
|
3293
|
-
}
|
|
3294
|
-
interface GetSiteContributorsV2Request {
|
|
3295
|
-
/** The locale of the request. Defaults to en-us. */
|
|
3296
|
-
locale?: string | null;
|
|
3297
|
-
}
|
|
3298
|
-
interface GetSiteContributorsV2Response {
|
|
3299
|
-
/** List of contributors of the given site. */
|
|
3300
|
-
contributors?: Contributor[];
|
|
3301
|
-
/** List of invites to contribute to the given site. */
|
|
3302
|
-
invites?: SiteInvite[];
|
|
3303
|
-
/** Quota information for contributors on the given site. */
|
|
3304
|
-
contributorsQuota?: ContributorsQuota;
|
|
3305
|
-
}
|
|
3306
|
-
interface ContributorsQuota extends ContributorsQuotaOptionsOneOf {
|
|
3307
|
-
/** Limited contributors quota details. */
|
|
3308
|
-
limitedOptions?: LimitedOptions;
|
|
3309
|
-
/** Type of contributors quota */
|
|
3310
|
-
type?: Type;
|
|
3311
|
-
}
|
|
3312
|
-
/** @oneof */
|
|
3313
|
-
interface ContributorsQuotaOptionsOneOf {
|
|
3314
|
-
/** Limited contributors quota details. */
|
|
3315
|
-
limitedOptions?: LimitedOptions;
|
|
3316
|
-
}
|
|
3317
|
-
/** Enum to represent different types of contributors quota. */
|
|
3318
|
-
declare enum Type {
|
|
3319
|
-
UNKNOWN = "UNKNOWN",
|
|
3320
|
-
LIMITED = "LIMITED",
|
|
3321
|
-
UNLIMITED = "UNLIMITED"
|
|
3322
|
-
}
|
|
3323
|
-
/** Details for a limited contributors quota. */
|
|
3324
|
-
interface LimitedOptions {
|
|
3325
|
-
/** Maximum number of contributors allowed. */
|
|
3326
|
-
limit?: number;
|
|
3327
|
-
/** Number of accepted or pending invitations. */
|
|
3328
|
-
used?: number;
|
|
3329
|
-
}
|
|
3330
|
-
interface HandleSiteTransferRequest {
|
|
3331
|
-
originalOwnerAccountId?: string;
|
|
3332
|
-
newOwnerAccountId?: string;
|
|
3333
|
-
metaSiteId?: string;
|
|
3334
|
-
keepOriginalOwnerAsContributor?: boolean;
|
|
3335
|
-
}
|
|
3336
|
-
interface HandleSiteTransferResponse {
|
|
3337
|
-
}
|
|
3338
|
-
interface GetCurrentUserRolesRequest {
|
|
3339
|
-
/** The locale of the request. Defaults to en-us */
|
|
3340
|
-
locale?: string | null;
|
|
3341
|
-
}
|
|
3342
|
-
interface GetCurrentUserRolesResponse {
|
|
3343
|
-
roles?: LocalizedRole[];
|
|
3344
|
-
}
|
|
3345
|
-
interface LocalizedRole {
|
|
3346
|
-
name?: string;
|
|
3347
|
-
description?: string | null;
|
|
3348
|
-
}
|
|
3349
|
-
interface BulkGetUserRolesOnSiteRequest {
|
|
3350
|
-
users?: UserSubject[];
|
|
3351
|
-
/** The locale of the request. Defaults to en-us */
|
|
3352
|
-
locale?: string | null;
|
|
3353
|
-
}
|
|
3354
|
-
interface UserSubject {
|
|
3355
|
-
userId?: string;
|
|
3356
|
-
accountId?: string;
|
|
3357
|
-
}
|
|
3358
|
-
interface BulkGetUserRolesOnSiteResponse {
|
|
3359
|
-
userRoles?: UserLocalizedRoles[];
|
|
3360
|
-
}
|
|
3361
|
-
interface UserLocalizedRoles {
|
|
3362
|
-
user?: UserSubject;
|
|
3363
|
-
roles?: LocalizedRole[];
|
|
3364
|
-
}
|
|
3365
|
-
interface ChangeContributorRoleRequest {
|
|
3366
|
-
/** Contributor's account ID. */
|
|
3367
|
-
accountId: string;
|
|
3368
|
-
/** New roles to assign to the contributor on the site. */
|
|
3369
|
-
newRoles: SiteRoleAssignment[];
|
|
3370
|
-
}
|
|
3371
|
-
interface SiteRoleAssignment {
|
|
3372
|
-
/** Role ID. Sometimes referred to as policy ID. See [Roles and Permissions](https://support.wix.com/en/article/roles-permissions-overview) for a list of available roles. */
|
|
3373
|
-
roleId?: string;
|
|
3374
|
-
/**
|
|
3375
|
-
* Assignment ID mapping the role to the contributor on the site.
|
|
3376
|
-
* @readonly
|
|
3377
|
-
*/
|
|
3378
|
-
assignmentId?: string;
|
|
3379
|
-
}
|
|
3380
|
-
interface ChangeContributorRoleResponse {
|
|
3381
|
-
/** New roles assigned to the contributor on the site. */
|
|
3382
|
-
newAssignedRoles?: SiteRoleAssignment[];
|
|
3383
|
-
}
|
|
3384
|
-
interface QuerySiteContributorsRequest {
|
|
3385
|
-
filter?: QuerySiteContributorsFilter;
|
|
3386
|
-
}
|
|
3387
|
-
interface QuerySiteContributorsFilter {
|
|
3388
|
-
/** Role IDs (referred to here as policy IDs) to return. See [Roles and Permissions](https://support.wix.com/en/article/roles-permissions-overview) for available roles. */
|
|
3389
|
-
policyIds?: string[];
|
|
3390
|
-
}
|
|
3391
|
-
declare enum FieldSet {
|
|
3392
|
-
UNKNOWN = "UNKNOWN",
|
|
3393
|
-
/** Include only `account_id` and `account_owner_id` fields. */
|
|
3394
|
-
META_DATA = "META_DATA"
|
|
3395
|
-
}
|
|
3396
|
-
interface QuerySiteContributorsResponse {
|
|
3397
|
-
/** List of site contributors. */
|
|
3398
|
-
contributors?: ContributorV2[];
|
|
3399
|
-
}
|
|
3400
|
-
interface ContributorV2 {
|
|
3401
|
-
/** Contributor's account ID. */
|
|
3402
|
-
accountId?: string | null;
|
|
3403
|
-
/** User ID of the owner of the account that the contributor has joined. */
|
|
3404
|
-
accountOwnerId?: string | null;
|
|
3405
|
-
}
|
|
3406
|
-
interface GetContributorsQuotaRequest {
|
|
3407
|
-
}
|
|
3408
|
-
interface GetContributorsQuotaResponse {
|
|
3409
|
-
/** Quota information for contributors on the given site. */
|
|
3410
|
-
contributorsQuota?: ContributorsQuota;
|
|
3411
|
-
}
|
|
3412
|
-
interface SiteRoleAssignmentNonNullableFields {
|
|
3413
|
-
roleId: string;
|
|
3414
|
-
assignmentId: string;
|
|
3415
|
-
}
|
|
3416
|
-
interface ChangeContributorRoleResponseNonNullableFields {
|
|
3417
|
-
newAssignedRoles: SiteRoleAssignmentNonNullableFields[];
|
|
3418
|
-
}
|
|
3419
|
-
interface ChangeRoleOptions {
|
|
3420
|
-
/** New roles to assign to the contributor on the site. */
|
|
3421
|
-
newRoles: SiteRoleAssignment[];
|
|
3422
|
-
}
|
|
3423
|
-
interface QuerySiteContributorsOptions {
|
|
3424
|
-
filter?: QuerySiteContributorsFilter;
|
|
3425
|
-
}
|
|
3426
|
-
|
|
3427
|
-
declare function changeRole$1(httpClient: HttpClient): ChangeRoleSignature;
|
|
3428
|
-
interface ChangeRoleSignature {
|
|
3429
|
-
/**
|
|
3430
|
-
* Overrides all the roles of a contributor for the specified site.
|
|
3431
|
-
* @param - Contributor's account ID.
|
|
3432
|
-
* @param - Filter options. The `newRoles` field **must** be passed.
|
|
3433
|
-
*/
|
|
3434
|
-
(accountId: string, options: ChangeRoleOptions): Promise<ChangeContributorRoleResponse & ChangeContributorRoleResponseNonNullableFields>;
|
|
3435
|
-
}
|
|
3436
|
-
declare function querySiteContributors$1(httpClient: HttpClient): QuerySiteContributorsSignature;
|
|
3437
|
-
interface QuerySiteContributorsSignature {
|
|
3438
|
-
/**
|
|
3439
|
-
* Retrieves a list of contributors for the specified site, given the provided filters.
|
|
3440
|
-
* @param - Filter options.
|
|
3441
|
-
*/
|
|
3442
|
-
(options?: QuerySiteContributorsOptions | undefined): Promise<QuerySiteContributorsResponse>;
|
|
3443
|
-
}
|
|
3444
|
-
|
|
3445
|
-
declare const changeRole: MaybeContext<BuildRESTFunction<typeof changeRole$1> & typeof changeRole$1>;
|
|
3446
|
-
declare const querySiteContributors: MaybeContext<BuildRESTFunction<typeof querySiteContributors$1> & typeof querySiteContributors$1>;
|
|
3447
|
-
|
|
3448
|
-
type context_AccountInfo = AccountInfo;
|
|
3449
|
-
type context_AppInvite = AppInvite;
|
|
3450
|
-
type context_AssignedPolicy = AssignedPolicy;
|
|
3451
|
-
type context_Assignment = Assignment;
|
|
3452
|
-
type context_BulkGetUserRolesOnSiteRequest = BulkGetUserRolesOnSiteRequest;
|
|
3453
|
-
type context_BulkGetUserRolesOnSiteResponse = BulkGetUserRolesOnSiteResponse;
|
|
3454
|
-
type context_ChangeContributorRoleRequest = ChangeContributorRoleRequest;
|
|
3455
|
-
type context_ChangeContributorRoleResponse = ChangeContributorRoleResponse;
|
|
3456
|
-
type context_ChangeContributorRoleResponseNonNullableFields = ChangeContributorRoleResponseNonNullableFields;
|
|
3457
|
-
type context_ChangeRoleOptions = ChangeRoleOptions;
|
|
3458
|
-
type context_CompanionResource = CompanionResource;
|
|
3459
|
-
type context_Condition = Condition;
|
|
3460
|
-
type context_ConditionAttributeType = ConditionAttributeType;
|
|
3461
|
-
declare const context_ConditionAttributeType: typeof ConditionAttributeType;
|
|
3462
|
-
type context_Conditions = Conditions;
|
|
3463
|
-
type context_Contributor = Contributor;
|
|
3464
|
-
type context_ContributorLimit = ContributorLimit;
|
|
3465
|
-
type context_ContributorV2 = ContributorV2;
|
|
3466
|
-
type context_ContributorsQuota = ContributorsQuota;
|
|
3467
|
-
type context_ContributorsQuotaOptionsOneOf = ContributorsQuotaOptionsOneOf;
|
|
3468
|
-
type context_FieldSet = FieldSet;
|
|
3469
|
-
declare const context_FieldSet: typeof FieldSet;
|
|
3470
|
-
type context_GetAppContributorsRequest = GetAppContributorsRequest;
|
|
3471
|
-
type context_GetAppContributorsResponse = GetAppContributorsResponse;
|
|
3472
|
-
type context_GetContributorsQuotaRequest = GetContributorsQuotaRequest;
|
|
3473
|
-
type context_GetContributorsQuotaResponse = GetContributorsQuotaResponse;
|
|
3474
|
-
type context_GetCurrentUserRolesRequest = GetCurrentUserRolesRequest;
|
|
3475
|
-
type context_GetCurrentUserRolesResponse = GetCurrentUserRolesResponse;
|
|
3476
|
-
type context_GetSiteContributorsRequest = GetSiteContributorsRequest;
|
|
3477
|
-
type context_GetSiteContributorsResponse = GetSiteContributorsResponse;
|
|
3478
|
-
type context_GetSiteContributorsV2Request = GetSiteContributorsV2Request;
|
|
3479
|
-
type context_GetSiteContributorsV2Response = GetSiteContributorsV2Response;
|
|
3480
|
-
type context_HandleSiteTransferRequest = HandleSiteTransferRequest;
|
|
3481
|
-
type context_HandleSiteTransferResponse = HandleSiteTransferResponse;
|
|
3482
|
-
type context_InviteStatus = InviteStatus;
|
|
3483
|
-
declare const context_InviteStatus: typeof InviteStatus;
|
|
3484
|
-
type context_LimitedOptions = LimitedOptions;
|
|
3485
|
-
type context_LocalizedRole = LocalizedRole;
|
|
3486
|
-
type context_Name = Name;
|
|
3487
|
-
type context_PendingOwner = PendingOwner;
|
|
3488
|
-
type context_PersonMetaData = PersonMetaData;
|
|
3489
|
-
type context_Policy = Policy;
|
|
3490
|
-
type context_PredefinedRole = PredefinedRole;
|
|
3491
|
-
type context_PredefinedRoles = PredefinedRoles;
|
|
3492
|
-
type context_QuerySiteContributorsFilter = QuerySiteContributorsFilter;
|
|
3493
|
-
type context_QuerySiteContributorsOptions = QuerySiteContributorsOptions;
|
|
3494
|
-
type context_QuerySiteContributorsRequest = QuerySiteContributorsRequest;
|
|
3495
|
-
type context_QuerySiteContributorsResponse = QuerySiteContributorsResponse;
|
|
3496
|
-
type context_Resource = Resource;
|
|
3497
|
-
type context_ResourceType = ResourceType;
|
|
3498
|
-
declare const context_ResourceType: typeof ResourceType;
|
|
3499
|
-
type context_Restriction = Restriction;
|
|
3500
|
-
type context_RestrictionRestrictionsOneOf = RestrictionRestrictionsOneOf;
|
|
3501
|
-
type context_Role = Role;
|
|
3502
|
-
type context_SiteInvite = SiteInvite;
|
|
3503
|
-
type context_SiteRestriction = SiteRestriction;
|
|
3504
|
-
type context_SiteRoleAssignment = SiteRoleAssignment;
|
|
3505
|
-
type context_Subject = Subject;
|
|
3506
|
-
type context_SubjectContext = SubjectContext;
|
|
3507
|
-
type context_SubjectContextType = SubjectContextType;
|
|
3508
|
-
declare const context_SubjectContextType: typeof SubjectContextType;
|
|
3509
|
-
type context_SubjectType = SubjectType;
|
|
3510
|
-
declare const context_SubjectType: typeof SubjectType;
|
|
3511
|
-
type context_Team = Team;
|
|
3512
|
-
type context_Type = Type;
|
|
3513
|
-
declare const context_Type: typeof Type;
|
|
3514
|
-
type context_User = User;
|
|
3515
|
-
type context_UserLocalizedRoles = UserLocalizedRoles;
|
|
3516
|
-
type context_UserSubject = UserSubject;
|
|
3517
|
-
declare const context_changeRole: typeof changeRole;
|
|
3518
|
-
declare const context_querySiteContributors: typeof querySiteContributors;
|
|
3519
|
-
declare namespace context {
|
|
3520
|
-
export { type context_AccountInfo as AccountInfo, type context_AppInvite as AppInvite, type context_AssignedPolicy as AssignedPolicy, type context_Assignment as Assignment, type context_BulkGetUserRolesOnSiteRequest as BulkGetUserRolesOnSiteRequest, type context_BulkGetUserRolesOnSiteResponse as BulkGetUserRolesOnSiteResponse, type context_ChangeContributorRoleRequest as ChangeContributorRoleRequest, type context_ChangeContributorRoleResponse as ChangeContributorRoleResponse, type context_ChangeContributorRoleResponseNonNullableFields as ChangeContributorRoleResponseNonNullableFields, type context_ChangeRoleOptions as ChangeRoleOptions, type context_CompanionResource as CompanionResource, type context_Condition as Condition, context_ConditionAttributeType as ConditionAttributeType, type context_Conditions as Conditions, type context_Contributor as Contributor, type context_ContributorLimit as ContributorLimit, type context_ContributorV2 as ContributorV2, type context_ContributorsQuota as ContributorsQuota, type context_ContributorsQuotaOptionsOneOf as ContributorsQuotaOptionsOneOf, context_FieldSet as FieldSet, type context_GetAppContributorsRequest as GetAppContributorsRequest, type context_GetAppContributorsResponse as GetAppContributorsResponse, type context_GetContributorsQuotaRequest as GetContributorsQuotaRequest, type context_GetContributorsQuotaResponse as GetContributorsQuotaResponse, type context_GetCurrentUserRolesRequest as GetCurrentUserRolesRequest, type context_GetCurrentUserRolesResponse as GetCurrentUserRolesResponse, type context_GetSiteContributorsRequest as GetSiteContributorsRequest, type context_GetSiteContributorsResponse as GetSiteContributorsResponse, type context_GetSiteContributorsV2Request as GetSiteContributorsV2Request, type context_GetSiteContributorsV2Response as GetSiteContributorsV2Response, type context_HandleSiteTransferRequest as HandleSiteTransferRequest, type context_HandleSiteTransferResponse as HandleSiteTransferResponse, context_InviteStatus as InviteStatus, type context_LimitedOptions as LimitedOptions, type context_LocalizedRole as LocalizedRole, type context_Name as Name, type context_PendingOwner as PendingOwner, type context_PersonMetaData as PersonMetaData, type context_Policy as Policy, type context_PredefinedRole as PredefinedRole, type context_PredefinedRoles as PredefinedRoles, type context_QuerySiteContributorsFilter as QuerySiteContributorsFilter, type context_QuerySiteContributorsOptions as QuerySiteContributorsOptions, type context_QuerySiteContributorsRequest as QuerySiteContributorsRequest, type context_QuerySiteContributorsResponse as QuerySiteContributorsResponse, type context_Resource as Resource, context_ResourceType as ResourceType, type context_Restriction as Restriction, type context_RestrictionRestrictionsOneOf as RestrictionRestrictionsOneOf, type context_Role as Role, type context_SiteInvite as SiteInvite, type context_SiteRestriction as SiteRestriction, type context_SiteRoleAssignment as SiteRoleAssignment, type context_Subject as Subject, type context_SubjectContext as SubjectContext, context_SubjectContextType as SubjectContextType, context_SubjectType as SubjectType, type context_Team as Team, context_Type as Type, type context_User as User, type context_UserLocalizedRoles as UserLocalizedRoles, type context_UserSubject as UserSubject, context_changeRole as changeRole, context_querySiteContributors as querySiteContributors };
|
|
3521
|
-
}
|
|
3522
|
-
|
|
3523
|
-
export { context$3 as accountInvites, context$4 as accounts, context as contributors, context$2 as siteInvites, context$1 as users };
|