@wix/user-management 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/context.d.ts +1 -0
- package/build/cjs/context.js +2 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +2 -1
- package/build/cjs/index.js +3 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +2 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +1 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +2 -1
- package/build/es/index.js +2 -1
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +4 -3
- package/type-bundles/context.bundle.d.ts +1453 -253
- package/type-bundles/index.bundle.d.ts +1453 -253
- package/type-bundles/meta.bundle.d.ts +806 -41
|
@@ -2,7 +2,7 @@ interface AccountV2$1 {
|
|
|
2
2
|
/** Account ID. */
|
|
3
3
|
accountId?: string;
|
|
4
4
|
}
|
|
5
|
-
interface Paging$
|
|
5
|
+
interface Paging$3 {
|
|
6
6
|
/** Number of items to load. */
|
|
7
7
|
limit?: number | null;
|
|
8
8
|
/** Number of items to skip in the current sort order. */
|
|
@@ -79,7 +79,7 @@ interface ListChildAccountsRequest$1 {
|
|
|
79
79
|
* Paging options to limit and offset the number of items.
|
|
80
80
|
* Default: 20. Max: 50.
|
|
81
81
|
*/
|
|
82
|
-
paging?: Paging$
|
|
82
|
+
paging?: Paging$3;
|
|
83
83
|
}
|
|
84
84
|
interface ListChildAccountsResponse$1 {
|
|
85
85
|
/** The requested child accounts. */
|
|
@@ -101,7 +101,7 @@ interface AccountV2 {
|
|
|
101
101
|
/** Account ID. */
|
|
102
102
|
accountId?: string;
|
|
103
103
|
}
|
|
104
|
-
interface Paging {
|
|
104
|
+
interface Paging$2 {
|
|
105
105
|
/** Number of items to load. */
|
|
106
106
|
limit?: number | null;
|
|
107
107
|
/** Number of items to skip in the current sort order. */
|
|
@@ -178,7 +178,7 @@ interface ListChildAccountsRequest {
|
|
|
178
178
|
* Paging options to limit and offset the number of items.
|
|
179
179
|
* Default: 20. Max: 50.
|
|
180
180
|
*/
|
|
181
|
-
paging?: Paging;
|
|
181
|
+
paging?: Paging$2;
|
|
182
182
|
}
|
|
183
183
|
interface ListChildAccountsResponse {
|
|
184
184
|
/** The requested child accounts. */
|
|
@@ -196,7 +196,7 @@ interface ListChildAccountsResponseNonNullableFields {
|
|
|
196
196
|
childAccounts: AccountV2NonNullableFields[];
|
|
197
197
|
}
|
|
198
198
|
|
|
199
|
-
type __PublicMethodMetaInfo$
|
|
199
|
+
type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
200
200
|
getUrl: (context: any) => string;
|
|
201
201
|
httpMethod: K;
|
|
202
202
|
path: string;
|
|
@@ -206,13 +206,13 @@ type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
206
206
|
__responseType: Q;
|
|
207
207
|
__originalResponseType: R;
|
|
208
208
|
};
|
|
209
|
-
declare function createAccount(): __PublicMethodMetaInfo$
|
|
210
|
-
declare function listChildAccounts(): __PublicMethodMetaInfo$
|
|
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
211
|
|
|
212
|
-
declare const meta$
|
|
213
|
-
declare const meta$
|
|
214
|
-
declare namespace meta$
|
|
215
|
-
export { type __PublicMethodMetaInfo$
|
|
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
216
|
}
|
|
217
217
|
|
|
218
218
|
interface AccountInvite$1 {
|
|
@@ -249,7 +249,7 @@ interface AccountInvite$1 {
|
|
|
249
249
|
* - **Declined:** The user has declined the invite.
|
|
250
250
|
* - **Expired:** The invite has expired without being accepted.
|
|
251
251
|
*/
|
|
252
|
-
status?: InviteStatus$
|
|
252
|
+
status?: InviteStatus$5;
|
|
253
253
|
/** Link to accept the invite. */
|
|
254
254
|
acceptLink?: string;
|
|
255
255
|
/**
|
|
@@ -274,7 +274,7 @@ interface AccountInvite$1 {
|
|
|
274
274
|
expirationDate?: Date | null;
|
|
275
275
|
}
|
|
276
276
|
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
277
|
-
declare enum InviteStatus$
|
|
277
|
+
declare enum InviteStatus$5 {
|
|
278
278
|
Pending = "Pending",
|
|
279
279
|
Used = "Used",
|
|
280
280
|
Deleted = "Deleted",
|
|
@@ -323,7 +323,7 @@ declare enum JoinedConditionOperator$1 {
|
|
|
323
323
|
OR = "OR",
|
|
324
324
|
AND = "AND"
|
|
325
325
|
}
|
|
326
|
-
declare enum SubjectType$
|
|
326
|
+
declare enum SubjectType$3 {
|
|
327
327
|
UNKNOWN = "UNKNOWN",
|
|
328
328
|
ACCOUNT = "ACCOUNT",
|
|
329
329
|
USER = "USER",
|
|
@@ -420,7 +420,7 @@ interface SubjectContextNonNullableFields$1 {
|
|
|
420
420
|
}
|
|
421
421
|
interface SubjectNonNullableFields$1 {
|
|
422
422
|
id: string;
|
|
423
|
-
subjectType: SubjectType$
|
|
423
|
+
subjectType: SubjectType$3;
|
|
424
424
|
context?: SubjectContextNonNullableFields$1;
|
|
425
425
|
}
|
|
426
426
|
interface DependOnOperatorNonNullableFields$1 {
|
|
@@ -459,7 +459,7 @@ interface AccountInviteNonNullableFields$1 {
|
|
|
459
459
|
email: string;
|
|
460
460
|
role: string;
|
|
461
461
|
inviterId: string;
|
|
462
|
-
status: InviteStatus$
|
|
462
|
+
status: InviteStatus$5;
|
|
463
463
|
acceptLink: string;
|
|
464
464
|
inviterAccountId: string;
|
|
465
465
|
policyIds: string[];
|
|
@@ -508,7 +508,7 @@ interface AccountInvite {
|
|
|
508
508
|
* - **Declined:** The user has declined the invite.
|
|
509
509
|
* - **Expired:** The invite has expired without being accepted.
|
|
510
510
|
*/
|
|
511
|
-
status?: InviteStatus$
|
|
511
|
+
status?: InviteStatus$4;
|
|
512
512
|
/** Link to accept the invite. */
|
|
513
513
|
acceptLink?: string;
|
|
514
514
|
/**
|
|
@@ -533,7 +533,7 @@ interface AccountInvite {
|
|
|
533
533
|
expirationDate?: Date | null;
|
|
534
534
|
}
|
|
535
535
|
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
536
|
-
declare enum InviteStatus$
|
|
536
|
+
declare enum InviteStatus$4 {
|
|
537
537
|
Pending = "Pending",
|
|
538
538
|
Used = "Used",
|
|
539
539
|
Deleted = "Deleted",
|
|
@@ -582,7 +582,7 @@ declare enum JoinedConditionOperator {
|
|
|
582
582
|
OR = "OR",
|
|
583
583
|
AND = "AND"
|
|
584
584
|
}
|
|
585
|
-
declare enum SubjectType {
|
|
585
|
+
declare enum SubjectType$2 {
|
|
586
586
|
UNKNOWN = "UNKNOWN",
|
|
587
587
|
ACCOUNT = "ACCOUNT",
|
|
588
588
|
USER = "USER",
|
|
@@ -679,7 +679,7 @@ interface SubjectContextNonNullableFields {
|
|
|
679
679
|
}
|
|
680
680
|
interface SubjectNonNullableFields {
|
|
681
681
|
_id: string;
|
|
682
|
-
subjectType: SubjectType;
|
|
682
|
+
subjectType: SubjectType$2;
|
|
683
683
|
context?: SubjectContextNonNullableFields;
|
|
684
684
|
}
|
|
685
685
|
interface DependOnOperatorNonNullableFields {
|
|
@@ -718,7 +718,7 @@ interface AccountInviteNonNullableFields {
|
|
|
718
718
|
email: string;
|
|
719
719
|
role: string;
|
|
720
720
|
inviterId: string;
|
|
721
|
-
status: InviteStatus$
|
|
721
|
+
status: InviteStatus$4;
|
|
722
722
|
acceptLink: string;
|
|
723
723
|
inviterAccountId: string;
|
|
724
724
|
policyIds: string[];
|
|
@@ -733,7 +733,7 @@ interface CreateInviteResponseNonNullableFields {
|
|
|
733
733
|
failedInvites: InviteFailureNonNullableFields[];
|
|
734
734
|
}
|
|
735
735
|
|
|
736
|
-
type __PublicMethodMetaInfo$
|
|
736
|
+
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
737
737
|
getUrl: (context: any) => string;
|
|
738
738
|
httpMethod: K;
|
|
739
739
|
path: string;
|
|
@@ -743,11 +743,11 @@ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
743
743
|
__responseType: Q;
|
|
744
744
|
__originalResponseType: R;
|
|
745
745
|
};
|
|
746
|
-
declare function createInvite(): __PublicMethodMetaInfo$
|
|
746
|
+
declare function createInvite(): __PublicMethodMetaInfo$3<'POST', {}, CreateInviteRequest, CreateInviteRequest$1, CreateInviteResponse & CreateInviteResponseNonNullableFields, CreateInviteResponse$1 & CreateInviteResponseNonNullableFields$1>;
|
|
747
747
|
|
|
748
|
-
declare const meta$
|
|
749
|
-
declare namespace meta$
|
|
750
|
-
export { type __PublicMethodMetaInfo$
|
|
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
751
|
}
|
|
752
752
|
|
|
753
753
|
interface SiteInvite$1 {
|
|
@@ -781,7 +781,7 @@ interface SiteInvite$1 {
|
|
|
781
781
|
* - **Declined:** The user declined the invite.
|
|
782
782
|
* - **Expired:** The invite has expired without being accepted.
|
|
783
783
|
*/
|
|
784
|
-
status?: InviteStatus$
|
|
784
|
+
status?: InviteStatus$3;
|
|
785
785
|
/** Link to accept the invite. */
|
|
786
786
|
acceptLink?: string;
|
|
787
787
|
/**
|
|
@@ -802,7 +802,7 @@ interface SiteInvite$1 {
|
|
|
802
802
|
expirationDate?: Date | null;
|
|
803
803
|
}
|
|
804
804
|
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
805
|
-
declare enum InviteStatus$
|
|
805
|
+
declare enum InviteStatus$3 {
|
|
806
806
|
Pending = "Pending",
|
|
807
807
|
Used = "Used",
|
|
808
808
|
Deleted = "Deleted",
|
|
@@ -847,7 +847,7 @@ interface SiteInviteNonNullableFields$1 {
|
|
|
847
847
|
email: string;
|
|
848
848
|
policyIds: string[];
|
|
849
849
|
inviterId: string;
|
|
850
|
-
status: InviteStatus$
|
|
850
|
+
status: InviteStatus$3;
|
|
851
851
|
acceptLink: string;
|
|
852
852
|
inviterAccountId: string;
|
|
853
853
|
}
|
|
@@ -890,7 +890,7 @@ interface SiteInvite {
|
|
|
890
890
|
* - **Declined:** The user declined the invite.
|
|
891
891
|
* - **Expired:** The invite has expired without being accepted.
|
|
892
892
|
*/
|
|
893
|
-
status?: InviteStatus;
|
|
893
|
+
status?: InviteStatus$2;
|
|
894
894
|
/** Link to accept the invite. */
|
|
895
895
|
acceptLink?: string;
|
|
896
896
|
/**
|
|
@@ -911,7 +911,7 @@ interface SiteInvite {
|
|
|
911
911
|
expirationDate?: Date | null;
|
|
912
912
|
}
|
|
913
913
|
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
914
|
-
declare enum InviteStatus {
|
|
914
|
+
declare enum InviteStatus$2 {
|
|
915
915
|
Pending = "Pending",
|
|
916
916
|
Used = "Used",
|
|
917
917
|
Deleted = "Deleted",
|
|
@@ -956,7 +956,7 @@ interface SiteInviteNonNullableFields {
|
|
|
956
956
|
email: string;
|
|
957
957
|
policyIds: string[];
|
|
958
958
|
inviterId: string;
|
|
959
|
-
status: InviteStatus;
|
|
959
|
+
status: InviteStatus$2;
|
|
960
960
|
acceptLink: string;
|
|
961
961
|
inviterAccountId: string;
|
|
962
962
|
}
|
|
@@ -968,7 +968,7 @@ interface SiteInviteResponseNonNullableFields {
|
|
|
968
968
|
invite?: SiteInviteNonNullableFields;
|
|
969
969
|
}
|
|
970
970
|
|
|
971
|
-
type __PublicMethodMetaInfo$
|
|
971
|
+
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
972
972
|
getUrl: (context: any) => string;
|
|
973
973
|
httpMethod: K;
|
|
974
974
|
path: string;
|
|
@@ -978,19 +978,784 @@ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
978
978
|
__responseType: Q;
|
|
979
979
|
__originalResponseType: R;
|
|
980
980
|
};
|
|
981
|
-
declare function bulkInvite(): __PublicMethodMetaInfo$
|
|
982
|
-
declare function resendInvite(): __PublicMethodMetaInfo$
|
|
981
|
+
declare function bulkInvite(): __PublicMethodMetaInfo$2<'POST', {}, BulkSiteInviteRequest, BulkSiteInviteRequest$1, BulkSiteInviteResponse & BulkSiteInviteResponseNonNullableFields, BulkSiteInviteResponse$1 & BulkSiteInviteResponseNonNullableFields$1>;
|
|
982
|
+
declare function resendInvite(): __PublicMethodMetaInfo$2<'POST', {
|
|
983
983
|
inviteId: string;
|
|
984
984
|
}, ResendSiteInviteRequest, ResendSiteInviteRequest$1, SiteInviteResponse & SiteInviteResponseNonNullableFields, SiteInviteResponse$1 & SiteInviteResponseNonNullableFields$1>;
|
|
985
|
-
declare function revokeInvite(): __PublicMethodMetaInfo$
|
|
985
|
+
declare function revokeInvite(): __PublicMethodMetaInfo$2<'POST', {
|
|
986
986
|
inviteId: string;
|
|
987
987
|
}, RevokeSiteInviteRequest, RevokeSiteInviteRequest$1, RevokeSiteInviteResponse, RevokeSiteInviteResponse$1>;
|
|
988
988
|
|
|
989
|
-
declare const meta$
|
|
990
|
-
declare const meta$
|
|
991
|
-
declare const meta$
|
|
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;
|
|
992
1757
|
declare namespace meta$1 {
|
|
993
|
-
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$
|
|
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 };
|
|
994
1759
|
}
|
|
995
1760
|
|
|
996
1761
|
interface ChangeContributorRoleRequest$1 {
|
|
@@ -1101,4 +1866,4 @@ declare namespace meta {
|
|
|
1101
1866
|
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_changeRole as changeRole, meta_querySiteContributors as querySiteContributors };
|
|
1102
1867
|
}
|
|
1103
1868
|
|
|
1104
|
-
export { meta$
|
|
1869
|
+
export { meta$3 as accountInvites, meta$4 as accounts, meta as contributors, meta$2 as siteInvites, meta$1 as users };
|