@qlik/api 2.3.1 → 2.4.0
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/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -3
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-XusKk8IA.js +0 -32
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/users.d.ts
CHANGED
|
@@ -1,18 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/users.d.ts
|
|
5
5
|
/**
|
|
6
6
|
* An array of group references.
|
|
7
7
|
*/
|
|
8
8
|
type AssignedGroups = {
|
|
9
|
-
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
10
|
-
|
|
11
|
-
/** The
|
|
12
|
-
id: string;
|
|
13
|
-
/** The group name */
|
|
14
|
-
readonly name: string;
|
|
15
|
-
/** The provider type of the group */
|
|
9
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */assignedRoles?: AssignedRoles; /** The unique group identitier */
|
|
10
|
+
id: string; /** The group name */
|
|
11
|
+
readonly name: string; /** The provider type of the group */
|
|
16
12
|
providerType?: "idp" | "custom";
|
|
17
13
|
}[];
|
|
18
14
|
/**
|
|
@@ -20,28 +16,22 @@ type AssignedGroups = {
|
|
|
20
16
|
* @example
|
|
21
17
|
* [
|
|
22
18
|
* {
|
|
23
|
-
* name: "
|
|
19
|
+
* name: "My Custom Group",
|
|
24
20
|
* providerType: "custom"
|
|
25
21
|
* }
|
|
26
22
|
* ]
|
|
27
23
|
*/
|
|
28
24
|
type AssignedGroupsRefNames = {
|
|
29
|
-
/** The name of the group */
|
|
30
|
-
name: string;
|
|
31
|
-
/** The type of provider for the group. */
|
|
25
|
+
/** The name of the group */name: string; /** The type of provider for the group. */
|
|
32
26
|
providerType: "idp" | "custom";
|
|
33
27
|
}[];
|
|
34
28
|
/**
|
|
35
29
|
* An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
|
|
36
30
|
*/
|
|
37
31
|
type AssignedRoles = {
|
|
38
|
-
/** The unique role identitier */
|
|
39
|
-
|
|
40
|
-
/** The role
|
|
41
|
-
readonly level: "admin" | "user";
|
|
42
|
-
/** The role name */
|
|
43
|
-
readonly name: string;
|
|
44
|
-
/** The type of role */
|
|
32
|
+
/** The unique role identitier */id: string; /** The role level */
|
|
33
|
+
readonly level: "admin" | "user"; /** The role name */
|
|
34
|
+
readonly name: string; /** The type of role */
|
|
45
35
|
readonly type: "default" | "custom";
|
|
46
36
|
}[];
|
|
47
37
|
/**
|
|
@@ -52,33 +42,22 @@ type AssignedScopes = string[];
|
|
|
52
42
|
* An error object describing the error.
|
|
53
43
|
*/
|
|
54
44
|
type Error = {
|
|
55
|
-
/** The error code. */
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
detail?: string;
|
|
59
|
-
/** Additional properties relating to the error. */
|
|
60
|
-
meta?: unknown;
|
|
61
|
-
/** References to the source of the error. */
|
|
45
|
+
/** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the problem. */
|
|
46
|
+
detail?: string; /** Additional properties relating to the error. */
|
|
47
|
+
meta?: unknown; /** References to the source of the error. */
|
|
62
48
|
source?: {
|
|
63
|
-
/** The URI query parameter that caused the error. */
|
|
64
|
-
parameter?: string;
|
|
65
|
-
/** A JSON Pointer to the property that caused the error. */
|
|
49
|
+
/** The URI query parameter that caused the error. */parameter?: string; /** A JSON Pointer to the property that caused the error. */
|
|
66
50
|
pointer?: string;
|
|
67
|
-
};
|
|
68
|
-
/**
|
|
69
|
-
status?: number;
|
|
70
|
-
/** Summary of the problem. */
|
|
51
|
+
}; /** The HTTP status code. */
|
|
52
|
+
status?: number; /** Summary of the problem. */
|
|
71
53
|
title: string;
|
|
72
54
|
};
|
|
73
55
|
/**
|
|
74
56
|
* Error object.
|
|
75
57
|
*/
|
|
76
58
|
type ErrorItem = {
|
|
77
|
-
/** Error code */
|
|
78
|
-
|
|
79
|
-
/** A human-readable explanation specific to this occurrence of the problem (if applicable) */
|
|
80
|
-
detail?: string;
|
|
81
|
-
/** Summary of the problem */
|
|
59
|
+
/** Error code */code: number; /** A human-readable explanation specific to this occurrence of the problem (if applicable) */
|
|
60
|
+
detail?: string; /** Summary of the problem */
|
|
82
61
|
title: string;
|
|
83
62
|
};
|
|
84
63
|
/**
|
|
@@ -96,9 +75,7 @@ type ErrorItem = {
|
|
|
96
75
|
* }
|
|
97
76
|
*/
|
|
98
77
|
type Errors = {
|
|
99
|
-
/** An array of errors related to the operation. */
|
|
100
|
-
errors?: Error[];
|
|
101
|
-
/** A unique identifier for tracing the error. */
|
|
78
|
+
/** An array of errors related to the operation. */errors?: Error[]; /** A unique identifier for tracing the error. */
|
|
102
79
|
traceId?: string;
|
|
103
80
|
};
|
|
104
81
|
type ErrorsResponse = {
|
|
@@ -108,8 +85,7 @@ type ErrorsResponse = {
|
|
|
108
85
|
* An advanced query filter to be used for complex user querying in the tenant.
|
|
109
86
|
*/
|
|
110
87
|
type Filter = {
|
|
111
|
-
/** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
|
|
112
|
-
filter?: string;
|
|
88
|
+
/** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */filter?: string;
|
|
113
89
|
};
|
|
114
90
|
/**
|
|
115
91
|
* Data list - ResultItem or ErrorItem for each InviteeItem.
|
|
@@ -121,36 +97,25 @@ type InviteDataResponse = {
|
|
|
121
97
|
* Error object.
|
|
122
98
|
*/
|
|
123
99
|
type InviteErrorItem = ErrorItem & {
|
|
124
|
-
/** Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error | */
|
|
125
|
-
|
|
126
|
-
/** Invitee email */
|
|
127
|
-
email: string;
|
|
128
|
-
/** Result status = "error" */
|
|
100
|
+
/** Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error | */code?: string; /** Invitee email */
|
|
101
|
+
email: string; /** Result status = "error" */
|
|
129
102
|
status: "error";
|
|
130
103
|
};
|
|
131
104
|
type InviteItem = {
|
|
132
|
-
/** Email address for this invitee. Example - "foo@qlik.com". */
|
|
133
|
-
|
|
134
|
-
/**
|
|
135
|
-
language?: string;
|
|
136
|
-
/** Optional display name for this invitee. Example - "Elvis Presley". */
|
|
137
|
-
name?: string;
|
|
138
|
-
/** Flag - when true invite message is sent to inactive or invited users. Typically used to force email resend to users who are not yet active. */
|
|
105
|
+
/** Email address for this invitee. Example - "foo@qlik.com". */email: string; /** Optional ISO 639-1 2 letter code for invite language. Defaults to 'en' when missing or not found. */
|
|
106
|
+
language?: string; /** Optional display name for this invitee. Example - "Elvis Presley". */
|
|
107
|
+
name?: string; /** Flag - when true invite message is sent to inactive or invited users. Typically used to force email resend to users who are not yet active. */
|
|
139
108
|
resend?: boolean;
|
|
140
109
|
};
|
|
141
110
|
type InviteRequestData = {
|
|
142
|
-
/** List of invitees who should receive an invite email. */
|
|
143
|
-
invitees?: InviteItem[];
|
|
111
|
+
/** List of invitees who should receive an invite email. */invitees?: InviteItem[];
|
|
144
112
|
};
|
|
145
113
|
/**
|
|
146
114
|
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
147
115
|
*/
|
|
148
116
|
type JSONPatch = {
|
|
149
|
-
/** The operation to be performed. The fields `set` and `unset` are deprecated. */
|
|
150
|
-
|
|
151
|
-
/** A JSON Pointer. The field `roles` is deprecated. */
|
|
152
|
-
path: "/name" | "/roles" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
|
|
153
|
-
/** The value to be used for this operation. */
|
|
117
|
+
/** The operation to be performed. The fields `set` and `unset` are deprecated. */op: "replace" | "set" | "unset" | "add" | "renew" | "remove-value"; /** A JSON Pointer. The field `roles` is deprecated. */
|
|
118
|
+
path: "/name" | "/roles" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups"; /** The value to be used for this operation. */
|
|
154
119
|
value: string | boolean | unknown[] | RefIDs | RefNames | AssignedGroupsRefNames;
|
|
155
120
|
};
|
|
156
121
|
/**
|
|
@@ -167,7 +132,7 @@ type JSONPatch = {
|
|
|
167
132
|
* path: "/assignedRoles",
|
|
168
133
|
* value: [
|
|
169
134
|
* {
|
|
170
|
-
* "name": "
|
|
135
|
+
* "name": "My Custom Role"
|
|
171
136
|
* }
|
|
172
137
|
* ]
|
|
173
138
|
* },
|
|
@@ -209,8 +174,7 @@ type JSONPatchArray = JSONPatch[];
|
|
|
209
174
|
* ]
|
|
210
175
|
*/
|
|
211
176
|
type RefIDs = {
|
|
212
|
-
/** The unique identitier */
|
|
213
|
-
id: string;
|
|
177
|
+
/** The unique identitier */id: string;
|
|
214
178
|
}[];
|
|
215
179
|
/**
|
|
216
180
|
* An array of reference names (e.g. roles).
|
|
@@ -222,82 +186,56 @@ type RefIDs = {
|
|
|
222
186
|
* ]
|
|
223
187
|
*/
|
|
224
188
|
type RefNames = {
|
|
225
|
-
/** The name of the entity */
|
|
226
|
-
name: string;
|
|
189
|
+
/** The name of the entity */name: string;
|
|
227
190
|
}[];
|
|
228
191
|
/**
|
|
229
192
|
* Invitee result item
|
|
230
193
|
*/
|
|
231
194
|
type ResultItem = {
|
|
232
|
-
/** Email specified for this invitee */
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
status: "ok" | "exists";
|
|
236
|
-
/** IdP generated UUID for this invitee */
|
|
237
|
-
subject: string;
|
|
238
|
-
/** UserId for this invitee */
|
|
195
|
+
/** Email specified for this invitee */email: string; /** Result status = {"ok" (new user; email sent) | "exists" (existing user; no email sent)} */
|
|
196
|
+
status: "ok" | "exists"; /** IdP generated UUID for this invitee */
|
|
197
|
+
subject: string; /** UserId for this invitee */
|
|
239
198
|
userId: string;
|
|
240
199
|
};
|
|
241
200
|
/**
|
|
242
201
|
* A user object.
|
|
243
202
|
*/
|
|
244
203
|
type User = {
|
|
245
|
-
/** An array of group references. */
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
readonly
|
|
251
|
-
/** The timestamp for when the user record was
|
|
252
|
-
readonly
|
|
253
|
-
/** The email address for the user. */
|
|
254
|
-
email?: string;
|
|
255
|
-
/** The unique user identifier. */
|
|
256
|
-
readonly id: string;
|
|
257
|
-
/** The Unix timestamp indicating when the invite will expire. */
|
|
258
|
-
readonly inviteExpiry?: number;
|
|
259
|
-
/** The timestamp for when the user record was last updated. */
|
|
260
|
-
readonly lastUpdatedAt?: string;
|
|
261
|
-
/** Pagination links to the user. */
|
|
204
|
+
/** An array of group references. */assignedGroups?: AssignedGroups; /** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
205
|
+
assignedRoles?: AssignedRoles; /** An array of scopes assigned to a user */
|
|
206
|
+
readonly assignedScopes?: AssignedScopes; /** The timestamp for when the user record was created. */
|
|
207
|
+
readonly createdAt?: string; /** The email address for the user. */
|
|
208
|
+
email?: string; /** The unique user identifier. */
|
|
209
|
+
readonly id: string; /** The Unix timestamp indicating when the invite will expire. */
|
|
210
|
+
readonly inviteExpiry?: number; /** The timestamp for when the user record was last updated. */
|
|
211
|
+
readonly lastUpdatedAt?: string; /** Pagination links to the user. */
|
|
262
212
|
readonly links?: {
|
|
263
|
-
/** A link to this user. */
|
|
264
|
-
|
|
265
|
-
/** URL that defines the resource. */
|
|
266
|
-
href: string;
|
|
213
|
+
/** A link to this user. */self: {
|
|
214
|
+
/** URL that defines the resource. */href: string;
|
|
267
215
|
};
|
|
268
|
-
};
|
|
269
|
-
/**
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
|
|
277
|
-
/** Represents the end-user's preferred time zone. */
|
|
278
|
-
preferredZoneinfo?: string;
|
|
279
|
-
/** The status of the user within the tenant. */
|
|
280
|
-
status?: "active" | "invited" | "disabled" | "deleted" | "provisioned";
|
|
281
|
-
/** The unique user identitier from an identity provider. */
|
|
282
|
-
subject: string;
|
|
283
|
-
/** The tenant that the user belongs too. */
|
|
284
|
-
tenantId: string;
|
|
285
|
-
/** Represents the end-user's time zone. */
|
|
216
|
+
}; /** Represents the end-user's language tag. */
|
|
217
|
+
locale?: string; /** The name of the user. */
|
|
218
|
+
name: string; /** A static url linking to the avatar of the user. */
|
|
219
|
+
picture?: string; /** Represents the end-user's preferred language tag. */
|
|
220
|
+
preferredLocale?: string; /** Represents the end-user's preferred time zone. */
|
|
221
|
+
preferredZoneinfo?: string; /** The status of the user within the tenant. */
|
|
222
|
+
status?: "active" | "invited" | "disabled" | "deleted" | "provisioned"; /** The unique user identitier from an identity provider. */
|
|
223
|
+
subject: string; /** The tenant that the user belongs too. */
|
|
224
|
+
tenantId: string; /** Represents the end-user's time zone. */
|
|
286
225
|
zoneinfo?: string;
|
|
287
226
|
};
|
|
288
227
|
/**
|
|
289
228
|
* The result object for the user count.
|
|
290
229
|
*/
|
|
291
230
|
type UserCount = {
|
|
292
|
-
/** The total number of users in the tenant. */
|
|
293
|
-
total: number;
|
|
231
|
+
/** The total number of users in the tenant. */total: number;
|
|
294
232
|
};
|
|
295
233
|
/**
|
|
296
234
|
* @example
|
|
297
235
|
* {
|
|
298
236
|
* assignedRoles: [
|
|
299
237
|
* {
|
|
300
|
-
* name: "
|
|
238
|
+
* name: "My Custom Role"
|
|
301
239
|
* }
|
|
302
240
|
* ],
|
|
303
241
|
* email: "john.smith@corp.example",
|
|
@@ -309,43 +247,27 @@ type UserCount = {
|
|
|
309
247
|
* }
|
|
310
248
|
*/
|
|
311
249
|
type UserPostSchema = {
|
|
312
|
-
/** The roles to assign to the user. */
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
/** The
|
|
317
|
-
|
|
318
|
-
/** A static url linking to the avatar of the user. */
|
|
319
|
-
picture?: string;
|
|
320
|
-
/** The status of the created user within the tenant. */
|
|
321
|
-
status?: "invited";
|
|
322
|
-
/** The unique user identitier from an identity provider. */
|
|
323
|
-
subject: string;
|
|
324
|
-
/** The tenant that the user will belong too. */
|
|
250
|
+
/** The roles to assign to the user. */assignedRoles?: RefIDs | RefNames; /** The email address for the user. This is a required field when inviting a user. */
|
|
251
|
+
email?: string; /** The name of the user. */
|
|
252
|
+
name?: string; /** A static url linking to the avatar of the user. */
|
|
253
|
+
picture?: string; /** The status of the created user within the tenant. */
|
|
254
|
+
status?: "invited"; /** The unique user identitier from an identity provider. */
|
|
255
|
+
subject: string; /** The tenant that the user will belong too. */
|
|
325
256
|
tenantId?: string;
|
|
326
257
|
};
|
|
327
258
|
type Users = {
|
|
328
|
-
/** List of users. */
|
|
329
|
-
data?: User[];
|
|
330
|
-
/** Pagination links */
|
|
259
|
+
/** List of users. */data?: User[]; /** Pagination links */
|
|
331
260
|
links?: {
|
|
332
|
-
/** Link information for next page */
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
href: string;
|
|
336
|
-
};
|
|
337
|
-
/** Link information for previous page */
|
|
261
|
+
/** Link information for next page */next?: {
|
|
262
|
+
/** URL to the next page of records */href: string;
|
|
263
|
+
}; /** Link information for previous page */
|
|
338
264
|
prev?: {
|
|
339
|
-
/** URL to the previous page of records */
|
|
340
|
-
|
|
341
|
-
};
|
|
342
|
-
/** Link information for current page */
|
|
265
|
+
/** URL to the previous page of records */href: string;
|
|
266
|
+
}; /** Link information for current page */
|
|
343
267
|
self: {
|
|
344
|
-
/** URL to the current page of records */
|
|
345
|
-
href: string;
|
|
268
|
+
/** URL to the current page of records */href: string;
|
|
346
269
|
};
|
|
347
|
-
};
|
|
348
|
-
/** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
|
|
270
|
+
}; /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
|
|
349
271
|
totalResults?: number;
|
|
350
272
|
};
|
|
351
273
|
/**
|
|
@@ -355,8 +277,7 @@ type Users = {
|
|
|
355
277
|
* @throws GetUsersHttpError
|
|
356
278
|
*/
|
|
357
279
|
declare function getUsers(query: {
|
|
358
|
-
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */
|
|
359
|
-
fields?: string;
|
|
280
|
+
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */fields?: string;
|
|
360
281
|
/** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.
|
|
361
282
|
*
|
|
362
283
|
* The following fields support the `eq` operator: `id`, `subject`, `name`, `email`, `status`, `clientId`, `assignedRoles.id` `assignedRoles.name`, `assignedGroups.id`, `assignedGroupsAssignedRoles.name`
|
|
@@ -386,16 +307,11 @@ declare function getUsers(query: {
|
|
|
386
307
|
* ```
|
|
387
308
|
* name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
|
|
388
309
|
* ``` */
|
|
389
|
-
filter?: string;
|
|
390
|
-
/**
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
/** Get users that come before this cursor value when sorted. Cannot be used in conjunction with `next`. */
|
|
395
|
-
prev?: string;
|
|
396
|
-
/** The field to sort by, with +/- prefix indicating sort order */
|
|
397
|
-
sort?: "name" | "+name" | "-name" | "_id" | "+_id" | "-_id" | "id" | "+id" | "-id" | "tenantId" | "+tenantId" | "-tenantId" | "clientId" | "+clientId" | "-clientId" | "status" | "+status" | "-status" | "subject" | "+subject" | "-subject" | "email" | "+email" | "-email" | "inviteExpiry" | "+inviteExpiry" | "-inviteExpiry" | "createdAt" | "+createdAt" | "-createdAt";
|
|
398
|
-
/** Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint. */
|
|
310
|
+
filter?: string; /** The number of user entries to retrieve. */
|
|
311
|
+
limit?: number; /** Get users that come after this cursor value when sorted. Cannot be used in conjunction with `prev`. */
|
|
312
|
+
next?: string; /** Get users that come before this cursor value when sorted. Cannot be used in conjunction with `next`. */
|
|
313
|
+
prev?: string; /** The field to sort by, with +/- prefix indicating sort order */
|
|
314
|
+
sort?: "name" | "+name" | "-name" | "_id" | "+_id" | "-_id" | "id" | "+id" | "-id" | "tenantId" | "+tenantId" | "-tenantId" | "clientId" | "+clientId" | "-clientId" | "status" | "+status" | "-status" | "subject" | "+subject" | "-subject" | "email" | "+email" | "-email" | "inviteExpiry" | "+inviteExpiry" | "-inviteExpiry" | "createdAt" | "+createdAt" | "-createdAt"; /** Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint. */
|
|
399
315
|
totalResults?: boolean;
|
|
400
316
|
}, options?: ApiCallOptions): Promise<GetUsersHttpResponse>;
|
|
401
317
|
type GetUsersHttpResponse = {
|
|
@@ -468,15 +384,10 @@ type CountUsersWithoutQueryHttpError = {
|
|
|
468
384
|
* @throws FilterUsersHttpError
|
|
469
385
|
*/
|
|
470
386
|
declare function filterUsers(query: {
|
|
471
|
-
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */
|
|
472
|
-
|
|
473
|
-
/**
|
|
474
|
-
|
|
475
|
-
/** Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with prev. */
|
|
476
|
-
next?: string;
|
|
477
|
-
/** Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with next. */
|
|
478
|
-
prev?: string;
|
|
479
|
-
/** The field to sort by, with +/- prefix indicating sort order */
|
|
387
|
+
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */fields?: string; /** The number of user entries to retrieve. */
|
|
388
|
+
limit?: number; /** Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with prev. */
|
|
389
|
+
next?: string; /** Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with next. */
|
|
390
|
+
prev?: string; /** The field to sort by, with +/- prefix indicating sort order */
|
|
480
391
|
sort?: "name" | "+name" | "-name";
|
|
481
392
|
}, body: Filter, options?: ApiCallOptions): Promise<FilterUsersHttpResponse>;
|
|
482
393
|
type FilterUsersHttpResponse = {
|
|
@@ -549,8 +460,7 @@ type DeleteUserHttpError = {
|
|
|
549
460
|
* @throws GetUserHttpError
|
|
550
461
|
*/
|
|
551
462
|
declare function getUser(userId: string, query: {
|
|
552
|
-
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */
|
|
553
|
-
fields?: string;
|
|
463
|
+
/** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */fields?: string;
|
|
554
464
|
}, options?: ApiCallOptions): Promise<GetUserHttpResponse>;
|
|
555
465
|
type GetUserHttpResponse = {
|
|
556
466
|
data: User & unknown;
|
package/users.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/users.ts
|
|
5
5
|
/**
|
|
@@ -170,7 +170,6 @@ const usersExport = {
|
|
|
170
170
|
patchUser,
|
|
171
171
|
clearCache
|
|
172
172
|
};
|
|
173
|
-
var users_default = usersExport;
|
|
174
173
|
|
|
175
174
|
//#endregion
|
|
176
|
-
export { clearCache, countUsers, countUsersWithoutQuery, createUser,
|
|
175
|
+
export { clearCache, countUsers, countUsersWithoutQuery, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, inviteUsers, patchUser };
|
package/web-integrations.d.ts
CHANGED
|
@@ -1,27 +1,19 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/web-integrations.d.ts
|
|
5
5
|
/**
|
|
6
6
|
* An error object describing the error.
|
|
7
7
|
*/
|
|
8
8
|
type Error = {
|
|
9
|
-
/** The error code. */
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
detail?: string;
|
|
13
|
-
/** Additional properties relating to the error. */
|
|
14
|
-
meta?: unknown;
|
|
15
|
-
/** References to the source of the error. */
|
|
9
|
+
/** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the error. */
|
|
10
|
+
detail?: string; /** Additional properties relating to the error. */
|
|
11
|
+
meta?: unknown; /** References to the source of the error. */
|
|
16
12
|
source?: {
|
|
17
|
-
/** The URI query parameter that caused the error. */
|
|
18
|
-
parameter?: string;
|
|
19
|
-
/** A JSON Pointer to the property that caused the error. */
|
|
13
|
+
/** The URI query parameter that caused the error. */parameter?: string; /** A JSON Pointer to the property that caused the error. */
|
|
20
14
|
pointer?: string;
|
|
21
|
-
};
|
|
22
|
-
/**
|
|
23
|
-
status: string;
|
|
24
|
-
/** Summary of the problem. */
|
|
15
|
+
}; /** The HTTP status code. */
|
|
16
|
+
status: string; /** Summary of the problem. */
|
|
25
17
|
title: string;
|
|
26
18
|
};
|
|
27
19
|
/**
|
|
@@ -38,39 +30,27 @@ type Error = {
|
|
|
38
30
|
* }
|
|
39
31
|
*/
|
|
40
32
|
type Errors = {
|
|
41
|
-
/** An array of errors related to the operation. */
|
|
42
|
-
errors?: Error[];
|
|
43
|
-
/** A unique identifier for tracing the error. */
|
|
33
|
+
/** An array of errors related to the operation. */errors?: Error[]; /** A unique identifier for tracing the error. */
|
|
44
34
|
traceId?: string;
|
|
45
35
|
};
|
|
46
36
|
/**
|
|
47
37
|
* A web integration object.
|
|
48
38
|
*/
|
|
49
39
|
type WebIntegration = {
|
|
50
|
-
/** The time the web integration was created. */
|
|
51
|
-
readonly
|
|
52
|
-
/** The
|
|
53
|
-
readonly
|
|
54
|
-
/** The
|
|
55
|
-
|
|
56
|
-
/** The time the web integration was last updated. */
|
|
57
|
-
readonly lastUpdated?: string;
|
|
58
|
-
/** The name of the web integration. */
|
|
59
|
-
name?: string;
|
|
60
|
-
/** The tenant that the web integration belongs to. */
|
|
61
|
-
tenantId?: string;
|
|
62
|
-
/** The origins that are allowed to make requests to the tenant. */
|
|
40
|
+
/** The time the web integration was created. */readonly created?: string; /** The user that created the web integration. */
|
|
41
|
+
readonly createdBy?: string; /** The unique web integration identifier. */
|
|
42
|
+
readonly id?: string; /** The time the web integration was last updated. */
|
|
43
|
+
readonly lastUpdated?: string; /** The name of the web integration. */
|
|
44
|
+
name?: string; /** The tenant that the web integration belongs to. */
|
|
45
|
+
tenantId?: string; /** The origins that are allowed to make requests to the tenant. */
|
|
63
46
|
validOrigins?: string[];
|
|
64
47
|
};
|
|
65
48
|
/**
|
|
66
49
|
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
67
50
|
*/
|
|
68
51
|
type WebIntegrationPatch = {
|
|
69
|
-
/** The operation to be performed. */
|
|
70
|
-
|
|
71
|
-
/** A JSON Pointer. */
|
|
72
|
-
path: "/name" | "/validOrigins";
|
|
73
|
-
/** New value to be used for this operation. */
|
|
52
|
+
/** The operation to be performed. */op: "replace"; /** A JSON Pointer. */
|
|
53
|
+
path: "/name" | "/validOrigins"; /** New value to be used for this operation. */
|
|
74
54
|
value: string;
|
|
75
55
|
};
|
|
76
56
|
/**
|
|
@@ -88,57 +68,37 @@ type WebIntegrationPatchSchema = WebIntegrationPatch[];
|
|
|
88
68
|
* The creation of a web integration response.
|
|
89
69
|
*/
|
|
90
70
|
type WebIntegrationPost = {
|
|
91
|
-
/** The time the web integration was created. */
|
|
92
|
-
readonly
|
|
93
|
-
/** The
|
|
94
|
-
readonly
|
|
95
|
-
/** The unique web integration identifier. */
|
|
96
|
-
readonly id?: string;
|
|
97
|
-
/** The time the web integration was last updated. */
|
|
98
|
-
readonly lastUpdated?: string;
|
|
99
|
-
/** Pagination links */
|
|
71
|
+
/** The time the web integration was created. */readonly created?: string; /** The user that created the web integration. */
|
|
72
|
+
readonly createdBy?: string; /** The unique web integration identifier. */
|
|
73
|
+
readonly id?: string; /** The time the web integration was last updated. */
|
|
74
|
+
readonly lastUpdated?: string; /** Pagination links */
|
|
100
75
|
links?: {
|
|
101
|
-
/** Link information for current page. */
|
|
102
|
-
|
|
103
|
-
/** URL to the current page of records. */
|
|
104
|
-
href: string;
|
|
76
|
+
/** Link information for current page. */self: {
|
|
77
|
+
/** URL to the current page of records. */href: string;
|
|
105
78
|
};
|
|
106
|
-
};
|
|
107
|
-
/** The
|
|
108
|
-
|
|
109
|
-
/** The tenant that the web integration belongs to. */
|
|
110
|
-
tenantId?: string;
|
|
111
|
-
/** The origins that are allowed to make requests to the tenant. */
|
|
79
|
+
}; /** The name of the newly created web integration. */
|
|
80
|
+
name?: string; /** The tenant that the web integration belongs to. */
|
|
81
|
+
tenantId?: string; /** The origins that are allowed to make requests to the tenant. */
|
|
112
82
|
validOrigins?: string[];
|
|
113
83
|
};
|
|
114
84
|
type WebIntegrationPostSchema = {
|
|
115
|
-
/** The name of the web integration to create. */
|
|
116
|
-
name: string;
|
|
117
|
-
/** The origins that are allowed to make requests to the tenant. */
|
|
85
|
+
/** The name of the web integration to create. */name: string; /** The origins that are allowed to make requests to the tenant. */
|
|
118
86
|
validOrigins?: string[];
|
|
119
87
|
};
|
|
120
88
|
/**
|
|
121
89
|
* An array of web integration objects.
|
|
122
90
|
*/
|
|
123
91
|
type WebIntegrations = {
|
|
124
|
-
/** Properties of web integrations in a given tenant. */
|
|
125
|
-
data?: WebIntegration[];
|
|
126
|
-
/** Pagination links */
|
|
92
|
+
/** Properties of web integrations in a given tenant. */data?: WebIntegration[]; /** Pagination links */
|
|
127
93
|
links?: {
|
|
128
|
-
/** Link information for next page. */
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
href: string;
|
|
132
|
-
};
|
|
133
|
-
/** Link information for previous page. */
|
|
94
|
+
/** Link information for next page. */next?: {
|
|
95
|
+
/** URL to the next page of records. */href: string;
|
|
96
|
+
}; /** Link information for previous page. */
|
|
134
97
|
prev?: {
|
|
135
|
-
/** URL to the previous page of records. */
|
|
136
|
-
|
|
137
|
-
};
|
|
138
|
-
/** Link information for current page. */
|
|
98
|
+
/** URL to the previous page of records. */href: string;
|
|
99
|
+
}; /** Link information for current page. */
|
|
139
100
|
self: {
|
|
140
|
-
/** URL to the current page of records. */
|
|
141
|
-
href: string;
|
|
101
|
+
/** URL to the current page of records. */href: string;
|
|
142
102
|
};
|
|
143
103
|
};
|
|
144
104
|
};
|
|
@@ -149,15 +109,10 @@ type WebIntegrations = {
|
|
|
149
109
|
* @throws GetWebIntegrationsHttpError
|
|
150
110
|
*/
|
|
151
111
|
declare function getWebIntegrations(query: {
|
|
152
|
-
/** The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter. */
|
|
153
|
-
|
|
154
|
-
/** The
|
|
155
|
-
|
|
156
|
-
/** The field to sort by. Prefix with +/- to indicate ascending/descending order. */
|
|
157
|
-
sort?: "name" | "+name" | "-name";
|
|
158
|
-
/** The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore. */
|
|
159
|
-
startingAfter?: string;
|
|
160
|
-
/** The tenant ID to filter by. */
|
|
112
|
+
/** The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter. */endingBefore?: string; /** The number of web integration entries to retrieve. */
|
|
113
|
+
limit?: number; /** The field to sort by. Prefix with +/- to indicate ascending/descending order. */
|
|
114
|
+
sort?: "name" | "+name" | "-name"; /** The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore. */
|
|
115
|
+
startingAfter?: string; /** The tenant ID to filter by. */
|
|
161
116
|
tenantId?: string;
|
|
162
117
|
}, options?: ApiCallOptions): Promise<GetWebIntegrationsHttpResponse>;
|
|
163
118
|
type GetWebIntegrationsHttpResponse = {
|
package/web-integrations.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/web-integrations.ts
|
|
5
5
|
/**
|
|
@@ -93,7 +93,6 @@ const webIntegrationsExport = {
|
|
|
93
93
|
patchWebIntegration,
|
|
94
94
|
clearCache
|
|
95
95
|
};
|
|
96
|
-
var web_integrations_default = webIntegrationsExport;
|
|
97
96
|
|
|
98
97
|
//#endregion
|
|
99
|
-
export { clearCache, createWebIntegration,
|
|
98
|
+
export { clearCache, createWebIntegration, webIntegrationsExport as default, deleteWebIntegration, getWebIntegration, getWebIntegrations, patchWebIntegration };
|