@qlik/api 2.2.0 → 2.3.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 (231) 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-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  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-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.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 +6 -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-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,52 +0,0 @@
1
- import { C as InvokeFetchProperties, w as InvokeFetchResponse } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/interceptors/interceptors.d.ts
4
-
5
- /**
6
- * The RestInterceptor type is a function that can be used to intercept requests and responses
7
- */
8
- type RestInterceptor = <T extends InvokeFetchResponse>(request: InvokeFetchProperties, proceed: (props: InvokeFetchProperties) => Promise<T>, id?: string) => Promise<T>;
9
- declare function createInterceptors(): InterceptorsAPI;
10
- declare function addDefaultInterceptors(): void;
11
- /**
12
- * Adds an interceptor to the global interceptor stack
13
- * Returns the newly added interceptor
14
- * @param interceptor the interceptor to add
15
- * @returns the newly added interceptor
16
- */
17
- declare function addInterceptor(interceptor: RestInterceptor): RestInterceptor;
18
- /**
19
- * Removes an interceptor from the global interceptor stack
20
- * @param interceptor the interceptor remove
21
- */
22
- declare function removeInterceptor(interceptor: RestInterceptor): RestInterceptor | null;
23
- /**
24
- * Gets all registered interceptors
25
- */
26
- declare function getInterceptors(): RestInterceptor[];
27
- interface InterceptorsAPI {
28
- /**
29
- * Adds an interceptor to the global interceptor stack
30
- * Returns the newly added interceptor
31
- * @param interceptor the interceptor to add
32
- * @returns the newly added interceptor
33
- */
34
- addInterceptor: typeof addInterceptor;
35
- /**
36
- * Removes an interceptor from the global interceptor stack
37
- * @param interceptor the interceptor remove
38
- */
39
- removeInterceptor: typeof removeInterceptor;
40
- /**
41
- * Gets all registered interceptors
42
- */
43
- getInterceptors: typeof getInterceptors;
44
- }
45
- /**
46
- * The interceptors API
47
- */
48
- declare const interceptors: InterceptorsAPI & {
49
- createInterceptors: typeof createInterceptors;
50
- };
51
- //#endregion
52
- export { createInterceptors as a, removeInterceptor as c, addInterceptor as i, RestInterceptor as n, getInterceptors as o, addDefaultInterceptors as r, interceptors as s, InterceptorsAPI as t };
@@ -1,104 +0,0 @@
1
- import { r as isBrowser } from "./utils-BnC4lrlq.js";
2
-
3
- //#region src/interceptors/interceptors.ts
4
- let GLOBAL_INTERCEPTORS;
5
- function createInterceptors() {
6
- const interceptors$1 = [...GLOBAL_INTERCEPTORS?.getInterceptors() || []];
7
- return {
8
- addInterceptor: (interceptor) => {
9
- interceptors$1.push(interceptor);
10
- return interceptor;
11
- },
12
- removeInterceptor: (interceptor) => {
13
- const index = interceptors$1.indexOf(interceptor);
14
- let removed;
15
- if (index !== -1) removed = interceptors$1.splice(index, 1)[0];
16
- return removed || null;
17
- },
18
- getInterceptors: () => interceptors$1
19
- };
20
- }
21
- let addDefaultInterceptorsRun = false;
22
- function addDefaultInterceptors() {
23
- if (addDefaultInterceptorsRun) return;
24
- if (isBrowser()) {
25
- const readFlagsFromUrlQuery = () => {
26
- const featuresParam = new URLSearchParams(window.location.search).get("features");
27
- if (!featuresParam) return {};
28
- return featuresParam.split(",").map((item) => item.trim()).reduce((map, obj) => {
29
- const value = !obj.startsWith("!");
30
- const key = value ? obj : obj.substring(1);
31
- map[key] = value;
32
- return map;
33
- }, {});
34
- };
35
- const readFlagsFromLocalStorage = () => {
36
- try {
37
- const featuresParam = localStorage.getItem("qcs-features");
38
- if (featuresParam) return JSON.parse(featuresParam);
39
- return {};
40
- } catch {
41
- return {};
42
- }
43
- };
44
- const flagsFromUrl = readFlagsFromUrlQuery();
45
- const flagsFromLocalStorage = readFlagsFromLocalStorage();
46
- const interceptor = async (request, proceed) => {
47
- let resultPromise;
48
- if (request.pathTemplate === "/api/v1/features") {
49
- resultPromise = proceed(request);
50
- const result = await resultPromise;
51
- return {
52
- ...result,
53
- data: {
54
- ...result.data || {},
55
- ...flagsFromLocalStorage,
56
- ...flagsFromUrl
57
- }
58
- };
59
- }
60
- return proceed(request);
61
- };
62
- GLOBAL_INTERCEPTORS.addInterceptor(interceptor);
63
- }
64
- addDefaultInterceptorsRun = true;
65
- }
66
- /**
67
- * The global interceptor stack
68
- */
69
- GLOBAL_INTERCEPTORS = createInterceptors();
70
- /**
71
- * Adds an interceptor to the global interceptor stack
72
- * Returns the newly added interceptor
73
- * @param interceptor the interceptor to add
74
- * @returns the newly added interceptor
75
- */
76
- function addInterceptor(interceptor) {
77
- return GLOBAL_INTERCEPTORS.addInterceptor(interceptor);
78
- }
79
- /**
80
- * Removes an interceptor from the global interceptor stack
81
- * @param interceptor the interceptor remove
82
- */
83
- function removeInterceptor(interceptor) {
84
- return GLOBAL_INTERCEPTORS.removeInterceptor(interceptor);
85
- }
86
- /**
87
- * Gets all registered interceptors
88
- */
89
- function getInterceptors() {
90
- return GLOBAL_INTERCEPTORS.getInterceptors();
91
- }
92
- /**
93
- * The interceptors API
94
- */
95
- const interceptors = {
96
- addInterceptor,
97
- removeInterceptor,
98
- getInterceptors,
99
- createInterceptors
100
- };
101
- var interceptors_default = interceptors;
102
-
103
- //#endregion
104
- export { interceptors_default as a, getInterceptors as i, addInterceptor as n, removeInterceptor as o, createInterceptors as r, addDefaultInterceptors as t };
@@ -1,327 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/core/ip-policies.d.ts
4
- declare namespace ip_policies_d_exports {
5
- export { CreateIPPolicy, CreateIpPolicyHttpError, CreateIpPolicyHttpResponse, DeleteIpPolicyHttpError, DeleteIpPolicyHttpResponse, Error, Errors, GetIpPoliciesHttpError, GetIpPoliciesHttpResponse, GetIpPolicyHttpError, GetIpPolicyHttpResponse, IPPolicyListItem, IPPolicyResource, IpPoliciesAPI, JSONPatch, JSONPatchArray, Link, Links, ListIPPoliciesResult, PatchIpPolicyHttpError, PatchIpPolicyHttpResponse, clearCache, createIpPolicy, ipPoliciesExport as default, deleteIpPolicy, getIpPolicies, getIpPolicy, patchIpPolicy };
6
- }
7
- type CreateIPPolicy = {
8
- /** An array of allowed IP IPv4 addresses, either as plain IP addresses, or as CIDR ranges. */
9
- allowedIps: string[];
10
- /** Indicates whether the IP policy is enabled. */
11
- enabled?: boolean;
12
- /** The descriptive name for the IP policy. */
13
- name?: string;
14
- };
15
- /**
16
- * An error object describing the error.
17
- */
18
- type Error = {
19
- /** The error code. */
20
- code: string;
21
- /** A human-readable explanation specific to this occurrence of the problem. */
22
- detail?: string;
23
- /** Additional properties relating to the error. */
24
- meta?: unknown;
25
- /** References to the source of the error. */
26
- source?: {
27
- /** The URI query parameter that caused the error. */
28
- parameter?: string;
29
- /** A JSON Pointer to the property that caused the error. */
30
- pointer?: string;
31
- };
32
- /** Summary of the problem. */
33
- title: string;
34
- };
35
- /**
36
- * The error response object describing the error from the handling of an HTTP request.
37
- * @example
38
- * {
39
- * errors: [
40
- * {
41
- * code: "CODE-10402",
42
- * title: "Not Found"
43
- * }
44
- * ],
45
- * traceId: "0000000000000000200ba0714061b982"
46
- * }
47
- */
48
- type Errors = {
49
- /** An array of errors related to the operation. */
50
- errors?: Error[];
51
- /** A unique identifier for tracing the error. */
52
- traceId?: string;
53
- };
54
- type IPPolicyListItem = {
55
- /** An array of allowed IP addresses. */
56
- allowedIps?: string[];
57
- /** The timestamp for when the resource was created. */
58
- createdAt?: string;
59
- /** The user ID of the user who created the IP policy. */
60
- createdBy?: string;
61
- /** Indicates whether the IP policy can be deleted. */
62
- deletable?: boolean;
63
- /** Indicates whether the IP policy can be updated. */
64
- editable?: boolean;
65
- /** Indicates whether the IP policy is enabled. */
66
- enabled?: boolean;
67
- /** The unique identifier for the IP policy. */
68
- readonly id: string;
69
- /** The descriptive name for the IP policy. */
70
- name?: string;
71
- /** The tenant unique identifier associated with the given IP policy. */
72
- tenantId?: string;
73
- /** Indicates whether the IP policy can be enabled/disabled. */
74
- toggleable?: boolean;
75
- /** The timestamp for when the resource was last updated. */
76
- updatedAt?: string;
77
- /** The user ID of the user who last updated the IP policy. */
78
- updatedBy?: string;
79
- };
80
- type IPPolicyResource = {
81
- /** An array of allowed public IPv4 addresses. */
82
- allowedIps: string[];
83
- /** The timestamp for when the IP policy was created. */
84
- createdAt: string;
85
- /** The user ID of the user who created the IP policy. */
86
- createdBy: string;
87
- /** Indicates whether the IP policy can be deleted. */
88
- deletable: boolean;
89
- /** Indicates whether the IP policy can be updated. */
90
- editable: boolean;
91
- /** Indicates whether the IP policy is enabled. */
92
- enabled: boolean;
93
- /** The unique identifier for the IP policy. */
94
- readonly id: string;
95
- /** The descriptive name for the IP policy. */
96
- name: string;
97
- /** The tenant unique identifier associated with the given IP policy. */
98
- tenantId: string;
99
- /** Indicates whether the IP policy can be enabled/disabled.. */
100
- toggleable: boolean;
101
- /** The timestamp for when the IP policy was last updated. */
102
- updatedAt: string;
103
- /** The user ID of the user who last updated the IP policy. */
104
- updatedBy: string;
105
- };
106
- /**
107
- * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
108
- */
109
- type JSONPatch = {
110
- /** The operation to be performed. */
111
- op: "replace";
112
- /** A JSON Pointer. */
113
- path: "/enabled" | "/name" | "/allowedIps";
114
- /** The value to be used for this operation. */
115
- value: string | boolean | string[];
116
- };
117
- /**
118
- * An array of JSON Patch documents
119
- * @example
120
- * [
121
- * {
122
- * op: "replace",
123
- * path: "/name",
124
- * value: "New name"
125
- * },
126
- * {
127
- * op: "replace",
128
- * path: "/allowedIps",
129
- * value: [
130
- * "61.254.213.0/24",
131
- * "22.46.216.142"
132
- * ]
133
- * },
134
- * {
135
- * op: "replace",
136
- * path: "/enabled",
137
- * value: true
138
- * }
139
- * ]
140
- */
141
- type JSONPatchArray = JSONPatch[];
142
- /**
143
- * A link
144
- */
145
- type Link = {
146
- href: string;
147
- };
148
- /**
149
- * Contains pagination links. self is a link to the current results page, next is a link to the next results page and prev is a link to the previous results page
150
- */
151
- type Links = {
152
- /** A link */
153
- next?: Link;
154
- /** A link */
155
- prev?: Link;
156
- /** A link */
157
- self: Link;
158
- };
159
- type ListIPPoliciesResult = {
160
- /** An array of IP policies. */
161
- data: IPPolicyListItem[];
162
- /** Contains pagination links. self is a link to the current results page, next is a link to the next results page and prev is a link to the previous results page */
163
- links: Links;
164
- /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
165
- totalResults?: number;
166
- };
167
- /**
168
- * Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
169
- *
170
- * @param query an object with query parameters
171
- * @throws GetIpPoliciesHttpError
172
- */
173
- declare function getIpPolicies(query: {
174
- /** A comma-separated list of fields to limit in the response. */
175
- fields?: string;
176
- /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. All conditional statements within this query parameter are case insensitive.
177
- *
178
- * field "enabled" supports following operators: eq
179
- *
180
- * field "id" supports following operators: eq, ne
181
- *
182
- * field "name" supports following operators: eq, co
183
- *
184
- * field "tenantId" supports following operators: eq */
185
- filter?: string;
186
- /** The number of IP policies to retrieve. */
187
- limit?: number;
188
- /** The page cursor. Takes precedence over other parameters. */
189
- page?: string;
190
- /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
191
- sort?: "enabled" | "+enabled" | "-enabled" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt" | "name" | "+name" | "-name";
192
- /** Determines whether to return a count of the total records matched in the query. Defaults to false. */
193
- totalResults?: boolean;
194
- }, options?: ApiCallOptions): Promise<GetIpPoliciesHttpResponse>;
195
- type GetIpPoliciesHttpResponse = {
196
- data: ListIPPoliciesResult;
197
- headers: Headers;
198
- status: 200;
199
- prev?: (options?: ApiCallOptions) => Promise<GetIpPoliciesHttpResponse>;
200
- next?: (options?: ApiCallOptions) => Promise<GetIpPoliciesHttpResponse>;
201
- };
202
- type GetIpPoliciesHttpError = {
203
- data: Errors;
204
- headers: Headers;
205
- status: 400 | 401 | 429 | 500;
206
- };
207
- /**
208
- * Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
209
- *
210
- * @param body an object with the body content
211
- * @throws CreateIpPolicyHttpError
212
- */
213
- declare function createIpPolicy(body: CreateIPPolicy, options?: ApiCallOptions): Promise<CreateIpPolicyHttpResponse>;
214
- type CreateIpPolicyHttpResponse = {
215
- data: IPPolicyResource;
216
- headers: Headers;
217
- status: 201;
218
- };
219
- type CreateIpPolicyHttpError = {
220
- data: Errors;
221
- headers: Headers;
222
- status: 400 | 404 | 429 | 500;
223
- };
224
- /**
225
- * Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
226
- *
227
- * @param id The unique identifier for the IP policy.
228
- * @throws DeleteIpPolicyHttpError
229
- */
230
- declare function deleteIpPolicy(id: string, options?: ApiCallOptions): Promise<DeleteIpPolicyHttpResponse>;
231
- type DeleteIpPolicyHttpResponse = {
232
- data: void;
233
- headers: Headers;
234
- status: 204;
235
- };
236
- type DeleteIpPolicyHttpError = {
237
- data: Errors;
238
- headers: Headers;
239
- status: 401 | 403 | 404 | 429 | 500;
240
- };
241
- /**
242
- * Retrieves details for a specific IP policy by policy ID.
243
- *
244
- * @param id The IP policy unique identifier
245
- * @throws GetIpPolicyHttpError
246
- */
247
- declare function getIpPolicy(id: string, options?: ApiCallOptions): Promise<GetIpPolicyHttpResponse>;
248
- type GetIpPolicyHttpResponse = {
249
- data: IPPolicyResource;
250
- headers: Headers;
251
- status: 200;
252
- };
253
- type GetIpPolicyHttpError = {
254
- data: Errors;
255
- headers: Headers;
256
- status: 401 | 404 | 429 | 500;
257
- };
258
- /**
259
- * Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
260
- *
261
- * @param id The unique identifier for the IP policy.
262
- * @param body an object with the body content
263
- * @throws PatchIpPolicyHttpError
264
- */
265
- declare function patchIpPolicy(id: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchIpPolicyHttpResponse>;
266
- type PatchIpPolicyHttpResponse = {
267
- data: void;
268
- headers: Headers;
269
- status: 204;
270
- };
271
- type PatchIpPolicyHttpError = {
272
- data: Errors;
273
- headers: Headers;
274
- status: 400 | 401 | 403 | 404 | 429 | 500;
275
- };
276
- /**
277
- * Clears the cache for core/ip-policies api requests.
278
- */
279
- declare function clearCache(): void;
280
- type IpPoliciesAPI = {
281
- /**
282
- * Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
283
- *
284
- * @param query an object with query parameters
285
- * @throws GetIpPoliciesHttpError
286
- */
287
- getIpPolicies: typeof getIpPolicies;
288
- /**
289
- * Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
290
- *
291
- * @param body an object with the body content
292
- * @throws CreateIpPolicyHttpError
293
- */
294
- createIpPolicy: typeof createIpPolicy;
295
- /**
296
- * Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
297
- *
298
- * @param id The unique identifier for the IP policy.
299
- * @throws DeleteIpPolicyHttpError
300
- */
301
- deleteIpPolicy: typeof deleteIpPolicy;
302
- /**
303
- * Retrieves details for a specific IP policy by policy ID.
304
- *
305
- * @param id The IP policy unique identifier
306
- * @throws GetIpPolicyHttpError
307
- */
308
- getIpPolicy: typeof getIpPolicy;
309
- /**
310
- * Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
311
- *
312
- * @param id The unique identifier for the IP policy.
313
- * @param body an object with the body content
314
- * @throws PatchIpPolicyHttpError
315
- */
316
- patchIpPolicy: typeof patchIpPolicy;
317
- /**
318
- * Clears the cache for ip-policies api requests.
319
- */
320
- clearCache: typeof clearCache;
321
- };
322
- /**
323
- * Functions for the ip-policies api
324
- */
325
- declare const ipPoliciesExport: IpPoliciesAPI;
326
- //#endregion
327
- export { createIpPolicy as C, ipPoliciesExport as D, getIpPolicy as E, ip_policies_d_exports as O, clearCache as S, getIpPolicies as T, Link as _, DeleteIpPolicyHttpResponse as a, PatchIpPolicyHttpError as b, GetIpPoliciesHttpError as c, GetIpPolicyHttpResponse as d, IPPolicyListItem as f, JSONPatchArray as g, JSONPatch as h, DeleteIpPolicyHttpError as i, patchIpPolicy as k, GetIpPoliciesHttpResponse as l, IpPoliciesAPI as m, CreateIpPolicyHttpError as n, Error as o, IPPolicyResource as p, CreateIpPolicyHttpResponse as r, Errors as s, CreateIPPolicy as t, GetIpPolicyHttpError as u, Links as v, deleteIpPolicy as w, PatchIpPolicyHttpResponse as x, ListIPPoliciesResult as y };
@@ -1,108 +0,0 @@
1
- import { t as __export } from "./chunk-EtTptKIv.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./invoke-fetch-PcVIxLW4.js";
3
-
4
- //#region src/public/rest/core/ip-policies.ts
5
- var ip_policies_exports = /* @__PURE__ */ __export({
6
- clearCache: () => clearCache,
7
- createIpPolicy: () => createIpPolicy,
8
- default: () => ip_policies_default,
9
- deleteIpPolicy: () => deleteIpPolicy,
10
- getIpPolicies: () => getIpPolicies,
11
- getIpPolicy: () => getIpPolicy,
12
- patchIpPolicy: () => patchIpPolicy
13
- });
14
- /**
15
- * Returns a list of IP policies present in the tenant. The user must be assigned the `TenantAdmin` role.
16
- *
17
- * @param query an object with query parameters
18
- * @throws GetIpPoliciesHttpError
19
- */
20
- async function getIpPolicies(query, options) {
21
- return invokeFetch("core/ip-policies", {
22
- method: "get",
23
- pathTemplate: "/api/core/ip-policies",
24
- query,
25
- options
26
- });
27
- }
28
- /**
29
- * Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role. IPv6 IP addresses are not currently supported.
30
- *
31
- * @param body an object with the body content
32
- * @throws CreateIpPolicyHttpError
33
- */
34
- async function createIpPolicy(body, options) {
35
- return invokeFetch("core/ip-policies", {
36
- method: "post",
37
- pathTemplate: "/api/core/ip-policies",
38
- body,
39
- contentType: "application/json",
40
- options
41
- });
42
- }
43
- /**
44
- * Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
45
- *
46
- * @param id The unique identifier for the IP policy.
47
- * @throws DeleteIpPolicyHttpError
48
- */
49
- async function deleteIpPolicy(id, options) {
50
- return invokeFetch("core/ip-policies", {
51
- method: "delete",
52
- pathTemplate: "/api/core/ip-policies/{id}",
53
- pathVariables: { id },
54
- options
55
- });
56
- }
57
- /**
58
- * Retrieves details for a specific IP policy by policy ID.
59
- *
60
- * @param id The IP policy unique identifier
61
- * @throws GetIpPolicyHttpError
62
- */
63
- async function getIpPolicy(id, options) {
64
- return invokeFetch("core/ip-policies", {
65
- method: "get",
66
- pathTemplate: "/api/core/ip-policies/{id}",
67
- pathVariables: { id },
68
- options
69
- });
70
- }
71
- /**
72
- * Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the `TenantAdmin` role.
73
- *
74
- * @param id The unique identifier for the IP policy.
75
- * @param body an object with the body content
76
- * @throws PatchIpPolicyHttpError
77
- */
78
- async function patchIpPolicy(id, body, options) {
79
- return invokeFetch("core/ip-policies", {
80
- method: "patch",
81
- pathTemplate: "/api/core/ip-policies/{id}",
82
- pathVariables: { id },
83
- body,
84
- contentType: "application/json",
85
- options
86
- });
87
- }
88
- /**
89
- * Clears the cache for core/ip-policies api requests.
90
- */
91
- function clearCache() {
92
- return clearApiCache("core/ip-policies");
93
- }
94
- /**
95
- * Functions for the ip-policies api
96
- */
97
- const ipPoliciesExport = {
98
- getIpPolicies,
99
- createIpPolicy,
100
- deleteIpPolicy,
101
- getIpPolicy,
102
- patchIpPolicy,
103
- clearCache
104
- };
105
- var ip_policies_default = ipPoliciesExport;
106
-
107
- //#endregion
108
- export { getIpPolicy as a, patchIpPolicy as c, getIpPolicies as i, createIpPolicy as n, ip_policies_default as o, deleteIpPolicy as r, ip_policies_exports as s, clearCache as t };