@qlik/api 1.22.0 → 1.24.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.
Files changed (84) hide show
  1. package/api-keys.d.ts +6 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +10 -2
  4. package/apps.js +2 -2
  5. package/audits.d.ts +4 -16
  6. package/audits.js +2 -2
  7. package/auth.js +2 -2
  8. package/automations.d.ts +2 -59
  9. package/automations.js +3 -19
  10. package/brands.d.ts +23 -23
  11. package/brands.js +2 -2
  12. package/chunks/{GZRY5VHW.js → 3DYV7KOJ.js} +2 -2
  13. package/chunks/{SEBN4KFZ.js → 6DEESTGF.js} +2 -2
  14. package/chunks/{PR52AAWU.js → 6QRR5VUM.js} +36 -32
  15. package/chunks/7BDAXGID.js +116 -0
  16. package/chunks/{TGDZVKG2.js → BL5PJM4B.js} +1 -1
  17. package/chunks/{SNQHDUYY.js → CZC7KEJN.js} +3 -3
  18. package/chunks/{OEVNZ5IQ.js → I5UOE4ZZ.js} +90 -85
  19. package/chunks/{KBR7JBWC.js → N3ZFICDU.js} +38 -24
  20. package/chunks/{VHPC6L7L.js → OIQ5ELGS.js} +1 -1
  21. package/chunks/{TUPLQG25.js → UA6BE3VB.js} +2 -2
  22. package/chunks/{EUWNVVK5.js → VX3MQBE7.js} +1 -1
  23. package/collections.d.ts +1 -1
  24. package/collections.js +2 -2
  25. package/csp-origins.d.ts +1 -1
  26. package/csp-origins.js +2 -2
  27. package/data-assets.d.ts +1 -1
  28. package/data-assets.js +2 -2
  29. package/data-connections.d.ts +2 -2
  30. package/data-connections.js +2 -2
  31. package/data-credentials.d.ts +64 -2
  32. package/data-credentials.js +11 -2
  33. package/data-files.d.ts +1 -1
  34. package/data-files.js +2 -2
  35. package/docs/rest.md +47 -0
  36. package/extensions.d.ts +1 -1
  37. package/extensions.js +2 -2
  38. package/glossaries.d.ts +3 -4
  39. package/glossaries.js +2 -2
  40. package/groups.d.ts +1 -1
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +17 -17
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +11 -4
  45. package/index.js +90 -79
  46. package/interceptors.d.ts +51 -0
  47. package/interceptors.js +17 -0
  48. package/{global.types-qsBNouXJ.d.ts → invoke-fetch-types-BLrpeZOL.d.ts} +81 -48
  49. package/items.d.ts +1 -1
  50. package/items.js +2 -2
  51. package/licenses.d.ts +3 -1
  52. package/licenses.js +2 -2
  53. package/package.json +2 -2
  54. package/qix.d.ts +6 -3
  55. package/qix.js +2 -2
  56. package/quotas.d.ts +1 -1
  57. package/quotas.js +2 -2
  58. package/reload-tasks.d.ts +1 -1
  59. package/reload-tasks.js +2 -2
  60. package/reloads.d.ts +1 -1
  61. package/reloads.js +2 -2
  62. package/reports.d.ts +42 -4
  63. package/reports.js +2 -2
  64. package/roles.d.ts +98 -4
  65. package/roles.js +28 -4
  66. package/spaces.d.ts +3 -1
  67. package/spaces.js +2 -2
  68. package/temp-contents.d.ts +5 -5
  69. package/temp-contents.js +2 -2
  70. package/tenants.d.ts +25 -16
  71. package/tenants.js +2 -2
  72. package/themes.d.ts +1 -1
  73. package/themes.js +2 -2
  74. package/transports.d.ts +1 -1
  75. package/transports.js +2 -2
  76. package/users.d.ts +4 -39
  77. package/users.js +2 -9
  78. package/web-integrations.d.ts +1 -1
  79. package/web-integrations.js +2 -2
  80. package/web-notifications.d.ts +1 -1
  81. package/web-notifications.js +2 -2
  82. package/webhooks.d.ts +1 -1
  83. package/webhooks.js +2 -2
  84. package/chunks/7RHSSS4W.js +0 -0
package/api-keys.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type ApiKey = {
@@ -121,6 +121,10 @@ type Link = {
121
121
  /** The URL for the link. */
122
122
  href: string;
123
123
  };
124
+ type RetryAfterHeader = {
125
+ /** The amount of seconds to wait before retrying the request. */
126
+ "retry-after"?: number;
127
+ };
124
128
  type ApiKeyPage = {
125
129
  /** Properties of API keys in a given tenant. */
126
130
  data: ApiKey[];
@@ -337,4 +341,4 @@ interface ApiKeysAPI {
337
341
  */
338
342
  declare const apiKeysExport: ApiKeysAPI;
339
343
 
340
- export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysConfigHttpError, type GetApiKeysConfigHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, type PatchApiKeysConfigHttpError, type PatchApiKeysConfigHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeys, getApiKeysConfig, patchApiKey, patchApiKeysConfig };
344
+ export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysConfigHttpError, type GetApiKeysConfigHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, type PatchApiKeysConfigHttpError, type PatchApiKeysConfigHttpResponse, type RetryAfterHeader, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeys, getApiKeysConfig, patchApiKey, patchApiKeysConfig };
package/api-keys.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/api-keys.ts
package/apps.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
@@ -463,7 +463,15 @@ type FilterError = {
463
463
  * - "REP-500000" Fail to resolve resource.
464
464
  * - "REP-503005" Engine unavailable, qix-sessions error no engines available.
465
465
  * - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
466
- * - "REP-504042" Context deadline exceeded applying selections of the Filter. */
466
+ * - "REP-504042" Context deadline exceeded applying selections of the Filter.
467
+ * - "REP-500031" Error creating bookmark.
468
+ * - "REP-404032" Bookmark not found after creating the bookmark.
469
+ * - "REP-500033" Error destroying bookmark.
470
+ * - "REP-404033" Bookmark not found destroying the bookmark.
471
+ * - "REP-409043" Dupliacate bookmark name.
472
+ * - "REP-429034" Filters quota exceeded.
473
+ * - "REP-400044" Missing or renamed field.
474
+ * - "REP-403049" Report filter access not allowed. */
467
475
  code: string;
468
476
  /** A summary in english explaining what went wrong. */
469
477
  title: string;
package/apps.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/apps.ts
package/audits.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type ErrorResponse = {
@@ -59,8 +59,6 @@ type GetByIDResult = {
59
59
  userId?: string;
60
60
  };
61
61
  type GetLinks = {
62
- /** @deprecated */
63
- Self?: Href;
64
62
  self?: Href;
65
63
  };
66
64
  type GetObjectsResult = {
@@ -82,24 +80,14 @@ type GetSettingsResult = {
82
80
  EventTTL?: number;
83
81
  };
84
82
  };
85
- /**
86
- * @deprecated
87
- */
88
- type Href = {
89
- /** @deprecated */
90
- Href?: string;
91
- };
92
83
  type ListLinks = {
93
- /** @deprecated */
94
- Next?: Href;
95
- /** @deprecated */
96
- Prev?: Href;
97
- /** @deprecated */
98
- Self?: Href;
99
84
  next?: Href;
100
85
  prev?: Href;
101
86
  self?: Href;
102
87
  };
88
+ type Href = {
89
+ href?: string;
90
+ };
103
91
  /**
104
92
  * Retrieves list of events for subscribed services for your tenant. Stores events for 90 days, after which they can be accessed via `/v1/audits/archive`.
105
93
  *
package/audits.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/audits.ts
package/auth.js CHANGED
@@ -4,8 +4,8 @@ import {
4
4
  logout,
5
5
  registerAuthModule,
6
6
  setDefaultHostConfig
7
- } from "./chunks/TGDZVKG2.js";
8
- import "./chunks/SNQHDUYY.js";
7
+ } from "./chunks/BL5PJM4B.js";
8
+ import "./chunks/CZC7KEJN.js";
9
9
  export {
10
10
  auth_default as default,
11
11
  getAccessToken,
package/automations.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type AutomationDetailRequestObject = {
@@ -174,9 +174,6 @@ type ScheduleResponseObject = {
174
174
  stopAt?: string;
175
175
  timezone?: string;
176
176
  };
177
- type SettingsObject = {
178
- automationsEnabled?: boolean;
179
- };
180
177
  type UsageList = {
181
178
  data?: UsageObject[];
182
179
  links?: Links;
@@ -235,43 +232,6 @@ type CreateAutomationHttpError = {
235
232
  headers: Headers;
236
233
  status: number;
237
234
  };
238
- /**
239
- * @deprecated
240
- *
241
- * Retrieves the automation settings.
242
- *
243
- * @throws GetAutomationsSettingsHttpError
244
- */
245
- declare const getAutomationsSettings: (options?: ApiCallOptions) => Promise<GetAutomationsSettingsHttpResponse>;
246
- type GetAutomationsSettingsHttpResponse = {
247
- data: SettingsObject;
248
- headers: Headers;
249
- status: number;
250
- };
251
- type GetAutomationsSettingsHttpError = {
252
- data: ErrorResponse;
253
- headers: Headers;
254
- status: number;
255
- };
256
- /**
257
- * @deprecated
258
- *
259
- * Update the automation settings.
260
- *
261
- * @param body an object with the body content
262
- * @throws UpdateAutomationsSettingsHttpError
263
- */
264
- declare const updateAutomationsSettings: (body: SettingsObject, options?: ApiCallOptions) => Promise<UpdateAutomationsSettingsHttpResponse>;
265
- type UpdateAutomationsSettingsHttpResponse = {
266
- data: SettingsObject;
267
- headers: Headers;
268
- status: number;
269
- };
270
- type UpdateAutomationsSettingsHttpError = {
271
- data: ErrorResponse;
272
- headers: Headers;
273
- status: number;
274
- };
275
235
  /**
276
236
  * Retrieves all automation usage for a tenant
277
237
  *
@@ -609,23 +569,6 @@ interface AutomationsAPI {
609
569
  * @throws CreateAutomationHttpError
610
570
  */
611
571
  createAutomation: typeof createAutomation;
612
- /**
613
- * @deprecated
614
- *
615
- * Retrieves the automation settings.
616
- *
617
- * @throws GetAutomationsSettingsHttpError
618
- */
619
- getAutomationsSettings: typeof getAutomationsSettings;
620
- /**
621
- * @deprecated
622
- *
623
- * Update the automation settings.
624
- *
625
- * @param body an object with the body content
626
- * @throws UpdateAutomationsSettingsHttpError
627
- */
628
- updateAutomationsSettings: typeof updateAutomationsSettings;
629
572
  /**
630
573
  * Retrieves all automation usage for a tenant
631
574
  *
@@ -760,4 +703,4 @@ interface AutomationsAPI {
760
703
  */
761
704
  declare const automationsExport: AutomationsAPI;
762
705
 
763
- export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunWithQueryHttpError, type GetAutomationRunWithQueryHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type GetAutomationWithQueryHttpError, type GetAutomationWithQueryHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, type GetAutomationsSettingsHttpError, type GetAutomationsSettingsHttpResponse, type GetAutomationsUsageMetricsHttpError, type GetAutomationsUsageMetricsHttpResponse, type Links, type MoveAutomationHttpError, type MoveAutomationHttpResponse, type PaginationLink, type QueueAutomationRunHttpError, type QueueAutomationRunHttpResponse, type RetryAutomationRunHttpError, type RetryAutomationRunHttpResponse, type RunDetailRequestObject, type RunDetailResponseObject, type RunList, type RunListObject, type ScheduleRequestObject, type ScheduleResponseObject, type SettingsObject, type StopAutomationRunHttpError, type StopAutomationRunHttpResponse, type UpdateAutomationHttpError, type UpdateAutomationHttpResponse, type UpdateAutomationsSettingsHttpError, type UpdateAutomationsSettingsHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRunWithQuery, getAutomationRuns, getAutomationWithQuery, getAutomations, getAutomationsSettings, getAutomationsUsageMetrics, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation, updateAutomationsSettings };
706
+ export { type AutomationDetailRequestObject, type AutomationDetailResponseObject, type AutomationList, type AutomationListObject, type AutomationUsageObject, type AutomationsAPI, type CopyAutomationHttpError, type CopyAutomationHttpResponse, type CreateAutomationHttpError, type CreateAutomationHttpResponse, type DeleteAutomationHttpError, type DeleteAutomationHttpResponse, type DisableAutomationHttpError, type DisableAutomationHttpResponse, type EnableAutomationHttpError, type EnableAutomationHttpResponse, type Error, type ErrorResponse, type GetAutomationHttpError, type GetAutomationHttpResponse, type GetAutomationRunDetailsHttpError, type GetAutomationRunDetailsHttpResponse, type GetAutomationRunHttpError, type GetAutomationRunHttpResponse, type GetAutomationRunWithQueryHttpError, type GetAutomationRunWithQueryHttpResponse, type GetAutomationRunsHttpError, type GetAutomationRunsHttpResponse, type GetAutomationWithQueryHttpError, type GetAutomationWithQueryHttpResponse, type GetAutomationsHttpError, type GetAutomationsHttpResponse, type GetAutomationsUsageMetricsHttpError, type GetAutomationsUsageMetricsHttpResponse, type Links, type MoveAutomationHttpError, type MoveAutomationHttpResponse, type PaginationLink, type QueueAutomationRunHttpError, type QueueAutomationRunHttpResponse, type RetryAutomationRunHttpError, type RetryAutomationRunHttpResponse, type RunDetailRequestObject, type RunDetailResponseObject, type RunList, type RunListObject, type ScheduleRequestObject, type ScheduleResponseObject, type StopAutomationRunHttpError, type StopAutomationRunHttpResponse, type UpdateAutomationHttpError, type UpdateAutomationHttpResponse, type UsageList, type UsageObject, clearCache, copyAutomation, createAutomation, automationsExport as default, deleteAutomation, disableAutomation, enableAutomation, getAutomation, getAutomationRun, getAutomationRunDetails, getAutomationRunWithQuery, getAutomationRuns, getAutomationWithQuery, getAutomations, getAutomationsUsageMetrics, moveAutomation, queueAutomationRun, retryAutomationRun, stopAutomationRun, updateAutomation };
package/automations.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/automations.ts
@@ -19,18 +19,6 @@ var createAutomation = async (body, options) => invokeFetch("automations", {
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var getAutomationsSettings = async (options) => invokeFetch("automations", {
23
- method: "get",
24
- pathTemplate: "/api/v1/automations/settings",
25
- options
26
- });
27
- var updateAutomationsSettings = async (body, options) => invokeFetch("automations", {
28
- method: "put",
29
- pathTemplate: "/api/v1/automations/settings",
30
- body,
31
- contentType: "application/json",
32
- options
33
- });
34
22
  var getAutomationsUsageMetrics = async (query, options) => invokeFetch("automations", {
35
23
  method: "get",
36
24
  pathTemplate: "/api/v1/automations/usage",
@@ -144,8 +132,6 @@ function clearCache() {
144
132
  var automationsExport = {
145
133
  getAutomations,
146
134
  createAutomation,
147
- getAutomationsSettings,
148
- updateAutomationsSettings,
149
135
  getAutomationsUsageMetrics,
150
136
  deleteAutomation,
151
137
  getAutomationWithQuery,
@@ -180,12 +166,10 @@ export {
180
166
  getAutomationRuns,
181
167
  getAutomationWithQuery,
182
168
  getAutomations,
183
- getAutomationsSettings,
184
169
  getAutomationsUsageMetrics,
185
170
  moveAutomation,
186
171
  queueAutomationRun,
187
172
  retryAutomationRun,
188
173
  stopAutomationRun,
189
- updateAutomation,
190
- updateAutomationsSettings
174
+ updateAutomation
191
175
  };
package/brands.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -100,7 +100,7 @@ type Link = {
100
100
  */
101
101
  type NoActiveBrand = unknown;
102
102
  /**
103
- * Lists all brand entries for a tenant
103
+ * Lists all brand entries for a tenant.
104
104
  *
105
105
  * @param query an object with query parameters
106
106
  * @throws GetBrandsHttpError
@@ -144,7 +144,7 @@ type GetBrands500HttpError = {
144
144
  };
145
145
  type GetBrandsHttpError = GetBrands400HttpError | GetBrands401HttpError | GetBrands403HttpError | GetBrands500HttpError;
146
146
  /**
147
- * Creates a new brand
147
+ * Creates a new brand.
148
148
  *
149
149
  * @param body an object with the body content
150
150
  * @throws CreateBrandHttpError
@@ -188,7 +188,7 @@ type CreateBrand500HttpError = {
188
188
  };
189
189
  type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError | CreateBrand403HttpError | CreateBrand500HttpError;
190
190
  /**
191
- * Retrieves the current active brand
191
+ * Returns the current active brand. If using the Qlik default brand, no value is returned.
192
192
  *
193
193
  * @throws GetActiveBrandHttpError
194
194
  */
@@ -204,7 +204,7 @@ type GetActiveBrandHttpError = {
204
204
  status: number;
205
205
  };
206
206
  /**
207
- * Deletes a specific brand
207
+ * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
208
208
  *
209
209
  * @param brandId The brand's unique identifier.
210
210
  * @throws DeleteBrandHttpError
@@ -242,7 +242,7 @@ type DeleteBrand500HttpError = {
242
242
  };
243
243
  type DeleteBrandHttpError = DeleteBrand400HttpError | DeleteBrand401HttpError | DeleteBrand403HttpError | DeleteBrand404HttpError | DeleteBrand500HttpError;
244
244
  /**
245
- * Retrieves a specific brand
245
+ * Returns a specific brand.
246
246
  *
247
247
  * @param brandId The brand's unique identifier.
248
248
  * @throws GetBrandHttpError
@@ -280,7 +280,7 @@ type GetBrand500HttpError = {
280
280
  };
281
281
  type GetBrandHttpError = GetBrand400HttpError | GetBrand401HttpError | GetBrand403HttpError | GetBrand404HttpError | GetBrand500HttpError;
282
282
  /**
283
- * Patches a brand
283
+ * Patches a brand.
284
284
  *
285
285
  * @param brandId The brand's unique identifier.
286
286
  * @param body an object with the body content
@@ -358,7 +358,7 @@ type ActivateBrand500HttpError = {
358
358
  };
359
359
  type ActivateBrandHttpError = ActivateBrand400HttpError | ActivateBrand401HttpError | ActivateBrand403HttpError | ActivateBrand404HttpError | ActivateBrand500HttpError;
360
360
  /**
361
- * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
361
+ * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
362
362
  *
363
363
  * @param brandId The brand's unique identifier.
364
364
  * @param body an object with the body content
@@ -397,7 +397,7 @@ type DeactivateBrand500HttpError = {
397
397
  };
398
398
  type DeactivateBrandHttpError = DeactivateBrand400HttpError | DeactivateBrand401HttpError | DeactivateBrand403HttpError | DeactivateBrand404HttpError | DeactivateBrand500HttpError;
399
399
  /**
400
- * Deletes a specific brand file
400
+ * Deletes the specified brand file.
401
401
  *
402
402
  * @param brandId The brand's unique identifier.
403
403
  * @param brandFileId The unique identifier of a file within a brand.
@@ -436,7 +436,7 @@ type DeleteBrandFile500HttpError = {
436
436
  };
437
437
  type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401HttpError | DeleteBrandFile403HttpError | DeleteBrandFile404HttpError | DeleteBrandFile500HttpError;
438
438
  /**
439
- * Downloads the brand file
439
+ * Downloads the specified brand file.
440
440
  *
441
441
  * @param brandId The brand's unique identifier.
442
442
  * @param brandFileId The unique identifier of a file within a brand.
@@ -475,7 +475,7 @@ type GetBrandFile500HttpError = {
475
475
  };
476
476
  type GetBrandFileHttpError = GetBrandFile400HttpError | GetBrandFile401HttpError | GetBrandFile403HttpError | GetBrandFile404HttpError | GetBrandFile500HttpError;
477
477
  /**
478
- * Creates a brand file
478
+ * Creates a brand file for the specified identifier.
479
479
  *
480
480
  * @param brandId The brand's unique identifier.
481
481
  * @param brandFileId The unique identifier of a file within a brand.
@@ -518,7 +518,7 @@ type CreateBrandFile500HttpError = {
518
518
  };
519
519
  type CreateBrandFileHttpError = CreateBrandFile400HttpError | CreateBrandFile401HttpError | CreateBrandFile403HttpError | CreateBrandFile404HttpError | CreateBrandFile500HttpError;
520
520
  /**
521
- * Updates existing file
521
+ * Updates the specified brand file.
522
522
  *
523
523
  * @param brandId The brand's unique identifier.
524
524
  * @param brandFileId The unique identifier of a file within a brand.
@@ -566,41 +566,41 @@ type UpdateBrandFileHttpError = UpdateBrandFile400HttpError | UpdateBrandFile401
566
566
  declare function clearCache(): void;
567
567
  interface BrandsAPI {
568
568
  /**
569
- * Lists all brand entries for a tenant
569
+ * Lists all brand entries for a tenant.
570
570
  *
571
571
  * @param query an object with query parameters
572
572
  * @throws GetBrandsHttpError
573
573
  */
574
574
  getBrands: typeof getBrands;
575
575
  /**
576
- * Creates a new brand
576
+ * Creates a new brand.
577
577
  *
578
578
  * @param body an object with the body content
579
579
  * @throws CreateBrandHttpError
580
580
  */
581
581
  createBrand: typeof createBrand;
582
582
  /**
583
- * Retrieves the current active brand
583
+ * Returns the current active brand. If using the Qlik default brand, no value is returned.
584
584
  *
585
585
  * @throws GetActiveBrandHttpError
586
586
  */
587
587
  getActiveBrand: typeof getActiveBrand;
588
588
  /**
589
- * Deletes a specific brand
589
+ * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
590
590
  *
591
591
  * @param brandId The brand's unique identifier.
592
592
  * @throws DeleteBrandHttpError
593
593
  */
594
594
  deleteBrand: typeof deleteBrand;
595
595
  /**
596
- * Retrieves a specific brand
596
+ * Returns a specific brand.
597
597
  *
598
598
  * @param brandId The brand's unique identifier.
599
599
  * @throws GetBrandHttpError
600
600
  */
601
601
  getBrand: typeof getBrand;
602
602
  /**
603
- * Patches a brand
603
+ * Patches a brand.
604
604
  *
605
605
  * @param brandId The brand's unique identifier.
606
606
  * @param body an object with the body content
@@ -616,7 +616,7 @@ interface BrandsAPI {
616
616
  */
617
617
  activateBrand: typeof activateBrand;
618
618
  /**
619
- * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
619
+ * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
620
620
  *
621
621
  * @param brandId The brand's unique identifier.
622
622
  * @param body an object with the body content
@@ -624,7 +624,7 @@ interface BrandsAPI {
624
624
  */
625
625
  deactivateBrand: typeof deactivateBrand;
626
626
  /**
627
- * Deletes a specific brand file
627
+ * Deletes the specified brand file.
628
628
  *
629
629
  * @param brandId The brand's unique identifier.
630
630
  * @param brandFileId The unique identifier of a file within a brand.
@@ -632,7 +632,7 @@ interface BrandsAPI {
632
632
  */
633
633
  deleteBrandFile: typeof deleteBrandFile;
634
634
  /**
635
- * Downloads the brand file
635
+ * Downloads the specified brand file.
636
636
  *
637
637
  * @param brandId The brand's unique identifier.
638
638
  * @param brandFileId The unique identifier of a file within a brand.
@@ -640,7 +640,7 @@ interface BrandsAPI {
640
640
  */
641
641
  getBrandFile: typeof getBrandFile;
642
642
  /**
643
- * Creates a brand file
643
+ * Creates a brand file for the specified identifier.
644
644
  *
645
645
  * @param brandId The brand's unique identifier.
646
646
  * @param brandFileId The unique identifier of a file within a brand.
@@ -649,7 +649,7 @@ interface BrandsAPI {
649
649
  */
650
650
  createBrandFile: typeof createBrandFile;
651
651
  /**
652
- * Updates existing file
652
+ * Updates the specified brand file.
653
653
  *
654
654
  * @param brandId The brand's unique identifier.
655
655
  * @param brandFileId The unique identifier of a file within a brand.
package/brands.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/brands.ts
@@ -5,8 +5,8 @@ import {
5
5
  invokeFetch,
6
6
  invoke_fetch_default,
7
7
  parseFetchResponse
8
- } from "./OEVNZ5IQ.js";
9
- import "./7RHSSS4W.js";
8
+ } from "./I5UOE4ZZ.js";
9
+ import "./7BDAXGID.js";
10
10
  import "./2ZQ3ZX7F.js";
11
11
  export {
12
12
  EncodingError,
@@ -19,8 +19,8 @@ import {
19
19
  toValidEnigmaLocationUrl,
20
20
  toValidLocationUrl,
21
21
  toValidWebsocketLocationUrl
22
- } from "./OEVNZ5IQ.js";
23
- import "./7RHSSS4W.js";
22
+ } from "./I5UOE4ZZ.js";
23
+ import "./7BDAXGID.js";
24
24
  import "./2ZQ3ZX7F.js";
25
25
  export {
26
26
  AuthorizationError,
@@ -1,13 +1,11 @@
1
1
  import {
2
2
  generateRandomString,
3
- getCsrfToken,
4
3
  getRestCallAuthParams,
5
4
  getWebSocketAuthParams,
6
5
  toValidWebsocketLocationUrl
7
- } from "./OEVNZ5IQ.js";
8
- import "./7RHSSS4W.js";
6
+ } from "./I5UOE4ZZ.js";
7
+ import "./7BDAXGID.js";
9
8
  import {
10
- isBrowser,
11
9
  isNode
12
10
  } from "./2ZQ3ZX7F.js";
13
11
 
@@ -10368,49 +10366,48 @@ async function createEnigmaSession({
10368
10366
  identity,
10369
10367
  hostConfig,
10370
10368
  useReloadEngine = false,
10371
- ttlSeconds
10369
+ ttlSeconds,
10370
+ workloadType
10372
10371
  }) {
10372
+ const isNodeEnvironment = isNode();
10373
10373
  const locationUrl = toValidWebsocketLocationUrl(hostConfig);
10374
10374
  const reloadUri = encodeURIComponent(`${locationUrl}/sense/app/${appId}`);
10375
10375
  const ttlPart = ttlSeconds !== void 0 && ttlSeconds >= 0 ? `/ttl/${ttlSeconds}` : "";
10376
10376
  const identityPart = identity ? `/identity/${identity}` : "";
10377
- const reloadEnginePart = useReloadEngine ? "&workloadType=interactive-reload" : "";
10378
- let csrfToken = "";
10379
- if (isBrowser() && (!hostConfig || hostConfig.authType === "cookie" || hostConfig.authType === "windowscookie")) {
10380
- try {
10381
- csrfToken = await getCsrfToken(hostConfig);
10382
- } catch {
10383
- }
10384
- }
10385
- const csrfPart = csrfToken ? `&qlik-csrf-token=${csrfToken}` : "";
10386
- let url = `${locationUrl}/app/${appId}${identityPart}${ttlPart}?reloadUri=${reloadUri}${reloadEnginePart}${csrfPart}`.replace(
10377
+ const workloadTypePart = useReloadEngine ? "&workloadType=interactive-reload" : workloadType ? `&workloadType=${workloadType}` : "";
10378
+ const baseUrl = `${locationUrl}/app/${appId}${identityPart}${ttlPart}?reloadUri=${reloadUri}${workloadTypePart}`.replace(
10387
10379
  /^http/,
10388
10380
  "ws"
10389
10381
  );
10390
- const isNodeEnvironment = isNode();
10391
- let createSocketMethod;
10382
+ let createSocketBuilder;
10392
10383
  if (isNodeEnvironment) {
10393
- const { headers, queryParams } = await getRestCallAuthParams({ hostConfig, method: "POST" });
10394
10384
  const WS = (await import("ws")).default;
10395
- Object.entries(queryParams).forEach(([key, value]) => {
10396
- url = `${url}&${key}=${value}`;
10397
- });
10398
- createSocketMethod = (socketUrl) => new WS(socketUrl, void 0, {
10399
- headers
10400
- });
10385
+ createSocketBuilder = async () => {
10386
+ let url = baseUrl;
10387
+ const { headers, queryParams } = await getRestCallAuthParams({ hostConfig, method: "POST" });
10388
+ Object.entries(queryParams).forEach(([key, value]) => {
10389
+ url = `${url}&${key}=${value}`;
10390
+ });
10391
+ return (socketUrl) => new WS(url, void 0, {
10392
+ headers
10393
+ });
10394
+ };
10401
10395
  } else {
10402
- const { queryParams } = await getWebSocketAuthParams({ hostConfig });
10403
- Object.entries(queryParams).forEach(([key, value]) => {
10404
- url = `${url}&${key}=${value}`;
10405
- });
10406
- createSocketMethod = (socketUrl) => new WebSocket(socketUrl);
10396
+ createSocketBuilder = async () => {
10397
+ let url = baseUrl;
10398
+ const { queryParams } = await getWebSocketAuthParams({ hostConfig });
10399
+ Object.entries(queryParams).forEach(([key, value]) => {
10400
+ url = `${url}&${key}=${value}`;
10401
+ });
10402
+ return (socketUrl) => new WebSocket(url);
10403
+ };
10407
10404
  }
10408
- return enigma.create({
10405
+ const session = enigma.create({
10409
10406
  schema: engine_api_default,
10410
10407
  mixins: mixins5,
10411
- url,
10408
+ url: baseUrl,
10412
10409
  suspendOnClose: !useReloadEngine,
10413
- createSocket: createSocketMethod,
10410
+ createSocket: await createSocketBuilder(),
10414
10411
  requestInterceptors: [somethingWithEmptyMethodsRequestInterceptor],
10415
10412
  responseInterceptors: [
10416
10413
  retryAbortedErrorResponseInterceptor,
@@ -10418,6 +10415,13 @@ async function createEnigmaSession({
10418
10415
  somethingWithErrorPopupsResponnseInterceptor
10419
10416
  ]
10420
10417
  });
10418
+ const originalResume = session.resume.bind(session);
10419
+ const resume = async (onlyIfAttached) => {
10420
+ session.rpc.createSocket = await createSocketBuilder();
10421
+ await originalResume(onlyIfAttached);
10422
+ };
10423
+ session.resume = resume;
10424
+ return session;
10421
10425
  }
10422
10426
  export {
10423
10427
  createEnigmaSession