@qlik/api 2.2.0 → 2.3.1

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 (232) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/auth-XusKk8IA.js +32 -0
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +5 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,4 +1,168 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { _ as downloadTempFile, a as DownloadTempFileHttpError, b as uploadTempFile, c as Errors, d as GetTempFileDetailsHttpError, f as GetTempFileDetailsHttpResponse, g as clearCache, h as UploadTempFileHttpResponse, i as DownloadTempFile206HttpResponse, l as GetTempFileDetails200HttpResponse, m as UploadTempFileHttpError, n as DownloadTempFile200HttpResponse, o as DownloadTempFileHttpResponse, p as TempContentsAPI, r as DownloadTempFile204HttpResponse, s as Error, t as DetailResponse, u as GetTempFileDetails204HttpResponse, v as getTempFileDetails, y as tempContentsExport } from "./chunks/temp-contents-zDomB-g6.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/temp-contents.d.ts
5
+ /**
6
+ * An Error object.
7
+ */
8
+ type Error = {
9
+ /** The API error code. */
10
+ code: string;
11
+ /** A human-readable problem description of the issue. */
12
+ detail?: string;
13
+ /** Additional properties and information regarding the issue. */
14
+ meta?: {
15
+ /** The error type. */
16
+ errorType?: string;
17
+ /** Locale */
18
+ locale?: string;
19
+ /** The source errors (stack trace). */
20
+ sourceErrors?: string;
21
+ };
22
+ /** Title of the type of API Error. */
23
+ title: string;
24
+ };
25
+ /**
26
+ * An array of Error objects.
27
+ */
28
+ type Errors = {
29
+ errors?: Error[];
30
+ /** A way to trace the source of the error. */
31
+ traceId?: string;
32
+ };
33
+ type DetailResponse = {
34
+ /** Datetime-stamp when the resource was created (in UTC). */
35
+ CreatedAt?: string;
36
+ /** Identifier for the subject / resource creator. */
37
+ CreatorID?: string;
38
+ /** Datetime-stamp when the resource expired (in UTC). */
39
+ Expires?: string;
40
+ /** Identifier */
41
+ ID?: string;
42
+ /** File name of the file uploaded by the user. */
43
+ Name?: string;
44
+ /** Size of resource (in bytes). */
45
+ Size?: string;
46
+ /** Time-to-live in seconds. */
47
+ TTLSeconds?: number;
48
+ /** Datetime-stamp when the resource was updated (in UTC). */
49
+ UpdatedAt?: string;
50
+ };
51
+ /**
52
+ * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
53
+ *
54
+ * @param query an object with query parameters
55
+ * @param body an object with the body content
56
+ * @throws UploadTempFileHttpError
57
+ */
58
+ declare function uploadTempFile(query: {
59
+ /** The name of the file to upload. */
60
+ filename?: string;
61
+ /** The TTL parameter is used to define the time-to-live for the content resource in seconds.
62
+ * It defaults to one hour (3600) if no input is provided. Max TTL is 259200 (3 days).' */
63
+ ttl?: number;
64
+ }, body: BodyInit, options?: ApiCallOptions): Promise<UploadTempFileHttpResponse>;
65
+ type UploadTempFileHttpResponse = {
66
+ data: void;
67
+ headers: Headers;
68
+ status: 201;
69
+ };
70
+ type UploadTempFileHttpError = {
71
+ data: Errors;
72
+ headers: Headers;
73
+ status: 400;
74
+ };
75
+ /**
76
+ * This endpoint is used to retrieve a temporary content file. It returns a valid (`200 OK`) in case the file exists and the user is authorized to view the contents. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
77
+ *
78
+ * @param id The temporary contents ID.
79
+ * @param query an object with query parameters
80
+ * @throws DownloadTempFileHttpError
81
+ */
82
+ declare function downloadTempFile(id: string, query: {
83
+ /** Set to "1" to download the file in inline mode. Useful for displaying a preview of the file in a browser. */
84
+ inline?: string;
85
+ }, options?: ApiCallOptions): Promise<DownloadTempFileHttpResponse>;
86
+ type DownloadTempFileHttpResponse = DownloadTempFile200HttpResponse | DownloadTempFile204HttpResponse | DownloadTempFile206HttpResponse;
87
+ type DownloadTempFile200HttpResponse = {
88
+ data: unknown;
89
+ headers: Headers;
90
+ status: 200;
91
+ };
92
+ type DownloadTempFile204HttpResponse = {
93
+ data: void;
94
+ headers: Headers;
95
+ status: 204;
96
+ };
97
+ type DownloadTempFile206HttpResponse = {
98
+ data: unknown;
99
+ headers: Headers;
100
+ status: 206;
101
+ };
102
+ type DownloadTempFileHttpError = {
103
+ data: Errors;
104
+ headers: Headers;
105
+ status: 400 | 404 | 410 | 416;
106
+ };
107
+ /**
108
+ * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
109
+ *
110
+ * @param id The temporary contents ID.
111
+ * @throws GetTempFileDetailsHttpError
112
+ */
113
+ declare function getTempFileDetails(id: string, options?: ApiCallOptions): Promise<GetTempFileDetailsHttpResponse>;
114
+ type GetTempFileDetailsHttpResponse = GetTempFileDetails200HttpResponse | GetTempFileDetails204HttpResponse;
115
+ type GetTempFileDetails200HttpResponse = {
116
+ data: DetailResponse;
117
+ headers: Headers;
118
+ status: 200;
119
+ };
120
+ type GetTempFileDetails204HttpResponse = {
121
+ data: void;
122
+ headers: Headers;
123
+ status: 204;
124
+ };
125
+ type GetTempFileDetailsHttpError = {
126
+ data: Errors;
127
+ headers: Headers;
128
+ status: 400 | 404 | 410;
129
+ };
130
+ /**
131
+ * Clears the cache for temp-contents api requests.
132
+ */
133
+ declare function clearCache(): void;
134
+ type TempContentsAPI = {
135
+ /**
136
+ * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
137
+ *
138
+ * @param query an object with query parameters
139
+ * @param body an object with the body content
140
+ * @throws UploadTempFileHttpError
141
+ */
142
+ uploadTempFile: typeof uploadTempFile;
143
+ /**
144
+ * This endpoint is used to retrieve a temporary content file. It returns a valid (`200 OK`) in case the file exists and the user is authorized to view the contents. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
145
+ *
146
+ * @param id The temporary contents ID.
147
+ * @param query an object with query parameters
148
+ * @throws DownloadTempFileHttpError
149
+ */
150
+ downloadTempFile: typeof downloadTempFile;
151
+ /**
152
+ * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
153
+ *
154
+ * @param id The temporary contents ID.
155
+ * @throws GetTempFileDetailsHttpError
156
+ */
157
+ getTempFileDetails: typeof getTempFileDetails;
158
+ /**
159
+ * Clears the cache for temp-contents api requests.
160
+ */
161
+ clearCache: typeof clearCache;
162
+ };
163
+ /**
164
+ * Functions for the temp-contents api
165
+ */
166
+ declare const tempContentsExport: TempContentsAPI;
167
+ //#endregion
4
168
  export { DetailResponse, DownloadTempFile200HttpResponse, DownloadTempFile204HttpResponse, DownloadTempFile206HttpResponse, DownloadTempFileHttpError, DownloadTempFileHttpResponse, Error, Errors, GetTempFileDetails200HttpResponse, GetTempFileDetails204HttpResponse, GetTempFileDetailsHttpError, GetTempFileDetailsHttpResponse, TempContentsAPI, UploadTempFileHttpError, UploadTempFileHttpResponse, clearCache, tempContentsExport as default, downloadTempFile, getTempFileDetails, uploadTempFile };
package/temp-contents.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
4
3
 
5
4
  //#region src/public/rest/temp-contents.ts
6
5
  /**
package/tenants.d.ts CHANGED
@@ -1,4 +1,361 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { A as createTenant, C as TenantDeactivateResponse, D as TenantSingleMetaErrorDetail, E as TenantPatchSchema, F as reactivateTenant, I as tenantsExport, M as getMyTenant, N as getTenant, O as TenantsAPI, P as patchTenant, S as TenantDeactivateRequest, T as TenantPatchErrors, _ as PatchTenantdefaultHttpError, a as Error, b as Tenant, c as GetMyTenantHttpResponse, d as PatchTenant400HttpError, f as PatchTenant403HttpError, g as PatchTenantHttpResponse, h as PatchTenantHttpError, i as DeactivateTenantHttpResponse, j as deactivateTenant, k as clearCache, l as GetTenantHttpError, m as PatchTenant429HttpError, n as CreateTenantHttpResponse, o as Errors, p as PatchTenant404HttpError, r as DeactivateTenantHttpError, s as GetMyTenantHttpError, t as CreateTenantHttpError, u as GetTenantHttpResponse, v as ReactivateTenantHttpError, w as TenantMultipleMetaErrorsDetail, x as TenantCreationRequest, y as ReactivateTenantHttpResponse } from "./chunks/tenants-Bhn86519.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/tenants.d.ts
5
+ /**
6
+ * An error object describing the error.
7
+ */
8
+ type Error = {
9
+ /** The error code. */
10
+ code: string;
11
+ /** A human-readable explanation specific to this occurrence of the error. */
12
+ detail?: string;
13
+ /** Additional properties relating to the error. */
14
+ meta?: unknown;
15
+ /** References to the source of the error. */
16
+ source?: {
17
+ /** The URI query parameter that caused the error. */
18
+ parameter?: string;
19
+ /** A JSON Pointer to the property that caused the error. */
20
+ pointer?: string;
21
+ };
22
+ /** The HTTP status code. */
23
+ status: string;
24
+ /** Summary of the problem. */
25
+ title: string;
26
+ };
27
+ /**
28
+ * The error response object describing the error from the handling of an HTTP request.
29
+ * @example
30
+ * {
31
+ * errors: [
32
+ * {
33
+ * code: "TENANTS-8",
34
+ * title: "Not found"
35
+ * }
36
+ * ],
37
+ * traceId: "000000000000000079cf1ebeae103de1"
38
+ * }
39
+ */
40
+ type Errors = {
41
+ /** An array of errors related to the operation. */
42
+ errors?: Error[];
43
+ /** A unique identifier for tracing the error. */
44
+ traceId?: string;
45
+ };
46
+ type Tenant = {
47
+ autoAssignCreateSharedSpacesRoleToProfessionals?: boolean;
48
+ autoAssignDataServicesContributorRoleToProfessionals?: boolean;
49
+ autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals?: boolean;
50
+ /** The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants). */
51
+ readonly created?: string;
52
+ /** The user ID who created the tenant. */
53
+ createdByUser?: string;
54
+ /** The datacenter where the tenant is located. */
55
+ datacenter?: string;
56
+ enableAnalyticCreation?: boolean;
57
+ enableAppOpeningFeedback?: boolean;
58
+ /** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
59
+ hostnames?: string[];
60
+ /** The unique tenant identifier. */
61
+ readonly id: string;
62
+ /** The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). */
63
+ readonly lastUpdated?: string;
64
+ readonly links?: {
65
+ /** A link to this tenant. */
66
+ self: {
67
+ /** URL that defines the resource. */
68
+ href: string;
69
+ };
70
+ };
71
+ /** The display name of the tenant. */
72
+ name: string;
73
+ /** The region where the tenant is located. */
74
+ readonly region?: string;
75
+ /** The status of the tenant. */
76
+ status?: "active" | "disabled" | "deleted";
77
+ };
78
+ type TenantCreationRequest = {
79
+ /** The datacenter where the tenant is located.
80
+ *
81
+ * Supported locations for commercial licenses:
82
+ * - `ap-northeast-1`: Japan (jp)
83
+ * - `ap-southeast-1`: Australia (ap)
84
+ * - `ap-southeast-2`: Singapore (sg)
85
+ * - `eu-central-1`: Germany (de)
86
+ * - `eu-west-1`: Ireland (eu)
87
+ * - `eu-west-2`: United Kingdom (uk)
88
+ * - `us-east-1`: United States of America (us) */
89
+ datacenter?: string;
90
+ /** The signed license key of the license that will be associated with the created tenant. */
91
+ licenseKey?: string;
92
+ };
93
+ /**
94
+ * A request to deactivate a tenant.
95
+ */
96
+ type TenantDeactivateRequest = {
97
+ /** Sets the number of days to purge the tenant after deactivation. Only available to OEMs. */
98
+ purgeAfterDays?: number;
99
+ };
100
+ /**
101
+ * The result of tenant deactivation.
102
+ */
103
+ type TenantDeactivateResponse = {
104
+ /** The estimated date time of when tenant will be purged. */
105
+ estimatedPurgeDate?: string;
106
+ /** The unique tenant identifier. */
107
+ readonly id?: string;
108
+ /** The status of the tenant. */
109
+ status?: "disabled";
110
+ };
111
+ type TenantMultipleMetaErrorsDetail = TenantSingleMetaErrorDetail[];
112
+ type TenantPatchErrors = {
113
+ errors?: {
114
+ /** The error code. */
115
+ code: string;
116
+ meta?: TenantSingleMetaErrorDetail | TenantMultipleMetaErrorsDetail;
117
+ /** References to the source of the error. */
118
+ source?: {
119
+ /** The URI query parameter that caused the error. */
120
+ parameter?: string;
121
+ /** A JSON Pointer to the property that caused the error. */
122
+ pointer?: string;
123
+ };
124
+ /** Summary of the problem. */
125
+ title: string;
126
+ }[];
127
+ };
128
+ /**
129
+ * @example
130
+ * [
131
+ * {
132
+ * op: "replace",
133
+ * path: "/name",
134
+ * value: "Corp"
135
+ * },
136
+ * {
137
+ * op: "replace",
138
+ * path: "/hostnames/1",
139
+ * value: "example-tenant.us.qlikcloud.com"
140
+ * },
141
+ * {
142
+ * op: "replace",
143
+ * path: "/autoAssignCreateSharedSpacesRoleToProfessionals",
144
+ * value: true
145
+ * },
146
+ * {
147
+ * op: "replace",
148
+ * path: "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals",
149
+ * value: false
150
+ * },
151
+ * {
152
+ * op: "replace",
153
+ * path: "/autoAssignDataServicesContributorRoleToProfessionals",
154
+ * value: true
155
+ * },
156
+ * {
157
+ * op: "replace",
158
+ * path: "/enableAnalyticCreation",
159
+ * value: false
160
+ * }
161
+ * ]
162
+ */
163
+ type TenantPatchSchema = {
164
+ /** The operation to be performed. */
165
+ op: "replace";
166
+ /** A JSON Pointer value that references a location within the target document where the operation is performed. */
167
+ path: "/name" | "/hostnames/1" | "/autoAssignCreateSharedSpacesRoleToProfessionals" | "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals" | "/autoAssignDataServicesContributorRoleToProfessionals" | "/enableAnalyticCreation" | "/enableAppOpeningFeedback";
168
+ /** The value to be used for this operation. */
169
+ value: string | boolean;
170
+ }[];
171
+ type TenantSingleMetaErrorDetail = {
172
+ /** The error code. */
173
+ code?: string;
174
+ /** The error summary. */
175
+ title?: string;
176
+ };
177
+ /**
178
+ * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
179
+ *
180
+ * @param body an object with the body content
181
+ * @throws CreateTenantHttpError
182
+ */
183
+ declare function createTenant(body: TenantCreationRequest, options?: ApiCallOptions): Promise<CreateTenantHttpResponse>;
184
+ type CreateTenantHttpResponse = {
185
+ data: Tenant;
186
+ headers: Headers;
187
+ status: 201;
188
+ };
189
+ type CreateTenantHttpError = {
190
+ data: Errors;
191
+ headers: Headers;
192
+ status: number;
193
+ };
194
+ /**
195
+ * Redirects to current tenant.
196
+ *
197
+ * @throws GetMyTenantHttpError
198
+ */
199
+ declare function getMyTenant(options?: ApiCallOptions): Promise<GetMyTenantHttpResponse>;
200
+ type GetMyTenantHttpResponse = {
201
+ data: Tenant;
202
+ headers: Headers;
203
+ status: 200;
204
+ };
205
+ type GetMyTenantHttpError = {
206
+ data: unknown;
207
+ headers: Headers;
208
+ status: number;
209
+ };
210
+ /**
211
+ * Retrieves a specific tenant by ID.
212
+ *
213
+ * @param tenantId The ID of the tenant to retrieve
214
+ * @throws GetTenantHttpError
215
+ */
216
+ declare function getTenant(tenantId: string, options?: ApiCallOptions): Promise<GetTenantHttpResponse>;
217
+ type GetTenantHttpResponse = {
218
+ data: Tenant;
219
+ headers: Headers;
220
+ status: 200;
221
+ };
222
+ type GetTenantHttpError = {
223
+ data: Errors;
224
+ headers: Headers;
225
+ status: number;
226
+ };
227
+ /**
228
+ * Updates properties of a specific tenant by ID.
229
+ *
230
+ * @param tenantId The ID of the tenant to update
231
+ * @param body an object with the body content
232
+ * @throws PatchTenantHttpError
233
+ */
234
+ declare function patchTenant(tenantId: string, body: TenantPatchSchema, options?: ApiCallOptions): Promise<PatchTenantHttpResponse>;
235
+ type PatchTenantHttpResponse = {
236
+ data: void;
237
+ headers: Headers;
238
+ status: 204;
239
+ };
240
+ type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantdefaultHttpError;
241
+ type PatchTenant400HttpError = {
242
+ data: TenantPatchErrors;
243
+ headers: Headers;
244
+ status: 400;
245
+ };
246
+ type PatchTenant403HttpError = {
247
+ data: Errors;
248
+ headers: Headers;
249
+ status: 403;
250
+ };
251
+ type PatchTenant404HttpError = {
252
+ data: Errors;
253
+ headers: Headers;
254
+ status: 404;
255
+ };
256
+ type PatchTenant429HttpError = {
257
+ data: Errors;
258
+ headers: Headers;
259
+ status: 429;
260
+ };
261
+ type PatchTenantdefaultHttpError = {
262
+ data: Errors;
263
+ headers: Headers;
264
+ status: "default";
265
+ };
266
+ /**
267
+ * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
268
+ *
269
+ * @param tenantId The id of the tenant to deactivate
270
+ * @param body an object with the body content
271
+ * @throws DeactivateTenantHttpError
272
+ */
273
+ declare function deactivateTenant(tenantId: string, body: TenantDeactivateRequest, options?: ApiCallOptions): Promise<DeactivateTenantHttpResponse>;
274
+ type DeactivateTenantHttpResponse = {
275
+ data: TenantDeactivateResponse;
276
+ headers: Headers;
277
+ status: 200;
278
+ };
279
+ type DeactivateTenantHttpError = {
280
+ data: Errors;
281
+ headers: Headers;
282
+ status: number;
283
+ };
284
+ /**
285
+ * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
286
+ *
287
+ * @param tenantId The id of the tenant to reactivate
288
+ * @param body an object with the body content
289
+ * @throws ReactivateTenantHttpError
290
+ */
291
+ declare function reactivateTenant(tenantId: string, body: unknown, options?: ApiCallOptions): Promise<ReactivateTenantHttpResponse>;
292
+ type ReactivateTenantHttpResponse = {
293
+ data: unknown;
294
+ headers: Headers;
295
+ status: 200;
296
+ };
297
+ type ReactivateTenantHttpError = {
298
+ data: Errors;
299
+ headers: Headers;
300
+ status: number;
301
+ };
302
+ /**
303
+ * Clears the cache for tenants api requests.
304
+ */
305
+ declare function clearCache(): void;
306
+ type TenantsAPI = {
307
+ /**
308
+ * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
309
+ *
310
+ * @param body an object with the body content
311
+ * @throws CreateTenantHttpError
312
+ */
313
+ createTenant: typeof createTenant;
314
+ /**
315
+ * Redirects to current tenant.
316
+ *
317
+ * @throws GetMyTenantHttpError
318
+ */
319
+ getMyTenant: typeof getMyTenant;
320
+ /**
321
+ * Retrieves a specific tenant by ID.
322
+ *
323
+ * @param tenantId The ID of the tenant to retrieve
324
+ * @throws GetTenantHttpError
325
+ */
326
+ getTenant: typeof getTenant;
327
+ /**
328
+ * Updates properties of a specific tenant by ID.
329
+ *
330
+ * @param tenantId The ID of the tenant to update
331
+ * @param body an object with the body content
332
+ * @throws PatchTenantHttpError
333
+ */
334
+ patchTenant: typeof patchTenant;
335
+ /**
336
+ * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
337
+ *
338
+ * @param tenantId The id of the tenant to deactivate
339
+ * @param body an object with the body content
340
+ * @throws DeactivateTenantHttpError
341
+ */
342
+ deactivateTenant: typeof deactivateTenant;
343
+ /**
344
+ * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
345
+ *
346
+ * @param tenantId The id of the tenant to reactivate
347
+ * @param body an object with the body content
348
+ * @throws ReactivateTenantHttpError
349
+ */
350
+ reactivateTenant: typeof reactivateTenant;
351
+ /**
352
+ * Clears the cache for tenants api requests.
353
+ */
354
+ clearCache: typeof clearCache;
355
+ };
356
+ /**
357
+ * Functions for the tenants api
358
+ */
359
+ declare const tenantsExport: TenantsAPI;
360
+ //#endregion
4
361
  export { CreateTenantHttpError, CreateTenantHttpResponse, DeactivateTenantHttpError, DeactivateTenantHttpResponse, Error, Errors, GetMyTenantHttpError, GetMyTenantHttpResponse, GetTenantHttpError, GetTenantHttpResponse, PatchTenant400HttpError, PatchTenant403HttpError, PatchTenant404HttpError, PatchTenant429HttpError, PatchTenantHttpError, PatchTenantHttpResponse, PatchTenantdefaultHttpError, ReactivateTenantHttpError, ReactivateTenantHttpResponse, Tenant, TenantCreationRequest, TenantDeactivateRequest, TenantDeactivateResponse, TenantMultipleMetaErrorsDetail, TenantPatchErrors, TenantPatchSchema, TenantSingleMetaErrorDetail, TenantsAPI, clearCache, createTenant, deactivateTenant, tenantsExport as default, getMyTenant, getTenant, patchTenant, reactivateTenant };
package/tenants.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
4
3
 
5
4
  //#region src/public/rest/tenants.ts
6
5
  /**