@qlik/api 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/api-keys.d.mts +14 -0
  2. package/api-keys.d.ts +14 -0
  3. package/api-keys.js +14 -10
  4. package/api-keys.mjs +6 -2
  5. package/apps.d.mts +479 -149
  6. package/apps.d.ts +479 -149
  7. package/apps.js +100 -42
  8. package/apps.mjs +60 -2
  9. package/audits.d.mts +12 -0
  10. package/audits.d.ts +12 -0
  11. package/audits.js +10 -9
  12. package/audits.mjs +3 -2
  13. package/auth-AWZV4DPP.js +41 -0
  14. package/{auth-RTFXVSSK.mjs → auth-CPBNNC7S.mjs} +4 -1
  15. package/auth.js +4 -3
  16. package/auth.mjs +3 -2
  17. package/automations.d.mts +36 -0
  18. package/automations.d.ts +36 -0
  19. package/automations.js +28 -21
  20. package/automations.mjs +9 -2
  21. package/brands.d.mts +45 -4
  22. package/brands.d.ts +45 -4
  23. package/brands.js +20 -15
  24. package/brands.mjs +7 -2
  25. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  26. package/{chunk-7REWEWCX.mjs → chunk-3SVRHJII.mjs} +3 -3
  27. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  28. package/{chunk-M7F4JFOB.js → chunk-7RY3NO6N.js} +2 -2
  29. package/{chunk-NALKLKZS.mjs → chunk-CYRLVHU3.mjs} +316 -53
  30. package/{chunk-RMKP2BDX.js → chunk-D52VW5UN.js} +318 -55
  31. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  32. package/{chunk-QN23TPIE.js → chunk-GV5SRHY2.js} +4 -4
  33. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  34. package/chunk-P57PW2II.js +11 -0
  35. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  36. package/chunk-ZFXKCRJC.mjs +11 -0
  37. package/collections.d.mts +51 -17
  38. package/collections.d.ts +51 -17
  39. package/collections.js +28 -14
  40. package/collections.mjs +16 -2
  41. package/csp-origins.d.mts +16 -1
  42. package/csp-origins.d.ts +16 -1
  43. package/csp-origins.js +12 -9
  44. package/csp-origins.mjs +5 -2
  45. package/data-assets.d.mts +10 -0
  46. package/data-assets.d.ts +10 -0
  47. package/data-assets.js +13 -8
  48. package/data-assets.mjs +7 -2
  49. package/data-connections.d.mts +18 -0
  50. package/data-connections.d.ts +18 -0
  51. package/data-connections.js +19 -12
  52. package/data-connections.mjs +9 -2
  53. package/data-credentials.d.mts +8 -0
  54. package/data-credentials.d.ts +8 -0
  55. package/data-credentials.js +10 -7
  56. package/data-credentials.mjs +5 -2
  57. package/data-files.d.mts +98 -13
  58. package/data-files.d.ts +98 -13
  59. package/data-files.js +22 -15
  60. package/data-files.mjs +9 -2
  61. package/{enigma-session-VPPJMBEM.js → enigma-session-XPXDQAIV.js} +5 -4
  62. package/{enigma-session-HGXKZJVO.mjs → enigma-session-ZH6MYA54.mjs} +2 -1
  63. package/{esm-RX7B2TUN.js → esm-3VXX2GKL.js} +3 -1
  64. package/{esm-M5ZBFTVD.mjs → esm-OY4XVIJB.mjs} +3 -1
  65. package/extensions.d.mts +26 -2
  66. package/extensions.d.ts +26 -2
  67. package/extensions.js +13 -10
  68. package/extensions.mjs +5 -2
  69. package/glossaries.d.mts +55 -20
  70. package/glossaries.d.ts +55 -20
  71. package/glossaries.js +39 -27
  72. package/glossaries.mjs +14 -2
  73. package/groups.d.mts +16 -0
  74. package/groups.d.ts +16 -0
  75. package/groups.js +16 -11
  76. package/groups.mjs +7 -2
  77. package/identity-providers.d.mts +16 -0
  78. package/identity-providers.d.ts +16 -0
  79. package/identity-providers.js +14 -11
  80. package/identity-providers.mjs +5 -2
  81. package/index.js +135 -101
  82. package/index.mjs +131 -97
  83. package/{invoke-fetch-IMO4AMA3.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  84. package/invoke-fetch-UNTAUR7O.js +17 -0
  85. package/items.d.mts +6 -6
  86. package/items.d.ts +6 -6
  87. package/items.js +14 -11
  88. package/items.mjs +5 -2
  89. package/licenses.d.mts +18 -0
  90. package/licenses.d.ts +18 -0
  91. package/licenses.js +17 -12
  92. package/licenses.mjs +7 -2
  93. package/package.json +4 -4
  94. package/{qix-K22VHZRH.js → qix-UNWXPGMA.js} +9 -8
  95. package/{qix-57WD2ZE6.mjs → qix-ZSJ4PIK3.mjs} +3 -2
  96. package/qix.d.mts +1 -1
  97. package/qix.d.ts +1 -1
  98. package/qix.js +4 -3
  99. package/qix.mjs +3 -2
  100. package/quotas.d.mts +4 -0
  101. package/quotas.d.ts +4 -0
  102. package/quotas.js +6 -5
  103. package/quotas.mjs +3 -2
  104. package/reload-tasks.js +11 -8
  105. package/reload-tasks.mjs +5 -2
  106. package/reloads.d.mts +17 -10
  107. package/reloads.d.ts +17 -10
  108. package/reloads.js +9 -7
  109. package/reloads.mjs +4 -2
  110. package/roles.d.mts +4 -0
  111. package/roles.d.ts +4 -0
  112. package/roles.js +6 -5
  113. package/roles.mjs +3 -2
  114. package/spaces.d.mts +27 -4
  115. package/spaces.d.ts +27 -4
  116. package/spaces.js +21 -15
  117. package/spaces.mjs +8 -2
  118. package/temp-contents.d.mts +8 -3
  119. package/temp-contents.d.ts +8 -3
  120. package/temp-contents.js +8 -6
  121. package/temp-contents.mjs +4 -2
  122. package/tenants.d.mts +12 -0
  123. package/tenants.d.ts +12 -0
  124. package/tenants.js +14 -9
  125. package/tenants.mjs +7 -2
  126. package/themes.d.mts +26 -2
  127. package/themes.d.ts +26 -2
  128. package/themes.js +13 -10
  129. package/themes.mjs +5 -2
  130. package/transports.d.mts +12 -0
  131. package/transports.d.ts +12 -0
  132. package/transports.js +12 -9
  133. package/transports.mjs +5 -2
  134. package/users.d.mts +48 -29
  135. package/users.d.ts +48 -29
  136. package/users.js +18 -13
  137. package/users.mjs +7 -2
  138. package/web-integrations.d.mts +10 -0
  139. package/web-integrations.d.ts +10 -0
  140. package/web-integrations.js +11 -8
  141. package/web-integrations.mjs +5 -2
  142. package/web-notifications.d.mts +12 -0
  143. package/web-notifications.d.ts +12 -0
  144. package/web-notifications.js +12 -9
  145. package/web-notifications.mjs +5 -2
  146. package/webhooks.d.mts +25 -5
  147. package/webhooks.d.ts +25 -5
  148. package/webhooks.js +17 -13
  149. package/webhooks.mjs +6 -2
  150. package/auth-CSVTXOZX.js +0 -36
  151. package/auth-OU7OTB7Y.js +0 -38
  152. package/auth-TE272Q34.mjs +0 -36
  153. package/chunk-4ES65KO3.js +0 -57
  154. package/chunk-4FLMND6T.js +0 -25
  155. package/chunk-4OMEH5SW.mjs +0 -1337
  156. package/chunk-6JERR27K.js +0 -17
  157. package/chunk-E42WUFCK.mjs +0 -57
  158. package/chunk-H7SAZYEE.js +0 -21
  159. package/chunk-KMMWJZHM.mjs +0 -25
  160. package/chunk-W4J34XGA.mjs +0 -17
  161. package/chunk-WM7FQU2U.mjs +0 -21
  162. package/chunk-XASXL2NC.js +0 -1337
  163. package/enigma-session-4L373ALV.mjs +0 -10196
  164. package/enigma-session-TEB53FAF.js +0 -10196
  165. package/esm-4X3DKK5D.js +0 -63
  166. package/esm-SOWVJKOQ.mjs +0 -63
  167. package/invoke-fetch-7PKPQ3FD.js +0 -14
  168. package/invoke-fetch-MSSJAZ7K.mjs +0 -14
  169. package/invoke-fetch-PEI54KZO.js +0 -14
  170. package/qix-EU7PXRZ6.mjs +0 -573
  171. package/qix-RLTISYTB.js +0 -573
package/themes.mjs CHANGED
@@ -1,8 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-W4J34XGA.mjs";
5
- import "./chunk-7REWEWCX.mjs";
4
+ } from "./chunk-TE7XMBT5.mjs";
5
+ import "./chunk-3SVRHJII.mjs";
6
+ import "./chunk-ZFXKCRJC.mjs";
6
7
 
7
8
  // src/public/rest/themes.ts
8
9
  var getThemes = async (options) => invokeFetch("themes", {
@@ -14,6 +15,7 @@ var uploadTheme = async (body, options) => invokeFetch("themes", {
14
15
  method: "post",
15
16
  pathTemplate: "/api/v1/themes",
16
17
  body,
18
+ contentType: "multipart/form-data",
17
19
  options
18
20
  });
19
21
  var deleteTheme = async (id, options) => invokeFetch("themes", {
@@ -33,6 +35,7 @@ var patchTheme = async (id, body, options) => invokeFetch("themes", {
33
35
  pathTemplate: "/api/v1/themes/{id}",
34
36
  pathVariables: { id },
35
37
  body,
38
+ contentType: "multipart/form-data",
36
39
  options
37
40
  });
38
41
  var downloadTheme = async (id, options) => invokeFetch("themes", {
package/transports.d.mts CHANGED
@@ -113,6 +113,7 @@ type SmtpResult = {
113
113
  };
114
114
  /**
115
115
  * Deletes email configuration for a given tenant id (retrieved from JWT).
116
+ *
116
117
  * @throws DeleteEmailConfigHttpError
117
118
  */
118
119
  declare const deleteEmailConfig: (options?: ApiCallOptions) => Promise<DeleteEmailConfigHttpResponse>;
@@ -139,6 +140,7 @@ type DeleteEmailConfigdefaultHttpError = {
139
140
  type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigdefaultHttpError;
140
141
  /**
141
142
  * Returns the email configuration for a given tenant id (retrieved from JWT).
143
+ *
142
144
  * @throws GetEmailConfigHttpError
143
145
  */
144
146
  declare const getEmailConfig: (options?: ApiCallOptions) => Promise<GetEmailConfigHttpResponse>;
@@ -160,6 +162,7 @@ type GetEmailConfigdefaultHttpError = {
160
162
  type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigdefaultHttpError;
161
163
  /**
162
164
  * Patch the email configuration for a given tenant id (retrieved from JWT).
165
+ *
163
166
  * @param body an object with the body content
164
167
  * @throws PatchEmailConfigHttpError
165
168
  */
@@ -187,6 +190,7 @@ type PatchEmailConfigdefaultHttpError = {
187
190
  type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigdefaultHttpError;
188
191
  /**
189
192
  * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
193
+ *
190
194
  * @param body an object with the body content
191
195
  * @throws SendTestEmailHttpError
192
196
  */
@@ -214,6 +218,7 @@ type SendTestEmaildefaultHttpError = {
214
218
  type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmaildefaultHttpError;
215
219
  /**
216
220
  * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
221
+ *
217
222
  * @throws ValidateEmailConfigHttpError
218
223
  */
219
224
  declare const validateEmailConfig: (options?: ApiCallOptions) => Promise<ValidateEmailConfigHttpResponse>;
@@ -229,6 +234,7 @@ type ValidateEmailConfigHttpError = {
229
234
  };
230
235
  /**
231
236
  * Verifies connection to email server for tenant provided via JWT
237
+ *
232
238
  * @throws VerifyEmailConfigConnectionHttpError
233
239
  */
234
240
  declare const verifyEmailConfigConnection: (options?: ApiCallOptions) => Promise<VerifyEmailConfigConnectionHttpResponse>;
@@ -255,33 +261,39 @@ declare function clearCache(): void;
255
261
  interface TransportsAPI {
256
262
  /**
257
263
  * Deletes email configuration for a given tenant id (retrieved from JWT).
264
+ *
258
265
  * @throws DeleteEmailConfigHttpError
259
266
  */
260
267
  deleteEmailConfig: typeof deleteEmailConfig;
261
268
  /**
262
269
  * Returns the email configuration for a given tenant id (retrieved from JWT).
270
+ *
263
271
  * @throws GetEmailConfigHttpError
264
272
  */
265
273
  getEmailConfig: typeof getEmailConfig;
266
274
  /**
267
275
  * Patch the email configuration for a given tenant id (retrieved from JWT).
276
+ *
268
277
  * @param body an object with the body content
269
278
  * @throws PatchEmailConfigHttpError
270
279
  */
271
280
  patchEmailConfig: typeof patchEmailConfig;
272
281
  /**
273
282
  * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
283
+ *
274
284
  * @param body an object with the body content
275
285
  * @throws SendTestEmailHttpError
276
286
  */
277
287
  sendTestEmail: typeof sendTestEmail;
278
288
  /**
279
289
  * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
290
+ *
280
291
  * @throws ValidateEmailConfigHttpError
281
292
  */
282
293
  validateEmailConfig: typeof validateEmailConfig;
283
294
  /**
284
295
  * Verifies connection to email server for tenant provided via JWT
296
+ *
285
297
  * @throws VerifyEmailConfigConnectionHttpError
286
298
  */
287
299
  verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
package/transports.d.ts CHANGED
@@ -113,6 +113,7 @@ type SmtpResult = {
113
113
  };
114
114
  /**
115
115
  * Deletes email configuration for a given tenant id (retrieved from JWT).
116
+ *
116
117
  * @throws DeleteEmailConfigHttpError
117
118
  */
118
119
  declare const deleteEmailConfig: (options?: ApiCallOptions) => Promise<DeleteEmailConfigHttpResponse>;
@@ -139,6 +140,7 @@ type DeleteEmailConfigdefaultHttpError = {
139
140
  type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigdefaultHttpError;
140
141
  /**
141
142
  * Returns the email configuration for a given tenant id (retrieved from JWT).
143
+ *
142
144
  * @throws GetEmailConfigHttpError
143
145
  */
144
146
  declare const getEmailConfig: (options?: ApiCallOptions) => Promise<GetEmailConfigHttpResponse>;
@@ -160,6 +162,7 @@ type GetEmailConfigdefaultHttpError = {
160
162
  type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigdefaultHttpError;
161
163
  /**
162
164
  * Patch the email configuration for a given tenant id (retrieved from JWT).
165
+ *
163
166
  * @param body an object with the body content
164
167
  * @throws PatchEmailConfigHttpError
165
168
  */
@@ -187,6 +190,7 @@ type PatchEmailConfigdefaultHttpError = {
187
190
  type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigdefaultHttpError;
188
191
  /**
189
192
  * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
193
+ *
190
194
  * @param body an object with the body content
191
195
  * @throws SendTestEmailHttpError
192
196
  */
@@ -214,6 +218,7 @@ type SendTestEmaildefaultHttpError = {
214
218
  type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmaildefaultHttpError;
215
219
  /**
216
220
  * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
221
+ *
217
222
  * @throws ValidateEmailConfigHttpError
218
223
  */
219
224
  declare const validateEmailConfig: (options?: ApiCallOptions) => Promise<ValidateEmailConfigHttpResponse>;
@@ -229,6 +234,7 @@ type ValidateEmailConfigHttpError = {
229
234
  };
230
235
  /**
231
236
  * Verifies connection to email server for tenant provided via JWT
237
+ *
232
238
  * @throws VerifyEmailConfigConnectionHttpError
233
239
  */
234
240
  declare const verifyEmailConfigConnection: (options?: ApiCallOptions) => Promise<VerifyEmailConfigConnectionHttpResponse>;
@@ -255,33 +261,39 @@ declare function clearCache(): void;
255
261
  interface TransportsAPI {
256
262
  /**
257
263
  * Deletes email configuration for a given tenant id (retrieved from JWT).
264
+ *
258
265
  * @throws DeleteEmailConfigHttpError
259
266
  */
260
267
  deleteEmailConfig: typeof deleteEmailConfig;
261
268
  /**
262
269
  * Returns the email configuration for a given tenant id (retrieved from JWT).
270
+ *
263
271
  * @throws GetEmailConfigHttpError
264
272
  */
265
273
  getEmailConfig: typeof getEmailConfig;
266
274
  /**
267
275
  * Patch the email configuration for a given tenant id (retrieved from JWT).
276
+ *
268
277
  * @param body an object with the body content
269
278
  * @throws PatchEmailConfigHttpError
270
279
  */
271
280
  patchEmailConfig: typeof patchEmailConfig;
272
281
  /**
273
282
  * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
283
+ *
274
284
  * @param body an object with the body content
275
285
  * @throws SendTestEmailHttpError
276
286
  */
277
287
  sendTestEmail: typeof sendTestEmail;
278
288
  /**
279
289
  * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
290
+ *
280
291
  * @throws ValidateEmailConfigHttpError
281
292
  */
282
293
  validateEmailConfig: typeof validateEmailConfig;
283
294
  /**
284
295
  * Verifies connection to email server for tenant provided via JWT
296
+ *
285
297
  * @throws VerifyEmailConfigConnectionHttpError
286
298
  */
287
299
  verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
package/transports.js CHANGED
@@ -1,44 +1,47 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunk6JERR27Kjs = require('./chunk-6JERR27K.js');
5
- require('./chunk-H7SAZYEE.js');
4
+ var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
5
+ require('./chunk-2STFUQKQ.js');
6
+ require('./chunk-P57PW2II.js');
6
7
 
7
8
  // src/public/rest/transports.ts
8
- var deleteEmailConfig = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
9
+ var deleteEmailConfig = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
9
10
  method: "delete",
10
11
  pathTemplate: "/api/v1/transports/email-config",
11
12
  options
12
13
  });
13
- var getEmailConfig = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
14
+ var getEmailConfig = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
14
15
  method: "get",
15
16
  pathTemplate: "/api/v1/transports/email-config",
16
17
  options
17
18
  });
18
- var patchEmailConfig = async (body, options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
19
+ var patchEmailConfig = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
19
20
  method: "patch",
20
21
  pathTemplate: "/api/v1/transports/email-config",
21
22
  body,
23
+ contentType: "application/json",
22
24
  options
23
25
  });
24
- var sendTestEmail = async (body, options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
26
+ var sendTestEmail = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
25
27
  method: "post",
26
28
  pathTemplate: "/api/v1/transports/email-config/actions/send-test-email",
27
29
  body,
30
+ contentType: "application/json",
28
31
  options
29
32
  });
30
- var validateEmailConfig = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
33
+ var validateEmailConfig = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
31
34
  method: "post",
32
35
  pathTemplate: "/api/v1/transports/email-config/actions/validate",
33
36
  options
34
37
  });
35
- var verifyEmailConfigConnection = async (options) => _chunk6JERR27Kjs.invokeFetch.call(void 0, "transports", {
38
+ var verifyEmailConfigConnection = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "transports", {
36
39
  method: "post",
37
40
  pathTemplate: "/api/v1/transports/email-config/actions/verify-connection",
38
41
  options
39
42
  });
40
43
  function clearCache() {
41
- return _chunk6JERR27Kjs.clearApiCache.call(void 0, "transports");
44
+ return _chunkJNGURO23js.clearApiCache.call(void 0, "transports");
42
45
  }
43
46
  var transportsExport = {
44
47
  deleteEmailConfig,
package/transports.mjs CHANGED
@@ -1,8 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-W4J34XGA.mjs";
5
- import "./chunk-7REWEWCX.mjs";
4
+ } from "./chunk-TE7XMBT5.mjs";
5
+ import "./chunk-3SVRHJII.mjs";
6
+ import "./chunk-ZFXKCRJC.mjs";
6
7
 
7
8
  // src/public/rest/transports.ts
8
9
  var deleteEmailConfig = async (options) => invokeFetch("transports", {
@@ -19,12 +20,14 @@ var patchEmailConfig = async (body, options) => invokeFetch("transports", {
19
20
  method: "patch",
20
21
  pathTemplate: "/api/v1/transports/email-config",
21
22
  body,
23
+ contentType: "application/json",
22
24
  options
23
25
  });
24
26
  var sendTestEmail = async (body, options) => invokeFetch("transports", {
25
27
  method: "post",
26
28
  pathTemplate: "/api/v1/transports/email-config/actions/send-test-email",
27
29
  body,
30
+ contentType: "application/json",
28
31
  options
29
32
  });
30
33
  var validateEmailConfig = async (options) => invokeFetch("transports", {
package/users.d.mts CHANGED
@@ -211,6 +211,7 @@ type Users = {
211
211
  };
212
212
  /**
213
213
  * Returns a list of users using cursor-based pagination.
214
+ *
214
215
  * @param query an object with query parameters
215
216
  * @throws GetUsersHttpError
216
217
  */
@@ -222,35 +223,34 @@ declare const getUsers: (query: {
222
223
  /** 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. */
223
224
  fields?: string;
224
225
  /** 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.
225
- //
226
- // The following fields support the `eq` operator: `id`, `subject`, `name`, `email`, `status`, `clientId`, `assignedRoles.id` `assignedRoles.name`, `assignedGroups.id`, `assignedGroupsAssignedRoles.name`
227
- //
228
- // Additionally, the following fields support the `co` operator: `name`, `email`, `subject`
229
- //
230
- // Queries may be rate limited if they differ greatly from these examples:
231
- //
232
- // ```
233
- // (id eq "62716ab404a7bd8626af9bd6" or id eq "62716ac4c7e500e13ff5fa22") and (status eq "active" or status eq "disabled")
234
- // ```
235
- //
236
- // ```
237
- // name co "query" or email co "query" or subject co "query" or id eq "query" or assignedRoles.name eq "query"
238
- // ```
239
- //
240
- // Any filters for status must be grouped together and applied to the whole query.
241
- //
242
- // Valid:
243
- //
244
- // ```
245
- // (name eq "Bob" or name eq "Alice") and (status eq "active" or status eq "disabled")
246
- // ```
247
- //
248
- // Invalid:
249
- //
250
- // ```
251
- // name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
252
- // ```
253
- // */
226
+ *
227
+ * The following fields support the `eq` operator: `id`, `subject`, `name`, `email`, `status`, `clientId`, `assignedRoles.id` `assignedRoles.name`, `assignedGroups.id`, `assignedGroupsAssignedRoles.name`
228
+ *
229
+ * Additionally, the following fields support the `co` operator: `name`, `email`, `subject`
230
+ *
231
+ * Queries may be rate limited if they differ greatly from these examples:
232
+ *
233
+ * ```
234
+ * (id eq "62716ab404a7bd8626af9bd6" or id eq "62716ac4c7e500e13ff5fa22") and (status eq "active" or status eq "disabled")
235
+ * ```
236
+ *
237
+ * ```
238
+ * name co "query" or email co "query" or subject co "query" or id eq "query" or assignedRoles.name eq "query"
239
+ * ```
240
+ *
241
+ * Any filters for status must be grouped together and applied to the whole query.
242
+ *
243
+ * Valid:
244
+ *
245
+ * ```
246
+ * (name eq "Bob" or name eq "Alice") and (status eq "active" or status eq "disabled")
247
+ * ```
248
+ *
249
+ * Invalid:
250
+ *
251
+ * ```
252
+ * name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
253
+ * ``` */
254
254
  filter?: string;
255
255
  /** The number of user entries to retrieve. */
256
256
  limit?: number;
@@ -291,6 +291,7 @@ type GetUsersHttpError = {
291
291
  };
292
292
  /**
293
293
  * Creates an invited user.
294
+ *
294
295
  * @param body an object with the body content
295
296
  * @throws CreateUserHttpError
296
297
  */
@@ -307,6 +308,7 @@ type CreateUserHttpError = {
307
308
  };
308
309
  /**
309
310
  * Returns the number of users in a given tenant
311
+ *
310
312
  * @param query an object with query parameters
311
313
  * @throws CountUsersHttpError
312
314
  */
@@ -326,6 +328,7 @@ type CountUsersHttpError = {
326
328
  };
327
329
  /**
328
330
  * Retrieves a list of users matching the filter using an advanced query string.
331
+ *
329
332
  * @param query an object with query parameters
330
333
  * @param body an object with the body content
331
334
  * @throws FilterUsersHttpError
@@ -356,6 +359,7 @@ type FilterUsersHttpError = {
356
359
  };
357
360
  /**
358
361
  * Invite one or more users by email address.
362
+ *
359
363
  * @param body an object with the body content
360
364
  * @throws InviteUsersHttpError
361
365
  */
@@ -372,6 +376,7 @@ type InviteUsersHttpError = {
372
376
  };
373
377
  /**
374
378
  * Redirects to retrieve the user resource associated with the JWT claims.
379
+ *
375
380
  * @throws GetMyUserHttpError
376
381
  */
377
382
  declare const getMyUser: (options?: ApiCallOptions) => Promise<GetMyUserHttpResponse>;
@@ -393,6 +398,7 @@ type GetMyUser429HttpError = {
393
398
  type GetMyUserHttpError = GetMyUser301HttpError | GetMyUser429HttpError;
394
399
  /**
395
400
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
401
+ *
396
402
  * @throws GetUsersMetadataHttpError
397
403
  */
398
404
  declare const getUsersMetadata: (options?: ApiCallOptions) => Promise<GetUsersMetadataHttpResponse>;
@@ -408,6 +414,7 @@ type GetUsersMetadataHttpError = {
408
414
  };
409
415
  /**
410
416
  * Deletes the requested user.
417
+ *
411
418
  * @param userId The ID of the user to delete.
412
419
  * @throws DeleteUserHttpError
413
420
  */
@@ -424,6 +431,7 @@ type DeleteUserHttpError = {
424
431
  };
425
432
  /**
426
433
  * Returns the requested user.
434
+ *
427
435
  * @param userId The user's unique identifier
428
436
  * @param query an object with query parameters
429
437
  * @throws GetUserHttpError
@@ -444,6 +452,7 @@ type GetUserHttpError = {
444
452
  };
445
453
  /**
446
454
  * Updates fields for a user resource
455
+ *
447
456
  * @param userId The ID of the user to update.
448
457
  * @param body an object with the body content
449
458
  * @throws PatchUserHttpError
@@ -472,24 +481,28 @@ declare function clearCache(): void;
472
481
  interface UsersAPI {
473
482
  /**
474
483
  * Returns a list of users using cursor-based pagination.
484
+ *
475
485
  * @param query an object with query parameters
476
486
  * @throws GetUsersHttpError
477
487
  */
478
488
  getUsers: typeof getUsers;
479
489
  /**
480
490
  * Creates an invited user.
491
+ *
481
492
  * @param body an object with the body content
482
493
  * @throws CreateUserHttpError
483
494
  */
484
495
  createUser: typeof createUser;
485
496
  /**
486
497
  * Returns the number of users in a given tenant
498
+ *
487
499
  * @param query an object with query parameters
488
500
  * @throws CountUsersHttpError
489
501
  */
490
502
  countUsers: typeof countUsers;
491
503
  /**
492
504
  * Retrieves a list of users matching the filter using an advanced query string.
505
+ *
493
506
  * @param query an object with query parameters
494
507
  * @param body an object with the body content
495
508
  * @throws FilterUsersHttpError
@@ -497,28 +510,33 @@ interface UsersAPI {
497
510
  filterUsers: typeof filterUsers;
498
511
  /**
499
512
  * Invite one or more users by email address.
513
+ *
500
514
  * @param body an object with the body content
501
515
  * @throws InviteUsersHttpError
502
516
  */
503
517
  inviteUsers: typeof inviteUsers;
504
518
  /**
505
519
  * Redirects to retrieve the user resource associated with the JWT claims.
520
+ *
506
521
  * @throws GetMyUserHttpError
507
522
  */
508
523
  getMyUser: typeof getMyUser;
509
524
  /**
510
525
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
526
+ *
511
527
  * @throws GetUsersMetadataHttpError
512
528
  */
513
529
  getUsersMetadata: typeof getUsersMetadata;
514
530
  /**
515
531
  * Deletes the requested user.
532
+ *
516
533
  * @param userId The ID of the user to delete.
517
534
  * @throws DeleteUserHttpError
518
535
  */
519
536
  deleteUser: typeof deleteUser;
520
537
  /**
521
538
  * Returns the requested user.
539
+ *
522
540
  * @param userId The user's unique identifier
523
541
  * @param query an object with query parameters
524
542
  * @throws GetUserHttpError
@@ -526,6 +544,7 @@ interface UsersAPI {
526
544
  getUser: typeof getUser;
527
545
  /**
528
546
  * Updates fields for a user resource
547
+ *
529
548
  * @param userId The ID of the user to update.
530
549
  * @param body an object with the body content
531
550
  * @throws PatchUserHttpError