@qlik/api 0.0.8 → 0.0.10

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.
Files changed (157) hide show
  1. package/api-keys.d.mts +10 -1
  2. package/api-keys.d.ts +10 -1
  3. package/api-keys.js +11 -11
  4. package/api-keys.mjs +3 -3
  5. package/apps.d.mts +134 -8
  6. package/apps.d.ts +134 -8
  7. package/apps.js +47 -47
  8. package/apps.mjs +3 -3
  9. package/audits.d.mts +14 -1
  10. package/audits.d.ts +14 -1
  11. package/audits.js +10 -10
  12. package/audits.mjs +3 -3
  13. package/auth.js +4 -4
  14. package/auth.mjs +3 -3
  15. package/automations.d.mts +9 -1
  16. package/automations.d.ts +9 -1
  17. package/automations.js +22 -22
  18. package/automations.mjs +3 -3
  19. package/brands.d.mts +19 -4
  20. package/brands.d.ts +19 -4
  21. package/brands.js +16 -16
  22. package/brands.mjs +3 -3
  23. package/{enigma-session-VSFGLOYW.mjs → chunks/34FMVD4C.mjs} +165 -21
  24. package/{chunk-QTCDGPKS.js → chunks/37PLWNAN.js} +82 -60
  25. package/{chunk-GY2TAYQH.js → chunks/3MHXEHLQ.js} +2 -2
  26. package/{invoke-fetch-X42FV2FS.mjs → chunks/42LZKDDD.mjs} +2 -2
  27. package/{enigma-session-VTHT4O6N.js → chunks/AVQ3WHH7.js} +168 -24
  28. package/{chunk-BRDPNGQ7.js → chunks/FG5GDUSZ.js} +3 -3
  29. package/{chunk-4R2XCEVK.mjs → chunks/FUU5VIC4.mjs} +1 -1
  30. package/{esm-HMY2LVVZ.mjs → chunks/H32EGPZN.mjs} +1 -1
  31. package/{qix-57OF6A7B.mjs → chunks/HFNJ3ERI.mjs} +3 -3
  32. package/{chunk-4MWB2T3C.mjs → chunks/HWZC3PIL.mjs} +1 -1
  33. package/{chunk-RYBRKLOY.js → chunks/ILOY5QEA.js} +4 -4
  34. package/{chunk-YILVC32M.mjs → chunks/KEPPVUY3.mjs} +1 -1
  35. package/{auth-U6QTT3H4.mjs → chunks/MMUU2CQM.mjs} +2 -2
  36. package/{chunk-LLLEO6K6.mjs → chunks/O5POHH2Q.mjs} +3 -3
  37. package/{chunk-EALMXU6S.js → chunks/QMWU5E4D.js} +3 -3
  38. package/chunks/RMNAO4DP.js +17 -0
  39. package/chunks/SUYUL6MB.js +41 -0
  40. package/{chunk-F24SLAYP.mjs → chunks/VMS4MOCI.mjs} +79 -57
  41. package/{qix-QWSMFPQY.js → chunks/WCJ4JQHA.js} +9 -9
  42. package/{esm-PXQUPJYJ.js → chunks/WM2VCN4G.js} +1 -1
  43. package/collections.d.mts +34 -22
  44. package/collections.d.ts +34 -22
  45. package/collections.js +15 -15
  46. package/collections.mjs +3 -3
  47. package/csp-origins.d.mts +1 -1
  48. package/csp-origins.d.ts +1 -1
  49. package/csp-origins.js +10 -10
  50. package/csp-origins.mjs +3 -3
  51. package/data-assets.d.mts +1 -1
  52. package/data-assets.d.ts +1 -1
  53. package/data-assets.js +9 -9
  54. package/data-assets.mjs +3 -3
  55. package/data-connections.d.mts +13 -2
  56. package/data-connections.d.ts +13 -2
  57. package/data-connections.js +13 -13
  58. package/data-connections.mjs +3 -3
  59. package/data-credentials.d.mts +6 -1
  60. package/data-credentials.d.ts +6 -1
  61. package/data-credentials.js +8 -8
  62. package/data-credentials.mjs +3 -3
  63. package/data-files.d.mts +7 -1
  64. package/data-files.d.ts +7 -1
  65. package/data-files.js +16 -16
  66. package/data-files.mjs +3 -3
  67. package/extensions.d.mts +13 -1
  68. package/extensions.d.ts +13 -1
  69. package/extensions.js +11 -11
  70. package/extensions.mjs +3 -3
  71. package/{global.types-4jzAvW7R.d.mts → global.types-5iFvFJvX.d.mts} +5 -1
  72. package/{global.types-1rNhDH7j.d.ts → global.types-TzVhFPid.d.ts} +5 -1
  73. package/glossaries.d.mts +51 -1
  74. package/glossaries.d.ts +51 -1
  75. package/glossaries.js +28 -28
  76. package/glossaries.mjs +3 -3
  77. package/groups.d.mts +40 -1
  78. package/groups.d.ts +40 -1
  79. package/groups.js +12 -12
  80. package/groups.mjs +3 -3
  81. package/identity-providers.d.mts +43 -1
  82. package/identity-providers.d.ts +43 -1
  83. package/identity-providers.js +12 -12
  84. package/identity-providers.mjs +3 -3
  85. package/index.d.mts +1 -1
  86. package/index.d.ts +1 -1
  87. package/index.js +9 -9
  88. package/index.mjs +5 -5
  89. package/items.d.mts +33 -2
  90. package/items.d.ts +33 -2
  91. package/items.js +12 -12
  92. package/items.mjs +3 -3
  93. package/licenses.d.mts +8 -5
  94. package/licenses.d.ts +8 -5
  95. package/licenses.js +13 -13
  96. package/licenses.mjs +3 -3
  97. package/package.json +4 -1
  98. package/qix.d.mts +20 -2
  99. package/qix.d.ts +20 -2
  100. package/qix.js +4 -4
  101. package/qix.mjs +3 -3
  102. package/quotas.d.mts +4 -1
  103. package/quotas.d.ts +4 -1
  104. package/quotas.js +6 -6
  105. package/quotas.mjs +3 -3
  106. package/reload-tasks.d.mts +7 -4
  107. package/reload-tasks.d.ts +7 -4
  108. package/reload-tasks.js +9 -9
  109. package/reload-tasks.mjs +3 -3
  110. package/reloads.d.mts +10 -1
  111. package/reloads.d.ts +10 -1
  112. package/reloads.js +8 -8
  113. package/reloads.mjs +3 -3
  114. package/roles.d.mts +11 -2
  115. package/roles.d.ts +11 -2
  116. package/roles.js +6 -6
  117. package/roles.mjs +3 -3
  118. package/spaces.d.mts +38 -6
  119. package/spaces.d.ts +38 -6
  120. package/spaces.js +16 -16
  121. package/spaces.mjs +3 -3
  122. package/temp-contents.d.mts +7 -1
  123. package/temp-contents.d.ts +7 -1
  124. package/temp-contents.js +7 -7
  125. package/temp-contents.mjs +3 -3
  126. package/tenants.d.mts +18 -6
  127. package/tenants.d.ts +18 -6
  128. package/tenants.js +10 -10
  129. package/tenants.mjs +3 -3
  130. package/themes.d.mts +10 -1
  131. package/themes.d.ts +10 -1
  132. package/themes.js +11 -11
  133. package/themes.mjs +3 -3
  134. package/transports.d.mts +21 -12
  135. package/transports.d.ts +21 -12
  136. package/transports.js +10 -10
  137. package/transports.mjs +3 -3
  138. package/users.d.mts +90 -25
  139. package/users.d.ts +90 -25
  140. package/users.js +14 -14
  141. package/users.mjs +3 -3
  142. package/web-integrations.d.mts +19 -1
  143. package/web-integrations.d.ts +19 -1
  144. package/web-integrations.js +9 -9
  145. package/web-integrations.mjs +3 -3
  146. package/web-notifications.d.mts +19 -1
  147. package/web-notifications.d.ts +19 -1
  148. package/web-notifications.js +10 -10
  149. package/web-notifications.mjs +3 -3
  150. package/webhooks.d.mts +4 -1
  151. package/webhooks.d.ts +4 -1
  152. package/webhooks.js +14 -14
  153. package/webhooks.mjs +3 -3
  154. package/auth-XY6FVSVM.js +0 -41
  155. package/invoke-fetch-FRLO3CK6.js +0 -17
  156. /package/{chunk-P57PW2II.js → chunks/4HB3TAEO.js} +0 -0
  157. /package/{chunk-ZFXKCRJC.mjs → chunks/VSY5YIQY.mjs} +0 -0
package/users.d.mts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
1
+ import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
+ /**
5
+ * An array of group references.
6
+ */
4
7
  type AssignedGroups = {
5
8
  /** An array of role references. */
6
9
  assignedRoles?: AssignedRoles;
@@ -9,6 +12,9 @@ type AssignedGroups = {
9
12
  /** The group name */
10
13
  readonly name: string;
11
14
  }[];
15
+ /**
16
+ * An array of role references.
17
+ */
12
18
  type AssignedRoles = {
13
19
  /** The unique role identitier */
14
20
  id: string;
@@ -21,15 +27,27 @@ type AssignedRoles = {
21
27
  /** The type of role */
22
28
  readonly type: "default";
23
29
  }[];
30
+ /**
31
+ * An array of role reference identifiers.
32
+ */
24
33
  type AssignedRolesRefIDs = {
25
34
  /** The unique role identitier */
26
35
  id: string;
27
36
  }[];
37
+ /**
38
+ * An array of role reference names.
39
+ */
28
40
  type AssignedRolesRefNames = {
29
41
  /** The name of the role */
30
42
  name: string;
31
43
  }[];
44
+ /**
45
+ * An array of scopes assigned to user
46
+ */
32
47
  type AssignedScopes = string[];
48
+ /**
49
+ * An error object describing the error.
50
+ */
33
51
  type Error = {
34
52
  /** The error code. */
35
53
  code: string;
@@ -49,6 +67,9 @@ type Error = {
49
67
  /** Summary of the problem. */
50
68
  title: string;
51
69
  };
70
+ /**
71
+ * Error object.
72
+ */
52
73
  type ErrorItem = {
53
74
  /** Error code */
54
75
  code: number;
@@ -57,6 +78,9 @@ type ErrorItem = {
57
78
  /** Summary of the problem */
58
79
  title: string;
59
80
  };
81
+ /**
82
+ * The error response object describing the error from the handling of an HTTP request.
83
+ */
60
84
  type Errors = {
61
85
  /** An array of errors related to the operation. */
62
86
  errors?: Error[];
@@ -66,13 +90,22 @@ type Errors = {
66
90
  type ErrorsResponse = {
67
91
  errors?: ErrorItem[];
68
92
  };
93
+ /**
94
+ * An advanced query filter to be used for complex user querying in the tenant.
95
+ */
69
96
  type Filter = {
70
97
  /** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
71
98
  filter?: string;
72
99
  };
100
+ /**
101
+ * Data list - ResultItem or ErrorItem for each InviteeItem.
102
+ */
73
103
  type InviteDataResponse = {
74
104
  data?: (ResultItem | InviteErrorItem)[];
75
105
  };
106
+ /**
107
+ * Error object.
108
+ */
76
109
  type InviteErrorItem = ErrorItem & {
77
110
  /** Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error | */
78
111
  code?: string;
@@ -95,6 +128,9 @@ type InviteRequestData = {
95
128
  /** List of invitees who should receive an invite email. */
96
129
  invitees?: InviteItem[];
97
130
  };
131
+ /**
132
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
133
+ */
98
134
  type JSONPatch = {
99
135
  /** The operation to be performed. */
100
136
  op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
@@ -103,11 +139,22 @@ type JSONPatch = {
103
139
  /** The value to be used for this operation. */
104
140
  value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
105
141
  };
142
+ /**
143
+ * An array of JSON Patch documents
144
+ */
106
145
  type JSONPatchArray = JSONPatch[];
146
+ /**
147
+ * @deprecated
148
+ *
149
+ * An object containing the metadata for the user configuration.
150
+ */
107
151
  type Metadata = {
108
152
  /** List of system roles to which the user can be assigned. */
109
153
  valid_roles?: string[];
110
154
  };
155
+ /**
156
+ * Invitee result item
157
+ */
111
158
  type ResultItem = {
112
159
  /** Email specified for this invitee */
113
160
  email: string;
@@ -118,6 +165,9 @@ type ResultItem = {
118
165
  /** UserId for this invitee */
119
166
  userId: string;
120
167
  };
168
+ /**
169
+ * A user object.
170
+ */
121
171
  type User = {
122
172
  /** An array of group references. */
123
173
  assignedGroups?: AssignedGroups;
@@ -125,7 +175,8 @@ type User = {
125
175
  assignedRoles?: AssignedRoles;
126
176
  /** An array of scopes assigned to user */
127
177
  readonly assignedScopes?: AssignedScopes;
128
- /** Deprecated. Use `createdAt` instead. */
178
+ /** @deprecated
179
+ * Deprecated. Use `createdAt` instead. */
129
180
  readonly created?: string;
130
181
  /** The timestamp for when the user record was created. */
131
182
  readonly createdAt?: string;
@@ -135,7 +186,8 @@ type User = {
135
186
  readonly id: string;
136
187
  /** The number of seconds until the user invitation will expire. */
137
188
  readonly inviteExpiry?: number;
138
- /** Deprecated. Use `lastUpdatedAt` instead. */
189
+ /** @deprecated
190
+ * Deprecated. Use `lastUpdatedAt` instead. */
139
191
  readonly lastUpdated?: string;
140
192
  /** The timestamp for when the user record was last updated. */
141
193
  readonly lastUpdatedAt?: string;
@@ -157,7 +209,8 @@ type User = {
157
209
  preferredLocale?: string;
158
210
  /** Represents the end-user's preferred time zone. */
159
211
  preferredZoneinfo?: string;
160
- /** List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
212
+ /** @deprecated
213
+ * List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
161
214
  roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
162
215
  /** The status of the user within the tenant. */
163
216
  status?: "active" | "invited" | "disabled" | "deleted";
@@ -168,6 +221,9 @@ type User = {
168
221
  /** Represents the end-user's time zone. */
169
222
  zoneinfo?: string;
170
223
  };
224
+ /**
225
+ * The result object for the user count.
226
+ */
171
227
  type UserCount = {
172
228
  /** The total number of users in the tenant. */
173
229
  total: number;
@@ -181,7 +237,8 @@ type UserPostSchema = {
181
237
  name?: string;
182
238
  /** A static url linking to the avatar of the user. */
183
239
  picture?: string;
184
- /** List of system roles to which the user has been assigned. Only returned when permitted by access control. */
240
+ /** @deprecated
241
+ * List of system roles to which the user has been assigned. Only returned when permitted by access control. */
185
242
  roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
186
243
  /** The status of the created user within the tenant. */
187
244
  status?: "invited";
@@ -219,9 +276,11 @@ type Users = {
219
276
  * @throws GetUsersHttpError
220
277
  */
221
278
  declare const getUsers: (query: {
222
- /** The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
279
+ /** @deprecated
280
+ * The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
223
281
  email?: string;
224
- /** Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
282
+ /** @deprecated
283
+ * Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
225
284
  endingBefore?: string;
226
285
  /** 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. */
227
286
  fields?: string;
@@ -261,21 +320,28 @@ declare const getUsers: (query: {
261
320
  next?: string;
262
321
  /** Get users that come before this cursor value when sorted. Cannot be used in conjunction with `next`. */
263
322
  prev?: string;
264
- /** The role to filter by. Deprecated. */
323
+ /** @deprecated
324
+ * The role to filter by. Deprecated. */
265
325
  role?: string;
266
326
  /** The field to sort by, with +/- prefix indicating sort order */
267
327
  sort?: "name" | "+name" | "-name";
268
- /** The user parameter to sort by. Deprecated. Use `sort` instead. */
328
+ /** @deprecated
329
+ * The user parameter to sort by. Deprecated. Use `sort` instead. */
269
330
  sortBy?: "name";
270
- /** The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
331
+ /** @deprecated
332
+ * The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
271
333
  sortOrder?: "asc" | "desc";
272
- /** Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
334
+ /** @deprecated
335
+ * Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
273
336
  startingAfter?: string;
274
- /** The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
337
+ /** @deprecated
338
+ * The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
275
339
  status?: "active" | "invited" | "disabled" | "deleted";
276
- /** The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
340
+ /** @deprecated
341
+ * The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
277
342
  subject?: string;
278
- /** The tenant ID to filter by. Deprecated. */
343
+ /** @deprecated
344
+ * The tenant ID to filter by. Deprecated. */
279
345
  tenantId?: string;
280
346
  /** 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. */
281
347
  totalResults?: boolean;
@@ -316,7 +382,8 @@ type CreateUserHttpError = {
316
382
  * @throws CountUsersHttpError
317
383
  */
318
384
  declare const countUsers: (query: {
319
- /** The tenant ID to filter by. */
385
+ /** @deprecated
386
+ * The tenant ID to filter by. */
320
387
  tenantId?: string;
321
388
  }, options?: ApiCallOptions) => Promise<CountUsersHttpResponse>;
322
389
  type CountUsersHttpResponse = {
@@ -384,22 +451,18 @@ type InviteUsersHttpError = {
384
451
  */
385
452
  declare const getMyUser: (options?: ApiCallOptions) => Promise<GetMyUserHttpResponse>;
386
453
  type GetMyUserHttpResponse = {
387
- data: void;
454
+ data: User;
388
455
  headers: Headers;
389
456
  status: number;
390
457
  };
391
- type GetMyUser301HttpError = {
392
- data: void;
393
- headers: Headers;
394
- status: 301;
395
- };
396
- type GetMyUser429HttpError = {
458
+ type GetMyUserHttpError = {
397
459
  data: Errors;
398
460
  headers: Headers;
399
- status: 429;
461
+ status: number;
400
462
  };
401
- type GetMyUserHttpError = GetMyUser301HttpError | GetMyUser429HttpError;
402
463
  /**
464
+ * @deprecated
465
+ *
403
466
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
404
467
  *
405
468
  * @throws GetUsersMetadataHttpError
@@ -525,6 +588,8 @@ interface UsersAPI {
525
588
  */
526
589
  getMyUser: typeof getMyUser;
527
590
  /**
591
+ * @deprecated
592
+ *
528
593
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
529
594
  *
530
595
  * @throws GetUsersMetadataHttpError
@@ -563,4 +628,4 @@ interface UsersAPI {
563
628
  */
564
629
  declare const usersExport: UsersAPI;
565
630
 
566
- export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUser301HttpError, type GetMyUser429HttpError, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, getUsersMetadata, inviteUsers, patchUser };
631
+ export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, getUsersMetadata, inviteUsers, patchUser };
package/users.d.ts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
1
+ import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
+ /**
5
+ * An array of group references.
6
+ */
4
7
  type AssignedGroups = {
5
8
  /** An array of role references. */
6
9
  assignedRoles?: AssignedRoles;
@@ -9,6 +12,9 @@ type AssignedGroups = {
9
12
  /** The group name */
10
13
  readonly name: string;
11
14
  }[];
15
+ /**
16
+ * An array of role references.
17
+ */
12
18
  type AssignedRoles = {
13
19
  /** The unique role identitier */
14
20
  id: string;
@@ -21,15 +27,27 @@ type AssignedRoles = {
21
27
  /** The type of role */
22
28
  readonly type: "default";
23
29
  }[];
30
+ /**
31
+ * An array of role reference identifiers.
32
+ */
24
33
  type AssignedRolesRefIDs = {
25
34
  /** The unique role identitier */
26
35
  id: string;
27
36
  }[];
37
+ /**
38
+ * An array of role reference names.
39
+ */
28
40
  type AssignedRolesRefNames = {
29
41
  /** The name of the role */
30
42
  name: string;
31
43
  }[];
44
+ /**
45
+ * An array of scopes assigned to user
46
+ */
32
47
  type AssignedScopes = string[];
48
+ /**
49
+ * An error object describing the error.
50
+ */
33
51
  type Error = {
34
52
  /** The error code. */
35
53
  code: string;
@@ -49,6 +67,9 @@ type Error = {
49
67
  /** Summary of the problem. */
50
68
  title: string;
51
69
  };
70
+ /**
71
+ * Error object.
72
+ */
52
73
  type ErrorItem = {
53
74
  /** Error code */
54
75
  code: number;
@@ -57,6 +78,9 @@ type ErrorItem = {
57
78
  /** Summary of the problem */
58
79
  title: string;
59
80
  };
81
+ /**
82
+ * The error response object describing the error from the handling of an HTTP request.
83
+ */
60
84
  type Errors = {
61
85
  /** An array of errors related to the operation. */
62
86
  errors?: Error[];
@@ -66,13 +90,22 @@ type Errors = {
66
90
  type ErrorsResponse = {
67
91
  errors?: ErrorItem[];
68
92
  };
93
+ /**
94
+ * An advanced query filter to be used for complex user querying in the tenant.
95
+ */
69
96
  type Filter = {
70
97
  /** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
71
98
  filter?: string;
72
99
  };
100
+ /**
101
+ * Data list - ResultItem or ErrorItem for each InviteeItem.
102
+ */
73
103
  type InviteDataResponse = {
74
104
  data?: (ResultItem | InviteErrorItem)[];
75
105
  };
106
+ /**
107
+ * Error object.
108
+ */
76
109
  type InviteErrorItem = ErrorItem & {
77
110
  /** Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error | */
78
111
  code?: string;
@@ -95,6 +128,9 @@ type InviteRequestData = {
95
128
  /** List of invitees who should receive an invite email. */
96
129
  invitees?: InviteItem[];
97
130
  };
131
+ /**
132
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
133
+ */
98
134
  type JSONPatch = {
99
135
  /** The operation to be performed. */
100
136
  op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
@@ -103,11 +139,22 @@ type JSONPatch = {
103
139
  /** The value to be used for this operation. */
104
140
  value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
105
141
  };
142
+ /**
143
+ * An array of JSON Patch documents
144
+ */
106
145
  type JSONPatchArray = JSONPatch[];
146
+ /**
147
+ * @deprecated
148
+ *
149
+ * An object containing the metadata for the user configuration.
150
+ */
107
151
  type Metadata = {
108
152
  /** List of system roles to which the user can be assigned. */
109
153
  valid_roles?: string[];
110
154
  };
155
+ /**
156
+ * Invitee result item
157
+ */
111
158
  type ResultItem = {
112
159
  /** Email specified for this invitee */
113
160
  email: string;
@@ -118,6 +165,9 @@ type ResultItem = {
118
165
  /** UserId for this invitee */
119
166
  userId: string;
120
167
  };
168
+ /**
169
+ * A user object.
170
+ */
121
171
  type User = {
122
172
  /** An array of group references. */
123
173
  assignedGroups?: AssignedGroups;
@@ -125,7 +175,8 @@ type User = {
125
175
  assignedRoles?: AssignedRoles;
126
176
  /** An array of scopes assigned to user */
127
177
  readonly assignedScopes?: AssignedScopes;
128
- /** Deprecated. Use `createdAt` instead. */
178
+ /** @deprecated
179
+ * Deprecated. Use `createdAt` instead. */
129
180
  readonly created?: string;
130
181
  /** The timestamp for when the user record was created. */
131
182
  readonly createdAt?: string;
@@ -135,7 +186,8 @@ type User = {
135
186
  readonly id: string;
136
187
  /** The number of seconds until the user invitation will expire. */
137
188
  readonly inviteExpiry?: number;
138
- /** Deprecated. Use `lastUpdatedAt` instead. */
189
+ /** @deprecated
190
+ * Deprecated. Use `lastUpdatedAt` instead. */
139
191
  readonly lastUpdated?: string;
140
192
  /** The timestamp for when the user record was last updated. */
141
193
  readonly lastUpdatedAt?: string;
@@ -157,7 +209,8 @@ type User = {
157
209
  preferredLocale?: string;
158
210
  /** Represents the end-user's preferred time zone. */
159
211
  preferredZoneinfo?: string;
160
- /** List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
212
+ /** @deprecated
213
+ * List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
161
214
  roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
162
215
  /** The status of the user within the tenant. */
163
216
  status?: "active" | "invited" | "disabled" | "deleted";
@@ -168,6 +221,9 @@ type User = {
168
221
  /** Represents the end-user's time zone. */
169
222
  zoneinfo?: string;
170
223
  };
224
+ /**
225
+ * The result object for the user count.
226
+ */
171
227
  type UserCount = {
172
228
  /** The total number of users in the tenant. */
173
229
  total: number;
@@ -181,7 +237,8 @@ type UserPostSchema = {
181
237
  name?: string;
182
238
  /** A static url linking to the avatar of the user. */
183
239
  picture?: string;
184
- /** List of system roles to which the user has been assigned. Only returned when permitted by access control. */
240
+ /** @deprecated
241
+ * List of system roles to which the user has been assigned. Only returned when permitted by access control. */
185
242
  roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
186
243
  /** The status of the created user within the tenant. */
187
244
  status?: "invited";
@@ -219,9 +276,11 @@ type Users = {
219
276
  * @throws GetUsersHttpError
220
277
  */
221
278
  declare const getUsers: (query: {
222
- /** The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
279
+ /** @deprecated
280
+ * The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
223
281
  email?: string;
224
- /** Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
282
+ /** @deprecated
283
+ * Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
225
284
  endingBefore?: string;
226
285
  /** 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. */
227
286
  fields?: string;
@@ -261,21 +320,28 @@ declare const getUsers: (query: {
261
320
  next?: string;
262
321
  /** Get users that come before this cursor value when sorted. Cannot be used in conjunction with `next`. */
263
322
  prev?: string;
264
- /** The role to filter by. Deprecated. */
323
+ /** @deprecated
324
+ * The role to filter by. Deprecated. */
265
325
  role?: string;
266
326
  /** The field to sort by, with +/- prefix indicating sort order */
267
327
  sort?: "name" | "+name" | "-name";
268
- /** The user parameter to sort by. Deprecated. Use `sort` instead. */
328
+ /** @deprecated
329
+ * The user parameter to sort by. Deprecated. Use `sort` instead. */
269
330
  sortBy?: "name";
270
- /** The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
331
+ /** @deprecated
332
+ * The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
271
333
  sortOrder?: "asc" | "desc";
272
- /** Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
334
+ /** @deprecated
335
+ * Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
273
336
  startingAfter?: string;
274
- /** The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
337
+ /** @deprecated
338
+ * The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
275
339
  status?: "active" | "invited" | "disabled" | "deleted";
276
- /** The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
340
+ /** @deprecated
341
+ * The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
277
342
  subject?: string;
278
- /** The tenant ID to filter by. Deprecated. */
343
+ /** @deprecated
344
+ * The tenant ID to filter by. Deprecated. */
279
345
  tenantId?: string;
280
346
  /** 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. */
281
347
  totalResults?: boolean;
@@ -316,7 +382,8 @@ type CreateUserHttpError = {
316
382
  * @throws CountUsersHttpError
317
383
  */
318
384
  declare const countUsers: (query: {
319
- /** The tenant ID to filter by. */
385
+ /** @deprecated
386
+ * The tenant ID to filter by. */
320
387
  tenantId?: string;
321
388
  }, options?: ApiCallOptions) => Promise<CountUsersHttpResponse>;
322
389
  type CountUsersHttpResponse = {
@@ -384,22 +451,18 @@ type InviteUsersHttpError = {
384
451
  */
385
452
  declare const getMyUser: (options?: ApiCallOptions) => Promise<GetMyUserHttpResponse>;
386
453
  type GetMyUserHttpResponse = {
387
- data: void;
454
+ data: User;
388
455
  headers: Headers;
389
456
  status: number;
390
457
  };
391
- type GetMyUser301HttpError = {
392
- data: void;
393
- headers: Headers;
394
- status: 301;
395
- };
396
- type GetMyUser429HttpError = {
458
+ type GetMyUserHttpError = {
397
459
  data: Errors;
398
460
  headers: Headers;
399
- status: 429;
461
+ status: number;
400
462
  };
401
- type GetMyUserHttpError = GetMyUser301HttpError | GetMyUser429HttpError;
402
463
  /**
464
+ * @deprecated
465
+ *
403
466
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
404
467
  *
405
468
  * @throws GetUsersMetadataHttpError
@@ -525,6 +588,8 @@ interface UsersAPI {
525
588
  */
526
589
  getMyUser: typeof getMyUser;
527
590
  /**
591
+ * @deprecated
592
+ *
528
593
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
529
594
  *
530
595
  * @throws GetUsersMetadataHttpError
@@ -563,4 +628,4 @@ interface UsersAPI {
563
628
  */
564
629
  declare const usersExport: UsersAPI;
565
630
 
566
- export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUser301HttpError, type GetMyUser429HttpError, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, getUsersMetadata, inviteUsers, patchUser };
631
+ export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, getUsersMetadata, inviteUsers, patchUser };
package/users.js CHANGED
@@ -1,31 +1,31 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
5
- require('./chunk-BRDPNGQ7.js');
6
- require('./chunk-P57PW2II.js');
4
+ var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
5
+ require('./chunks/FG5GDUSZ.js');
6
+ require('./chunks/4HB3TAEO.js');
7
7
 
8
8
  // src/public/rest/users.ts
9
- var getUsers = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
9
+ var getUsers = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/users",
12
12
  query,
13
13
  options
14
14
  });
15
- var createUser = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
15
+ var createUser = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
16
16
  method: "post",
17
17
  pathTemplate: "/api/v1/users",
18
18
  body,
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var countUsers = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
22
+ var countUsers = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
23
23
  method: "get",
24
24
  pathTemplate: "/api/v1/users/actions/count",
25
25
  query,
26
26
  options
27
27
  });
28
- var filterUsers = async (query, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
28
+ var filterUsers = async (query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
29
29
  method: "post",
30
30
  pathTemplate: "/api/v1/users/actions/filter",
31
31
  query,
@@ -33,37 +33,37 @@ var filterUsers = async (query, body, options) => _chunkEALMXU6Sjs.invokeFetch.c
33
33
  contentType: "application/json",
34
34
  options
35
35
  });
36
- var inviteUsers = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
36
+ var inviteUsers = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
37
37
  method: "post",
38
38
  pathTemplate: "/api/v1/users/actions/invite",
39
39
  body,
40
40
  contentType: "application/json",
41
41
  options
42
42
  });
43
- var getMyUser = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
43
+ var getMyUser = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
44
44
  method: "get",
45
45
  pathTemplate: "/api/v1/users/me",
46
46
  options
47
47
  });
48
- var getUsersMetadata = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
48
+ var getUsersMetadata = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
49
49
  method: "get",
50
50
  pathTemplate: "/api/v1/users/metadata",
51
51
  options
52
52
  });
53
- var deleteUser = async (userId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
53
+ var deleteUser = async (userId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
54
54
  method: "delete",
55
55
  pathTemplate: "/api/v1/users/{userId}",
56
56
  pathVariables: { userId },
57
57
  options
58
58
  });
59
- var getUser = async (userId, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
59
+ var getUser = async (userId, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
60
60
  method: "get",
61
61
  pathTemplate: "/api/v1/users/{userId}",
62
62
  pathVariables: { userId },
63
63
  query,
64
64
  options
65
65
  });
66
- var patchUser = async (userId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "users", {
66
+ var patchUser = async (userId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "users", {
67
67
  method: "patch",
68
68
  pathTemplate: "/api/v1/users/{userId}",
69
69
  pathVariables: { userId },
@@ -72,7 +72,7 @@ var patchUser = async (userId, body, options) => _chunkEALMXU6Sjs.invokeFetch.ca
72
72
  options
73
73
  });
74
74
  function clearCache() {
75
- return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "users");
75
+ return _QMWU5E4Djs.clearApiCache.call(void 0, "users");
76
76
  }
77
77
  var usersExport = {
78
78
  getUsers,
package/users.mjs CHANGED
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-4MWB2T3C.mjs";
5
- import "./chunk-LLLEO6K6.mjs";
6
- import "./chunk-ZFXKCRJC.mjs";
4
+ } from "./chunks/HWZC3PIL.mjs";
5
+ import "./chunks/O5POHH2Q.mjs";
6
+ import "./chunks/VSY5YIQY.mjs";
7
7
 
8
8
  // src/public/rest/users.ts
9
9
  var getUsers = async (query, options) => invokeFetch("users", {