@wix/auto_sdk_user-management_users 1.0.7 → 1.0.8
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/src/identity-roles-v1-user-users.universal.d.ts → identity-roles-v1-user-users.universal-CDQCBpHX.d.mts} +155 -195
- package/build/{es/src/identity-roles-v1-user-users.universal.d.ts → identity-roles-v1-user-users.universal-CDQCBpHX.d.ts} +155 -195
- package/build/index.d.mts +48 -0
- package/build/index.d.ts +48 -0
- package/build/index.js +625 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +578 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/identity-roles-v1-user-users.universal.d.ts → identity-roles-v1-user-users.universal-CnEmCMhq.d.mts} +155 -209
- package/build/internal/{es/src/identity-roles-v1-user-users.universal.d.ts → identity-roles-v1-user-users.universal-CnEmCMhq.d.ts} +155 -209
- package/build/internal/index.d.mts +60 -0
- package/build/internal/index.d.ts +60 -0
- package/build/internal/index.js +625 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +578 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +377 -0
- package/build/internal/meta.d.ts +377 -0
- package/build/internal/meta.js +357 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +326 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +377 -0
- package/build/meta.d.ts +377 -0
- package/build/meta.js +357 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +326 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.context.d.ts +0 -8
- package/build/cjs/src/identity-roles-v1-user-users.context.js +0 -32
- package/build/cjs/src/identity-roles-v1-user-users.context.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.http.d.ts +0 -26
- package/build/cjs/src/identity-roles-v1-user-users.http.js +0 -254
- package/build/cjs/src/identity-roles-v1-user-users.http.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.meta.d.ts +0 -17
- package/build/cjs/src/identity-roles-v1-user-users.meta.js +0 -123
- package/build/cjs/src/identity-roles-v1-user-users.meta.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.public.d.ts +0 -43
- package/build/cjs/src/identity-roles-v1-user-users.public.js +0 -57
- package/build/cjs/src/identity-roles-v1-user-users.public.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.types.d.ts +0 -1040
- package/build/cjs/src/identity-roles-v1-user-users.types.js +0 -140
- package/build/cjs/src/identity-roles-v1-user-users.types.js.map +0 -1
- package/build/cjs/src/identity-roles-v1-user-users.universal.js +0 -359
- package/build/cjs/src/identity-roles-v1-user-users.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/identity-roles-v1-user-users.context.d.ts +0 -8
- package/build/es/src/identity-roles-v1-user-users.context.js +0 -10
- package/build/es/src/identity-roles-v1-user-users.context.js.map +0 -1
- package/build/es/src/identity-roles-v1-user-users.http.d.ts +0 -26
- package/build/es/src/identity-roles-v1-user-users.http.js +0 -246
- package/build/es/src/identity-roles-v1-user-users.http.js.map +0 -1
- package/build/es/src/identity-roles-v1-user-users.meta.d.ts +0 -17
- package/build/es/src/identity-roles-v1-user-users.meta.js +0 -92
- package/build/es/src/identity-roles-v1-user-users.meta.js.map +0 -1
- package/build/es/src/identity-roles-v1-user-users.public.d.ts +0 -43
- package/build/es/src/identity-roles-v1-user-users.public.js +0 -30
- package/build/es/src/identity-roles-v1-user-users.public.js.map +0 -1
- package/build/es/src/identity-roles-v1-user-users.types.d.ts +0 -1040
- package/build/es/src/identity-roles-v1-user-users.types.js +0 -137
- package/build/es/src/identity-roles-v1-user-users.types.js.map +0 -1
- package/build/es/src/identity-roles-v1-user-users.universal.js +0 -328
- package/build/es/src/identity-roles-v1-user-users.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.context.d.ts +0 -10
- package/build/internal/cjs/src/identity-roles-v1-user-users.context.js +0 -32
- package/build/internal/cjs/src/identity-roles-v1-user-users.context.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.http.d.ts +0 -26
- package/build/internal/cjs/src/identity-roles-v1-user-users.http.js +0 -254
- package/build/internal/cjs/src/identity-roles-v1-user-users.http.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.meta.d.ts +0 -17
- package/build/internal/cjs/src/identity-roles-v1-user-users.meta.js +0 -123
- package/build/internal/cjs/src/identity-roles-v1-user-users.meta.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.public.d.ts +0 -53
- package/build/internal/cjs/src/identity-roles-v1-user-users.public.js +0 -57
- package/build/internal/cjs/src/identity-roles-v1-user-users.public.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.types.d.ts +0 -1040
- package/build/internal/cjs/src/identity-roles-v1-user-users.types.js +0 -140
- package/build/internal/cjs/src/identity-roles-v1-user-users.types.js.map +0 -1
- package/build/internal/cjs/src/identity-roles-v1-user-users.universal.js +0 -359
- package/build/internal/cjs/src/identity-roles-v1-user-users.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.context.d.ts +0 -10
- package/build/internal/es/src/identity-roles-v1-user-users.context.js +0 -10
- package/build/internal/es/src/identity-roles-v1-user-users.context.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.http.d.ts +0 -26
- package/build/internal/es/src/identity-roles-v1-user-users.http.js +0 -246
- package/build/internal/es/src/identity-roles-v1-user-users.http.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.meta.d.ts +0 -17
- package/build/internal/es/src/identity-roles-v1-user-users.meta.js +0 -92
- package/build/internal/es/src/identity-roles-v1-user-users.meta.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.public.d.ts +0 -53
- package/build/internal/es/src/identity-roles-v1-user-users.public.js +0 -30
- package/build/internal/es/src/identity-roles-v1-user-users.public.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.types.d.ts +0 -1040
- package/build/internal/es/src/identity-roles-v1-user-users.types.js +0 -137
- package/build/internal/es/src/identity-roles-v1-user-users.types.js.map +0 -1
- package/build/internal/es/src/identity-roles-v1-user-users.universal.js +0 -328
- package/build/internal/es/src/identity-roles-v1-user-users.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface User {
|
|
1
|
+
interface User {
|
|
3
2
|
/** User ID. */
|
|
4
3
|
_id?: string;
|
|
5
4
|
/**
|
|
@@ -23,13 +22,13 @@ export interface User {
|
|
|
23
22
|
/** Resources the user can access. */
|
|
24
23
|
assignments?: Assignment[];
|
|
25
24
|
}
|
|
26
|
-
|
|
25
|
+
interface Name {
|
|
27
26
|
/** User's first name. */
|
|
28
27
|
firstName?: string;
|
|
29
28
|
/** User's last name. */
|
|
30
29
|
lastName?: string;
|
|
31
30
|
}
|
|
32
|
-
|
|
31
|
+
interface Assignment {
|
|
33
32
|
/** Role assigned to the user. */
|
|
34
33
|
policy?: AssignedPolicy;
|
|
35
34
|
/** Unique ID for this specific assignment. */
|
|
@@ -37,7 +36,7 @@ export interface Assignment {
|
|
|
37
36
|
/** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
|
|
38
37
|
subject?: Subject;
|
|
39
38
|
}
|
|
40
|
-
|
|
39
|
+
interface AssignedPolicy {
|
|
41
40
|
/** Role ID. */
|
|
42
41
|
policyId?: string;
|
|
43
42
|
/** Role title. */
|
|
@@ -45,7 +44,7 @@ export interface AssignedPolicy {
|
|
|
45
44
|
/** Role description. */
|
|
46
45
|
description?: string | null;
|
|
47
46
|
}
|
|
48
|
-
|
|
47
|
+
interface Restriction extends RestrictionRestrictionsOneOf {
|
|
49
48
|
/**
|
|
50
49
|
* Deprecated.
|
|
51
50
|
* @deprecated
|
|
@@ -59,7 +58,7 @@ export interface Restriction extends RestrictionRestrictionsOneOf {
|
|
|
59
58
|
locations?: LocationsRestriction;
|
|
60
59
|
}
|
|
61
60
|
/** @oneof */
|
|
62
|
-
|
|
61
|
+
interface RestrictionRestrictionsOneOf {
|
|
63
62
|
/**
|
|
64
63
|
* Deprecated.
|
|
65
64
|
* @deprecated
|
|
@@ -72,24 +71,24 @@ export interface RestrictionRestrictionsOneOf {
|
|
|
72
71
|
/** Location where the assignment restrictions apply. */
|
|
73
72
|
locations?: LocationsRestriction;
|
|
74
73
|
}
|
|
75
|
-
|
|
74
|
+
interface ApiResource {
|
|
76
75
|
/** Resource type. */
|
|
77
76
|
resourceType?: ResourceTypeWithLiterals;
|
|
78
77
|
/** Resource ID. */
|
|
79
78
|
_id?: string;
|
|
80
79
|
value?: string | null;
|
|
81
80
|
}
|
|
82
|
-
|
|
81
|
+
declare enum ResourceType {
|
|
83
82
|
UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
|
|
84
83
|
SITE = "SITE"
|
|
85
84
|
}
|
|
86
85
|
/** @enumType */
|
|
87
|
-
|
|
88
|
-
|
|
86
|
+
type ResourceTypeWithLiterals = ResourceType | 'UNKNOWN_RESOURCE_TYPE' | 'SITE';
|
|
87
|
+
interface Conditions {
|
|
89
88
|
/** List of conditions. */
|
|
90
89
|
conditions?: ApiCondition[];
|
|
91
90
|
}
|
|
92
|
-
|
|
91
|
+
interface ApiCondition {
|
|
93
92
|
/** Condition type. */
|
|
94
93
|
conditionType?: ConditionAttributeTypeWithLiterals;
|
|
95
94
|
/** Condition ID. */
|
|
@@ -97,25 +96,25 @@ export interface ApiCondition {
|
|
|
97
96
|
/** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
|
|
98
97
|
value?: string | null;
|
|
99
98
|
}
|
|
100
|
-
|
|
99
|
+
declare enum ConditionAttributeType {
|
|
101
100
|
UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
|
|
102
101
|
FOLDER = "FOLDER"
|
|
103
102
|
}
|
|
104
103
|
/** @enumType */
|
|
105
|
-
|
|
106
|
-
|
|
104
|
+
type ConditionAttributeTypeWithLiterals = ConditionAttributeType | 'UNKNOWN_CONDITION_TYPE' | 'FOLDER';
|
|
105
|
+
interface SiteRestriction {
|
|
107
106
|
/** Site ID. */
|
|
108
107
|
_id?: string;
|
|
109
108
|
/** Site name. */
|
|
110
109
|
value?: string | null;
|
|
111
110
|
}
|
|
112
|
-
|
|
111
|
+
interface CompanionResource {
|
|
113
112
|
/** Asset ID (referred to here as resource ID). */
|
|
114
113
|
_id?: string;
|
|
115
114
|
/** Asset type (referred to here as resource type). as predefined in the authorization system */
|
|
116
115
|
resourceType?: string;
|
|
117
116
|
}
|
|
118
|
-
|
|
117
|
+
interface LocationsRestriction {
|
|
119
118
|
/**
|
|
120
119
|
* Location IDs.
|
|
121
120
|
* @format GUID
|
|
@@ -123,7 +122,7 @@ export interface LocationsRestriction {
|
|
|
123
122
|
*/
|
|
124
123
|
ids?: string[];
|
|
125
124
|
}
|
|
126
|
-
|
|
125
|
+
interface Subject {
|
|
127
126
|
/** ID of identity assigned to the asset. */
|
|
128
127
|
_id?: string;
|
|
129
128
|
/** Type of identity assigned to the asset. Supported subject types include user IDs, account IDs, and app IDs. */
|
|
@@ -131,7 +130,7 @@ export interface Subject {
|
|
|
131
130
|
/** Context of identity assigned to the asset. For example, a `subjectType` = `USER` will have `context` = `ACCOUNT`. */
|
|
132
131
|
context?: SubjectContext;
|
|
133
132
|
}
|
|
134
|
-
|
|
133
|
+
declare enum SubjectType {
|
|
135
134
|
UNKNOWN = "UNKNOWN",
|
|
136
135
|
ACCOUNT = "ACCOUNT",
|
|
137
136
|
USER = "USER",
|
|
@@ -143,32 +142,32 @@ export declare enum SubjectType {
|
|
|
143
142
|
WIX_APP = "WIX_APP"
|
|
144
143
|
}
|
|
145
144
|
/** @enumType */
|
|
146
|
-
|
|
147
|
-
|
|
145
|
+
type SubjectTypeWithLiterals = SubjectType | 'UNKNOWN' | 'ACCOUNT' | 'USER' | 'USER_GROUP' | 'MEMBER_GROUP' | 'VISITOR_GROUP' | 'EXTERNAL_APP' | 'ACCOUNT_GROUP' | 'WIX_APP';
|
|
146
|
+
interface SubjectContext {
|
|
148
147
|
_id?: string;
|
|
149
148
|
contextType?: SubjectContextTypeWithLiterals;
|
|
150
149
|
}
|
|
151
|
-
|
|
150
|
+
declare enum SubjectContextType {
|
|
152
151
|
UNKNOWN_CTX = "UNKNOWN_CTX",
|
|
153
152
|
ORG_CTX = "ORG_CTX",
|
|
154
153
|
ACCOUNT_CTX = "ACCOUNT_CTX"
|
|
155
154
|
}
|
|
156
155
|
/** @enumType */
|
|
157
|
-
|
|
158
|
-
|
|
156
|
+
type SubjectContextTypeWithLiterals = SubjectContextType | 'UNKNOWN_CTX' | 'ORG_CTX' | 'ACCOUNT_CTX';
|
|
157
|
+
interface GetTeamRequest {
|
|
159
158
|
/** @deprecated */
|
|
160
159
|
usersLimit?: number | null;
|
|
161
160
|
/** The locale of the request. Defaults to en */
|
|
162
161
|
locale?: string | null;
|
|
163
162
|
paging?: Paging;
|
|
164
163
|
}
|
|
165
|
-
|
|
164
|
+
interface Paging {
|
|
166
165
|
/** Number of items to load. */
|
|
167
166
|
limit?: number | null;
|
|
168
167
|
/** Number of items to skip in the current sort order. */
|
|
169
168
|
offset?: number | null;
|
|
170
169
|
}
|
|
171
|
-
|
|
170
|
+
interface GetTeamResponse {
|
|
172
171
|
users?: User[];
|
|
173
172
|
invites?: AccountInvite[];
|
|
174
173
|
accountInfo?: AccountInfo;
|
|
@@ -179,7 +178,7 @@ export interface GetTeamResponse {
|
|
|
179
178
|
totalUsersInAccount?: string;
|
|
180
179
|
predefinedRoles?: PredefinedRoles;
|
|
181
180
|
}
|
|
182
|
-
|
|
181
|
+
interface AccountInvite {
|
|
183
182
|
/**
|
|
184
183
|
* Invite ID.
|
|
185
184
|
* @format GUID
|
|
@@ -245,7 +244,7 @@ export interface AccountInvite {
|
|
|
245
244
|
expirationDate?: Date | null;
|
|
246
245
|
}
|
|
247
246
|
/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
|
|
248
|
-
|
|
247
|
+
declare enum InviteStatus {
|
|
249
248
|
Pending = "Pending",
|
|
250
249
|
Used = "Used",
|
|
251
250
|
Deleted = "Deleted",
|
|
@@ -253,57 +252,57 @@ export declare enum InviteStatus {
|
|
|
253
252
|
Expired = "Expired"
|
|
254
253
|
}
|
|
255
254
|
/** @enumType */
|
|
256
|
-
|
|
257
|
-
|
|
255
|
+
type InviteStatusWithLiterals = InviteStatus | 'Pending' | 'Used' | 'Deleted' | 'Declined' | 'Expired';
|
|
256
|
+
interface InviteResourceAssignment {
|
|
258
257
|
/** Role ID. */
|
|
259
258
|
policyId?: string;
|
|
260
259
|
/** Resources the user will be able to access. */
|
|
261
260
|
assignments?: InviteAssignment[];
|
|
262
261
|
}
|
|
263
|
-
|
|
262
|
+
interface InviteAssignment {
|
|
264
263
|
/** Full name of resource to be assigned. */
|
|
265
264
|
fullNameResource?: FullNameResource;
|
|
266
265
|
}
|
|
267
|
-
|
|
266
|
+
interface FullNameResource extends FullNameResourceResourceContextOneOf {
|
|
268
267
|
/** Specific site details. */
|
|
269
268
|
siteContext?: SiteResourceContext;
|
|
270
269
|
/** Specific account details. */
|
|
271
270
|
accountContext?: AccountResourceContext;
|
|
272
271
|
}
|
|
273
272
|
/** @oneof */
|
|
274
|
-
|
|
273
|
+
interface FullNameResourceResourceContextOneOf {
|
|
275
274
|
/** Specific site details. */
|
|
276
275
|
siteContext?: SiteResourceContext;
|
|
277
276
|
/** Specific account details. */
|
|
278
277
|
accountContext?: AccountResourceContext;
|
|
279
278
|
}
|
|
280
279
|
/** 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) */
|
|
281
|
-
|
|
280
|
+
interface SiteResourceContext {
|
|
282
281
|
/** Site ID. */
|
|
283
282
|
metasiteId?: string;
|
|
284
283
|
}
|
|
285
284
|
/** 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) */
|
|
286
|
-
|
|
285
|
+
interface AccountResourceContext {
|
|
287
286
|
/** Account ID. */
|
|
288
287
|
accountId?: string;
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface OrganizationResourceContext {
|
|
291
290
|
}
|
|
292
291
|
/**
|
|
293
292
|
* A custom resource. Is used to represent some asset that is not a direct resource context (site or account), but something custom.
|
|
294
293
|
* For example: payment method, blog post, domain, logo.
|
|
295
294
|
*/
|
|
296
|
-
|
|
295
|
+
interface Resource {
|
|
297
296
|
/** The resource id. */
|
|
298
297
|
_id?: string | null;
|
|
299
298
|
/** The resource type */
|
|
300
299
|
type?: string | null;
|
|
301
300
|
}
|
|
302
|
-
|
|
301
|
+
interface PolicyCondition {
|
|
303
302
|
/** The type of the condition */
|
|
304
303
|
condition?: ConditionType;
|
|
305
304
|
}
|
|
306
|
-
|
|
305
|
+
interface ConditionType extends ConditionTypeOfOneOf {
|
|
307
306
|
/** @deprecated */
|
|
308
307
|
simpleCondition?: SimpleCondition;
|
|
309
308
|
/** A logic combination between several conditions, with an operator between them */
|
|
@@ -314,7 +313,7 @@ export interface ConditionType extends ConditionTypeOfOneOf {
|
|
|
314
313
|
condition?: Condition;
|
|
315
314
|
}
|
|
316
315
|
/** @oneof */
|
|
317
|
-
|
|
316
|
+
interface ConditionTypeOfOneOf {
|
|
318
317
|
/** @deprecated */
|
|
319
318
|
simpleCondition?: SimpleCondition;
|
|
320
319
|
/** A logic combination between several conditions, with an operator between them */
|
|
@@ -324,61 +323,61 @@ export interface ConditionTypeOfOneOf {
|
|
|
324
323
|
/** A single condition */
|
|
325
324
|
condition?: Condition;
|
|
326
325
|
}
|
|
327
|
-
|
|
326
|
+
interface SimpleCondition {
|
|
328
327
|
attrName?: string;
|
|
329
328
|
value?: SimpleConditionValue;
|
|
330
329
|
op?: SimpleConditionOperatorWithLiterals;
|
|
331
330
|
conditionModelId?: string;
|
|
332
331
|
}
|
|
333
|
-
|
|
332
|
+
interface SimpleConditionValue extends SimpleConditionValueValueOneOf {
|
|
334
333
|
attrName?: string;
|
|
335
334
|
stringValue?: string;
|
|
336
335
|
boolValue?: boolean;
|
|
337
336
|
}
|
|
338
337
|
/** @oneof */
|
|
339
|
-
|
|
338
|
+
interface SimpleConditionValueValueOneOf {
|
|
340
339
|
attrName?: string;
|
|
341
340
|
stringValue?: string;
|
|
342
341
|
boolValue?: boolean;
|
|
343
342
|
}
|
|
344
|
-
|
|
343
|
+
declare enum SimpleConditionOperator {
|
|
345
344
|
UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP",
|
|
346
345
|
EQUAL = "EQUAL"
|
|
347
346
|
}
|
|
348
347
|
/** @enumType */
|
|
349
|
-
|
|
350
|
-
|
|
348
|
+
type SimpleConditionOperatorWithLiterals = SimpleConditionOperator | 'UNKNOWN_SIMPLE_OP' | 'EQUAL';
|
|
349
|
+
interface JoinedCondition {
|
|
351
350
|
/** The operator that should be used when evaluating the condition */
|
|
352
351
|
op?: JoinedConditionOperatorWithLiterals;
|
|
353
352
|
/** The conditions that should be evaluated, and then joined using the operator provided */
|
|
354
353
|
conditions?: ConditionType[];
|
|
355
354
|
}
|
|
356
|
-
|
|
355
|
+
declare enum JoinedConditionOperator {
|
|
357
356
|
UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP",
|
|
358
357
|
OR = "OR",
|
|
359
358
|
AND = "AND"
|
|
360
359
|
}
|
|
361
360
|
/** @enumType */
|
|
362
|
-
|
|
363
|
-
|
|
361
|
+
type JoinedConditionOperatorWithLiterals = JoinedConditionOperator | 'UNKNOWN_JOIN_OP' | 'OR' | 'AND';
|
|
362
|
+
interface EnvironmentCondition extends EnvironmentConditionConditionOneOf {
|
|
364
363
|
experimentCondition?: ExperimentCondition;
|
|
365
364
|
}
|
|
366
365
|
/** @oneof */
|
|
367
|
-
|
|
366
|
+
interface EnvironmentConditionConditionOneOf {
|
|
368
367
|
experimentCondition?: ExperimentCondition;
|
|
369
368
|
}
|
|
370
|
-
|
|
369
|
+
interface ExperimentCondition {
|
|
371
370
|
spec?: string;
|
|
372
371
|
fallbackValue?: string;
|
|
373
372
|
expectedValue?: string;
|
|
374
373
|
}
|
|
375
|
-
|
|
374
|
+
interface Condition {
|
|
376
375
|
/** The unique identifier of the condition model. Indicates which actions the condition is working on */
|
|
377
376
|
conditionModelId?: string;
|
|
378
377
|
/** The operator that should be evaluated */
|
|
379
378
|
operator?: ConditionOperator;
|
|
380
379
|
}
|
|
381
|
-
|
|
380
|
+
interface ConditionOperator extends ConditionOperatorOperatorsOneOf {
|
|
382
381
|
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
383
382
|
equals?: EqualOperator;
|
|
384
383
|
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
@@ -389,7 +388,7 @@ export interface ConditionOperator extends ConditionOperatorOperatorsOneOf {
|
|
|
389
388
|
dependOn?: DependOnOperator;
|
|
390
389
|
}
|
|
391
390
|
/** @oneof */
|
|
392
|
-
|
|
391
|
+
interface ConditionOperatorOperatorsOneOf {
|
|
393
392
|
/** Comparison of equality - will be evaluated to true if the given parties are equal */
|
|
394
393
|
equals?: EqualOperator;
|
|
395
394
|
/** Regex operator - will be evaluated to true if the given value matches the provided regex */
|
|
@@ -399,13 +398,13 @@ export interface ConditionOperatorOperatorsOneOf {
|
|
|
399
398
|
/** Operator that indicates a dependency on another subject being allowed to perform something. */
|
|
400
399
|
dependOn?: DependOnOperator;
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface EqualOperator {
|
|
403
402
|
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the other side (attribute/value) */
|
|
404
403
|
attrName?: string;
|
|
405
404
|
/** The value to compare to. If the two parties are equal - we will return true. */
|
|
406
405
|
value?: ConditionValue;
|
|
407
406
|
}
|
|
408
|
-
|
|
407
|
+
interface ConditionValue extends ConditionValueValueOneOf {
|
|
409
408
|
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
410
409
|
attrName?: string;
|
|
411
410
|
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
@@ -414,7 +413,7 @@ export interface ConditionValue extends ConditionValueValueOneOf {
|
|
|
414
413
|
boolValue?: boolean;
|
|
415
414
|
}
|
|
416
415
|
/** @oneof */
|
|
417
|
-
|
|
416
|
+
interface ConditionValueValueOneOf {
|
|
418
417
|
/** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */
|
|
419
418
|
attrName?: string;
|
|
420
419
|
/** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
@@ -422,13 +421,13 @@ export interface ConditionValueValueOneOf {
|
|
|
422
421
|
/** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */
|
|
423
422
|
boolValue?: boolean;
|
|
424
423
|
}
|
|
425
|
-
|
|
424
|
+
interface LikeOperator {
|
|
426
425
|
/** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the regex values provided. */
|
|
427
426
|
attrName?: string;
|
|
428
427
|
/** The regex values which the attribute value should be evaluated on. If the attribute value matches at least one of the regular expressions provided - we will return true */
|
|
429
428
|
values?: string[];
|
|
430
429
|
}
|
|
431
|
-
|
|
430
|
+
interface ExperimentOperator {
|
|
432
431
|
/** The spec to conduct the experiment on. */
|
|
433
432
|
spec?: string;
|
|
434
433
|
/** The value to use if the experiment could not be conducted */
|
|
@@ -437,32 +436,32 @@ export interface ExperimentOperator {
|
|
|
437
436
|
expectedValue?: string;
|
|
438
437
|
}
|
|
439
438
|
/** Implies that the policy takes affect only if the depend on subject is permitted as well. */
|
|
440
|
-
|
|
439
|
+
interface DependOnOperator {
|
|
441
440
|
/** The subject on which the current entry depends on. If the subject is allowed to perform what the query was about - the condition will be evaluated to true. Otherwise - false */
|
|
442
441
|
dependOnSubject?: Subject;
|
|
443
442
|
}
|
|
444
|
-
|
|
443
|
+
interface AccountInfo {
|
|
445
444
|
accountName?: string;
|
|
446
445
|
accountImage?: string;
|
|
447
446
|
isTeam?: boolean;
|
|
448
447
|
}
|
|
449
|
-
|
|
448
|
+
interface ApiPolicy {
|
|
450
449
|
_id?: string;
|
|
451
450
|
description?: string | null;
|
|
452
451
|
name?: string | null;
|
|
453
452
|
isCustom?: boolean;
|
|
454
453
|
scopes?: string[];
|
|
455
454
|
}
|
|
456
|
-
|
|
455
|
+
interface PredefinedRoles {
|
|
457
456
|
roles?: PredefinedRole[];
|
|
458
457
|
}
|
|
459
|
-
|
|
458
|
+
interface PredefinedRole {
|
|
460
459
|
titleKey?: string;
|
|
461
460
|
roles?: Role[];
|
|
462
461
|
title?: string | null;
|
|
463
462
|
areaId?: string;
|
|
464
463
|
}
|
|
465
|
-
|
|
464
|
+
interface Role {
|
|
466
465
|
_id?: string;
|
|
467
466
|
deprecatedKey?: string;
|
|
468
467
|
/** @deprecated */
|
|
@@ -481,7 +480,7 @@ export interface Role {
|
|
|
481
480
|
availableConditions?: ConditionAttributeTypeWithLiterals[];
|
|
482
481
|
limitToEditorTypes?: string[];
|
|
483
482
|
}
|
|
484
|
-
|
|
483
|
+
interface ChangeRoleRequest {
|
|
485
484
|
/** User ID. */
|
|
486
485
|
_id?: string;
|
|
487
486
|
/**
|
|
@@ -492,37 +491,37 @@ export interface ChangeRoleRequest {
|
|
|
492
491
|
/** Role IDs to be assigned. */
|
|
493
492
|
policyIds?: string[];
|
|
494
493
|
}
|
|
495
|
-
|
|
494
|
+
interface ChangeRoleResponse {
|
|
496
495
|
}
|
|
497
|
-
|
|
496
|
+
interface RemoveMemberRequest {
|
|
498
497
|
/** User ID of the team member to remove. */
|
|
499
498
|
userId: string;
|
|
500
499
|
}
|
|
501
|
-
|
|
500
|
+
interface RemoveMemberResponse {
|
|
502
501
|
}
|
|
503
|
-
|
|
502
|
+
interface GetUsersRequest {
|
|
504
503
|
/** The number of items to load */
|
|
505
504
|
limit?: number | null;
|
|
506
505
|
/** number of items to skip in the current sort order */
|
|
507
506
|
offset?: number | null;
|
|
508
507
|
}
|
|
509
|
-
|
|
508
|
+
interface GetUsersResponse {
|
|
510
509
|
users?: User[];
|
|
511
510
|
}
|
|
512
|
-
|
|
511
|
+
interface GetScopesRequest {
|
|
513
512
|
/** The locale of the request. Defaults to en */
|
|
514
513
|
locale?: string | null;
|
|
515
514
|
}
|
|
516
|
-
|
|
515
|
+
interface GetScopesResponse {
|
|
517
516
|
scopeAreas?: ScopeArea[];
|
|
518
517
|
}
|
|
519
|
-
|
|
518
|
+
interface ScopeArea {
|
|
520
519
|
title?: string;
|
|
521
520
|
appDefIds?: string[];
|
|
522
521
|
scopes?: PermissionScope[];
|
|
523
522
|
restrictFromLevel?: ScopeLevelWithLiterals;
|
|
524
523
|
}
|
|
525
|
-
|
|
524
|
+
interface PermissionScope {
|
|
526
525
|
_id?: string;
|
|
527
526
|
title?: string;
|
|
528
527
|
description?: string;
|
|
@@ -539,65 +538,65 @@ export interface PermissionScope {
|
|
|
539
538
|
*/
|
|
540
539
|
appDefIds?: string[];
|
|
541
540
|
}
|
|
542
|
-
|
|
541
|
+
declare enum ScopeLevel {
|
|
543
542
|
None = "None",
|
|
544
543
|
SITE = "SITE",
|
|
545
544
|
ACCOUNT = "ACCOUNT"
|
|
546
545
|
}
|
|
547
546
|
/** @enumType */
|
|
548
|
-
|
|
549
|
-
|
|
547
|
+
type ScopeLevelWithLiterals = ScopeLevel | 'None' | 'SITE' | 'ACCOUNT';
|
|
548
|
+
declare enum Visibility {
|
|
550
549
|
/** The scope should be visible to the caller */
|
|
551
550
|
VISIBLE = "VISIBLE",
|
|
552
551
|
/** The scope shouldn't be visible for the caller, because the capability that blocks it is turned on for the caller */
|
|
553
552
|
BLOCKED_BY_CAPABILITY = "BLOCKED_BY_CAPABILITY"
|
|
554
553
|
}
|
|
555
554
|
/** @enumType */
|
|
556
|
-
|
|
557
|
-
|
|
555
|
+
type VisibilityWithLiterals = Visibility | 'VISIBLE' | 'BLOCKED_BY_CAPABILITY';
|
|
556
|
+
interface GetPeopleRequest {
|
|
558
557
|
resource?: PeopleResource;
|
|
559
558
|
peopleType?: PeopleTypeWithLiterals;
|
|
560
559
|
paging?: Paging;
|
|
561
560
|
/** The locale of the request. Defaults to en */
|
|
562
561
|
locale?: string | null;
|
|
563
562
|
}
|
|
564
|
-
|
|
563
|
+
interface PeopleResource extends PeopleResourceResourceTypeOneOf {
|
|
565
564
|
site?: string;
|
|
566
565
|
folder?: FolderResource;
|
|
567
566
|
}
|
|
568
567
|
/** @oneof */
|
|
569
|
-
|
|
568
|
+
interface PeopleResourceResourceTypeOneOf {
|
|
570
569
|
site?: string;
|
|
571
570
|
folder?: FolderResource;
|
|
572
571
|
}
|
|
573
|
-
|
|
572
|
+
interface FolderResource {
|
|
574
573
|
folderId?: string;
|
|
575
574
|
folderFullPath?: string;
|
|
576
575
|
}
|
|
577
|
-
|
|
576
|
+
declare enum PeopleType {
|
|
578
577
|
UNDEF_PEOPLE_TYPE = "UNDEF_PEOPLE_TYPE",
|
|
579
578
|
CONTRIBUTOR = "CONTRIBUTOR",
|
|
580
579
|
TEAM_MEMBER = "TEAM_MEMBER"
|
|
581
580
|
}
|
|
582
581
|
/** @enumType */
|
|
583
|
-
|
|
584
|
-
|
|
582
|
+
type PeopleTypeWithLiterals = PeopleType | 'UNDEF_PEOPLE_TYPE' | 'CONTRIBUTOR' | 'TEAM_MEMBER';
|
|
583
|
+
interface GetPeopleResponse {
|
|
585
584
|
people?: People;
|
|
586
585
|
}
|
|
587
|
-
|
|
586
|
+
interface People {
|
|
588
587
|
people?: Person[];
|
|
589
588
|
totalPeople?: number;
|
|
590
589
|
}
|
|
591
|
-
|
|
590
|
+
interface Person extends PersonPersonOneOf {
|
|
592
591
|
contributor?: Contributor;
|
|
593
592
|
teamMember?: TeamMember;
|
|
594
593
|
}
|
|
595
594
|
/** @oneof */
|
|
596
|
-
|
|
595
|
+
interface PersonPersonOneOf {
|
|
597
596
|
contributor?: Contributor;
|
|
598
597
|
teamMember?: TeamMember;
|
|
599
598
|
}
|
|
600
|
-
|
|
599
|
+
interface Contributor {
|
|
601
600
|
/** Contributor's metadata. */
|
|
602
601
|
metaData?: PersonMetaData;
|
|
603
602
|
/** Whether the contributor account is a team account. */
|
|
@@ -615,7 +614,7 @@ export interface Contributor {
|
|
|
615
614
|
*/
|
|
616
615
|
_id?: string;
|
|
617
616
|
}
|
|
618
|
-
|
|
617
|
+
interface PersonMetaData {
|
|
619
618
|
/** Contributor's account ID. */
|
|
620
619
|
_id?: string;
|
|
621
620
|
/** Contributor's full name. */
|
|
@@ -627,21 +626,21 @@ export interface PersonMetaData {
|
|
|
627
626
|
/** Contributor's access to assets and their assigned role (`policy`) for that asset. */
|
|
628
627
|
assignments?: Assignment[];
|
|
629
628
|
}
|
|
630
|
-
|
|
629
|
+
interface TeamMember {
|
|
631
630
|
metaData?: PersonMetaData;
|
|
632
631
|
}
|
|
633
|
-
|
|
632
|
+
interface GetTeamV2Response {
|
|
634
633
|
users?: User[];
|
|
635
634
|
totalUsersInAccount?: string;
|
|
636
635
|
}
|
|
637
|
-
|
|
636
|
+
interface GetTeamInvitesRequest {
|
|
638
637
|
/** The locale of the request. Defaults to en */
|
|
639
638
|
locale?: string | null;
|
|
640
639
|
}
|
|
641
|
-
|
|
640
|
+
interface GetTeamInvitesResponse {
|
|
642
641
|
invites?: Invite[];
|
|
643
642
|
}
|
|
644
|
-
|
|
643
|
+
interface Invite {
|
|
645
644
|
/**
|
|
646
645
|
* @format GUID
|
|
647
646
|
* @readonly
|
|
@@ -661,11 +660,11 @@ export interface Invite {
|
|
|
661
660
|
/** Invite expiration date */
|
|
662
661
|
expirationDate?: Date | null;
|
|
663
662
|
}
|
|
664
|
-
|
|
663
|
+
interface ApiInviteAssignment {
|
|
665
664
|
policy?: AssignedPolicy;
|
|
666
665
|
restrictions?: Restriction;
|
|
667
666
|
}
|
|
668
|
-
|
|
667
|
+
interface GetPoliciesRequest {
|
|
669
668
|
/** The locale of the request. Defaults to en */
|
|
670
669
|
locale?: string | null;
|
|
671
670
|
/** Areas filter to include only roles from areas that pass this filter. When not provided, roles from all areas will be returned */
|
|
@@ -673,21 +672,21 @@ export interface GetPoliciesRequest {
|
|
|
673
672
|
/** Role level filter to include only roles that are not restricted from the requested resource level (site/account). When set to ALL, all levels are returned */
|
|
674
673
|
roleLevel?: RoleLevelWithLiterals;
|
|
675
674
|
}
|
|
676
|
-
|
|
675
|
+
interface AreasFilter {
|
|
677
676
|
/** A list of role area ids, to filter only roles belonging to these areas */
|
|
678
677
|
areaIds?: string[];
|
|
679
678
|
}
|
|
680
|
-
|
|
679
|
+
declare enum RoleLevel {
|
|
681
680
|
ALL = "ALL",
|
|
682
681
|
SITE_LEVEL = "SITE_LEVEL",
|
|
683
682
|
ACCOUNT_LEVEL = "ACCOUNT_LEVEL"
|
|
684
683
|
}
|
|
685
684
|
/** @enumType */
|
|
686
|
-
|
|
687
|
-
|
|
685
|
+
type RoleLevelWithLiterals = RoleLevel | 'ALL' | 'SITE_LEVEL' | 'ACCOUNT_LEVEL';
|
|
686
|
+
interface GetPoliciesResponse {
|
|
688
687
|
policies?: PredefinedRoles;
|
|
689
688
|
}
|
|
690
|
-
|
|
689
|
+
interface SearchTeamRequest {
|
|
691
690
|
/** Free text to search for within team member name and email address fields. */
|
|
692
691
|
query?: string | null;
|
|
693
692
|
/** Sort data. */
|
|
@@ -705,13 +704,13 @@ export interface SearchTeamRequest {
|
|
|
705
704
|
/** Pagination. */
|
|
706
705
|
paging?: Paging;
|
|
707
706
|
}
|
|
708
|
-
|
|
707
|
+
interface Ordering {
|
|
709
708
|
/** Field to sort by. */
|
|
710
709
|
fieldName?: OrderFieldWithLiterals;
|
|
711
710
|
/** Sort order. */
|
|
712
711
|
direction?: DirectionWithLiterals;
|
|
713
712
|
}
|
|
714
|
-
|
|
713
|
+
declare enum OrderField {
|
|
715
714
|
/** For internal use. */
|
|
716
715
|
Undefined = "Undefined",
|
|
717
716
|
/** Team member name. */
|
|
@@ -720,8 +719,8 @@ export declare enum OrderField {
|
|
|
720
719
|
JoinedAt = "JoinedAt"
|
|
721
720
|
}
|
|
722
721
|
/** @enumType */
|
|
723
|
-
|
|
724
|
-
|
|
722
|
+
type OrderFieldWithLiterals = OrderField | 'Undefined' | 'Name' | 'JoinedAt';
|
|
723
|
+
declare enum Direction {
|
|
725
724
|
/** For internal use. */
|
|
726
725
|
UninitializedDirection = "UninitializedDirection",
|
|
727
726
|
/** Ascending. */
|
|
@@ -730,8 +729,8 @@ export declare enum Direction {
|
|
|
730
729
|
DESC = "DESC"
|
|
731
730
|
}
|
|
732
731
|
/** @enumType */
|
|
733
|
-
|
|
734
|
-
|
|
732
|
+
type DirectionWithLiterals = Direction | 'UninitializedDirection' | 'ASC' | 'DESC';
|
|
733
|
+
declare enum FacetType {
|
|
735
734
|
Undefined = "Undefined",
|
|
736
735
|
/** How many team members with each role */
|
|
737
736
|
Roles = "Roles",
|
|
@@ -741,39 +740,39 @@ export declare enum FacetType {
|
|
|
741
740
|
Users = "Users"
|
|
742
741
|
}
|
|
743
742
|
/** @enumType */
|
|
744
|
-
|
|
745
|
-
|
|
743
|
+
type FacetTypeWithLiterals = FacetType | 'Undefined' | 'Roles' | 'InviteStatus' | 'Users';
|
|
744
|
+
interface SearchTeamResponse {
|
|
746
745
|
/** List of facets, as requested. */
|
|
747
746
|
facets?: Facet[];
|
|
748
747
|
/** Existing team members and invites sent to join the account. */
|
|
749
748
|
teamMembers?: TeamMemberV3[];
|
|
750
749
|
}
|
|
751
|
-
|
|
750
|
+
interface Facet {
|
|
752
751
|
/** Facet type. */
|
|
753
752
|
facetType?: FacetTypeWithLiterals;
|
|
754
753
|
/** Values and their counters. Values with count = 0 are not returned. */
|
|
755
754
|
values?: FacetValue[];
|
|
756
755
|
}
|
|
757
|
-
|
|
756
|
+
interface FacetValue {
|
|
758
757
|
/** Supported values: `Roles`, `InviteStatus`, `Users`. */
|
|
759
758
|
value?: string;
|
|
760
759
|
/** Number of existing items for the value. */
|
|
761
760
|
count?: number;
|
|
762
761
|
}
|
|
763
|
-
|
|
762
|
+
interface TeamMemberV3 extends TeamMemberV3MembersOneOf {
|
|
764
763
|
/** Existing team member data. */
|
|
765
764
|
user?: UserV3;
|
|
766
765
|
/** Invited team member data. */
|
|
767
766
|
invite?: InviteV3;
|
|
768
767
|
}
|
|
769
768
|
/** @oneof */
|
|
770
|
-
|
|
769
|
+
interface TeamMemberV3MembersOneOf {
|
|
771
770
|
/** Existing team member data. */
|
|
772
771
|
user?: UserV3;
|
|
773
772
|
/** Invited team member data. */
|
|
774
773
|
invite?: InviteV3;
|
|
775
774
|
}
|
|
776
|
-
|
|
775
|
+
interface UserV3 {
|
|
777
776
|
/** User ID. */
|
|
778
777
|
_id?: string;
|
|
779
778
|
/**
|
|
@@ -790,7 +789,7 @@ export interface UserV3 {
|
|
|
790
789
|
/** Mapping of the user's access to an asset and their assigned role. */
|
|
791
790
|
assignments?: AssignmentV3[];
|
|
792
791
|
}
|
|
793
|
-
|
|
792
|
+
interface AssignmentV3 {
|
|
794
793
|
/** Role assigned to the user. To retrieve all available roles, call Get Roles Info. */
|
|
795
794
|
policyId?: string | null;
|
|
796
795
|
/**
|
|
@@ -803,7 +802,7 @@ export interface AssignmentV3 {
|
|
|
803
802
|
/** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
|
|
804
803
|
subject?: AssignedSubject;
|
|
805
804
|
}
|
|
806
|
-
|
|
805
|
+
interface AssignedSubject {
|
|
807
806
|
/**
|
|
808
807
|
* Identity ID.
|
|
809
808
|
* @format GUID
|
|
@@ -813,7 +812,7 @@ export interface AssignedSubject {
|
|
|
813
812
|
/** Identity type. */
|
|
814
813
|
subjectType?: SubjectTypeWithLiterals;
|
|
815
814
|
}
|
|
816
|
-
|
|
815
|
+
interface InviteV3 {
|
|
817
816
|
/**
|
|
818
817
|
* Invite ID.
|
|
819
818
|
* @format GUID
|
|
@@ -838,23 +837,23 @@ export interface InviteV3 {
|
|
|
838
837
|
/** Invite expiration date. */
|
|
839
838
|
expirationDate?: Date | null;
|
|
840
839
|
}
|
|
841
|
-
|
|
840
|
+
interface InviteAssignmentV3 {
|
|
842
841
|
/** Role ID that will be assigned once the invite is accepted. */
|
|
843
842
|
policyId?: string | null;
|
|
844
843
|
/** Assets where the user will be assigned access. When empty, the role covers all assets, with no restrictions to specific sites or folders. */
|
|
845
844
|
restrictions?: Restriction;
|
|
846
845
|
}
|
|
847
|
-
|
|
846
|
+
interface GetRolesRequest {
|
|
848
847
|
/** The locale of the predefined roles names and descriptions. Defaults to English */
|
|
849
848
|
locale?: string | null;
|
|
850
849
|
}
|
|
851
|
-
|
|
850
|
+
interface GetRolesResponse {
|
|
852
851
|
/** The predefined roles (by areas) */
|
|
853
852
|
predefinedRolesAreas?: PredefinedRolesArea[];
|
|
854
853
|
/** The custom roles */
|
|
855
854
|
customRoles?: CustomRole[];
|
|
856
855
|
}
|
|
857
|
-
|
|
856
|
+
interface PredefinedRolesArea {
|
|
858
857
|
/** The id of the area (e.g "Blog") */
|
|
859
858
|
areaId?: string;
|
|
860
859
|
/** The translated area title, according to the request locale, or the original title if translation failed */
|
|
@@ -862,7 +861,7 @@ export interface PredefinedRolesArea {
|
|
|
862
861
|
/** The predefined roles belonging to this area */
|
|
863
862
|
roles?: PredefinedRoleV2[];
|
|
864
863
|
}
|
|
865
|
-
|
|
864
|
+
interface PredefinedRoleV2 {
|
|
866
865
|
/** The policy id of this role */
|
|
867
866
|
_id?: string;
|
|
868
867
|
/** The title of this role, translated according to the request locale, or the original title if translation failed */
|
|
@@ -884,22 +883,22 @@ export interface PredefinedRoleV2 {
|
|
|
884
883
|
/** The visibility of the role */
|
|
885
884
|
visibility?: RoleVisibilityWithLiterals;
|
|
886
885
|
}
|
|
887
|
-
|
|
886
|
+
declare enum RoleLevelRestriction {
|
|
888
887
|
NoRestriction = "NoRestriction",
|
|
889
888
|
Site = "Site",
|
|
890
889
|
Account = "Account"
|
|
891
890
|
}
|
|
892
891
|
/** @enumType */
|
|
893
|
-
|
|
894
|
-
|
|
892
|
+
type RoleLevelRestrictionWithLiterals = RoleLevelRestriction | 'NoRestriction' | 'Site' | 'Account';
|
|
893
|
+
declare enum EditorType {
|
|
895
894
|
UNINITIALIZED = "UNINITIALIZED",
|
|
896
895
|
EDITORX = "EDITORX",
|
|
897
896
|
BLOCKS = "BLOCKS",
|
|
898
897
|
STUDIO = "STUDIO"
|
|
899
898
|
}
|
|
900
899
|
/** @enumType */
|
|
901
|
-
|
|
902
|
-
|
|
900
|
+
type EditorTypeWithLiterals = EditorType | 'UNINITIALIZED' | 'EDITORX' | 'BLOCKS' | 'STUDIO';
|
|
901
|
+
declare enum RoleVisibility {
|
|
903
902
|
/** the role should be visible to the caller */
|
|
904
903
|
Visible = "Visible",
|
|
905
904
|
/** the role should be disabled for the caller, because it contains permissions the caller wasn't granted on the call context (site/account) */
|
|
@@ -908,8 +907,8 @@ export declare enum RoleVisibility {
|
|
|
908
907
|
Disabled_Capability = "Disabled_Capability"
|
|
909
908
|
}
|
|
910
909
|
/** @enumType */
|
|
911
|
-
|
|
912
|
-
|
|
910
|
+
type RoleVisibilityWithLiterals = RoleVisibility | 'Visible' | 'Disabled_Dependency' | 'Disabled_Capability';
|
|
911
|
+
interface CustomRole {
|
|
913
912
|
/** The policy this role grants */
|
|
914
913
|
policy?: ApiPolicy;
|
|
915
914
|
/** The visibility of the role */
|
|
@@ -917,25 +916,25 @@ export interface CustomRole {
|
|
|
917
916
|
/** Whether this role is assigned to a subject */
|
|
918
917
|
assigned?: boolean | null;
|
|
919
918
|
}
|
|
920
|
-
|
|
919
|
+
interface GetRolesInfoRequest {
|
|
921
920
|
/** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
|
|
922
921
|
locale?: string | null;
|
|
923
922
|
/** Roles to return. */
|
|
924
923
|
filter?: RolesInfoFilter;
|
|
925
924
|
}
|
|
926
|
-
|
|
925
|
+
interface RolesInfoFilter {
|
|
927
926
|
/** Role level to return. Default: ALL. */
|
|
928
927
|
roleLevel?: RoleLevelWithLiterals;
|
|
929
928
|
/** Filter for editor-specific roles. Default: ALL. */
|
|
930
929
|
editorTypes?: EditorTypeWithLiterals[];
|
|
931
930
|
}
|
|
932
|
-
|
|
931
|
+
interface GetRolesInfoResponse {
|
|
933
932
|
/** Predefined roles. */
|
|
934
933
|
predefinedRoles?: RoleInfo[];
|
|
935
934
|
/** Custom roles. */
|
|
936
935
|
customRoles?: RoleInfo[];
|
|
937
936
|
}
|
|
938
|
-
|
|
937
|
+
interface RoleInfo {
|
|
939
938
|
/** Role ID. */
|
|
940
939
|
_id?: string;
|
|
941
940
|
/** Role title, translated according to the request locale. If translation fails, the original title is returned. */
|
|
@@ -945,11 +944,11 @@ export interface RoleInfo {
|
|
|
945
944
|
/** Whether this role is restricted from accessing a specific resource type. Default: `NoRestriction`. */
|
|
946
945
|
restrictFromLevel?: RoleLevelRestrictionWithLiterals;
|
|
947
946
|
}
|
|
948
|
-
|
|
947
|
+
interface CreateCustomRoleRequest {
|
|
949
948
|
/** The custom role to create */
|
|
950
949
|
role?: Policy;
|
|
951
950
|
}
|
|
952
|
-
|
|
951
|
+
interface Policy {
|
|
953
952
|
/** @readonly */
|
|
954
953
|
_id?: string | null;
|
|
955
954
|
/** @maxLength 50 */
|
|
@@ -961,15 +960,15 @@ export interface Policy {
|
|
|
961
960
|
policyType?: PolicyTypeWithLiterals;
|
|
962
961
|
statements?: PolicyStatement[];
|
|
963
962
|
}
|
|
964
|
-
|
|
963
|
+
declare enum PolicyType {
|
|
965
964
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
966
965
|
PREDEFINED = "PREDEFINED",
|
|
967
966
|
CUSTOM = "CUSTOM",
|
|
968
967
|
INLINE_CUSTOM = "INLINE_CUSTOM"
|
|
969
968
|
}
|
|
970
969
|
/** @enumType */
|
|
971
|
-
|
|
972
|
-
|
|
970
|
+
type PolicyTypeWithLiterals = PolicyType | 'UNKNOWN_STATUS' | 'PREDEFINED' | 'CUSTOM' | 'INLINE_CUSTOM';
|
|
971
|
+
interface PolicyStatement {
|
|
973
972
|
/** @readonly */
|
|
974
973
|
_id?: string | null;
|
|
975
974
|
permissions?: string[];
|
|
@@ -977,18 +976,18 @@ export interface PolicyStatement {
|
|
|
977
976
|
effect?: EffectWithLiterals;
|
|
978
977
|
condition?: PolicyCondition;
|
|
979
978
|
}
|
|
980
|
-
|
|
979
|
+
declare enum Effect {
|
|
981
980
|
UNKNOWN_EFFECT = "UNKNOWN_EFFECT",
|
|
982
981
|
ALLOW = "ALLOW",
|
|
983
982
|
DENY = "DENY"
|
|
984
983
|
}
|
|
985
984
|
/** @enumType */
|
|
986
|
-
|
|
987
|
-
|
|
985
|
+
type EffectWithLiterals = Effect | 'UNKNOWN_EFFECT' | 'ALLOW' | 'DENY';
|
|
986
|
+
interface CreateCustomRoleResponse {
|
|
988
987
|
/** The newly created custom role */
|
|
989
988
|
roleCreated?: Policy;
|
|
990
989
|
}
|
|
991
|
-
|
|
990
|
+
interface ChangeRoleV2Request {
|
|
992
991
|
/**
|
|
993
992
|
* ID of team member being affected.
|
|
994
993
|
* @format GUID
|
|
@@ -999,11 +998,11 @@ export interface ChangeRoleV2Request {
|
|
|
999
998
|
/** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
|
|
1000
999
|
assignmentIdsToReplace: string[];
|
|
1001
1000
|
}
|
|
1002
|
-
|
|
1001
|
+
interface ChangeRoleV2Response {
|
|
1003
1002
|
/** New roles assigned to the given team member. */
|
|
1004
1003
|
roles?: AssignmentV3[];
|
|
1005
1004
|
}
|
|
1006
|
-
|
|
1005
|
+
interface UpdateTeamMemberAssignmentsRequest {
|
|
1007
1006
|
/**
|
|
1008
1007
|
* ID of team member being affected.
|
|
1009
1008
|
* @format GUID
|
|
@@ -1021,43 +1020,25 @@ export interface UpdateTeamMemberAssignmentsRequest {
|
|
|
1021
1020
|
*/
|
|
1022
1021
|
assignmentIdsToRemove: string[];
|
|
1023
1022
|
}
|
|
1024
|
-
|
|
1023
|
+
interface UpdateTeamMemberAssignmentsResponse {
|
|
1025
1024
|
/** The new assignments, assigned to the given team member. */
|
|
1026
1025
|
assignments?: AssignmentV3[];
|
|
1027
1026
|
}
|
|
1028
|
-
|
|
1027
|
+
interface GetSubjectsAssignmentsRequest {
|
|
1029
1028
|
/** The locale of the request. Defaults to en */
|
|
1030
1029
|
locale?: string | null;
|
|
1031
1030
|
/** list of subjects */
|
|
1032
1031
|
subjects?: Subject[];
|
|
1033
1032
|
}
|
|
1034
|
-
|
|
1033
|
+
interface GetSubjectsAssignmentsResponse {
|
|
1035
1034
|
/** list of subjects with assignments */
|
|
1036
1035
|
subjectsAssignments?: SubjectAssignments[];
|
|
1037
1036
|
}
|
|
1038
|
-
|
|
1037
|
+
interface SubjectAssignments {
|
|
1039
1038
|
subject?: Subject;
|
|
1040
1039
|
assignments?: Assignment[];
|
|
1041
1040
|
}
|
|
1042
|
-
|
|
1043
|
-
* Removes a team member from the requesting account.
|
|
1044
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1045
|
-
* @param userId - User ID of the team member to remove.
|
|
1046
|
-
* @public
|
|
1047
|
-
* @requiredField userId
|
|
1048
|
-
* @permissionId team.delete-member
|
|
1049
|
-
* @fqn com.wixpress.roles.management.api.RolesManagementService.RemoveMember
|
|
1050
|
-
*/
|
|
1051
|
-
export declare function removeMember(userId: string): Promise<void>;
|
|
1052
|
-
/**
|
|
1053
|
-
* Retrieves all team members of the requesting account, based on the provided filters and free text queries.
|
|
1054
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1055
|
-
* @public
|
|
1056
|
-
* @param options - Filter options.
|
|
1057
|
-
* @fqn com.wixpress.roles.management.api.RolesManagementService.SearchTeam
|
|
1058
|
-
*/
|
|
1059
|
-
export declare function searchTeam(options?: SearchTeamOptions): Promise<NonNullablePaths<SearchTeamResponse, `facets` | `facets.${number}.facetType` | `teamMembers` | `teamMembers.${number}.user._id` | `teamMembers.${number}.user.name.firstName` | `teamMembers.${number}.user.name.lastName` | `teamMembers.${number}.invite._id` | `teamMembers.${number}.invite.status`>>;
|
|
1060
|
-
export interface SearchTeamOptions {
|
|
1041
|
+
interface SearchTeamOptions {
|
|
1061
1042
|
/** Free text to search for within team member name and email address fields. */
|
|
1062
1043
|
query?: string | null;
|
|
1063
1044
|
/** Sort data. */
|
|
@@ -1075,42 +1056,19 @@ export interface SearchTeamOptions {
|
|
|
1075
1056
|
/** Pagination. */
|
|
1076
1057
|
paging?: Paging;
|
|
1077
1058
|
}
|
|
1078
|
-
|
|
1079
|
-
* Retrieves all available roles in the requesting account, including predefined and custom roles.
|
|
1080
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1081
|
-
* @public
|
|
1082
|
-
* @param options - Filter options.
|
|
1083
|
-
* @permissionId ACCOUNT_ROLES.GET_ROLES
|
|
1084
|
-
* @fqn com.wixpress.roles.management.api.RolesManagementService.GetRolesInfo
|
|
1085
|
-
*/
|
|
1086
|
-
export declare function getRolesInfo(options?: GetRolesInfoOptions): Promise<NonNullablePaths<GetRolesInfoResponse, `predefinedRoles` | `predefinedRoles.${number}._id` | `predefinedRoles.${number}.title` | `predefinedRoles.${number}.description` | `predefinedRoles.${number}.restrictFromLevel` | `customRoles` | `customRoles.${number}._id` | `customRoles.${number}.title` | `customRoles.${number}.description` | `customRoles.${number}.restrictFromLevel`>>;
|
|
1087
|
-
export interface GetRolesInfoOptions {
|
|
1059
|
+
interface GetRolesInfoOptions {
|
|
1088
1060
|
/** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
|
|
1089
1061
|
locale?: string | null;
|
|
1090
1062
|
/** Roles to return. */
|
|
1091
1063
|
filter?: RolesInfoFilter;
|
|
1092
1064
|
}
|
|
1093
|
-
|
|
1065
|
+
interface ChangeRoleV2Options {
|
|
1094
1066
|
/** New assignments, including roles, to apply to the team member in this account. To retrieve all available roles, call Get Roles Info. */
|
|
1095
1067
|
roles: AssignmentV3[];
|
|
1096
1068
|
/** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
|
|
1097
1069
|
assignmentIdsToReplace: string[];
|
|
1098
1070
|
}
|
|
1099
|
-
|
|
1100
|
-
* Updates the assignments of roles and conditions for an existing team member. Changing assignments changes the team member’s access to account assets.
|
|
1101
|
-
* > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
|
|
1102
|
-
* @param userId - ID of team member being affected.
|
|
1103
|
-
* @public
|
|
1104
|
-
* @requiredField options
|
|
1105
|
-
* @requiredField options.assignmentIdsToRemove
|
|
1106
|
-
* @requiredField options.newAssignments
|
|
1107
|
-
* @requiredField userId
|
|
1108
|
-
* @param options - Filter options. The `assignmentIdsToRemove` and `newAssignments` fields **must** be passed.
|
|
1109
|
-
* @permissionId team.manage-team-member-roles
|
|
1110
|
-
* @fqn com.wixpress.roles.management.api.RolesManagementService.UpdateTeamMemberAssignments
|
|
1111
|
-
*/
|
|
1112
|
-
export declare function updateTeamMemberAssignments(userId: string, options: NonNullablePaths<UpdateTeamMemberAssignmentsOptions, `assignmentIdsToRemove` | `newAssignments`>): Promise<NonNullablePaths<UpdateTeamMemberAssignmentsResponse, `assignments` | `assignments.${number}.restrictions.resource.resourceType` | `assignments.${number}.restrictions.resource._id` | `assignments.${number}.restrictions.site._id` | `assignments.${number}.subject._id` | `assignments.${number}.subject.subjectType`>>;
|
|
1113
|
-
export interface UpdateTeamMemberAssignmentsOptions {
|
|
1071
|
+
interface UpdateTeamMemberAssignmentsOptions {
|
|
1114
1072
|
/**
|
|
1115
1073
|
* New assignments to apply to the team member in this account.
|
|
1116
1074
|
* @maxSize 50
|
|
@@ -1123,3 +1081,5 @@ export interface UpdateTeamMemberAssignmentsOptions {
|
|
|
1123
1081
|
*/
|
|
1124
1082
|
assignmentIdsToRemove: string[];
|
|
1125
1083
|
}
|
|
1084
|
+
|
|
1085
|
+
export { type ConditionTypeOfOneOf as $, type Assignment as A, type AccountInvite as B, ConditionAttributeType as C, Direction as D, EditorType as E, FacetType as F, type GetRolesInfoOptions as G, type InviteResourceAssignment as H, InviteStatus as I, JoinedConditionOperator as J, type InviteAssignment as K, type LocationsRestriction as L, type FullNameResource as M, type Name as N, OrderField as O, PeopleType as P, type FullNameResourceResourceContextOneOf as Q, ResourceType as R, type SearchTeamOptions as S, type SiteResourceContext as T, type UpdateTeamMemberAssignmentsOptions as U, Visibility as V, type AccountResourceContext as W, type OrganizationResourceContext as X, type Resource as Y, type PolicyCondition as Z, type ConditionType as _, type SearchTeamResponse as a, type PredefinedRolesArea as a$, type SimpleCondition as a0, type SimpleConditionValue as a1, type SimpleConditionValueValueOneOf as a2, type JoinedCondition as a3, type EnvironmentCondition as a4, type EnvironmentConditionConditionOneOf as a5, type ExperimentCondition as a6, type Condition as a7, type ConditionOperator as a8, type ConditionOperatorOperatorsOneOf as a9, type People as aA, type Person as aB, type PersonPersonOneOf as aC, type Contributor as aD, type PersonMetaData as aE, type TeamMember as aF, type GetTeamV2Response as aG, type GetTeamInvitesRequest as aH, type GetTeamInvitesResponse as aI, type Invite as aJ, type ApiInviteAssignment as aK, type GetPoliciesRequest as aL, type AreasFilter as aM, type GetPoliciesResponse as aN, type SearchTeamRequest as aO, type Ordering as aP, type Facet as aQ, type FacetValue as aR, type TeamMemberV3 as aS, type TeamMemberV3MembersOneOf as aT, type UserV3 as aU, type AssignmentV3 as aV, type AssignedSubject as aW, type InviteV3 as aX, type InviteAssignmentV3 as aY, type GetRolesRequest as aZ, type GetRolesResponse as a_, type EqualOperator as aa, type ConditionValue as ab, type ConditionValueValueOneOf as ac, type LikeOperator as ad, type ExperimentOperator as ae, type DependOnOperator as af, type AccountInfo as ag, type ApiPolicy as ah, type PredefinedRoles as ai, type PredefinedRole as aj, type Role as ak, type ChangeRoleRequest as al, type ChangeRoleResponse as am, type RemoveMemberRequest as an, type RemoveMemberResponse as ao, type GetUsersRequest as ap, type GetUsersResponse as aq, type GetScopesRequest as ar, type GetScopesResponse as as, type ScopeArea as at, type PermissionScope as au, type GetPeopleRequest as av, type PeopleResource as aw, type PeopleResourceResourceTypeOneOf as ax, type FolderResource as ay, type GetPeopleResponse as az, type GetRolesInfoResponse as b, type PredefinedRoleV2 as b0, type CustomRole as b1, type GetRolesInfoRequest as b2, type RolesInfoFilter as b3, type RoleInfo as b4, type CreateCustomRoleRequest as b5, type Policy as b6, type PolicyStatement as b7, type CreateCustomRoleResponse as b8, type ChangeRoleV2Request as b9, type ChangeRoleV2Response as ba, type UpdateTeamMemberAssignmentsRequest as bb, type GetSubjectsAssignmentsRequest as bc, type GetSubjectsAssignmentsResponse as bd, type SubjectAssignments as be, type ChangeRoleV2Options as bf, type UpdateTeamMemberAssignmentsResponse as c, SubjectType as d, SubjectContextType as e, SimpleConditionOperator as f, ScopeLevel as g, RoleLevel as h, RoleLevelRestriction as i, RoleVisibility as j, PolicyType as k, Effect as l, type User as m, type AssignedPolicy as n, type Restriction as o, type RestrictionRestrictionsOneOf as p, type ApiResource as q, type Conditions as r, type ApiCondition as s, type SiteRestriction as t, type CompanionResource as u, type Subject as v, type SubjectContext as w, type GetTeamRequest as x, type Paging as y, type GetTeamResponse as z };
|