@qlik/api 0.0.16 → 0.1.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 (134) hide show
  1. package/README.md +1 -1
  2. package/api-keys.js +25 -25
  3. package/apps.d.ts +9 -1
  4. package/apps.js +97 -97
  5. package/audits.js +23 -23
  6. package/auth.js +14 -14
  7. package/automations.js +47 -47
  8. package/brands.js +35 -35
  9. package/chunks/4HB3TAEO.js +4 -4
  10. package/chunks/{HHOVS7QC.mjs → CHNBNLXY.js} +3 -3
  11. package/chunks/{3YV6X7S6.mjs → FFGE2RP7.js} +1 -1
  12. package/chunks/{HOCTJESP.mjs → JEGN7XQV.js} +3 -3
  13. package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
  14. package/chunks/OPRGGO4C.js +8 -8
  15. package/chunks/{O4EAKEIN.mjs → RHF624NQ.js} +1 -1
  16. package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
  17. package/chunks/{EHAANYDL.mjs → TT66UJZY.js} +3 -3
  18. package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
  19. package/chunks/{6AD3HYSF.mjs → XZQNE4HH.js} +1 -1
  20. package/collections.js +33 -33
  21. package/csp-origins.js +23 -23
  22. package/data-assets.js +21 -21
  23. package/data-connections.js +29 -29
  24. package/data-credentials.js +19 -19
  25. package/data-files.js +35 -35
  26. package/docs/authentication.md +5 -5
  27. package/docs/examples/fetch-spaces.md +1 -15
  28. package/docs/examples/show-sheet-list.md +1 -1
  29. package/docs/features.md +1 -1
  30. package/extensions.js +25 -25
  31. package/glossaries.js +59 -59
  32. package/groups.d.ts +0 -3
  33. package/groups.js +27 -27
  34. package/identity-providers.d.ts +144 -10
  35. package/identity-providers.js +27 -27
  36. package/index.js +53 -53
  37. package/items.js +27 -27
  38. package/licenses.js +29 -29
  39. package/package.json +36 -232
  40. package/qix.d.ts +1 -1
  41. package/qix.js +10 -10
  42. package/quotas.js +15 -15
  43. package/reload-tasks.js +21 -21
  44. package/reloads.js +19 -19
  45. package/roles.js +15 -15
  46. package/spaces.js +35 -35
  47. package/temp-contents.js +17 -17
  48. package/tenants.js +23 -23
  49. package/themes.js +25 -25
  50. package/transports.js +23 -23
  51. package/users.d.ts +1 -3
  52. package/users.js +31 -31
  53. package/web-integrations.js +21 -21
  54. package/web-notifications.js +23 -23
  55. package/webhooks.js +31 -31
  56. package/api-keys.d.mts +0 -336
  57. package/api-keys.mjs +0 -80
  58. package/apps.d.mts +0 -2431
  59. package/apps.mjs +0 -398
  60. package/audits.d.mts +0 -286
  61. package/audits.mjs +0 -64
  62. package/auth-types-nnUcWhuU.d.mts +0 -98
  63. package/auth.d.mts +0 -26
  64. package/auth.mjs +0 -14
  65. package/automations.d.mts +0 -682
  66. package/automations.mjs +0 -173
  67. package/brands.d.mts +0 -670
  68. package/brands.mjs +0 -123
  69. package/chunks/2YWCEGTS.js +0 -21
  70. package/chunks/34ZKUFEA.js +0 -41
  71. package/chunks/4WHZ4EIW.js +0 -57
  72. package/chunks/B4VPD3ZT.js +0 -574
  73. package/chunks/BM4OSDRZ.js +0 -17
  74. package/chunks/DCXUEDOW.mjs +0 -67
  75. package/chunks/MTAQE4WC.js +0 -10411
  76. package/chunks/PLOSYUG2.js +0 -25
  77. package/chunks/URIW2U5M.js +0 -17
  78. package/chunks/VSY5YIQY.mjs +0 -11
  79. package/chunks/WOYJLK4Y.js +0 -1623
  80. package/collections.d.mts +0 -581
  81. package/collections.mjs +0 -114
  82. package/csp-origins.d.mts +0 -273
  83. package/csp-origins.mjs +0 -69
  84. package/data-assets.d.mts +0 -205
  85. package/data-assets.mjs +0 -66
  86. package/data-connections.d.mts +0 -594
  87. package/data-connections.mjs +0 -103
  88. package/data-credentials.d.mts +0 -204
  89. package/data-credentials.mjs +0 -59
  90. package/data-files.d.mts +0 -562
  91. package/data-files.mjs +0 -123
  92. package/extensions.d.mts +0 -293
  93. package/extensions.mjs +0 -77
  94. package/global.types-5iFvFJvX.d.mts +0 -115
  95. package/glossaries.d.mts +0 -1173
  96. package/glossaries.mjs +0 -237
  97. package/groups.d.mts +0 -434
  98. package/groups.mjs +0 -88
  99. package/identity-providers.d.mts +0 -550
  100. package/identity-providers.mjs +0 -83
  101. package/index.d.mts +0 -142
  102. package/index.mjs +0 -716
  103. package/items.d.mts +0 -535
  104. package/items.mjs +0 -87
  105. package/licenses.d.mts +0 -459
  106. package/licenses.mjs +0 -92
  107. package/qix.d.mts +0 -11629
  108. package/qix.mjs +0 -10
  109. package/quotas.d.mts +0 -112
  110. package/quotas.mjs +0 -32
  111. package/reload-tasks.d.mts +0 -227
  112. package/reload-tasks.mjs +0 -62
  113. package/reloads.d.mts +0 -207
  114. package/reloads.mjs +0 -46
  115. package/roles.d.mts +0 -175
  116. package/roles.mjs +0 -31
  117. package/spaces.d.mts +0 -562
  118. package/spaces.mjs +0 -124
  119. package/temp-contents.d.mts +0 -167
  120. package/temp-contents.mjs +0 -41
  121. package/tenants.d.mts +0 -300
  122. package/tenants.mjs +0 -73
  123. package/themes.d.mts +0 -268
  124. package/themes.mjs +0 -77
  125. package/transports.d.mts +0 -319
  126. package/transports.mjs +0 -65
  127. package/users.d.mts +0 -631
  128. package/users.mjs +0 -104
  129. package/web-integrations.d.mts +0 -274
  130. package/web-integrations.mjs +0 -62
  131. package/web-notifications.d.mts +0 -250
  132. package/web-notifications.mjs +0 -69
  133. package/webhooks.d.mts +0 -445
  134. package/webhooks.mjs +0 -104
package/qix.mjs DELETED
@@ -1,10 +0,0 @@
1
- import {
2
- openAppSession,
3
- qix_default
4
- } from "./chunks/O4EAKEIN.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
- export {
8
- qix_default as default,
9
- openAppSession
10
- };
package/quotas.d.mts DELETED
@@ -1,112 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- /**
5
- * A specific error.
6
- */
7
- type Error = {
8
- /** The error code. */
9
- code: string;
10
- /** Summary of the problem. */
11
- title: string;
12
- };
13
- type ErrorResponse = {
14
- errors?: Error[];
15
- };
16
- type GetQuotaByIdResult = {
17
- /** Quota item. */
18
- data: Quota[];
19
- };
20
- type GetQuotasResult = {
21
- /** Array of quota items. */
22
- data: Quota[];
23
- };
24
- type Quota = {
25
- /** The attributes of the quota. */
26
- attributes: {
27
- /** The quota limit. If there is no quota limit, -1 is returned. */
28
- quota: number;
29
- /** The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces". */
30
- unit: string;
31
- /** The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter. */
32
- usage?: number;
33
- /** The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit. */
34
- warningThresholds?: number[];
35
- };
36
- /** The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces". */
37
- id: string;
38
- /** The resource type of the quota item. Always equal to "quotas". */
39
- type: string;
40
- };
41
- /**
42
- * Returns all quota items for the tenant (provided in JWT).
43
- *
44
- * @param query an object with query parameters
45
- * @throws GetQuotasHttpError
46
- */
47
- declare const getQuotas: (query: {
48
- /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned). */
49
- reportUsage?: boolean;
50
- }, options?: ApiCallOptions) => Promise<GetQuotasHttpResponse>;
51
- type GetQuotasHttpResponse = {
52
- data: GetQuotasResult;
53
- headers: Headers;
54
- status: number;
55
- };
56
- type GetQuotasHttpError = {
57
- data: ErrorResponse;
58
- headers: Headers;
59
- status: number;
60
- };
61
- /**
62
- * Returns a specific quota item for the tenant (provided in JWT).
63
- *
64
- * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
65
- * @param query an object with query parameters
66
- * @throws GetQuotaHttpError
67
- */
68
- declare const getQuota: (id: string, query: {
69
- /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included). */
70
- reportUsage?: boolean;
71
- }, options?: ApiCallOptions) => Promise<GetQuotaHttpResponse>;
72
- type GetQuotaHttpResponse = {
73
- data: GetQuotaByIdResult;
74
- headers: Headers;
75
- status: number;
76
- };
77
- type GetQuotaHttpError = {
78
- data: ErrorResponse;
79
- headers: Headers;
80
- status: number;
81
- };
82
- /**
83
- * Clears the cache for quotas api requests.
84
- */
85
- declare function clearCache(): void;
86
- interface QuotasAPI {
87
- /**
88
- * Returns all quota items for the tenant (provided in JWT).
89
- *
90
- * @param query an object with query parameters
91
- * @throws GetQuotasHttpError
92
- */
93
- getQuotas: typeof getQuotas;
94
- /**
95
- * Returns a specific quota item for the tenant (provided in JWT).
96
- *
97
- * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
98
- * @param query an object with query parameters
99
- * @throws GetQuotaHttpError
100
- */
101
- getQuota: typeof getQuota;
102
- /**
103
- * Clears the cache for quotas api requests.
104
- */
105
- clearCache: typeof clearCache;
106
- }
107
- /**
108
- * Functions for the quotas api
109
- */
110
- declare const quotasExport: QuotasAPI;
111
-
112
- export { type Error, type ErrorResponse, type GetQuotaByIdResult, type GetQuotaHttpError, type GetQuotaHttpResponse, type GetQuotasHttpError, type GetQuotasHttpResponse, type GetQuotasResult, type Quota, type QuotasAPI, clearCache, quotasExport as default, getQuota, getQuotas };
package/quotas.mjs DELETED
@@ -1,32 +0,0 @@
1
- import {
2
- clearApiCache,
3
- invokeFetch
4
- } from "./chunks/3YV6X7S6.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
-
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
- });
22
- function clearCache() {
23
- return clearApiCache("quotas");
24
- }
25
- var quotasExport = { getQuotas, getQuota, clearCache };
26
- var quotas_default = quotasExport;
27
- export {
28
- clearCache,
29
- quotas_default as default,
30
- getQuota,
31
- getQuotas
32
- };
@@ -1,227 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- type Error = {
5
- code: string;
6
- detail?: string;
7
- title: string;
8
- };
9
- type Errors = {
10
- errors?: Error[];
11
- traceId?: string;
12
- };
13
- type Href = {
14
- href: string;
15
- };
16
- type PaginationLinks = SelfLink & {
17
- next?: Href;
18
- prev?: Href;
19
- };
20
- type PostTaskBody = TaskBase & {
21
- /** @deprecated
22
- * Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
23
- type?: "scheduled_reload";
24
- };
25
- type PutTaskBody = TaskBase & {
26
- /** Toggle for enabling and disabling the reload task */
27
- state?: "Enabled" | "Disabled" | "Completed";
28
- };
29
- type SelfLink = {
30
- self: Href;
31
- };
32
- type Task = TaskBase & {
33
- /** The reason why the task was disabled. */
34
- disabledCode?: "MANUALLY" | "CONSECUTIVE-FAILURES" | "OWNER-DELETED" | "OWNER-DISABLED";
35
- /** @deprecated
36
- * The fortress ID of the application */
37
- fortressId?: string;
38
- /** The ID of the task. */
39
- id: string;
40
- /** The last time the task executed. */
41
- lastExecutionTime?: string;
42
- links: SelfLink;
43
- /** @deprecated
44
- * The reason why the task was disabled. */
45
- log?: string;
46
- /** The next time the task will execute. */
47
- nextExecutionTime?: string;
48
- /** The space ID of the application */
49
- spaceId?: string;
50
- /** Toggle for enabling and disabling the reload task */
51
- state: "Enabled" | "Disabled" | "Completed";
52
- /** The ID of the tenant who owns the task. */
53
- tenantId: string;
54
- /** The ID of the user who owns the task. */
55
- userId: string;
56
- };
57
- type TaskBase = {
58
- /** The ID of the app. */
59
- appId?: string;
60
- /** A flag that indicates whether a reload is triggered when data of the app is changed */
61
- autoReload?: boolean;
62
- /** A flag that indicates whether it is a partial reload or not for the auto reload */
63
- autoReloadPartial?: boolean;
64
- /** The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. */
65
- endDateTime?: string;
66
- /** The task is partial reload or not */
67
- partial?: boolean;
68
- /** List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events */
69
- recurrence?: string[];
70
- /** The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set. */
71
- startDateTime?: string;
72
- /** The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format. */
73
- timeZone?: string;
74
- };
75
- type Tasks = {
76
- data: Task[];
77
- links: PaginationLinks;
78
- };
79
- /**
80
- * Find and return the tasks that the user can access.
81
- *
82
- * @param query an object with query parameters
83
- * @throws GetReloadTasksHttpError
84
- */
85
- declare const getReloadTasks: (query: {
86
- /** The case sensitive string used to search for a task by app ID. */
87
- appId?: string;
88
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
89
- limit?: number;
90
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
91
- next?: string;
92
- /** The boolean value used to search for a task is partial or not */
93
- partial?: boolean;
94
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
95
- prev?: string;
96
- }, options?: ApiCallOptions) => Promise<GetReloadTasksHttpResponse>;
97
- type GetReloadTasksHttpResponse = {
98
- data: Tasks;
99
- headers: Headers;
100
- status: number;
101
- };
102
- type GetReloadTasksHttpError = {
103
- data: Errors;
104
- headers: Headers;
105
- status: number;
106
- };
107
- /**
108
- * Create a task for a specified app.
109
- *
110
- * @param body an object with the body content
111
- * @throws CreateReloadTaskHttpError
112
- */
113
- declare const createReloadTask: (body: PostTaskBody, options?: ApiCallOptions) => Promise<CreateReloadTaskHttpResponse>;
114
- type CreateReloadTaskHttpResponse = {
115
- data: Task;
116
- headers: Headers;
117
- status: number;
118
- };
119
- type CreateReloadTaskHttpError = {
120
- data: Errors;
121
- headers: Headers;
122
- status: number;
123
- };
124
- /**
125
- * Delete a task.
126
- *
127
- * @param taskId The unique identifier of the task.
128
- * @throws DeleteReloadTaskHttpError
129
- */
130
- declare const deleteReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<DeleteReloadTaskHttpResponse>;
131
- type DeleteReloadTaskHttpResponse = {
132
- data: void;
133
- headers: Headers;
134
- status: number;
135
- };
136
- type DeleteReloadTaskHttpError = {
137
- data: Errors;
138
- headers: Headers;
139
- status: number;
140
- };
141
- /**
142
- * Find and return a task.
143
- *
144
- * @param taskId The unique identifier of the task.
145
- * @throws GetReloadTaskHttpError
146
- */
147
- declare const getReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<GetReloadTaskHttpResponse>;
148
- type GetReloadTaskHttpResponse = {
149
- data: Task;
150
- headers: Headers;
151
- status: number;
152
- };
153
- type GetReloadTaskHttpError = {
154
- data: Errors;
155
- headers: Headers;
156
- status: number;
157
- };
158
- /**
159
- * Update an existing task.
160
- *
161
- * @param taskId The unique identifier of the task.
162
- * @param body an object with the body content
163
- * @throws UpdateReloadTaskHttpError
164
- */
165
- declare const updateReloadTask: (taskId: string, body: PutTaskBody, options?: ApiCallOptions) => Promise<UpdateReloadTaskHttpResponse>;
166
- type UpdateReloadTaskHttpResponse = {
167
- data: Task;
168
- headers: Headers;
169
- status: number;
170
- };
171
- type UpdateReloadTaskHttpError = {
172
- data: Errors;
173
- headers: Headers;
174
- status: number;
175
- };
176
- /**
177
- * Clears the cache for reload-tasks api requests.
178
- */
179
- declare function clearCache(): void;
180
- interface ReloadTasksAPI {
181
- /**
182
- * Find and return the tasks that the user can access.
183
- *
184
- * @param query an object with query parameters
185
- * @throws GetReloadTasksHttpError
186
- */
187
- getReloadTasks: typeof getReloadTasks;
188
- /**
189
- * Create a task for a specified app.
190
- *
191
- * @param body an object with the body content
192
- * @throws CreateReloadTaskHttpError
193
- */
194
- createReloadTask: typeof createReloadTask;
195
- /**
196
- * Delete a task.
197
- *
198
- * @param taskId The unique identifier of the task.
199
- * @throws DeleteReloadTaskHttpError
200
- */
201
- deleteReloadTask: typeof deleteReloadTask;
202
- /**
203
- * Find and return a task.
204
- *
205
- * @param taskId The unique identifier of the task.
206
- * @throws GetReloadTaskHttpError
207
- */
208
- getReloadTask: typeof getReloadTask;
209
- /**
210
- * Update an existing task.
211
- *
212
- * @param taskId The unique identifier of the task.
213
- * @param body an object with the body content
214
- * @throws UpdateReloadTaskHttpError
215
- */
216
- updateReloadTask: typeof updateReloadTask;
217
- /**
218
- * Clears the cache for reload-tasks api requests.
219
- */
220
- clearCache: typeof clearCache;
221
- }
222
- /**
223
- * Functions for the reload-tasks api
224
- */
225
- declare const reloadTasksExport: ReloadTasksAPI;
226
-
227
- export { type CreateReloadTaskHttpError, type CreateReloadTaskHttpResponse, type DeleteReloadTaskHttpError, type DeleteReloadTaskHttpResponse, type Error, type Errors, type GetReloadTaskHttpError, type GetReloadTaskHttpResponse, type GetReloadTasksHttpError, type GetReloadTasksHttpResponse, type Href, type PaginationLinks, type PostTaskBody, type PutTaskBody, type ReloadTasksAPI, type SelfLink, type Task, type TaskBase, type Tasks, type UpdateReloadTaskHttpError, type UpdateReloadTaskHttpResponse, clearCache, createReloadTask, reloadTasksExport as default, deleteReloadTask, getReloadTask, getReloadTasks, updateReloadTask };
package/reload-tasks.mjs DELETED
@@ -1,62 +0,0 @@
1
- import {
2
- clearApiCache,
3
- invokeFetch
4
- } from "./chunks/3YV6X7S6.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
-
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
- });
42
- function clearCache() {
43
- return clearApiCache("reload-tasks");
44
- }
45
- var reloadTasksExport = {
46
- getReloadTasks,
47
- createReloadTask,
48
- deleteReloadTask,
49
- getReloadTask,
50
- updateReloadTask,
51
- clearCache
52
- };
53
- var reload_tasks_default = reloadTasksExport;
54
- export {
55
- clearCache,
56
- createReloadTask,
57
- reload_tasks_default as default,
58
- deleteReloadTask,
59
- getReloadTask,
60
- getReloadTasks,
61
- updateReloadTask
62
- };
package/reloads.d.mts DELETED
@@ -1,207 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- type Error = {
5
- /** The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'. */
6
- code: string;
7
- detail?: string;
8
- title: string;
9
- };
10
- type Errors = {
11
- errors?: Error[];
12
- };
13
- type Href = {
14
- href?: string;
15
- };
16
- /**
17
- * The boolean value used to present the reload is partial or not.
18
- */
19
- type Partial = boolean;
20
- type Reload = {
21
- /** The ID of the app. */
22
- appId: string;
23
- /** The time the reload job was created. */
24
- creationTime: string;
25
- /** The time the reload job finished. */
26
- endTime?: string;
27
- /** The timestamp returned from the Sense engine upon successful reload. */
28
- engineTime?: string;
29
- /** The ID of the reload. */
30
- id: string;
31
- links?: ReloadLinks;
32
- /** The log describing the result of the latest reload execution from the request. */
33
- log?: string;
34
- /** The boolean value used to present the reload is partial or not. */
35
- partial?: Partial;
36
- /** The time the reload job was consumed from the queue. */
37
- startTime?: string;
38
- /** The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses. */
39
- status: Status;
40
- /** The ID of the tenant who owns the reload. */
41
- tenantId: string;
42
- /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data. */
43
- type: Type;
44
- /** The ID of the user who created the reload. */
45
- userId: string;
46
- };
47
- type ReloadLinks = {
48
- self?: Href;
49
- };
50
- type ReloadRequest = {
51
- /** The ID of the app to be reloaded. */
52
- appId: string;
53
- /** The boolean value used to present the reload is partial or not */
54
- partial?: boolean;
55
- };
56
- type Reloads = {
57
- data: Reload[];
58
- links: ReloadsLinks;
59
- };
60
- type ReloadsLinks = ReloadLinks & {
61
- next?: Href;
62
- prev?: Href;
63
- };
64
- /**
65
- * The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses.
66
- */
67
- type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
68
- /**
69
- * What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data.
70
- */
71
- type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh";
72
- /**
73
- * Finds and returns the reloads that the user has access to.
74
- *
75
- * @param query an object with query parameters
76
- * @throws GetReloadsHttpError
77
- */
78
- declare const getReloads: (query: {
79
- /** 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. */
80
- appId?: string;
81
- /** SCIM filter expression used to search for reloads.
82
- * The filter syntax is defined in RFC 7644 section 3.4.2.2
83
- *
84
- * Supported attributes:
85
- * - status: see #schemas/Status
86
- * - partial: see #schemas/Partial
87
- * - type: see #schemas/Type
88
- *
89
- * Supported operators:
90
- * - eq */
91
- filter?: string;
92
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
93
- limit?: number;
94
- /** The boolean value used to include the log field or not, default is included, set log=false to exclude the log field. */
95
- log?: boolean;
96
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
97
- next?: string;
98
- /** The boolean value used to search for a reload is partial or not. */
99
- partial?: boolean;
100
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
101
- prev?: string;
102
- }, options?: ApiCallOptions) => Promise<GetReloadsHttpResponse>;
103
- type GetReloadsHttpResponse = {
104
- data: Reloads;
105
- headers: Headers;
106
- status: number;
107
- };
108
- type GetReloadsHttpError = {
109
- data: Errors;
110
- headers: Headers;
111
- status: number;
112
- };
113
- /**
114
- * Reloads an app specified by an app ID.
115
- *
116
- * @param body an object with the body content
117
- * @throws QueueReloadHttpError
118
- */
119
- declare const queueReload: (body: ReloadRequest, options?: ApiCallOptions) => Promise<QueueReloadHttpResponse>;
120
- type QueueReloadHttpResponse = {
121
- data: Reload;
122
- headers: Headers;
123
- status: number;
124
- };
125
- type QueueReloadHttpError = {
126
- data: Errors;
127
- headers: Headers;
128
- status: number;
129
- };
130
- /**
131
- * Finds and returns a reload record
132
- *
133
- * @param reloadId The unique identifier of the reload.
134
- * @throws GetReloadHttpError
135
- */
136
- declare const getReload: (reloadId: string, options?: ApiCallOptions) => Promise<GetReloadHttpResponse>;
137
- type GetReloadHttpResponse = {
138
- data: Reload;
139
- headers: Headers;
140
- status: number;
141
- };
142
- type GetReloadHttpError = {
143
- data: Errors;
144
- headers: Headers;
145
- status: number;
146
- };
147
- /**
148
- * Cancels a reload that is in progress or has been queued
149
- *
150
- * @param reloadId The unique identifier of the reload.
151
- * @throws CancelReloadHttpError
152
- */
153
- declare const cancelReload: (reloadId: string, options?: ApiCallOptions) => Promise<CancelReloadHttpResponse>;
154
- type CancelReloadHttpResponse = {
155
- data: void;
156
- headers: Headers;
157
- status: number;
158
- };
159
- type CancelReloadHttpError = {
160
- data: Errors;
161
- headers: Headers;
162
- status: number;
163
- };
164
- /**
165
- * Clears the cache for reloads api requests.
166
- */
167
- declare function clearCache(): void;
168
- interface ReloadsAPI {
169
- /**
170
- * Finds and returns the reloads that the user has access to.
171
- *
172
- * @param query an object with query parameters
173
- * @throws GetReloadsHttpError
174
- */
175
- getReloads: typeof getReloads;
176
- /**
177
- * Reloads an app specified by an app ID.
178
- *
179
- * @param body an object with the body content
180
- * @throws QueueReloadHttpError
181
- */
182
- queueReload: typeof queueReload;
183
- /**
184
- * Finds and returns a reload record
185
- *
186
- * @param reloadId The unique identifier of the reload.
187
- * @throws GetReloadHttpError
188
- */
189
- getReload: typeof getReload;
190
- /**
191
- * Cancels a reload that is in progress or has been queued
192
- *
193
- * @param reloadId The unique identifier of the reload.
194
- * @throws CancelReloadHttpError
195
- */
196
- cancelReload: typeof cancelReload;
197
- /**
198
- * Clears the cache for reloads api requests.
199
- */
200
- clearCache: typeof clearCache;
201
- }
202
- /**
203
- * Functions for the reloads api
204
- */
205
- declare const reloadsExport: ReloadsAPI;
206
-
207
- export { type CancelReloadHttpError, type CancelReloadHttpResponse, type Error, type Errors, type GetReloadHttpError, type GetReloadHttpResponse, type GetReloadsHttpError, type GetReloadsHttpResponse, type Href, type Partial, type QueueReloadHttpError, type QueueReloadHttpResponse, type Reload, type ReloadLinks, type ReloadRequest, type Reloads, type ReloadsAPI, type ReloadsLinks, type Status, type Type, cancelReload, clearCache, reloadsExport as default, getReload, getReloads, queueReload };
package/reloads.mjs DELETED
@@ -1,46 +0,0 @@
1
- import {
2
- clearApiCache,
3
- invokeFetch
4
- } from "./chunks/3YV6X7S6.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
-
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
- });
34
- function clearCache() {
35
- return clearApiCache("reloads");
36
- }
37
- var reloadsExport = { getReloads, queueReload, getReload, cancelReload, clearCache };
38
- var reloads_default = reloadsExport;
39
- export {
40
- cancelReload,
41
- clearCache,
42
- reloads_default as default,
43
- getReload,
44
- getReloads,
45
- queueReload
46
- };