@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.
@@ -1,1869 +0,0 @@
1
- interface AccountV2$1 {
2
- /** Account ID. */
3
- accountId?: string;
4
- }
5
- interface Paging$3 {
6
- /** Number of items to load. */
7
- limit?: number | null;
8
- /** Number of items to skip in the current sort order. */
9
- offset?: number | null;
10
- }
11
- interface CreateAccountRequest$1 {
12
- /** The user to create under the new account, with the roles defined in `roles`. */
13
- user: User$1;
14
- /**
15
- * Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
16
- * Default: OWNER.
17
- */
18
- roles?: string[] | null;
19
- }
20
- /** A User to be created under an implicitly provided accountId: must have a unique email. */
21
- interface User$1 {
22
- /** User's unique email address details. Required. */
23
- email?: Email$1;
24
- /** 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. */
25
- ssoIdentities?: SsoIdentity$1[];
26
- /** Additional user details. */
27
- userDetails?: UserDetails$1;
28
- }
29
- /** User's email address. */
30
- interface Email$1 {
31
- /** User's email address. */
32
- emailAddress?: string;
33
- /** Whether the caller has verified the user's email address. */
34
- isVerified?: boolean;
35
- }
36
- /** Single Sign On (aka. SSO) identity; user is identified via SSO authentication response token params, as specified by OpenID Connect (aka. OIDC) protocol */
37
- interface SsoIdentity$1 {
38
- /** An SSO setting (URLs, clientId, secret, etc. as required by OIDC protocol) for a specific Identity-Provider (aka. IdP) for a specific Wix account. */
39
- ssoId?: string;
40
- /**
41
- * User ID as stored in IdP. For example a "sub" claim of OIDC protocol,
42
- * or any other alternative, specified by IdP (Identity Provider).
43
- */
44
- userId?: string;
45
- }
46
- /** additional user details */
47
- interface UserDetails$1 {
48
- /** User's first name. */
49
- firstName?: string | null;
50
- /** User's last name. */
51
- lastName?: string | null;
52
- /** URL to location of user's profile picture. */
53
- profilePictureUrl?: string | null;
54
- /** User's preferred language in [ISO 639-1:2002](https://en.wikipedia.org/wiki/ISO_639-1) format. For example, "en", "es". */
55
- language?: string | null;
56
- /**
57
- * Original Client IP from which a request was made.
58
- * 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.
59
- * Wix checks this IP against the [OFAC sanctioned countries](https://ofac.treasury.gov/sanctions-programs-and-country-information).
60
- */
61
- clientIp?: string | null;
62
- }
63
- interface CreateAccountResponse$1 {
64
- /** The created account. */
65
- account?: AccountV2$1;
66
- }
67
- interface PagingMetadata$1 {
68
- /** Number of items returned in the response. */
69
- count?: number | null;
70
- /** Offset that was requested. */
71
- offset?: number | null;
72
- /** Total number of items that match the query. */
73
- total?: number | null;
74
- /** Flag that indicates the server failed to calculate the `total` field. */
75
- tooManyToCount?: boolean | null;
76
- }
77
- interface ListChildAccountsRequest$1 {
78
- /**
79
- * Paging options to limit and offset the number of items.
80
- * Default: 20. Max: 50.
81
- */
82
- paging?: Paging$3;
83
- }
84
- interface ListChildAccountsResponse$1 {
85
- /** The requested child accounts. */
86
- childAccounts?: AccountV2$1[];
87
- /** Metadata of the response pagination. */
88
- pagingMetadata?: PagingMetadata$1;
89
- }
90
- interface AccountV2NonNullableFields$1 {
91
- accountId: string;
92
- }
93
- interface CreateAccountResponseNonNullableFields$1 {
94
- account?: AccountV2NonNullableFields$1;
95
- }
96
- interface ListChildAccountsResponseNonNullableFields$1 {
97
- childAccounts: AccountV2NonNullableFields$1[];
98
- }
99
-
100
- interface AccountV2 {
101
- /** Account ID. */
102
- accountId?: string;
103
- }
104
- interface Paging$2 {
105
- /** Number of items to load. */
106
- limit?: number | null;
107
- /** Number of items to skip in the current sort order. */
108
- offset?: number | null;
109
- }
110
- interface CreateAccountRequest {
111
- /** The user to create under the new account, with the roles defined in `roles`. */
112
- user: User;
113
- /**
114
- * Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
115
- * Default: OWNER.
116
- */
117
- roles?: string[] | null;
118
- }
119
- /** A User to be created under an implicitly provided accountId: must have a unique email. */
120
- interface User {
121
- /** User's unique email address details. Required. */
122
- email?: Email;
123
- /** 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. */
124
- ssoIdentities?: SsoIdentity[];
125
- /** Additional user details. */
126
- userDetails?: UserDetails;
127
- }
128
- /** User's email address. */
129
- interface Email {
130
- /** User's email address. */
131
- emailAddress?: string;
132
- /** Whether the caller has verified the user's email address. */
133
- isVerified?: boolean;
134
- }
135
- /** Single Sign On (aka. SSO) identity; user is identified via SSO authentication response token params, as specified by OpenID Connect (aka. OIDC) protocol */
136
- interface SsoIdentity {
137
- /** An SSO setting (URLs, clientId, secret, etc. as required by OIDC protocol) for a specific Identity-Provider (aka. IdP) for a specific Wix account. */
138
- ssoId?: string;
139
- /**
140
- * User ID as stored in IdP. For example a "sub" claim of OIDC protocol,
141
- * or any other alternative, specified by IdP (Identity Provider).
142
- */
143
- userId?: string;
144
- }
145
- /** additional user details */
146
- interface UserDetails {
147
- /** User's first name. */
148
- firstName?: string | null;
149
- /** User's last name. */
150
- lastName?: string | null;
151
- /** URL to location of user's profile picture. */
152
- profilePictureUrl?: string | null;
153
- /** User's preferred language in [ISO 639-1:2002](https://en.wikipedia.org/wiki/ISO_639-1) format. For example, "en", "es". */
154
- language?: string | null;
155
- /**
156
- * Original Client IP from which a request was made.
157
- * 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.
158
- * Wix checks this IP against the [OFAC sanctioned countries](https://ofac.treasury.gov/sanctions-programs-and-country-information).
159
- */
160
- clientIp?: string | null;
161
- }
162
- interface CreateAccountResponse {
163
- /** The created account. */
164
- account?: AccountV2;
165
- }
166
- interface PagingMetadata {
167
- /** Number of items returned in the response. */
168
- count?: number | null;
169
- /** Offset that was requested. */
170
- offset?: number | null;
171
- /** Total number of items that match the query. */
172
- total?: number | null;
173
- /** Flag that indicates the server failed to calculate the `total` field. */
174
- tooManyToCount?: boolean | null;
175
- }
176
- interface ListChildAccountsRequest {
177
- /**
178
- * Paging options to limit and offset the number of items.
179
- * Default: 20. Max: 50.
180
- */
181
- paging?: Paging$2;
182
- }
183
- interface ListChildAccountsResponse {
184
- /** The requested child accounts. */
185
- childAccounts?: AccountV2[];
186
- /** Metadata of the response pagination. */
187
- pagingMetadata?: PagingMetadata;
188
- }
189
- interface AccountV2NonNullableFields {
190
- accountId: string;
191
- }
192
- interface CreateAccountResponseNonNullableFields {
193
- account?: AccountV2NonNullableFields;
194
- }
195
- interface ListChildAccountsResponseNonNullableFields {
196
- childAccounts: AccountV2NonNullableFields[];
197
- }
198
-
199
- type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
200
- getUrl: (context: any) => string;
201
- httpMethod: K;
202
- path: string;
203
- pathParams: M;
204
- __requestType: T;
205
- __originalRequestType: S;
206
- __responseType: Q;
207
- __originalResponseType: R;
208
- };
209
- declare function createAccount(): __PublicMethodMetaInfo$4<'POST', {}, CreateAccountRequest, CreateAccountRequest$1, CreateAccountResponse & CreateAccountResponseNonNullableFields, CreateAccountResponse$1 & CreateAccountResponseNonNullableFields$1>;
210
- declare function listChildAccounts(): __PublicMethodMetaInfo$4<'GET', {}, ListChildAccountsRequest, ListChildAccountsRequest$1, ListChildAccountsResponse & ListChildAccountsResponseNonNullableFields, ListChildAccountsResponse$1 & ListChildAccountsResponseNonNullableFields$1>;
211
-
212
- declare const meta$4_createAccount: typeof createAccount;
213
- declare const meta$4_listChildAccounts: typeof listChildAccounts;
214
- declare namespace meta$4 {
215
- export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_createAccount as createAccount, meta$4_listChildAccounts as listChildAccounts };
216
- }
217
-
218
- interface AccountInvite$1 {
219
- /**
220
- * Invite ID.
221
- * @readonly
222
- */
223
- id?: string;
224
- /**
225
- * Account ID.
226
- * @readonly
227
- */
228
- accountId?: string;
229
- /** Email address where the invite was sent. */
230
- email?: string;
231
- /**
232
- * Deprecated. Use `policyIds`.
233
- * @deprecated
234
- */
235
- role?: string;
236
- /**
237
- * Deprecated. Use `inviterAccountId`.
238
- * @readonly
239
- * @deprecated
240
- */
241
- inviterId?: string;
242
- /**
243
- * Invite status.
244
- *
245
- * Supported values:
246
- * - **Pending:** The invite has been sent and is valid, waiting for the user's response.
247
- * - **Used:** The invite has been accepted.
248
- * - **Deleted:** The invite has been deleted or revoked.
249
- * - **Declined:** The user has declined the invite.
250
- * - **Expired:** The invite has expired without being accepted.
251
- */
252
- status?: InviteStatus$5;
253
- /** Link to accept the invite. */
254
- acceptLink?: string;
255
- /**
256
- * Inviting account ID.
257
- * @readonly
258
- */
259
- inviterAccountId?: string;
260
- /**
261
- * Account ID that accepted the invite. Populated only once the invite is accepted.
262
- * @readonly
263
- */
264
- acceptedByAccountId?: string | null;
265
- /** Date the invite was created. */
266
- dateCreated?: Date | null;
267
- /** Role IDs included in the invite. */
268
- policyIds?: string[];
269
- /** Date the invite was last updated. */
270
- dateUpdated?: Date | null;
271
- /** Assets the users are invited to join. */
272
- assignments?: InviteResourceAssignment$1[];
273
- /** Invite expiration date. */
274
- expirationDate?: Date | null;
275
- }
276
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
277
- declare enum InviteStatus$5 {
278
- Pending = "Pending",
279
- Used = "Used",
280
- Deleted = "Deleted",
281
- Declined = "Declined",
282
- Expired = "Expired"
283
- }
284
- interface InviteResourceAssignment$1 {
285
- /** Role ID. */
286
- policyId?: string;
287
- /** Resources the user will be able to access. */
288
- assignments?: InviteAssignment$1[];
289
- }
290
- interface InviteAssignment$1 {
291
- /** Full name of resource to be assigned. */
292
- fullNameResource?: FullNameResource$1;
293
- }
294
- interface FullNameResource$1 extends FullNameResourceResourceContextOneOf$1 {
295
- /** Specific site details. */
296
- siteContext?: SiteResourceContext$1;
297
- /** Specific account details. */
298
- accountContext?: AccountResourceContext$1;
299
- }
300
- /** @oneof */
301
- interface FullNameResourceResourceContextOneOf$1 {
302
- /** Specific site details. */
303
- siteContext?: SiteResourceContext$1;
304
- /** Specific account details. */
305
- accountContext?: AccountResourceContext$1;
306
- }
307
- /** 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) */
308
- interface SiteResourceContext$1 {
309
- /** Site ID. */
310
- metasiteId?: string;
311
- }
312
- /** 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) */
313
- interface AccountResourceContext$1 {
314
- /** Account ID. */
315
- accountId?: string;
316
- }
317
- declare enum SimpleConditionOperator$1 {
318
- UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP",
319
- EQUAL = "EQUAL"
320
- }
321
- declare enum JoinedConditionOperator$1 {
322
- UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP",
323
- OR = "OR",
324
- AND = "AND"
325
- }
326
- declare enum SubjectType$3 {
327
- UNKNOWN = "UNKNOWN",
328
- ACCOUNT = "ACCOUNT",
329
- USER = "USER",
330
- USER_GROUP = "USER_GROUP",
331
- MEMBER_GROUP = "MEMBER_GROUP",
332
- VISITOR_GROUP = "VISITOR_GROUP",
333
- EXTERNAL_APP = "EXTERNAL_APP",
334
- ACCOUNT_GROUP = "ACCOUNT_GROUP",
335
- WIX_APP = "WIX_APP"
336
- }
337
- declare enum SubjectContextType$1 {
338
- UNKNOWN_CTX = "UNKNOWN_CTX",
339
- ORG_CTX = "ORG_CTX",
340
- ACCOUNT_CTX = "ACCOUNT_CTX"
341
- }
342
- interface CreateInviteRequest$1 {
343
- /** Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite). */
344
- subjectsAssignments: SubjectInviteAssignments$1[];
345
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
346
- defaultEmailLanguage?: string | null;
347
- }
348
- interface SubjectInviteAssignments$1 {
349
- /** Invitee's email address. */
350
- subjectEmail?: string;
351
- /** 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. */
352
- assignments?: InviteResourceAssignment$1[];
353
- }
354
- interface CreateInviteResponse$1 {
355
- /** Invites that were sent successfully. */
356
- successfulInvites?: AccountInvite$1[];
357
- /** Invites that failed. */
358
- failedInvites?: InviteFailure$1[];
359
- }
360
- interface InviteFailure$1 {
361
- /** Email address of the failed invite. */
362
- subjectEmail?: string;
363
- /** Error description. */
364
- errorMessage?: string;
365
- }
366
- interface SiteResourceContextNonNullableFields$1 {
367
- metasiteId: string;
368
- }
369
- interface AccountResourceContextNonNullableFields$1 {
370
- accountId: string;
371
- }
372
- interface FullNameResourceNonNullableFields$1 {
373
- siteContext?: SiteResourceContextNonNullableFields$1;
374
- accountContext?: AccountResourceContextNonNullableFields$1;
375
- }
376
- interface SimpleConditionValueNonNullableFields$1 {
377
- attrName: string;
378
- stringValue: string;
379
- boolValue: boolean;
380
- }
381
- interface SimpleConditionNonNullableFields$1 {
382
- attrName: string;
383
- value?: SimpleConditionValueNonNullableFields$1;
384
- op: SimpleConditionOperator$1;
385
- conditionModelId: string;
386
- }
387
- interface JoinedConditionNonNullableFields$1 {
388
- op: JoinedConditionOperator$1;
389
- conditions: ConditionTypeNonNullableFields$1[];
390
- }
391
- interface ExperimentConditionNonNullableFields$1 {
392
- spec: string;
393
- fallbackValue: string;
394
- expectedValue: string;
395
- }
396
- interface EnvironmentConditionNonNullableFields$1 {
397
- experimentCondition?: ExperimentConditionNonNullableFields$1;
398
- }
399
- interface ConditionValueNonNullableFields$1 {
400
- attrName: string;
401
- stringValue: string;
402
- boolValue: boolean;
403
- }
404
- interface EqualOperatorNonNullableFields$1 {
405
- attrName: string;
406
- value?: ConditionValueNonNullableFields$1;
407
- }
408
- interface LikeOperatorNonNullableFields$1 {
409
- attrName: string;
410
- values: string[];
411
- }
412
- interface ExperimentOperatorNonNullableFields$1 {
413
- spec: string;
414
- fallbackValue: string;
415
- expectedValue: string;
416
- }
417
- interface SubjectContextNonNullableFields$1 {
418
- id: string;
419
- contextType: SubjectContextType$1;
420
- }
421
- interface SubjectNonNullableFields$1 {
422
- id: string;
423
- subjectType: SubjectType$3;
424
- context?: SubjectContextNonNullableFields$1;
425
- }
426
- interface DependOnOperatorNonNullableFields$1 {
427
- dependOnSubject?: SubjectNonNullableFields$1;
428
- }
429
- interface ConditionOperatorNonNullableFields$1 {
430
- equals?: EqualOperatorNonNullableFields$1;
431
- like?: LikeOperatorNonNullableFields$1;
432
- experiment?: ExperimentOperatorNonNullableFields$1;
433
- dependOn?: DependOnOperatorNonNullableFields$1;
434
- }
435
- interface ConditionNonNullableFields$1 {
436
- conditionModelId: string;
437
- operator?: ConditionOperatorNonNullableFields$1;
438
- }
439
- interface ConditionTypeNonNullableFields$1 {
440
- simpleCondition?: SimpleConditionNonNullableFields$1;
441
- joinedConditions?: JoinedConditionNonNullableFields$1;
442
- environmentCondition?: EnvironmentConditionNonNullableFields$1;
443
- condition?: ConditionNonNullableFields$1;
444
- }
445
- interface PolicyConditionNonNullableFields$1 {
446
- condition?: ConditionTypeNonNullableFields$1;
447
- }
448
- interface InviteAssignmentNonNullableFields$1 {
449
- fullNameResource?: FullNameResourceNonNullableFields$1;
450
- condition?: PolicyConditionNonNullableFields$1;
451
- }
452
- interface InviteResourceAssignmentNonNullableFields$1 {
453
- policyId: string;
454
- assignments: InviteAssignmentNonNullableFields$1[];
455
- }
456
- interface AccountInviteNonNullableFields$1 {
457
- id: string;
458
- accountId: string;
459
- email: string;
460
- role: string;
461
- inviterId: string;
462
- status: InviteStatus$5;
463
- acceptLink: string;
464
- inviterAccountId: string;
465
- policyIds: string[];
466
- assignments: InviteResourceAssignmentNonNullableFields$1[];
467
- }
468
- interface InviteFailureNonNullableFields$1 {
469
- subjectEmail: string;
470
- errorMessage: string;
471
- }
472
- interface CreateInviteResponseNonNullableFields$1 {
473
- successfulInvites: AccountInviteNonNullableFields$1[];
474
- failedInvites: InviteFailureNonNullableFields$1[];
475
- }
476
-
477
- interface AccountInvite {
478
- /**
479
- * Invite ID.
480
- * @readonly
481
- */
482
- _id?: string;
483
- /**
484
- * Account ID.
485
- * @readonly
486
- */
487
- accountId?: string;
488
- /** Email address where the invite was sent. */
489
- email?: string;
490
- /**
491
- * Deprecated. Use `policyIds`.
492
- * @deprecated
493
- */
494
- role?: string;
495
- /**
496
- * Deprecated. Use `inviterAccountId`.
497
- * @readonly
498
- * @deprecated
499
- */
500
- inviterId?: string;
501
- /**
502
- * Invite status.
503
- *
504
- * Supported values:
505
- * - **Pending:** The invite has been sent and is valid, waiting for the user's response.
506
- * - **Used:** The invite has been accepted.
507
- * - **Deleted:** The invite has been deleted or revoked.
508
- * - **Declined:** The user has declined the invite.
509
- * - **Expired:** The invite has expired without being accepted.
510
- */
511
- status?: InviteStatus$4;
512
- /** Link to accept the invite. */
513
- acceptLink?: string;
514
- /**
515
- * Inviting account ID.
516
- * @readonly
517
- */
518
- inviterAccountId?: string;
519
- /**
520
- * Account ID that accepted the invite. Populated only once the invite is accepted.
521
- * @readonly
522
- */
523
- acceptedByAccountId?: string | null;
524
- /** Date the invite was created. */
525
- dateCreated?: Date | null;
526
- /** Role IDs included in the invite. */
527
- policyIds?: string[];
528
- /** Date the invite was last updated. */
529
- dateUpdated?: Date | null;
530
- /** Assets the users are invited to join. */
531
- assignments?: InviteResourceAssignment[];
532
- /** Invite expiration date. */
533
- expirationDate?: Date | null;
534
- }
535
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
536
- declare enum InviteStatus$4 {
537
- Pending = "Pending",
538
- Used = "Used",
539
- Deleted = "Deleted",
540
- Declined = "Declined",
541
- Expired = "Expired"
542
- }
543
- interface InviteResourceAssignment {
544
- /** Role ID. */
545
- policyId?: string;
546
- /** Resources the user will be able to access. */
547
- assignments?: InviteAssignment[];
548
- }
549
- interface InviteAssignment {
550
- /** Full name of resource to be assigned. */
551
- fullNameResource?: FullNameResource;
552
- }
553
- interface FullNameResource extends FullNameResourceResourceContextOneOf {
554
- /** Specific site details. */
555
- siteContext?: SiteResourceContext;
556
- /** Specific account details. */
557
- accountContext?: AccountResourceContext;
558
- }
559
- /** @oneof */
560
- interface FullNameResourceResourceContextOneOf {
561
- /** Specific site details. */
562
- siteContext?: SiteResourceContext;
563
- /** Specific account details. */
564
- accountContext?: AccountResourceContext;
565
- }
566
- /** 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) */
567
- interface SiteResourceContext {
568
- /** Site ID. */
569
- metasiteId?: string;
570
- }
571
- /** 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) */
572
- interface AccountResourceContext {
573
- /** Account ID. */
574
- accountId?: string;
575
- }
576
- declare enum SimpleConditionOperator {
577
- UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP",
578
- EQUAL = "EQUAL"
579
- }
580
- declare enum JoinedConditionOperator {
581
- UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP",
582
- OR = "OR",
583
- AND = "AND"
584
- }
585
- declare enum SubjectType$2 {
586
- UNKNOWN = "UNKNOWN",
587
- ACCOUNT = "ACCOUNT",
588
- USER = "USER",
589
- USER_GROUP = "USER_GROUP",
590
- MEMBER_GROUP = "MEMBER_GROUP",
591
- VISITOR_GROUP = "VISITOR_GROUP",
592
- EXTERNAL_APP = "EXTERNAL_APP",
593
- ACCOUNT_GROUP = "ACCOUNT_GROUP",
594
- WIX_APP = "WIX_APP"
595
- }
596
- declare enum SubjectContextType {
597
- UNKNOWN_CTX = "UNKNOWN_CTX",
598
- ORG_CTX = "ORG_CTX",
599
- ACCOUNT_CTX = "ACCOUNT_CTX"
600
- }
601
- interface CreateInviteRequest {
602
- /** Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite). */
603
- subjectsAssignments: SubjectInviteAssignments[];
604
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
605
- defaultEmailLanguage?: string | null;
606
- }
607
- interface SubjectInviteAssignments {
608
- /** Invitee's email address. */
609
- subjectEmail?: string;
610
- /** 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. */
611
- assignments?: InviteResourceAssignment[];
612
- }
613
- interface CreateInviteResponse {
614
- /** Invites that were sent successfully. */
615
- successfulInvites?: AccountInvite[];
616
- /** Invites that failed. */
617
- failedInvites?: InviteFailure[];
618
- }
619
- interface InviteFailure {
620
- /** Email address of the failed invite. */
621
- subjectEmail?: string;
622
- /** Error description. */
623
- errorMessage?: string;
624
- }
625
- interface SiteResourceContextNonNullableFields {
626
- metasiteId: string;
627
- }
628
- interface AccountResourceContextNonNullableFields {
629
- accountId: string;
630
- }
631
- interface FullNameResourceNonNullableFields {
632
- siteContext?: SiteResourceContextNonNullableFields;
633
- accountContext?: AccountResourceContextNonNullableFields;
634
- }
635
- interface SimpleConditionValueNonNullableFields {
636
- attrName: string;
637
- stringValue: string;
638
- boolValue: boolean;
639
- }
640
- interface SimpleConditionNonNullableFields {
641
- attrName: string;
642
- value?: SimpleConditionValueNonNullableFields;
643
- op: SimpleConditionOperator;
644
- conditionModelId: string;
645
- }
646
- interface JoinedConditionNonNullableFields {
647
- op: JoinedConditionOperator;
648
- conditions: ConditionTypeNonNullableFields[];
649
- }
650
- interface ExperimentConditionNonNullableFields {
651
- spec: string;
652
- fallbackValue: string;
653
- expectedValue: string;
654
- }
655
- interface EnvironmentConditionNonNullableFields {
656
- experimentCondition?: ExperimentConditionNonNullableFields;
657
- }
658
- interface ConditionValueNonNullableFields {
659
- attrName: string;
660
- stringValue: string;
661
- boolValue: boolean;
662
- }
663
- interface EqualOperatorNonNullableFields {
664
- attrName: string;
665
- value?: ConditionValueNonNullableFields;
666
- }
667
- interface LikeOperatorNonNullableFields {
668
- attrName: string;
669
- values: string[];
670
- }
671
- interface ExperimentOperatorNonNullableFields {
672
- spec: string;
673
- fallbackValue: string;
674
- expectedValue: string;
675
- }
676
- interface SubjectContextNonNullableFields {
677
- _id: string;
678
- contextType: SubjectContextType;
679
- }
680
- interface SubjectNonNullableFields {
681
- _id: string;
682
- subjectType: SubjectType$2;
683
- context?: SubjectContextNonNullableFields;
684
- }
685
- interface DependOnOperatorNonNullableFields {
686
- dependOnSubject?: SubjectNonNullableFields;
687
- }
688
- interface ConditionOperatorNonNullableFields {
689
- equals?: EqualOperatorNonNullableFields;
690
- like?: LikeOperatorNonNullableFields;
691
- experiment?: ExperimentOperatorNonNullableFields;
692
- dependOn?: DependOnOperatorNonNullableFields;
693
- }
694
- interface ConditionNonNullableFields {
695
- conditionModelId: string;
696
- operator?: ConditionOperatorNonNullableFields;
697
- }
698
- interface ConditionTypeNonNullableFields {
699
- simpleCondition?: SimpleConditionNonNullableFields;
700
- joinedConditions?: JoinedConditionNonNullableFields;
701
- environmentCondition?: EnvironmentConditionNonNullableFields;
702
- condition?: ConditionNonNullableFields;
703
- }
704
- interface PolicyConditionNonNullableFields {
705
- condition?: ConditionTypeNonNullableFields;
706
- }
707
- interface InviteAssignmentNonNullableFields {
708
- fullNameResource?: FullNameResourceNonNullableFields;
709
- condition?: PolicyConditionNonNullableFields;
710
- }
711
- interface InviteResourceAssignmentNonNullableFields {
712
- policyId: string;
713
- assignments: InviteAssignmentNonNullableFields[];
714
- }
715
- interface AccountInviteNonNullableFields {
716
- _id: string;
717
- accountId: string;
718
- email: string;
719
- role: string;
720
- inviterId: string;
721
- status: InviteStatus$4;
722
- acceptLink: string;
723
- inviterAccountId: string;
724
- policyIds: string[];
725
- assignments: InviteResourceAssignmentNonNullableFields[];
726
- }
727
- interface InviteFailureNonNullableFields {
728
- subjectEmail: string;
729
- errorMessage: string;
730
- }
731
- interface CreateInviteResponseNonNullableFields {
732
- successfulInvites: AccountInviteNonNullableFields[];
733
- failedInvites: InviteFailureNonNullableFields[];
734
- }
735
-
736
- type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
737
- getUrl: (context: any) => string;
738
- httpMethod: K;
739
- path: string;
740
- pathParams: M;
741
- __requestType: T;
742
- __originalRequestType: S;
743
- __responseType: Q;
744
- __originalResponseType: R;
745
- };
746
- declare function createInvite(): __PublicMethodMetaInfo$3<'POST', {}, CreateInviteRequest, CreateInviteRequest$1, CreateInviteResponse & CreateInviteResponseNonNullableFields, CreateInviteResponse$1 & CreateInviteResponseNonNullableFields$1>;
747
-
748
- declare const meta$3_createInvite: typeof createInvite;
749
- declare namespace meta$3 {
750
- export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_createInvite as createInvite };
751
- }
752
-
753
- interface SiteInvite$1 {
754
- /**
755
- * Invite ID.
756
- * @readonly
757
- */
758
- id?: string;
759
- /**
760
- * Site ID the user is invited to as a collaborator.
761
- * @readonly
762
- */
763
- siteId?: string;
764
- /** Email address where the invite was sent. */
765
- email?: string;
766
- /** Role IDs included in the invite. */
767
- policyIds?: string[];
768
- /**
769
- * Deprecated. Use `inviterAccountId`.
770
- * @readonly
771
- * @deprecated
772
- */
773
- inviterId?: string;
774
- /**
775
- * Invite Status.
776
- *
777
- * Supported values:
778
- * - **Pending:** The invite has been sent and is valid, waiting for the user's response.
779
- * - **Used:** The invite has been accepted.
780
- * - **Deleted:** The invite has been deleted or revoked.
781
- * - **Declined:** The user declined the invite.
782
- * - **Expired:** The invite has expired without being accepted.
783
- */
784
- status?: InviteStatus$3;
785
- /** Link to accept the invite. */
786
- acceptLink?: string;
787
- /**
788
- * Inviting account ID.
789
- * @readonly
790
- */
791
- inviterAccountId?: string;
792
- /**
793
- * Account ID that accepted the invite. Populated only once the invite is accepted.
794
- * @readonly
795
- */
796
- acceptedByAccountId?: string | null;
797
- /** Date the invite was created. */
798
- dateCreated?: Date | null;
799
- /** User's Wix Bookings staff ID, if relevant. */
800
- staffId?: string | null;
801
- /** Invite expiration date */
802
- expirationDate?: Date | null;
803
- }
804
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
805
- declare enum InviteStatus$3 {
806
- Pending = "Pending",
807
- Used = "Used",
808
- Deleted = "Deleted",
809
- Declined = "Declined",
810
- Expired = "Expired"
811
- }
812
- interface SiteInviteResponse$1 {
813
- /** Invites that were sent. */
814
- invite?: SiteInvite$1;
815
- }
816
- interface BulkSiteInviteRequest$1 {
817
- /** Role IDs, referred to as policy IDs, to assign to the contributors. */
818
- policyIds: string[];
819
- /** Email addresses to which the invites should be sent. */
820
- emails: string[];
821
- /** Details explaining the purpose of the invite. */
822
- invitePurpose?: string | null;
823
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
824
- defaultEmailLanguage?: string | null;
825
- }
826
- interface BulkSiteInviteResponse$1 {
827
- /** Invites that were sent successfully. */
828
- invites?: SiteInvite$1[];
829
- /** Invites that failed. */
830
- failedEmails?: string[];
831
- }
832
- interface ResendSiteInviteRequest$1 {
833
- /** Invite ID. */
834
- inviteId: string;
835
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
836
- defaultEmailLanguage?: string | null;
837
- }
838
- interface RevokeSiteInviteRequest$1 {
839
- /** Invite ID. */
840
- inviteId: string;
841
- }
842
- interface RevokeSiteInviteResponse$1 {
843
- }
844
- interface SiteInviteNonNullableFields$1 {
845
- id: string;
846
- siteId: string;
847
- email: string;
848
- policyIds: string[];
849
- inviterId: string;
850
- status: InviteStatus$3;
851
- acceptLink: string;
852
- inviterAccountId: string;
853
- }
854
- interface BulkSiteInviteResponseNonNullableFields$1 {
855
- invites: SiteInviteNonNullableFields$1[];
856
- failedEmails: string[];
857
- }
858
- interface SiteInviteResponseNonNullableFields$1 {
859
- invite?: SiteInviteNonNullableFields$1;
860
- }
861
-
862
- interface SiteInvite {
863
- /**
864
- * Invite ID.
865
- * @readonly
866
- */
867
- _id?: string;
868
- /**
869
- * Site ID the user is invited to as a collaborator.
870
- * @readonly
871
- */
872
- siteId?: string;
873
- /** Email address where the invite was sent. */
874
- email?: string;
875
- /** Role IDs included in the invite. */
876
- policyIds?: string[];
877
- /**
878
- * Deprecated. Use `inviterAccountId`.
879
- * @readonly
880
- * @deprecated
881
- */
882
- inviterId?: string;
883
- /**
884
- * Invite Status.
885
- *
886
- * Supported values:
887
- * - **Pending:** The invite has been sent and is valid, waiting for the user's response.
888
- * - **Used:** The invite has been accepted.
889
- * - **Deleted:** The invite has been deleted or revoked.
890
- * - **Declined:** The user declined the invite.
891
- * - **Expired:** The invite has expired without being accepted.
892
- */
893
- status?: InviteStatus$2;
894
- /** Link to accept the invite. */
895
- acceptLink?: string;
896
- /**
897
- * Inviting account ID.
898
- * @readonly
899
- */
900
- inviterAccountId?: string;
901
- /**
902
- * Account ID that accepted the invite. Populated only once the invite is accepted.
903
- * @readonly
904
- */
905
- acceptedByAccountId?: string | null;
906
- /** Date the invite was created. */
907
- dateCreated?: Date | null;
908
- /** User's Wix Bookings staff ID, if relevant. */
909
- staffId?: string | null;
910
- /** Invite expiration date */
911
- expirationDate?: Date | null;
912
- }
913
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
914
- declare enum InviteStatus$2 {
915
- Pending = "Pending",
916
- Used = "Used",
917
- Deleted = "Deleted",
918
- Declined = "Declined",
919
- Expired = "Expired"
920
- }
921
- interface SiteInviteResponse {
922
- /** Invites that were sent. */
923
- invite?: SiteInvite;
924
- }
925
- interface BulkSiteInviteRequest {
926
- /** Role IDs, referred to as policy IDs, to assign to the contributors. */
927
- policyIds: string[];
928
- /** Email addresses to which the invites should be sent. */
929
- emails: string[];
930
- /** Details explaining the purpose of the invite. */
931
- invitePurpose?: string | null;
932
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
933
- defaultEmailLanguage?: string | null;
934
- }
935
- interface BulkSiteInviteResponse {
936
- /** Invites that were sent successfully. */
937
- invites?: SiteInvite[];
938
- /** Invites that failed. */
939
- failedEmails?: string[];
940
- }
941
- interface ResendSiteInviteRequest {
942
- /** Invite ID. */
943
- inviteId: string;
944
- /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */
945
- defaultEmailLanguage?: string | null;
946
- }
947
- interface RevokeSiteInviteRequest {
948
- /** Invite ID. */
949
- inviteId: string;
950
- }
951
- interface RevokeSiteInviteResponse {
952
- }
953
- interface SiteInviteNonNullableFields {
954
- _id: string;
955
- siteId: string;
956
- email: string;
957
- policyIds: string[];
958
- inviterId: string;
959
- status: InviteStatus$2;
960
- acceptLink: string;
961
- inviterAccountId: string;
962
- }
963
- interface BulkSiteInviteResponseNonNullableFields {
964
- invites: SiteInviteNonNullableFields[];
965
- failedEmails: string[];
966
- }
967
- interface SiteInviteResponseNonNullableFields {
968
- invite?: SiteInviteNonNullableFields;
969
- }
970
-
971
- type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
972
- getUrl: (context: any) => string;
973
- httpMethod: K;
974
- path: string;
975
- pathParams: M;
976
- __requestType: T;
977
- __originalRequestType: S;
978
- __responseType: Q;
979
- __originalResponseType: R;
980
- };
981
- declare function bulkInvite(): __PublicMethodMetaInfo$2<'POST', {}, BulkSiteInviteRequest, BulkSiteInviteRequest$1, BulkSiteInviteResponse & BulkSiteInviteResponseNonNullableFields, BulkSiteInviteResponse$1 & BulkSiteInviteResponseNonNullableFields$1>;
982
- declare function resendInvite(): __PublicMethodMetaInfo$2<'POST', {
983
- inviteId: string;
984
- }, ResendSiteInviteRequest, ResendSiteInviteRequest$1, SiteInviteResponse & SiteInviteResponseNonNullableFields, SiteInviteResponse$1 & SiteInviteResponseNonNullableFields$1>;
985
- declare function revokeInvite(): __PublicMethodMetaInfo$2<'POST', {
986
- inviteId: string;
987
- }, RevokeSiteInviteRequest, RevokeSiteInviteRequest$1, RevokeSiteInviteResponse, RevokeSiteInviteResponse$1>;
988
-
989
- declare const meta$2_bulkInvite: typeof bulkInvite;
990
- declare const meta$2_resendInvite: typeof resendInvite;
991
- declare const meta$2_revokeInvite: typeof revokeInvite;
992
- declare namespace meta$2 {
993
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkInvite as bulkInvite, meta$2_resendInvite as resendInvite, meta$2_revokeInvite as revokeInvite };
994
- }
995
-
996
- interface Name$1 {
997
- /** User's first name. */
998
- firstName?: string;
999
- /** User's last name. */
1000
- lastName?: string;
1001
- }
1002
- interface Restriction$1 extends RestrictionRestrictionsOneOf$1 {
1003
- /**
1004
- * Deprecated.
1005
- * @deprecated
1006
- */
1007
- resource?: ApiResource$1;
1008
- /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
1009
- conditions?: Conditions$1;
1010
- /** Site where the assignment restrictions apply. */
1011
- site?: SiteRestriction$1;
1012
- }
1013
- /** @oneof */
1014
- interface RestrictionRestrictionsOneOf$1 {
1015
- /**
1016
- * Deprecated.
1017
- * @deprecated
1018
- */
1019
- resource?: ApiResource$1;
1020
- /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
1021
- conditions?: Conditions$1;
1022
- /** Site where the assignment restrictions apply. */
1023
- site?: SiteRestriction$1;
1024
- }
1025
- interface ApiResource$1 {
1026
- /** Resource type. */
1027
- resourceType?: ResourceType$1;
1028
- /** Resource ID. */
1029
- id?: string;
1030
- value?: string | null;
1031
- }
1032
- declare enum ResourceType$1 {
1033
- UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
1034
- SITE = "SITE"
1035
- }
1036
- interface Conditions$1 {
1037
- /** List of conditions. */
1038
- conditions?: ApiCondition$1[];
1039
- }
1040
- interface ApiCondition$1 {
1041
- /** Condition type. */
1042
- conditionType?: ConditionAttributeType$1;
1043
- /** Condition ID. */
1044
- id?: string;
1045
- /** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
1046
- value?: string | null;
1047
- }
1048
- declare enum ConditionAttributeType$1 {
1049
- UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
1050
- FOLDER = "FOLDER"
1051
- }
1052
- interface SiteRestriction$1 {
1053
- /** Site ID. */
1054
- id?: string;
1055
- /** Site name. */
1056
- value?: string | null;
1057
- }
1058
- declare enum SubjectType$1 {
1059
- UNKNOWN = "UNKNOWN",
1060
- ACCOUNT = "ACCOUNT",
1061
- USER = "USER",
1062
- USER_GROUP = "USER_GROUP",
1063
- MEMBER_GROUP = "MEMBER_GROUP",
1064
- VISITOR_GROUP = "VISITOR_GROUP",
1065
- EXTERNAL_APP = "EXTERNAL_APP",
1066
- ACCOUNT_GROUP = "ACCOUNT_GROUP",
1067
- WIX_APP = "WIX_APP"
1068
- }
1069
- interface Paging$1 {
1070
- /** Number of items to load. */
1071
- limit?: number | null;
1072
- /** Number of items to skip in the current sort order. */
1073
- offset?: number | null;
1074
- }
1075
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
1076
- declare enum InviteStatus$1 {
1077
- Pending = "Pending",
1078
- Used = "Used",
1079
- Deleted = "Deleted",
1080
- Declined = "Declined",
1081
- Expired = "Expired"
1082
- }
1083
- interface RemoveMemberRequest$1 {
1084
- /** User ID of the team member to remove. */
1085
- userId: string;
1086
- }
1087
- interface RemoveMemberResponse$1 {
1088
- }
1089
- declare enum RoleLevel$1 {
1090
- ALL = "ALL",
1091
- SITE_LEVEL = "SITE_LEVEL",
1092
- ACCOUNT_LEVEL = "ACCOUNT_LEVEL"
1093
- }
1094
- interface SearchTeamRequest$1 {
1095
- /** Free text to search for within team member name and email address fields. */
1096
- query?: string | null;
1097
- /** Sort data. */
1098
- orderBy?: Ordering$1[];
1099
- /**
1100
- * Filter object. Supported values: `inviteType` and `roleId`. For example, `{'inviteType': {'$eq': 'Expired'}}`.
1101
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
1102
- */
1103
- filter?: Record<string, any> | null;
1104
- /**
1105
- * A list of facets to return in the response. Facets count the items within logical groupings.
1106
- * See [Filters and Facets: An Explainer](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) for more information.
1107
- */
1108
- facets?: FacetType$1[];
1109
- /** Pagination. */
1110
- paging?: Paging$1;
1111
- }
1112
- interface Ordering$1 {
1113
- /** Field to sort by. */
1114
- fieldName?: OrderField$1;
1115
- /** Sort order. */
1116
- direction?: Direction$1;
1117
- }
1118
- declare enum OrderField$1 {
1119
- /** For internal use. */
1120
- Undefined = "Undefined",
1121
- /** Team member name. */
1122
- Name = "Name",
1123
- /** Date team member joined the account. */
1124
- JoinedAt = "JoinedAt"
1125
- }
1126
- declare enum Direction$1 {
1127
- /** For internal use. */
1128
- UninitializedDirection = "UninitializedDirection",
1129
- /** Ascending. */
1130
- ASC = "ASC",
1131
- /** Descending. */
1132
- DESC = "DESC"
1133
- }
1134
- declare enum FacetType$1 {
1135
- Undefined = "Undefined",
1136
- /** How many team members with each role */
1137
- Roles = "Roles",
1138
- /** How many team members by invite status */
1139
- InviteStatus = "InviteStatus",
1140
- /** How many team members in total in the account */
1141
- Users = "Users"
1142
- }
1143
- interface SearchTeamResponse$1 {
1144
- /** List of facets, as requested. */
1145
- facets?: Facet$1[];
1146
- /** Existing team members and invites sent to join the account. */
1147
- teamMembers?: TeamMemberV3$1[];
1148
- }
1149
- interface Facet$1 {
1150
- /** Facet type. */
1151
- facetType?: FacetType$1;
1152
- /** Values and their counters. Values with count = 0 are not returned. */
1153
- values?: FacetValue$1[];
1154
- }
1155
- interface FacetValue$1 {
1156
- /** Supported values: `Roles`, `InviteStatus`, `Users`. */
1157
- value?: string;
1158
- /** Number of existing items for the value. */
1159
- count?: number;
1160
- }
1161
- interface TeamMemberV3$1 extends TeamMemberV3MembersOneOf$1 {
1162
- /** Existing team member data. */
1163
- user?: UserV3$1;
1164
- /** Invited team member data. */
1165
- invite?: InviteV3$1;
1166
- }
1167
- /** @oneof */
1168
- interface TeamMemberV3MembersOneOf$1 {
1169
- /** Existing team member data. */
1170
- user?: UserV3$1;
1171
- /** Invited team member data. */
1172
- invite?: InviteV3$1;
1173
- }
1174
- interface UserV3$1 {
1175
- /** User ID. */
1176
- id?: string;
1177
- /** User's email address. */
1178
- email?: string | null;
1179
- /** User's name, when provided. */
1180
- name?: Name$1;
1181
- /** URL to user's profile image, when provided. */
1182
- profileImage?: string | null;
1183
- /** Date the user joined the team. */
1184
- joinedTeamAt?: Date | null;
1185
- /** Mapping of the user's access to an asset and their assigned role. */
1186
- assignments?: AssignmentV3$1[];
1187
- }
1188
- interface AssignmentV3$1 {
1189
- /** Role assigned to the user. To retrieve all available roles, call Get Roles Info. */
1190
- policyId?: string | null;
1191
- /**
1192
- * Unique ID for this specific assignment.
1193
- * @readonly
1194
- */
1195
- assignmentId?: string | null;
1196
- /** 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. */
1197
- restrictions?: Restriction$1;
1198
- /** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
1199
- subject?: AssignedSubject$1;
1200
- }
1201
- interface AssignedSubject$1 {
1202
- /**
1203
- * Identity ID.
1204
- * @readonly
1205
- */
1206
- id?: string;
1207
- /** Identity type. */
1208
- subjectType?: SubjectType$1;
1209
- }
1210
- interface InviteV3$1 {
1211
- /**
1212
- * Invite ID.
1213
- * @readonly
1214
- */
1215
- id?: string;
1216
- /** Invitee's email address. */
1217
- email?: string | null;
1218
- /** Invite status. */
1219
- status?: InviteStatus$1;
1220
- /** URL of direct link to accept the invite. */
1221
- acceptLink?: string | null;
1222
- /** Date the invite was created. */
1223
- dateCreated?: Date | null;
1224
- /** Date the invite was last updated. */
1225
- dateUpdated?: Date | null;
1226
- /** A list of assignments that will be applied to the invitees when they accept the invite. */
1227
- assignments?: InviteAssignmentV3$1[];
1228
- /** Invite expiration date. */
1229
- expirationDate?: Date | null;
1230
- }
1231
- interface InviteAssignmentV3$1 {
1232
- /** Role ID that will be assigned once the invite is accepted. */
1233
- policyId?: string | null;
1234
- /** Assets where the user will be assigned access. When empty, the role covers all assets, with no restrictions to specific sites or folders. */
1235
- restrictions?: Restriction$1;
1236
- }
1237
- declare enum RoleLevelRestriction$1 {
1238
- NoRestriction = "NoRestriction",
1239
- Site = "Site",
1240
- Account = "Account"
1241
- }
1242
- declare enum EditorType$1 {
1243
- UNINITIALIZED = "UNINITIALIZED",
1244
- EDITORX = "EDITORX",
1245
- BLOCKS = "BLOCKS",
1246
- STUDIO = "STUDIO"
1247
- }
1248
- interface GetRolesInfoRequest$1 {
1249
- /** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
1250
- locale?: string | null;
1251
- /** Roles to return. */
1252
- filter?: RolesInfoFilter$1;
1253
- }
1254
- interface RolesInfoFilter$1 {
1255
- /** Role level to return. Default: ALL. */
1256
- roleLevel?: RoleLevel$1;
1257
- /** Filter for editor-specific roles. Default: ALL. */
1258
- editorTypes?: EditorType$1[];
1259
- }
1260
- interface GetRolesInfoResponse$1 {
1261
- /** Predefined roles. */
1262
- predefinedRoles?: RoleInfo$1[];
1263
- /** Custom roles. */
1264
- customRoles?: RoleInfo$1[];
1265
- }
1266
- interface RoleInfo$1 {
1267
- /** Role ID. */
1268
- id?: string;
1269
- /** Role title, translated according to the request locale. If translation fails, the original title is returned. */
1270
- title?: string;
1271
- /** Role description, translated according to the request locale. If translation fails, the original description is returned. */
1272
- description?: string;
1273
- /** Whether this role is restricted from accessing a specific resource type. Default: `NoRestriction`. */
1274
- restrictFromLevel?: RoleLevelRestriction$1;
1275
- }
1276
- interface UpdateTeamMemberAssignmentsRequest$1 {
1277
- /** ID of team member being affected. */
1278
- userId: string;
1279
- /** New assignments to apply to the team member in this account. */
1280
- newAssignments: AssignmentV3$1[];
1281
- /** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
1282
- assignmentIdsToRemove: string[];
1283
- }
1284
- interface UpdateTeamMemberAssignmentsResponse$1 {
1285
- /** The new assignments, assigned to the given team member. */
1286
- assignments?: AssignmentV3$1[];
1287
- }
1288
- interface FacetValueNonNullableFields$1 {
1289
- value: string;
1290
- count: number;
1291
- }
1292
- interface FacetNonNullableFields$1 {
1293
- facetType: FacetType$1;
1294
- values: FacetValueNonNullableFields$1[];
1295
- }
1296
- interface NameNonNullableFields$1 {
1297
- firstName: string;
1298
- lastName: string;
1299
- }
1300
- interface ApiResourceNonNullableFields$1 {
1301
- resourceType: ResourceType$1;
1302
- id: string;
1303
- }
1304
- interface ApiConditionNonNullableFields$1 {
1305
- conditionType: ConditionAttributeType$1;
1306
- id: string;
1307
- }
1308
- interface ConditionsNonNullableFields$1 {
1309
- conditions: ApiConditionNonNullableFields$1[];
1310
- }
1311
- interface CompanionResourceNonNullableFields$1 {
1312
- id: string;
1313
- resourceType: string;
1314
- }
1315
- interface SiteRestrictionNonNullableFields$1 {
1316
- id: string;
1317
- resource?: CompanionResourceNonNullableFields$1;
1318
- }
1319
- interface RestrictionNonNullableFields$1 {
1320
- resource?: ApiResourceNonNullableFields$1;
1321
- conditions?: ConditionsNonNullableFields$1;
1322
- site?: SiteRestrictionNonNullableFields$1;
1323
- }
1324
- interface AssignedSubjectNonNullableFields$1 {
1325
- id: string;
1326
- subjectType: SubjectType$1;
1327
- }
1328
- interface AssignmentV3NonNullableFields$1 {
1329
- restrictions?: RestrictionNonNullableFields$1;
1330
- subject?: AssignedSubjectNonNullableFields$1;
1331
- }
1332
- interface UserV3NonNullableFields$1 {
1333
- id: string;
1334
- name?: NameNonNullableFields$1;
1335
- assignments: AssignmentV3NonNullableFields$1[];
1336
- }
1337
- interface InviteAssignmentV3NonNullableFields$1 {
1338
- restrictions?: RestrictionNonNullableFields$1;
1339
- }
1340
- interface InviteV3NonNullableFields$1 {
1341
- id: string;
1342
- status: InviteStatus$1;
1343
- assignments: InviteAssignmentV3NonNullableFields$1[];
1344
- }
1345
- interface TeamMemberV3NonNullableFields$1 {
1346
- user?: UserV3NonNullableFields$1;
1347
- invite?: InviteV3NonNullableFields$1;
1348
- }
1349
- interface SearchTeamResponseNonNullableFields$1 {
1350
- facets: FacetNonNullableFields$1[];
1351
- teamMembers: TeamMemberV3NonNullableFields$1[];
1352
- }
1353
- interface RoleInfoNonNullableFields$1 {
1354
- id: string;
1355
- title: string;
1356
- description: string;
1357
- restrictFromLevel: RoleLevelRestriction$1;
1358
- }
1359
- interface GetRolesInfoResponseNonNullableFields$1 {
1360
- predefinedRoles: RoleInfoNonNullableFields$1[];
1361
- customRoles: RoleInfoNonNullableFields$1[];
1362
- }
1363
- interface UpdateTeamMemberAssignmentsResponseNonNullableFields$1 {
1364
- assignments: AssignmentV3NonNullableFields$1[];
1365
- }
1366
-
1367
- interface Name {
1368
- /** User's first name. */
1369
- firstName?: string;
1370
- /** User's last name. */
1371
- lastName?: string;
1372
- }
1373
- interface Restriction extends RestrictionRestrictionsOneOf {
1374
- /**
1375
- * Deprecated.
1376
- * @deprecated
1377
- */
1378
- resource?: ApiResource;
1379
- /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
1380
- conditions?: Conditions;
1381
- /** Site where the assignment restrictions apply. */
1382
- site?: SiteRestriction;
1383
- }
1384
- /** @oneof */
1385
- interface RestrictionRestrictionsOneOf {
1386
- /**
1387
- * Deprecated.
1388
- * @deprecated
1389
- */
1390
- resource?: ApiResource;
1391
- /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
1392
- conditions?: Conditions;
1393
- /** Site where the assignment restrictions apply. */
1394
- site?: SiteRestriction;
1395
- }
1396
- interface ApiResource {
1397
- /** Resource type. */
1398
- resourceType?: ResourceType;
1399
- /** Resource ID. */
1400
- _id?: string;
1401
- value?: string | null;
1402
- }
1403
- declare enum ResourceType {
1404
- UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
1405
- SITE = "SITE"
1406
- }
1407
- interface Conditions {
1408
- /** List of conditions. */
1409
- conditions?: ApiCondition[];
1410
- }
1411
- interface ApiCondition {
1412
- /** Condition type. */
1413
- conditionType?: ConditionAttributeType;
1414
- /** Condition ID. */
1415
- _id?: string;
1416
- /** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
1417
- value?: string | null;
1418
- }
1419
- declare enum ConditionAttributeType {
1420
- UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
1421
- FOLDER = "FOLDER"
1422
- }
1423
- interface SiteRestriction {
1424
- /** Site ID. */
1425
- _id?: string;
1426
- /** Site name. */
1427
- value?: string | null;
1428
- }
1429
- declare enum SubjectType {
1430
- UNKNOWN = "UNKNOWN",
1431
- ACCOUNT = "ACCOUNT",
1432
- USER = "USER",
1433
- USER_GROUP = "USER_GROUP",
1434
- MEMBER_GROUP = "MEMBER_GROUP",
1435
- VISITOR_GROUP = "VISITOR_GROUP",
1436
- EXTERNAL_APP = "EXTERNAL_APP",
1437
- ACCOUNT_GROUP = "ACCOUNT_GROUP",
1438
- WIX_APP = "WIX_APP"
1439
- }
1440
- interface Paging {
1441
- /** Number of items to load. */
1442
- limit?: number | null;
1443
- /** Number of items to skip in the current sort order. */
1444
- offset?: number | null;
1445
- }
1446
- /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
1447
- declare enum InviteStatus {
1448
- Pending = "Pending",
1449
- Used = "Used",
1450
- Deleted = "Deleted",
1451
- Declined = "Declined",
1452
- Expired = "Expired"
1453
- }
1454
- interface RemoveMemberRequest {
1455
- /** User ID of the team member to remove. */
1456
- userId: string;
1457
- }
1458
- interface RemoveMemberResponse {
1459
- }
1460
- declare enum RoleLevel {
1461
- ALL = "ALL",
1462
- SITE_LEVEL = "SITE_LEVEL",
1463
- ACCOUNT_LEVEL = "ACCOUNT_LEVEL"
1464
- }
1465
- interface SearchTeamRequest {
1466
- /** Free text to search for within team member name and email address fields. */
1467
- query?: string | null;
1468
- /** Sort data. */
1469
- orderBy?: Ordering[];
1470
- /**
1471
- * Filter object. Supported values: `inviteType` and `roleId`. For example, `{'inviteType': {'$eq': 'Expired'}}`.
1472
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
1473
- */
1474
- filter?: Record<string, any> | null;
1475
- /**
1476
- * A list of facets to return in the response. Facets count the items within logical groupings.
1477
- * See [Filters and Facets: An Explainer](https://medium.com/@westontt/filters-and-facets-an-explainer-3b73a9538eca) for more information.
1478
- */
1479
- facets?: FacetType[];
1480
- /** Pagination. */
1481
- paging?: Paging;
1482
- }
1483
- interface Ordering {
1484
- /** Field to sort by. */
1485
- fieldName?: OrderField;
1486
- /** Sort order. */
1487
- direction?: Direction;
1488
- }
1489
- declare enum OrderField {
1490
- /** For internal use. */
1491
- Undefined = "Undefined",
1492
- /** Team member name. */
1493
- Name = "Name",
1494
- /** Date team member joined the account. */
1495
- JoinedAt = "JoinedAt"
1496
- }
1497
- declare enum Direction {
1498
- /** For internal use. */
1499
- UninitializedDirection = "UninitializedDirection",
1500
- /** Ascending. */
1501
- ASC = "ASC",
1502
- /** Descending. */
1503
- DESC = "DESC"
1504
- }
1505
- declare enum FacetType {
1506
- Undefined = "Undefined",
1507
- /** How many team members with each role */
1508
- Roles = "Roles",
1509
- /** How many team members by invite status */
1510
- InviteStatus = "InviteStatus",
1511
- /** How many team members in total in the account */
1512
- Users = "Users"
1513
- }
1514
- interface SearchTeamResponse {
1515
- /** List of facets, as requested. */
1516
- facets?: Facet[];
1517
- /** Existing team members and invites sent to join the account. */
1518
- teamMembers?: TeamMemberV3[];
1519
- }
1520
- interface Facet {
1521
- /** Facet type. */
1522
- facetType?: FacetType;
1523
- /** Values and their counters. Values with count = 0 are not returned. */
1524
- values?: FacetValue[];
1525
- }
1526
- interface FacetValue {
1527
- /** Supported values: `Roles`, `InviteStatus`, `Users`. */
1528
- value?: string;
1529
- /** Number of existing items for the value. */
1530
- count?: number;
1531
- }
1532
- interface TeamMemberV3 extends TeamMemberV3MembersOneOf {
1533
- /** Existing team member data. */
1534
- user?: UserV3;
1535
- /** Invited team member data. */
1536
- invite?: InviteV3;
1537
- }
1538
- /** @oneof */
1539
- interface TeamMemberV3MembersOneOf {
1540
- /** Existing team member data. */
1541
- user?: UserV3;
1542
- /** Invited team member data. */
1543
- invite?: InviteV3;
1544
- }
1545
- interface UserV3 {
1546
- /** User ID. */
1547
- _id?: string;
1548
- /** User's email address. */
1549
- email?: string | null;
1550
- /** User's name, when provided. */
1551
- name?: Name;
1552
- /** URL to user's profile image, when provided. */
1553
- profileImage?: string | null;
1554
- /** Date the user joined the team. */
1555
- joinedTeamAt?: Date | null;
1556
- /** Mapping of the user's access to an asset and their assigned role. */
1557
- assignments?: AssignmentV3[];
1558
- }
1559
- interface AssignmentV3 {
1560
- /** Role assigned to the user. To retrieve all available roles, call Get Roles Info. */
1561
- policyId?: string | null;
1562
- /**
1563
- * Unique ID for this specific assignment.
1564
- * @readonly
1565
- */
1566
- assignmentId?: string | null;
1567
- /** 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. */
1568
- restrictions?: Restriction;
1569
- /** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
1570
- subject?: AssignedSubject;
1571
- }
1572
- interface AssignedSubject {
1573
- /**
1574
- * Identity ID.
1575
- * @readonly
1576
- */
1577
- _id?: string;
1578
- /** Identity type. */
1579
- subjectType?: SubjectType;
1580
- }
1581
- interface InviteV3 {
1582
- /**
1583
- * Invite ID.
1584
- * @readonly
1585
- */
1586
- _id?: string;
1587
- /** Invitee's email address. */
1588
- email?: string | null;
1589
- /** Invite status. */
1590
- status?: InviteStatus;
1591
- /** URL of direct link to accept the invite. */
1592
- acceptLink?: string | null;
1593
- /** Date the invite was created. */
1594
- dateCreated?: Date | null;
1595
- /** Date the invite was last updated. */
1596
- dateUpdated?: Date | null;
1597
- /** A list of assignments that will be applied to the invitees when they accept the invite. */
1598
- assignments?: InviteAssignmentV3[];
1599
- /** Invite expiration date. */
1600
- expirationDate?: Date | null;
1601
- }
1602
- interface InviteAssignmentV3 {
1603
- /** Role ID that will be assigned once the invite is accepted. */
1604
- policyId?: string | null;
1605
- /** Assets where the user will be assigned access. When empty, the role covers all assets, with no restrictions to specific sites or folders. */
1606
- restrictions?: Restriction;
1607
- }
1608
- declare enum RoleLevelRestriction {
1609
- NoRestriction = "NoRestriction",
1610
- Site = "Site",
1611
- Account = "Account"
1612
- }
1613
- declare enum EditorType {
1614
- UNINITIALIZED = "UNINITIALIZED",
1615
- EDITORX = "EDITORX",
1616
- BLOCKS = "BLOCKS",
1617
- STUDIO = "STUDIO"
1618
- }
1619
- interface GetRolesInfoRequest {
1620
- /** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
1621
- locale?: string | null;
1622
- /** Roles to return. */
1623
- filter?: RolesInfoFilter;
1624
- }
1625
- interface RolesInfoFilter {
1626
- /** Role level to return. Default: ALL. */
1627
- roleLevel?: RoleLevel;
1628
- /** Filter for editor-specific roles. Default: ALL. */
1629
- editorTypes?: EditorType[];
1630
- }
1631
- interface GetRolesInfoResponse {
1632
- /** Predefined roles. */
1633
- predefinedRoles?: RoleInfo[];
1634
- /** Custom roles. */
1635
- customRoles?: RoleInfo[];
1636
- }
1637
- interface RoleInfo {
1638
- /** Role ID. */
1639
- _id?: string;
1640
- /** Role title, translated according to the request locale. If translation fails, the original title is returned. */
1641
- title?: string;
1642
- /** Role description, translated according to the request locale. If translation fails, the original description is returned. */
1643
- description?: string;
1644
- /** Whether this role is restricted from accessing a specific resource type. Default: `NoRestriction`. */
1645
- restrictFromLevel?: RoleLevelRestriction;
1646
- }
1647
- interface UpdateTeamMemberAssignmentsRequest {
1648
- /** ID of team member being affected. */
1649
- userId: string;
1650
- /** New assignments to apply to the team member in this account. */
1651
- newAssignments: AssignmentV3[];
1652
- /** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
1653
- assignmentIdsToRemove: string[];
1654
- }
1655
- interface UpdateTeamMemberAssignmentsResponse {
1656
- /** The new assignments, assigned to the given team member. */
1657
- assignments?: AssignmentV3[];
1658
- }
1659
- interface FacetValueNonNullableFields {
1660
- value: string;
1661
- count: number;
1662
- }
1663
- interface FacetNonNullableFields {
1664
- facetType: FacetType;
1665
- values: FacetValueNonNullableFields[];
1666
- }
1667
- interface NameNonNullableFields {
1668
- firstName: string;
1669
- lastName: string;
1670
- }
1671
- interface ApiResourceNonNullableFields {
1672
- resourceType: ResourceType;
1673
- _id: string;
1674
- }
1675
- interface ApiConditionNonNullableFields {
1676
- conditionType: ConditionAttributeType;
1677
- _id: string;
1678
- }
1679
- interface ConditionsNonNullableFields {
1680
- conditions: ApiConditionNonNullableFields[];
1681
- }
1682
- interface CompanionResourceNonNullableFields {
1683
- _id: string;
1684
- resourceType: string;
1685
- }
1686
- interface SiteRestrictionNonNullableFields {
1687
- _id: string;
1688
- resource?: CompanionResourceNonNullableFields;
1689
- }
1690
- interface RestrictionNonNullableFields {
1691
- resource?: ApiResourceNonNullableFields;
1692
- conditions?: ConditionsNonNullableFields;
1693
- site?: SiteRestrictionNonNullableFields;
1694
- }
1695
- interface AssignedSubjectNonNullableFields {
1696
- _id: string;
1697
- subjectType: SubjectType;
1698
- }
1699
- interface AssignmentV3NonNullableFields {
1700
- restrictions?: RestrictionNonNullableFields;
1701
- subject?: AssignedSubjectNonNullableFields;
1702
- }
1703
- interface UserV3NonNullableFields {
1704
- _id: string;
1705
- name?: NameNonNullableFields;
1706
- assignments: AssignmentV3NonNullableFields[];
1707
- }
1708
- interface InviteAssignmentV3NonNullableFields {
1709
- restrictions?: RestrictionNonNullableFields;
1710
- }
1711
- interface InviteV3NonNullableFields {
1712
- _id: string;
1713
- status: InviteStatus;
1714
- assignments: InviteAssignmentV3NonNullableFields[];
1715
- }
1716
- interface TeamMemberV3NonNullableFields {
1717
- user?: UserV3NonNullableFields;
1718
- invite?: InviteV3NonNullableFields;
1719
- }
1720
- interface SearchTeamResponseNonNullableFields {
1721
- facets: FacetNonNullableFields[];
1722
- teamMembers: TeamMemberV3NonNullableFields[];
1723
- }
1724
- interface RoleInfoNonNullableFields {
1725
- _id: string;
1726
- title: string;
1727
- description: string;
1728
- restrictFromLevel: RoleLevelRestriction;
1729
- }
1730
- interface GetRolesInfoResponseNonNullableFields {
1731
- predefinedRoles: RoleInfoNonNullableFields[];
1732
- customRoles: RoleInfoNonNullableFields[];
1733
- }
1734
- interface UpdateTeamMemberAssignmentsResponseNonNullableFields {
1735
- assignments: AssignmentV3NonNullableFields[];
1736
- }
1737
-
1738
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1739
- getUrl: (context: any) => string;
1740
- httpMethod: K;
1741
- path: string;
1742
- pathParams: M;
1743
- __requestType: T;
1744
- __originalRequestType: S;
1745
- __responseType: Q;
1746
- __originalResponseType: R;
1747
- };
1748
- declare function removeMember(): __PublicMethodMetaInfo$1<'POST', {}, RemoveMemberRequest, RemoveMemberRequest$1, RemoveMemberResponse, RemoveMemberResponse$1>;
1749
- declare function searchTeam(): __PublicMethodMetaInfo$1<'POST', {}, SearchTeamRequest, SearchTeamRequest$1, SearchTeamResponse & SearchTeamResponseNonNullableFields, SearchTeamResponse$1 & SearchTeamResponseNonNullableFields$1>;
1750
- declare function getRolesInfo(): __PublicMethodMetaInfo$1<'GET', {}, GetRolesInfoRequest, GetRolesInfoRequest$1, GetRolesInfoResponse & GetRolesInfoResponseNonNullableFields, GetRolesInfoResponse$1 & GetRolesInfoResponseNonNullableFields$1>;
1751
- declare function updateTeamMemberAssignments(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateTeamMemberAssignmentsRequest, UpdateTeamMemberAssignmentsRequest$1, UpdateTeamMemberAssignmentsResponse & UpdateTeamMemberAssignmentsResponseNonNullableFields, UpdateTeamMemberAssignmentsResponse$1 & UpdateTeamMemberAssignmentsResponseNonNullableFields$1>;
1752
-
1753
- declare const meta$1_getRolesInfo: typeof getRolesInfo;
1754
- declare const meta$1_removeMember: typeof removeMember;
1755
- declare const meta$1_searchTeam: typeof searchTeam;
1756
- declare const meta$1_updateTeamMemberAssignments: typeof updateTeamMemberAssignments;
1757
- declare namespace meta$1 {
1758
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_getRolesInfo as getRolesInfo, meta$1_removeMember as removeMember, meta$1_searchTeam as searchTeam, meta$1_updateTeamMemberAssignments as updateTeamMemberAssignments };
1759
- }
1760
-
1761
- interface ChangeContributorRoleRequest$1 {
1762
- /** Contributor's account ID. */
1763
- accountId: string;
1764
- /** New roles to assign to the contributor on the site. */
1765
- newRoles: SiteRoleAssignment$1[];
1766
- }
1767
- interface SiteRoleAssignment$1 {
1768
- /** 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. */
1769
- roleId?: string;
1770
- /**
1771
- * Assignment ID mapping the role to the contributor on the site.
1772
- * @readonly
1773
- */
1774
- assignmentId?: string;
1775
- }
1776
- interface ChangeContributorRoleResponse$1 {
1777
- /** New roles assigned to the contributor on the site. */
1778
- newAssignedRoles?: SiteRoleAssignment$1[];
1779
- }
1780
- interface QuerySiteContributorsRequest$1 {
1781
- filter?: QuerySiteContributorsFilter$1;
1782
- }
1783
- interface QuerySiteContributorsFilter$1 {
1784
- /** 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. */
1785
- policyIds?: string[];
1786
- }
1787
- interface QuerySiteContributorsResponse$1 {
1788
- /** List of site contributors. */
1789
- contributors?: ContributorV2$1[];
1790
- }
1791
- interface ContributorV2$1 {
1792
- /** Contributor's account ID. */
1793
- accountId?: string | null;
1794
- /** User ID of the owner of the account that the contributor has joined. */
1795
- accountOwnerId?: string | null;
1796
- }
1797
- interface SiteRoleAssignmentNonNullableFields$1 {
1798
- roleId: string;
1799
- assignmentId: string;
1800
- }
1801
- interface ChangeContributorRoleResponseNonNullableFields$1 {
1802
- newAssignedRoles: SiteRoleAssignmentNonNullableFields$1[];
1803
- }
1804
-
1805
- interface ChangeContributorRoleRequest {
1806
- /** Contributor's account ID. */
1807
- accountId: string;
1808
- /** New roles to assign to the contributor on the site. */
1809
- newRoles: SiteRoleAssignment[];
1810
- }
1811
- interface SiteRoleAssignment {
1812
- /** 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. */
1813
- roleId?: string;
1814
- /**
1815
- * Assignment ID mapping the role to the contributor on the site.
1816
- * @readonly
1817
- */
1818
- assignmentId?: string;
1819
- }
1820
- interface ChangeContributorRoleResponse {
1821
- /** New roles assigned to the contributor on the site. */
1822
- newAssignedRoles?: SiteRoleAssignment[];
1823
- }
1824
- interface QuerySiteContributorsRequest {
1825
- filter?: QuerySiteContributorsFilter;
1826
- }
1827
- interface QuerySiteContributorsFilter {
1828
- /** 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. */
1829
- policyIds?: string[];
1830
- }
1831
- interface QuerySiteContributorsResponse {
1832
- /** List of site contributors. */
1833
- contributors?: ContributorV2[];
1834
- }
1835
- interface ContributorV2 {
1836
- /** Contributor's account ID. */
1837
- accountId?: string | null;
1838
- /** User ID of the owner of the account that the contributor has joined. */
1839
- accountOwnerId?: string | null;
1840
- }
1841
- interface SiteRoleAssignmentNonNullableFields {
1842
- roleId: string;
1843
- assignmentId: string;
1844
- }
1845
- interface ChangeContributorRoleResponseNonNullableFields {
1846
- newAssignedRoles: SiteRoleAssignmentNonNullableFields[];
1847
- }
1848
-
1849
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1850
- getUrl: (context: any) => string;
1851
- httpMethod: K;
1852
- path: string;
1853
- pathParams: M;
1854
- __requestType: T;
1855
- __originalRequestType: S;
1856
- __responseType: Q;
1857
- __originalResponseType: R;
1858
- };
1859
- declare function changeRole(): __PublicMethodMetaInfo<'PUT', {}, ChangeContributorRoleRequest, ChangeContributorRoleRequest$1, ChangeContributorRoleResponse & ChangeContributorRoleResponseNonNullableFields, ChangeContributorRoleResponse$1 & ChangeContributorRoleResponseNonNullableFields$1>;
1860
- declare function querySiteContributors(): __PublicMethodMetaInfo<'GET', {}, QuerySiteContributorsRequest, QuerySiteContributorsRequest$1, QuerySiteContributorsResponse, QuerySiteContributorsResponse$1>;
1861
-
1862
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1863
- declare const meta_changeRole: typeof changeRole;
1864
- declare const meta_querySiteContributors: typeof querySiteContributors;
1865
- declare namespace meta {
1866
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_changeRole as changeRole, meta_querySiteContributors as querySiteContributors };
1867
- }
1868
-
1869
- export { meta$3 as accountInvites, meta$4 as accounts, meta as contributors, meta$2 as siteInvites, meta$1 as users };