@qlik/api 1.31.0 → 1.33.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 (142) hide show
  1. package/api-keys.d.ts +10 -10
  2. package/api-keys.js +64 -50
  3. package/apps.d.ts +56 -56
  4. package/apps.js +392 -304
  5. package/assistants.d.ts +1301 -0
  6. package/assistants.js +329 -0
  7. package/audits.d.ts +10 -10
  8. package/audits.js +48 -36
  9. package/{auth-types-DqfMuSRX.d.ts → auth-types-Cj5bM3Yk.d.ts} +29 -9
  10. package/auth.d.ts +17 -4
  11. package/auth.js +4 -2
  12. package/automation-connections.d.ts +366 -0
  13. package/automation-connections.js +107 -0
  14. package/automations.d.ts +27 -27
  15. package/automations.js +159 -123
  16. package/automl-deployments.d.ts +97 -0
  17. package/automl-deployments.js +29 -0
  18. package/automl-predictions.d.ts +214 -0
  19. package/automl-predictions.js +84 -0
  20. package/brands.d.ts +18 -18
  21. package/brands.js +107 -83
  22. package/chunks/{KBSD75QL.js → 33GQY7N7.js} +1 -1
  23. package/chunks/{M64RLKVG.js → 62DXIH3S.js} +7 -5
  24. package/chunks/7MMXU6EL.js +86 -0
  25. package/chunks/{DLKLPD7T.js → GPRUNZV4.js} +3 -3
  26. package/chunks/{YKZ2QYHN.js → LIEZG7IM.js} +3 -3
  27. package/chunks/{FKDGGR2O.js → OTIO4SEJ.js} +698 -708
  28. package/chunks/{UZTIZ4H5.js → RP3EJGHG.js} +74 -74
  29. package/chunks/{GUU3KZGK.js → SPATCXXU.js} +9 -2
  30. package/chunks/{LY7RP2HA.js → XF3TPZKZ.js} +23 -8
  31. package/chunks/{6ZONDHRN.js → YYZCS5PW.js} +11 -4
  32. package/chunks/{3RGGGGAR.js → ZCTVPXGO.js} +1 -1
  33. package/collections.d.ts +16 -15
  34. package/collections.js +98 -76
  35. package/conditions.d.ts +662 -0
  36. package/conditions.js +135 -0
  37. package/consumption.d.ts +182 -0
  38. package/consumption.js +26 -0
  39. package/csp-origins.d.ts +9 -9
  40. package/csp-origins.js +53 -41
  41. package/csrf-token.d.ts +62 -0
  42. package/csrf-token.js +25 -0
  43. package/data-alerts.d.ts +1004 -0
  44. package/data-alerts.js +187 -0
  45. package/data-assets.d.ts +8 -8
  46. package/data-assets.js +50 -40
  47. package/data-connections.d.ts +16 -16
  48. package/data-connections.js +87 -69
  49. package/data-credentials.d.ts +11 -11
  50. package/data-credentials.js +52 -42
  51. package/data-files.d.ts +18 -18
  52. package/data-files.js +107 -83
  53. package/data-qualities.d.ts +175 -0
  54. package/data-qualities.js +50 -0
  55. package/data-sets.d.ts +424 -0
  56. package/data-sets.js +87 -0
  57. package/data-sources.d.ts +268 -0
  58. package/data-sources.js +45 -0
  59. package/data-stores.d.ts +537 -0
  60. package/data-stores.js +128 -0
  61. package/dcaas.d.ts +192 -0
  62. package/dcaas.js +45 -0
  63. package/di-projects.d.ts +673 -0
  64. package/di-projects.js +196 -0
  65. package/direct-access-agents.d.ts +328 -0
  66. package/direct-access-agents.js +108 -0
  67. package/encryption.d.ts +370 -0
  68. package/encryption.js +118 -0
  69. package/extensions.d.ts +11 -11
  70. package/extensions.js +61 -47
  71. package/glossaries.d.ts +33 -33
  72. package/glossaries.js +221 -173
  73. package/groups.d.ts +12 -12
  74. package/groups.js +72 -56
  75. package/identity-providers.d.ts +11 -11
  76. package/identity-providers.js +67 -51
  77. package/index.d.ts +113 -4
  78. package/index.js +626 -40
  79. package/interceptors.d.ts +9 -2
  80. package/interceptors.js +2 -2
  81. package/invoke-fetch-types-BYCD4pc9.d.ts +98 -0
  82. package/items.d.ts +14 -13
  83. package/items.js +71 -55
  84. package/knowledgebases.d.ts +890 -0
  85. package/knowledgebases.js +203 -0
  86. package/licenses.d.ts +14 -14
  87. package/licenses.js +76 -58
  88. package/lineage-graphs.d.ts +712 -0
  89. package/lineage-graphs.js +108 -0
  90. package/ml.d.ts +2676 -0
  91. package/ml.js +477 -0
  92. package/notes.d.ts +110 -0
  93. package/notes.js +35 -0
  94. package/notifications.d.ts +98 -0
  95. package/notifications.js +26 -0
  96. package/oauth-clients.d.ts +14 -14
  97. package/oauth-clients.js +96 -74
  98. package/oauth-tokens.d.ts +126 -0
  99. package/oauth-tokens.js +35 -0
  100. package/package.json +34 -6
  101. package/qix.d.ts +145 -4
  102. package/qix.js +2 -2
  103. package/questions.d.ts +364 -0
  104. package/questions.js +38 -0
  105. package/quotas.d.ts +6 -6
  106. package/quotas.js +20 -16
  107. package/reload-tasks.d.ts +8 -8
  108. package/reload-tasks.js +46 -36
  109. package/reloads.d.ts +7 -7
  110. package/reloads.js +36 -28
  111. package/report-templates.d.ts +287 -0
  112. package/report-templates.js +94 -0
  113. package/reports.d.ts +4 -4
  114. package/reports.js +20 -16
  115. package/roles.d.ts +8 -8
  116. package/roles.js +46 -36
  117. package/sharing-tasks.d.ts +952 -0
  118. package/sharing-tasks.js +125 -0
  119. package/spaces.d.ts +22 -22
  120. package/spaces.js +153 -119
  121. package/tasks.d.ts +564 -0
  122. package/tasks.js +126 -0
  123. package/temp-contents.d.ts +7 -7
  124. package/temp-contents.js +30 -24
  125. package/tenants.d.ts +8 -8
  126. package/tenants.js +57 -45
  127. package/themes.d.ts +11 -11
  128. package/themes.js +61 -47
  129. package/transports.d.ts +8 -8
  130. package/transports.js +49 -37
  131. package/ui-config.d.ts +274 -0
  132. package/ui-config.js +91 -0
  133. package/users.d.ts +15 -15
  134. package/users.js +81 -63
  135. package/web-integrations.d.ts +8 -8
  136. package/web-integrations.js +46 -36
  137. package/web-notifications.d.ts +9 -9
  138. package/web-notifications.js +53 -41
  139. package/webhooks.d.ts +14 -14
  140. package/webhooks.js +88 -68
  141. package/chunks/2ZQ3ZX7F.js +0 -33
  142. package/invoke-fetch-types-Cq7bjkqn.d.ts +0 -243
package/quotas.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
- import './auth-types-DqfMuSRX.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
3
 
4
4
  /**
5
5
  * A specific error.
@@ -44,10 +44,10 @@ type Quota = {
44
44
  * @param query an object with query parameters
45
45
  * @throws GetQuotasHttpError
46
46
  */
47
- declare const getQuotas: (query: {
47
+ declare function getQuotas(query: {
48
48
  /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned). */
49
49
  reportUsage?: boolean;
50
- }, options?: ApiCallOptions) => Promise<GetQuotasHttpResponse>;
50
+ }, options?: ApiCallOptions): Promise<GetQuotasHttpResponse>;
51
51
  type GetQuotasHttpResponse = {
52
52
  data: GetQuotasResult;
53
53
  headers: Headers;
@@ -65,10 +65,10 @@ type GetQuotasHttpError = {
65
65
  * @param query an object with query parameters
66
66
  * @throws GetQuotaHttpError
67
67
  */
68
- declare const getQuota: (id: string, query: {
68
+ declare function getQuota(id: string, query: {
69
69
  /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included). */
70
70
  reportUsage?: boolean;
71
- }, options?: ApiCallOptions) => Promise<GetQuotaHttpResponse>;
71
+ }, options?: ApiCallOptions): Promise<GetQuotaHttpResponse>;
72
72
  type GetQuotaHttpResponse = {
73
73
  data: GetQuotaByIdResult;
74
74
  headers: Headers;
package/quotas.js CHANGED
@@ -1,24 +1,28 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/YKZ2QYHN.js";
5
- import "./chunks/DLKLPD7T.js";
6
- import "./chunks/2ZQ3ZX7F.js";
4
+ } from "./chunks/LIEZG7IM.js";
5
+ import "./chunks/GPRUNZV4.js";
6
+ import "./chunks/7MMXU6EL.js";
7
7
 
8
8
  // src/public/rest/quotas.ts
9
- var getQuotas = async (query, options) => invokeFetch("quotas", {
10
- method: "get",
11
- pathTemplate: "/api/v1/quotas",
12
- query,
13
- options
14
- });
15
- var getQuota = async (id, query, options) => invokeFetch("quotas", {
16
- method: "get",
17
- pathTemplate: "/api/v1/quotas/{id}",
18
- pathVariables: { id },
19
- query,
20
- options
21
- });
9
+ async function getQuotas(query, options) {
10
+ return invokeFetch("quotas", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/quotas",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function getQuota(id, query, options) {
18
+ return invokeFetch("quotas", {
19
+ method: "get",
20
+ pathTemplate: "/api/v1/quotas/{id}",
21
+ pathVariables: { id },
22
+ query,
23
+ options
24
+ });
25
+ }
22
26
  function clearCache() {
23
27
  return clearApiCache("quotas");
24
28
  }
package/reload-tasks.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
- import './auth-types-DqfMuSRX.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
3
 
4
4
  type Error = {
5
5
  code: string;
@@ -102,7 +102,7 @@ type Tasks = {
102
102
  * @param query an object with query parameters
103
103
  * @throws GetReloadTasksHttpError
104
104
  */
105
- declare const getReloadTasks: (query: {
105
+ declare function getReloadTasks(query: {
106
106
  /** The case sensitive string used to search for a task by app ID. */
107
107
  appId?: string;
108
108
  /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
@@ -113,7 +113,7 @@ declare const getReloadTasks: (query: {
113
113
  partial?: boolean;
114
114
  /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
115
115
  prev?: string;
116
- }, options?: ApiCallOptions) => Promise<GetReloadTasksHttpResponse>;
116
+ }, options?: ApiCallOptions): Promise<GetReloadTasksHttpResponse>;
117
117
  type GetReloadTasksHttpResponse = {
118
118
  data: Tasks;
119
119
  headers: Headers;
@@ -132,7 +132,7 @@ type GetReloadTasksHttpError = {
132
132
  * @param body an object with the body content
133
133
  * @throws CreateReloadTaskHttpError
134
134
  */
135
- declare const createReloadTask: (body: PostTaskBody, options?: ApiCallOptions) => Promise<CreateReloadTaskHttpResponse>;
135
+ declare function createReloadTask(body: PostTaskBody, options?: ApiCallOptions): Promise<CreateReloadTaskHttpResponse>;
136
136
  type CreateReloadTaskHttpResponse = {
137
137
  data: Task;
138
138
  headers: Headers;
@@ -149,7 +149,7 @@ type CreateReloadTaskHttpError = {
149
149
  * @param taskId The unique identifier of the task.
150
150
  * @throws DeleteReloadTaskHttpError
151
151
  */
152
- declare const deleteReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<DeleteReloadTaskHttpResponse>;
152
+ declare function deleteReloadTask(taskId: string, options?: ApiCallOptions): Promise<DeleteReloadTaskHttpResponse>;
153
153
  type DeleteReloadTaskHttpResponse = {
154
154
  data: void;
155
155
  headers: Headers;
@@ -166,7 +166,7 @@ type DeleteReloadTaskHttpError = {
166
166
  * @param taskId The unique identifier of the task.
167
167
  * @throws GetReloadTaskHttpError
168
168
  */
169
- declare const getReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<GetReloadTaskHttpResponse>;
169
+ declare function getReloadTask(taskId: string, options?: ApiCallOptions): Promise<GetReloadTaskHttpResponse>;
170
170
  type GetReloadTaskHttpResponse = {
171
171
  data: Task;
172
172
  headers: Headers;
@@ -184,7 +184,7 @@ type GetReloadTaskHttpError = {
184
184
  * @param body an object with the body content
185
185
  * @throws UpdateReloadTaskHttpError
186
186
  */
187
- declare const updateReloadTask: (taskId: string, body: PutTaskBody, options?: ApiCallOptions) => Promise<UpdateReloadTaskHttpResponse>;
187
+ declare function updateReloadTask(taskId: string, body: PutTaskBody, options?: ApiCallOptions): Promise<UpdateReloadTaskHttpResponse>;
188
188
  type UpdateReloadTaskHttpResponse = {
189
189
  data: Task;
190
190
  headers: Headers;
package/reload-tasks.js CHANGED
@@ -1,44 +1,54 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/YKZ2QYHN.js";
5
- import "./chunks/DLKLPD7T.js";
6
- import "./chunks/2ZQ3ZX7F.js";
4
+ } from "./chunks/LIEZG7IM.js";
5
+ import "./chunks/GPRUNZV4.js";
6
+ import "./chunks/7MMXU6EL.js";
7
7
 
8
8
  // src/public/rest/reload-tasks.ts
9
- var getReloadTasks = async (query, options) => invokeFetch("reload-tasks", {
10
- method: "get",
11
- pathTemplate: "/api/v1/reload-tasks",
12
- query,
13
- options
14
- });
15
- var createReloadTask = async (body, options) => invokeFetch("reload-tasks", {
16
- method: "post",
17
- pathTemplate: "/api/v1/reload-tasks",
18
- body,
19
- contentType: "application/json",
20
- options
21
- });
22
- var deleteReloadTask = async (taskId, options) => invokeFetch("reload-tasks", {
23
- method: "delete",
24
- pathTemplate: "/api/v1/reload-tasks/{taskId}",
25
- pathVariables: { taskId },
26
- options
27
- });
28
- var getReloadTask = async (taskId, options) => invokeFetch("reload-tasks", {
29
- method: "get",
30
- pathTemplate: "/api/v1/reload-tasks/{taskId}",
31
- pathVariables: { taskId },
32
- options
33
- });
34
- var updateReloadTask = async (taskId, body, options) => invokeFetch("reload-tasks", {
35
- method: "put",
36
- pathTemplate: "/api/v1/reload-tasks/{taskId}",
37
- pathVariables: { taskId },
38
- body,
39
- contentType: "application/json",
40
- options
41
- });
9
+ async function getReloadTasks(query, options) {
10
+ return invokeFetch("reload-tasks", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/reload-tasks",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function createReloadTask(body, options) {
18
+ return invokeFetch("reload-tasks", {
19
+ method: "post",
20
+ pathTemplate: "/api/v1/reload-tasks",
21
+ body,
22
+ contentType: "application/json",
23
+ options
24
+ });
25
+ }
26
+ async function deleteReloadTask(taskId, options) {
27
+ return invokeFetch("reload-tasks", {
28
+ method: "delete",
29
+ pathTemplate: "/api/v1/reload-tasks/{taskId}",
30
+ pathVariables: { taskId },
31
+ options
32
+ });
33
+ }
34
+ async function getReloadTask(taskId, options) {
35
+ return invokeFetch("reload-tasks", {
36
+ method: "get",
37
+ pathTemplate: "/api/v1/reload-tasks/{taskId}",
38
+ pathVariables: { taskId },
39
+ options
40
+ });
41
+ }
42
+ async function updateReloadTask(taskId, body, options) {
43
+ return invokeFetch("reload-tasks", {
44
+ method: "put",
45
+ pathTemplate: "/api/v1/reload-tasks/{taskId}",
46
+ pathVariables: { taskId },
47
+ body,
48
+ contentType: "application/json",
49
+ options
50
+ });
51
+ }
42
52
  function clearCache() {
43
53
  return clearApiCache("reload-tasks");
44
54
  }
package/reloads.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
- import './auth-types-DqfMuSRX.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
3
 
4
4
  type Error = {
5
5
  /** The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'. */
@@ -111,7 +111,7 @@ type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh" | "c
111
111
  * @param query an object with query parameters
112
112
  * @throws GetReloadsHttpError
113
113
  */
114
- declare const getReloads: (query: {
114
+ declare function getReloads(query: {
115
115
  /** The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant. */
116
116
  appId: string;
117
117
  /** SCIM filter expression used to search for reloads.
@@ -135,7 +135,7 @@ declare const getReloads: (query: {
135
135
  partial?: boolean;
136
136
  /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
137
137
  prev?: string;
138
- }, options?: ApiCallOptions) => Promise<GetReloadsHttpResponse>;
138
+ }, options?: ApiCallOptions): Promise<GetReloadsHttpResponse>;
139
139
  type GetReloadsHttpResponse = {
140
140
  data: Reloads;
141
141
  headers: Headers;
@@ -154,7 +154,7 @@ type GetReloadsHttpError = {
154
154
  * @param body an object with the body content
155
155
  * @throws QueueReloadHttpError
156
156
  */
157
- declare const queueReload: (body: ReloadRequest, options?: ApiCallOptions) => Promise<QueueReloadHttpResponse>;
157
+ declare function queueReload(body: ReloadRequest, options?: ApiCallOptions): Promise<QueueReloadHttpResponse>;
158
158
  type QueueReloadHttpResponse = {
159
159
  data: Reload;
160
160
  headers: Headers;
@@ -171,7 +171,7 @@ type QueueReloadHttpError = {
171
171
  * @param reloadId The unique identifier of the reload.
172
172
  * @throws GetReloadHttpError
173
173
  */
174
- declare const getReload: (reloadId: string, options?: ApiCallOptions) => Promise<GetReloadHttpResponse>;
174
+ declare function getReload(reloadId: string, options?: ApiCallOptions): Promise<GetReloadHttpResponse>;
175
175
  type GetReloadHttpResponse = {
176
176
  data: Reload;
177
177
  headers: Headers;
@@ -188,7 +188,7 @@ type GetReloadHttpError = {
188
188
  * @param reloadId The unique identifier of the reload.
189
189
  * @throws CancelReloadHttpError
190
190
  */
191
- declare const cancelReload: (reloadId: string, options?: ApiCallOptions) => Promise<CancelReloadHttpResponse>;
191
+ declare function cancelReload(reloadId: string, options?: ApiCallOptions): Promise<CancelReloadHttpResponse>;
192
192
  type CancelReloadHttpResponse = {
193
193
  data: void;
194
194
  headers: Headers;
package/reloads.js CHANGED
@@ -1,36 +1,44 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/YKZ2QYHN.js";
5
- import "./chunks/DLKLPD7T.js";
6
- import "./chunks/2ZQ3ZX7F.js";
4
+ } from "./chunks/LIEZG7IM.js";
5
+ import "./chunks/GPRUNZV4.js";
6
+ import "./chunks/7MMXU6EL.js";
7
7
 
8
8
  // src/public/rest/reloads.ts
9
- var getReloads = async (query, options) => invokeFetch("reloads", {
10
- method: "get",
11
- pathTemplate: "/api/v1/reloads",
12
- query,
13
- options
14
- });
15
- var queueReload = async (body, options) => invokeFetch("reloads", {
16
- method: "post",
17
- pathTemplate: "/api/v1/reloads",
18
- body,
19
- contentType: "application/json",
20
- options
21
- });
22
- var getReload = async (reloadId, options) => invokeFetch("reloads", {
23
- method: "get",
24
- pathTemplate: "/api/v1/reloads/{reloadId}",
25
- pathVariables: { reloadId },
26
- options
27
- });
28
- var cancelReload = async (reloadId, options) => invokeFetch("reloads", {
29
- method: "post",
30
- pathTemplate: "/api/v1/reloads/{reloadId}/actions/cancel",
31
- pathVariables: { reloadId },
32
- options
33
- });
9
+ async function getReloads(query, options) {
10
+ return invokeFetch("reloads", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/reloads",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function queueReload(body, options) {
18
+ return invokeFetch("reloads", {
19
+ method: "post",
20
+ pathTemplate: "/api/v1/reloads",
21
+ body,
22
+ contentType: "application/json",
23
+ options
24
+ });
25
+ }
26
+ async function getReload(reloadId, options) {
27
+ return invokeFetch("reloads", {
28
+ method: "get",
29
+ pathTemplate: "/api/v1/reloads/{reloadId}",
30
+ pathVariables: { reloadId },
31
+ options
32
+ });
33
+ }
34
+ async function cancelReload(reloadId, options) {
35
+ return invokeFetch("reloads", {
36
+ method: "post",
37
+ pathTemplate: "/api/v1/reloads/{reloadId}/actions/cancel",
38
+ pathVariables: { reloadId },
39
+ options
40
+ });
41
+ }
34
42
  function clearCache() {
35
43
  return clearApiCache("reloads");
36
44
  }
@@ -0,0 +1,287 @@
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
+
4
+ type CreateTemplateRequest = {
5
+ /** Template description */
6
+ description?: string;
7
+ /** Template name */
8
+ name: string;
9
+ /** Specifies the action to perform with the given source app id. Use "validate" to verify that the template source app matches the provided value. Use "replace" to migrate the template to a different app by replacing the source app id. */
10
+ sourceAppAction?: "validate" | "replace";
11
+ /** The ID of the app that this template is using as data source. The id stored in the template file metadata is used if no value is specified. */
12
+ sourceAppId?: string;
13
+ /** The ID of a previously uploaded temporary content file */
14
+ temporaryContentId: string;
15
+ };
16
+ type ErrorResponseItem = {
17
+ /** The error code. */
18
+ code?: string;
19
+ /** A human-readable explanation specific to this occurrence of the problem. */
20
+ detail?: string;
21
+ /** Additional error metadata. */
22
+ meta?: unknown;
23
+ /** Summary of the problem. */
24
+ title?: string;
25
+ };
26
+ type ErrorResult = {
27
+ /** List of errors and their properties. */
28
+ errors?: ErrorResponseItem[];
29
+ readonly statusCode?: number;
30
+ };
31
+ type GetTemplatesResponse = {
32
+ /** The current page data. */
33
+ data?: ReportTemplateResponse[];
34
+ links?: PaginationLinks;
35
+ };
36
+ type Operation = {
37
+ from?: string;
38
+ op?: string;
39
+ path?: string;
40
+ value?: unknown;
41
+ };
42
+ type PaginationLink = {
43
+ /** The URL for the pagination link. */
44
+ href?: string;
45
+ };
46
+ type PaginationLinks = {
47
+ next?: PaginationLink;
48
+ prev?: PaginationLink;
49
+ self?: PaginationLink;
50
+ };
51
+ type ReportTemplateResponse = {
52
+ /** The date and time when the template was created. */
53
+ createdAt?: string;
54
+ /** The id of the user who created the template. */
55
+ createdBy?: string;
56
+ /** Template description */
57
+ description?: string;
58
+ /** The template ID */
59
+ id?: string;
60
+ /** The template metadata version */
61
+ metadataVersion?: number;
62
+ /** Template name */
63
+ name?: string;
64
+ /** The user that this template is scoped to. */
65
+ ownerId?: string;
66
+ /** The id of the app that this template is using as data source. */
67
+ sourceAppId?: string;
68
+ /** The name of the app that this template is using as data source. */
69
+ sourceAppName?: string;
70
+ /** The date and time when the template was last updated. */
71
+ updatedAt?: string;
72
+ /** The id of the user who last updated the template. */
73
+ updatedBy?: string;
74
+ };
75
+ type UpdateTemplateRequest = {
76
+ /** Template description */
77
+ description?: string;
78
+ /** Template name */
79
+ name: string;
80
+ /** Specifies the action to perform with the new source app. Use "validate" to verify that the source app of the uploaded template matches the target app. Use "replace" to migrate the uploaded template to the target app by replacing the source app id. */
81
+ sourceAppAction?: "validate" | "replace";
82
+ /** The ID of a previously uploaded temporary content file */
83
+ temporaryContentId: string;
84
+ };
85
+ /**
86
+ * Get descriptive info for the specified templates.
87
+ *
88
+ * @param query an object with query parameters
89
+ * @throws GetReportTemplatesHttpError
90
+ */
91
+ declare function getReportTemplates(query: {
92
+ /** If present, restrict the number of returned items to this value. */
93
+ limit?: number;
94
+ /** Template name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. */
95
+ name?: string;
96
+ /** Return the templates for the specified owner. */
97
+ ownerId?: string;
98
+ /** If present, skip this number of the returned values in the result set (facilitates paging). */
99
+ skip?: number;
100
+ /** Field to sort by. Prefix with +/- to indicate ascending/descending. By default, the sort order is ascending. */
101
+ sort?: ("name" | "+name" | "-name" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt" | "type" | "+type" | "-type")[];
102
+ /** Return the templates that are using the specified app as data source. */
103
+ sourceAppId?: string;
104
+ }, options?: ApiCallOptions): Promise<GetReportTemplatesHttpResponse>;
105
+ type GetReportTemplatesHttpResponse = {
106
+ data: GetTemplatesResponse;
107
+ headers: Headers;
108
+ status: 200;
109
+ prev?: (options?: ApiCallOptions) => Promise<GetReportTemplatesHttpResponse>;
110
+ next?: (options?: ApiCallOptions) => Promise<GetReportTemplatesHttpResponse>;
111
+ };
112
+ type GetReportTemplatesHttpError = {
113
+ data: ErrorResult;
114
+ headers: Headers;
115
+ status: 400;
116
+ };
117
+ /**
118
+ * Create a new report template.
119
+ *
120
+ * @param body an object with the body content
121
+ * @throws CreateReportTemplateHttpError
122
+ */
123
+ declare function createReportTemplate(body: CreateTemplateRequest, options?: ApiCallOptions): Promise<CreateReportTemplateHttpResponse>;
124
+ type CreateReportTemplateHttpResponse = {
125
+ data: ReportTemplateResponse;
126
+ headers: Headers;
127
+ status: 201;
128
+ };
129
+ type CreateReportTemplateHttpError = {
130
+ data: ErrorResult;
131
+ headers: Headers;
132
+ status: 400 | 403 | 404 | 413;
133
+ };
134
+ /**
135
+ * Delete the specified report template.
136
+ *
137
+ * @param id The ID of the report template to delete.
138
+ * @throws DeleteReportTemplateHttpError
139
+ */
140
+ declare function deleteReportTemplate(id: string, options?: ApiCallOptions): Promise<DeleteReportTemplateHttpResponse>;
141
+ type DeleteReportTemplateHttpResponse = {
142
+ data: void;
143
+ headers: Headers;
144
+ status: 204;
145
+ };
146
+ type DeleteReportTemplateHttpError = {
147
+ data: ErrorResult;
148
+ headers: Headers;
149
+ status: 400 | 403 | 404;
150
+ };
151
+ /**
152
+ * Get descriptive info for the specified report template.
153
+ *
154
+ * @param id The ID of the report template.
155
+ * @throws GetReportTemplateHttpError
156
+ */
157
+ declare function getReportTemplate(id: string, options?: ApiCallOptions): Promise<GetReportTemplateHttpResponse>;
158
+ type GetReportTemplateHttpResponse = {
159
+ data: ReportTemplateResponse;
160
+ headers: Headers;
161
+ status: 200;
162
+ };
163
+ type GetReportTemplateHttpError = {
164
+ data: ErrorResult;
165
+ headers: Headers;
166
+ status: 400 | 403 | 404;
167
+ };
168
+ /**
169
+ * Patch an existing report template.
170
+ *
171
+ * @param id The ID of the report template to patch.
172
+ * @param body an object with the body content
173
+ * @throws PatchReportTemplateHttpError
174
+ */
175
+ declare function patchReportTemplate(id: string, body: Operation[], options?: ApiCallOptions): Promise<PatchReportTemplateHttpResponse>;
176
+ type PatchReportTemplateHttpResponse = {
177
+ data: void;
178
+ headers: Headers;
179
+ status: 204;
180
+ };
181
+ type PatchReportTemplateHttpError = {
182
+ data: ErrorResult;
183
+ headers: Headers;
184
+ status: 400 | 403 | 404 | 409 | 413;
185
+ };
186
+ /**
187
+ * Update an existing report template.
188
+ *
189
+ * @param id The ID of the report template to update.
190
+ * @param body an object with the body content
191
+ * @throws UpdateReportTemplateHttpError
192
+ */
193
+ declare function updateReportTemplate(id: string, body: UpdateTemplateRequest, options?: ApiCallOptions): Promise<UpdateReportTemplateHttpResponse>;
194
+ type UpdateReportTemplateHttpResponse = {
195
+ data: ReportTemplateResponse;
196
+ headers: Headers;
197
+ status: 201;
198
+ };
199
+ type UpdateReportTemplateHttpError = {
200
+ data: ErrorResult;
201
+ headers: Headers;
202
+ status: 400 | 403 | 404 | 409 | 413;
203
+ };
204
+ /**
205
+ * Download the template file of the specified report template
206
+ *
207
+ * @param id The ID of the report template.
208
+ * @throws DownloadReportTemplateHttpError
209
+ */
210
+ declare function downloadReportTemplate(id: string, options?: ApiCallOptions): Promise<DownloadReportTemplateHttpResponse>;
211
+ type DownloadReportTemplateHttpResponse = {
212
+ data: DownloadableBlob;
213
+ headers: Headers;
214
+ status: 200;
215
+ };
216
+ type DownloadReportTemplateHttpError = {
217
+ data: ErrorResult;
218
+ headers: Headers;
219
+ status: 400 | 403 | 404;
220
+ };
221
+ /**
222
+ * Clears the cache for report-templates api requests.
223
+ */
224
+ declare function clearCache(): void;
225
+ interface ReportTemplatesAPI {
226
+ /**
227
+ * Get descriptive info for the specified templates.
228
+ *
229
+ * @param query an object with query parameters
230
+ * @throws GetReportTemplatesHttpError
231
+ */
232
+ getReportTemplates: typeof getReportTemplates;
233
+ /**
234
+ * Create a new report template.
235
+ *
236
+ * @param body an object with the body content
237
+ * @throws CreateReportTemplateHttpError
238
+ */
239
+ createReportTemplate: typeof createReportTemplate;
240
+ /**
241
+ * Delete the specified report template.
242
+ *
243
+ * @param id The ID of the report template to delete.
244
+ * @throws DeleteReportTemplateHttpError
245
+ */
246
+ deleteReportTemplate: typeof deleteReportTemplate;
247
+ /**
248
+ * Get descriptive info for the specified report template.
249
+ *
250
+ * @param id The ID of the report template.
251
+ * @throws GetReportTemplateHttpError
252
+ */
253
+ getReportTemplate: typeof getReportTemplate;
254
+ /**
255
+ * Patch an existing report template.
256
+ *
257
+ * @param id The ID of the report template to patch.
258
+ * @param body an object with the body content
259
+ * @throws PatchReportTemplateHttpError
260
+ */
261
+ patchReportTemplate: typeof patchReportTemplate;
262
+ /**
263
+ * Update an existing report template.
264
+ *
265
+ * @param id The ID of the report template to update.
266
+ * @param body an object with the body content
267
+ * @throws UpdateReportTemplateHttpError
268
+ */
269
+ updateReportTemplate: typeof updateReportTemplate;
270
+ /**
271
+ * Download the template file of the specified report template
272
+ *
273
+ * @param id The ID of the report template.
274
+ * @throws DownloadReportTemplateHttpError
275
+ */
276
+ downloadReportTemplate: typeof downloadReportTemplate;
277
+ /**
278
+ * Clears the cache for report-templates api requests.
279
+ */
280
+ clearCache: typeof clearCache;
281
+ }
282
+ /**
283
+ * Functions for the report-templates api
284
+ */
285
+ declare const reportTemplatesExport: ReportTemplatesAPI;
286
+
287
+ export { type CreateReportTemplateHttpError, type CreateReportTemplateHttpResponse, type CreateTemplateRequest, type DeleteReportTemplateHttpError, type DeleteReportTemplateHttpResponse, type DownloadReportTemplateHttpError, type DownloadReportTemplateHttpResponse, type ErrorResponseItem, type ErrorResult, type GetReportTemplateHttpError, type GetReportTemplateHttpResponse, type GetReportTemplatesHttpError, type GetReportTemplatesHttpResponse, type GetTemplatesResponse, type Operation, type PaginationLink, type PaginationLinks, type PatchReportTemplateHttpError, type PatchReportTemplateHttpResponse, type ReportTemplateResponse, type ReportTemplatesAPI, type UpdateReportTemplateHttpError, type UpdateReportTemplateHttpResponse, type UpdateTemplateRequest, clearCache, createReportTemplate, reportTemplatesExport as default, deleteReportTemplate, downloadReportTemplate, getReportTemplate, getReportTemplates, patchReportTemplate, updateReportTemplate };