@qlik/api 0.0.16 → 0.1.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 (132) hide show
  1. package/README.md +1 -1
  2. package/api-keys.js +25 -25
  3. package/apps.js +97 -97
  4. package/audits.js +23 -23
  5. package/auth.js +14 -14
  6. package/automations.js +47 -47
  7. package/brands.js +35 -35
  8. package/chunks/4HB3TAEO.js +4 -4
  9. package/chunks/{EHAANYDL.mjs → 4V5AAWUI.js} +3 -3
  10. package/chunks/{O4EAKEIN.mjs → D62LI5YU.js} +1 -1
  11. package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
  12. package/chunks/{3YV6X7S6.mjs → LHCJKIEO.js} +1 -1
  13. package/chunks/OPRGGO4C.js +8 -8
  14. package/chunks/{HHOVS7QC.mjs → RNLZBOJU.js} +3 -3
  15. package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
  16. package/chunks/{6AD3HYSF.mjs → TFSRDRRS.js} +1 -1
  17. package/chunks/{HOCTJESP.mjs → VK2CODYY.js} +2 -2
  18. package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
  19. package/collections.js +33 -33
  20. package/csp-origins.js +23 -23
  21. package/data-assets.js +21 -21
  22. package/data-connections.js +29 -29
  23. package/data-credentials.js +19 -19
  24. package/data-files.js +35 -35
  25. package/docs/authentication.md +5 -5
  26. package/docs/examples/fetch-spaces.md +1 -15
  27. package/docs/examples/show-sheet-list.md +1 -1
  28. package/docs/features.md +1 -1
  29. package/extensions.js +25 -25
  30. package/glossaries.js +59 -59
  31. package/groups.d.ts +0 -3
  32. package/groups.js +27 -27
  33. package/identity-providers.js +27 -27
  34. package/index.js +53 -53
  35. package/items.js +27 -27
  36. package/licenses.js +29 -29
  37. package/package.json +36 -232
  38. package/qix.d.ts +1 -1
  39. package/qix.js +10 -10
  40. package/quotas.js +15 -15
  41. package/reload-tasks.js +21 -21
  42. package/reloads.js +19 -19
  43. package/roles.js +15 -15
  44. package/spaces.js +35 -35
  45. package/temp-contents.js +17 -17
  46. package/tenants.js +23 -23
  47. package/themes.js +25 -25
  48. package/transports.js +23 -23
  49. package/users.d.ts +1 -3
  50. package/users.js +31 -31
  51. package/web-integrations.js +21 -21
  52. package/web-notifications.js +23 -23
  53. package/webhooks.js +31 -31
  54. package/api-keys.d.mts +0 -336
  55. package/api-keys.mjs +0 -80
  56. package/apps.d.mts +0 -2431
  57. package/apps.mjs +0 -398
  58. package/audits.d.mts +0 -286
  59. package/audits.mjs +0 -64
  60. package/auth-types-nnUcWhuU.d.mts +0 -98
  61. package/auth.d.mts +0 -26
  62. package/auth.mjs +0 -14
  63. package/automations.d.mts +0 -682
  64. package/automations.mjs +0 -173
  65. package/brands.d.mts +0 -670
  66. package/brands.mjs +0 -123
  67. package/chunks/2YWCEGTS.js +0 -21
  68. package/chunks/34ZKUFEA.js +0 -41
  69. package/chunks/4WHZ4EIW.js +0 -57
  70. package/chunks/B4VPD3ZT.js +0 -574
  71. package/chunks/BM4OSDRZ.js +0 -17
  72. package/chunks/DCXUEDOW.mjs +0 -67
  73. package/chunks/MTAQE4WC.js +0 -10411
  74. package/chunks/PLOSYUG2.js +0 -25
  75. package/chunks/URIW2U5M.js +0 -17
  76. package/chunks/VSY5YIQY.mjs +0 -11
  77. package/chunks/WOYJLK4Y.js +0 -1623
  78. package/collections.d.mts +0 -581
  79. package/collections.mjs +0 -114
  80. package/csp-origins.d.mts +0 -273
  81. package/csp-origins.mjs +0 -69
  82. package/data-assets.d.mts +0 -205
  83. package/data-assets.mjs +0 -66
  84. package/data-connections.d.mts +0 -594
  85. package/data-connections.mjs +0 -103
  86. package/data-credentials.d.mts +0 -204
  87. package/data-credentials.mjs +0 -59
  88. package/data-files.d.mts +0 -562
  89. package/data-files.mjs +0 -123
  90. package/extensions.d.mts +0 -293
  91. package/extensions.mjs +0 -77
  92. package/global.types-5iFvFJvX.d.mts +0 -115
  93. package/glossaries.d.mts +0 -1173
  94. package/glossaries.mjs +0 -237
  95. package/groups.d.mts +0 -434
  96. package/groups.mjs +0 -88
  97. package/identity-providers.d.mts +0 -550
  98. package/identity-providers.mjs +0 -83
  99. package/index.d.mts +0 -142
  100. package/index.mjs +0 -716
  101. package/items.d.mts +0 -535
  102. package/items.mjs +0 -87
  103. package/licenses.d.mts +0 -459
  104. package/licenses.mjs +0 -92
  105. package/qix.d.mts +0 -11629
  106. package/qix.mjs +0 -10
  107. package/quotas.d.mts +0 -112
  108. package/quotas.mjs +0 -32
  109. package/reload-tasks.d.mts +0 -227
  110. package/reload-tasks.mjs +0 -62
  111. package/reloads.d.mts +0 -207
  112. package/reloads.mjs +0 -46
  113. package/roles.d.mts +0 -175
  114. package/roles.mjs +0 -31
  115. package/spaces.d.mts +0 -562
  116. package/spaces.mjs +0 -124
  117. package/temp-contents.d.mts +0 -167
  118. package/temp-contents.mjs +0 -41
  119. package/tenants.d.mts +0 -300
  120. package/tenants.mjs +0 -73
  121. package/themes.d.mts +0 -268
  122. package/themes.mjs +0 -77
  123. package/transports.d.mts +0 -319
  124. package/transports.mjs +0 -65
  125. package/users.d.mts +0 -631
  126. package/users.mjs +0 -104
  127. package/web-integrations.d.mts +0 -274
  128. package/web-integrations.mjs +0 -62
  129. package/web-notifications.d.mts +0 -250
  130. package/web-notifications.mjs +0 -69
  131. package/webhooks.d.mts +0 -445
  132. package/webhooks.mjs +0 -104
@@ -1,37 +1,37 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
-
4
- var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
5
- require('./chunks/2YWCEGTS.js');
6
- require('./chunks/4HB3TAEO.js');
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/LHCJKIEO.js";
5
+ import "./chunks/4V5AAWUI.js";
6
+ import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/web-integrations.ts
9
- var getWebIntegrations = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-integrations", {
9
+ var getWebIntegrations = async (query, options) => invokeFetch("web-integrations", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/web-integrations",
12
12
  query,
13
13
  options
14
14
  });
15
- var createWebIntegration = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-integrations", {
15
+ var createWebIntegration = async (body, options) => invokeFetch("web-integrations", {
16
16
  method: "post",
17
17
  pathTemplate: "/api/v1/web-integrations",
18
18
  body,
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var deleteWebIntegration = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-integrations", {
22
+ var deleteWebIntegration = async (id, options) => invokeFetch("web-integrations", {
23
23
  method: "delete",
24
24
  pathTemplate: "/api/v1/web-integrations/{id}",
25
25
  pathVariables: { id },
26
26
  options
27
27
  });
28
- var getWebIntegration = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-integrations", {
28
+ var getWebIntegration = async (id, options) => invokeFetch("web-integrations", {
29
29
  method: "get",
30
30
  pathTemplate: "/api/v1/web-integrations/{id}",
31
31
  pathVariables: { id },
32
32
  options
33
33
  });
34
- var patchWebIntegration = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-integrations", {
34
+ var patchWebIntegration = async (id, body, options) => invokeFetch("web-integrations", {
35
35
  method: "patch",
36
36
  pathTemplate: "/api/v1/web-integrations/{id}",
37
37
  pathVariables: { id },
@@ -40,7 +40,7 @@ var patchWebIntegration = async (id, body, options) => _URIW2U5Mjs.invokeFetch.c
40
40
  options
41
41
  });
42
42
  function clearCache() {
43
- return _URIW2U5Mjs.clearApiCache.call(void 0, "web-integrations");
43
+ return clearApiCache("web-integrations");
44
44
  }
45
45
  var webIntegrationsExport = {
46
46
  getWebIntegrations,
@@ -51,12 +51,12 @@ var webIntegrationsExport = {
51
51
  clearCache
52
52
  };
53
53
  var web_integrations_default = webIntegrationsExport;
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
- exports.clearCache = clearCache; exports.createWebIntegration = createWebIntegration; exports.default = web_integrations_default; exports.deleteWebIntegration = deleteWebIntegration; exports.getWebIntegration = getWebIntegration; exports.getWebIntegrations = getWebIntegrations; exports.patchWebIntegration = patchWebIntegration;
54
+ export {
55
+ clearCache,
56
+ createWebIntegration,
57
+ web_integrations_default as default,
58
+ deleteWebIntegration,
59
+ getWebIntegration,
60
+ getWebIntegrations,
61
+ patchWebIntegration
62
+ };
@@ -1,42 +1,42 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
-
4
- var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
5
- require('./chunks/2YWCEGTS.js');
6
- require('./chunks/4HB3TAEO.js');
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/LHCJKIEO.js";
5
+ import "./chunks/4V5AAWUI.js";
6
+ import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/web-notifications.ts
9
- var getNotifications = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
9
+ var getNotifications = async (query, options) => invokeFetch("web-notifications", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/web-notifications",
12
12
  query,
13
13
  options
14
14
  });
15
- var deleteNotifications = async (options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
15
+ var deleteNotifications = async (options) => invokeFetch("web-notifications", {
16
16
  method: "delete",
17
17
  pathTemplate: "/api/v1/web-notifications/all",
18
18
  options
19
19
  });
20
- var patchNotifications = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
20
+ var patchNotifications = async (body, options) => invokeFetch("web-notifications", {
21
21
  method: "patch",
22
22
  pathTemplate: "/api/v1/web-notifications/all",
23
23
  body,
24
24
  contentType: "application/json",
25
25
  options
26
26
  });
27
- var deleteNotification = async (notificationId, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
27
+ var deleteNotification = async (notificationId, options) => invokeFetch("web-notifications", {
28
28
  method: "delete",
29
29
  pathTemplate: "/api/v1/web-notifications/{notificationId}",
30
30
  pathVariables: { notificationId },
31
31
  options
32
32
  });
33
- var getNotification = async (notificationId, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
33
+ var getNotification = async (notificationId, options) => invokeFetch("web-notifications", {
34
34
  method: "get",
35
35
  pathTemplate: "/api/v1/web-notifications/{notificationId}",
36
36
  pathVariables: { notificationId },
37
37
  options
38
38
  });
39
- var patchNotification = async (notificationId, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "web-notifications", {
39
+ var patchNotification = async (notificationId, body, options) => invokeFetch("web-notifications", {
40
40
  method: "patch",
41
41
  pathTemplate: "/api/v1/web-notifications/{notificationId}",
42
42
  pathVariables: { notificationId },
@@ -45,7 +45,7 @@ var patchNotification = async (notificationId, body, options) => _URIW2U5Mjs.inv
45
45
  options
46
46
  });
47
47
  function clearCache() {
48
- return _URIW2U5Mjs.clearApiCache.call(void 0, "web-notifications");
48
+ return clearApiCache("web-notifications");
49
49
  }
50
50
  var webNotificationsExport = {
51
51
  getNotifications,
@@ -57,13 +57,13 @@ var webNotificationsExport = {
57
57
  clearCache
58
58
  };
59
59
  var web_notifications_default = webNotificationsExport;
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
- exports.clearCache = clearCache; exports.default = web_notifications_default; exports.deleteNotification = deleteNotification; exports.deleteNotifications = deleteNotifications; exports.getNotification = getNotification; exports.getNotifications = getNotifications; exports.patchNotification = patchNotification; exports.patchNotifications = patchNotifications;
60
+ export {
61
+ clearCache,
62
+ web_notifications_default as default,
63
+ deleteNotification,
64
+ deleteNotifications,
65
+ getNotification,
66
+ getNotifications,
67
+ patchNotification,
68
+ patchNotifications
69
+ };
package/webhooks.js CHANGED
@@ -1,42 +1,42 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
-
4
- var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
5
- require('./chunks/2YWCEGTS.js');
6
- require('./chunks/4HB3TAEO.js');
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/LHCJKIEO.js";
5
+ import "./chunks/4V5AAWUI.js";
6
+ import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/webhooks.ts
9
- var getWebhooks = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
9
+ var getWebhooks = async (query, options) => invokeFetch("webhooks", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/webhooks",
12
12
  query,
13
13
  options
14
14
  });
15
- var createWebhook = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
15
+ var createWebhook = async (body, options) => invokeFetch("webhooks", {
16
16
  method: "post",
17
17
  pathTemplate: "/api/v1/webhooks",
18
18
  body,
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var getWebhookEventTypes = async (options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
22
+ var getWebhookEventTypes = async (options) => invokeFetch("webhooks", {
23
23
  method: "get",
24
24
  pathTemplate: "/api/v1/webhooks/event-types",
25
25
  options
26
26
  });
27
- var deleteWebhook = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
27
+ var deleteWebhook = async (id, options) => invokeFetch("webhooks", {
28
28
  method: "delete",
29
29
  pathTemplate: "/api/v1/webhooks/{id}",
30
30
  pathVariables: { id },
31
31
  options
32
32
  });
33
- var getWebhook = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
33
+ var getWebhook = async (id, options) => invokeFetch("webhooks", {
34
34
  method: "get",
35
35
  pathTemplate: "/api/v1/webhooks/{id}",
36
36
  pathVariables: { id },
37
37
  options
38
38
  });
39
- var patchWebhook = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
39
+ var patchWebhook = async (id, body, options) => invokeFetch("webhooks", {
40
40
  method: "patch",
41
41
  pathTemplate: "/api/v1/webhooks/{id}",
42
42
  pathVariables: { id },
@@ -44,7 +44,7 @@ var patchWebhook = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(voi
44
44
  contentType: "application/json",
45
45
  options
46
46
  });
47
- var updateWebhook = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
47
+ var updateWebhook = async (id, body, options) => invokeFetch("webhooks", {
48
48
  method: "put",
49
49
  pathTemplate: "/api/v1/webhooks/{id}",
50
50
  pathVariables: { id },
@@ -52,27 +52,27 @@ var updateWebhook = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(vo
52
52
  contentType: "application/json",
53
53
  options
54
54
  });
55
- var getWebhookDeliveries = async (id, query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
55
+ var getWebhookDeliveries = async (id, query, options) => invokeFetch("webhooks", {
56
56
  method: "get",
57
57
  pathTemplate: "/api/v1/webhooks/{id}/deliveries",
58
58
  pathVariables: { id },
59
59
  query,
60
60
  options
61
61
  });
62
- var getWebhookDelivery = async (id, deliveryId, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
62
+ var getWebhookDelivery = async (id, deliveryId, options) => invokeFetch("webhooks", {
63
63
  method: "get",
64
64
  pathTemplate: "/api/v1/webhooks/{id}/deliveries/{deliveryId}",
65
65
  pathVariables: { id, deliveryId },
66
66
  options
67
67
  });
68
- var resendWebhookDelivery = async (id, deliveryId, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "webhooks", {
68
+ var resendWebhookDelivery = async (id, deliveryId, options) => invokeFetch("webhooks", {
69
69
  method: "post",
70
70
  pathTemplate: "/api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend",
71
71
  pathVariables: { id, deliveryId },
72
72
  options
73
73
  });
74
74
  function clearCache() {
75
- return _URIW2U5Mjs.clearApiCache.call(void 0, "webhooks");
75
+ return clearApiCache("webhooks");
76
76
  }
77
77
  var webhooksExport = {
78
78
  getWebhooks,
@@ -88,17 +88,17 @@ var webhooksExport = {
88
88
  clearCache
89
89
  };
90
90
  var webhooks_default = webhooksExport;
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
- exports.clearCache = clearCache; exports.createWebhook = createWebhook; exports.default = webhooks_default; exports.deleteWebhook = deleteWebhook; exports.getWebhook = getWebhook; exports.getWebhookDeliveries = getWebhookDeliveries; exports.getWebhookDelivery = getWebhookDelivery; exports.getWebhookEventTypes = getWebhookEventTypes; exports.getWebhooks = getWebhooks; exports.patchWebhook = patchWebhook; exports.resendWebhookDelivery = resendWebhookDelivery; exports.updateWebhook = updateWebhook;
91
+ export {
92
+ clearCache,
93
+ createWebhook,
94
+ webhooks_default as default,
95
+ deleteWebhook,
96
+ getWebhook,
97
+ getWebhookDeliveries,
98
+ getWebhookDelivery,
99
+ getWebhookEventTypes,
100
+ getWebhooks,
101
+ patchWebhook,
102
+ resendWebhookDelivery,
103
+ updateWebhook
104
+ };
package/api-keys.d.mts DELETED
@@ -1,336 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- type ApiKey = {
5
- /** When the API key was created. */
6
- readonly created?: string;
7
- /** The ID of the user who created the key. */
8
- createdByUser: string;
9
- /** A description for the API key. */
10
- description: string;
11
- /** When the API key will expire and no longer be a valid authentication token. */
12
- expiry: string;
13
- /** The unique ID for the resource. */
14
- id: string;
15
- /** When the API key was last updated. */
16
- readonly lastUpdated?: string;
17
- /** The status of the API key. */
18
- status: "active" | "expired" | "revoked";
19
- /** The ID of the subject for the API key. */
20
- sub: string;
21
- /** Type of the subject. */
22
- subType: "user";
23
- /** The tenant ID. */
24
- tenantId: string;
25
- };
26
- type ApiKeyBody = {
27
- /** Text that describes the API key. */
28
- description: string;
29
- /** The expiry of the API key, in ISO8601 duration format. */
30
- expiry?: string;
31
- /** The ID of the subject for the API key. */
32
- sub?: string;
33
- /** Type of the subject. */
34
- subType?: string;
35
- };
36
- /**
37
- * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
38
- */
39
- type ApiKeyConfigPatch = {
40
- /** The operation to be performed. */
41
- op: "replace";
42
- /** The path for the given resource field to patch. */
43
- path: "/api_keys_enabled" | "/max_api_key_expiry" | "/max_keys_per_user";
44
- /** The value to be used for this operation. */
45
- value: unknown;
46
- };
47
- /**
48
- * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
49
- */
50
- type ApiKeyPatch = {
51
- /** The operation to be performed. */
52
- op: "replace";
53
- /** The path for the given resource field to patch. */
54
- path: "/description";
55
- /** The value to be used for this operation. */
56
- value: string;
57
- };
58
- type ApiKeyWithToken = {
59
- /** When the API key was created. */
60
- readonly created?: string;
61
- /** The id of the user who created the key. */
62
- createdByUser: string;
63
- /** A description for the API key. */
64
- description: string;
65
- /** When the API key will expire and no longer be a valid authentication token. */
66
- expiry: string;
67
- /** The unique ID for the resource. */
68
- id: string;
69
- /** When the API key was last updated. */
70
- readonly lastUpdated?: string;
71
- /** The status of the API key. */
72
- status: "active" | "expired" | "revoked";
73
- /** The ID of the subject for the API key. */
74
- sub: string;
75
- /** Type of the subject. */
76
- subType: "user";
77
- /** The tenant ID. */
78
- tenantId: string;
79
- /** The generated signed JWT. */
80
- token: string;
81
- };
82
- type ApiKeysConfig = {
83
- /** Enables or disables API key functionality for the specified tenant. */
84
- api_keys_enabled?: boolean;
85
- /** The maximum lifetime, in ISO8601 duration format, for which an API key can be issued for the specified tenant. */
86
- max_api_key_expiry?: string;
87
- /** The maximum number of active API keys that any user can create for the specified tenant. */
88
- max_keys_per_user?: number;
89
- };
90
- type ApiKeysConfigPatchSchema = ApiKeyConfigPatch[];
91
- type ApiKeysPatchSchema = ApiKeyPatch[];
92
- /**
93
- * An error object.
94
- */
95
- type Error = {
96
- /** The error code. */
97
- code: string;
98
- /** A human-readable explanation specific to this occurrence of the problem. */
99
- detail?: string;
100
- /** Additional properties relating to the error. */
101
- meta?: unknown;
102
- /** References to the source of the error. */
103
- source?: {
104
- /** The URI query parameter that caused the error. */
105
- parameter?: string;
106
- /** A JSON Pointer to the property that caused the error. */
107
- pointer?: string;
108
- };
109
- /** The HTTP status code. */
110
- status?: number;
111
- /** Summary of the problem. */
112
- title: string;
113
- };
114
- type Errors = {
115
- /** List of errors and their properties. */
116
- errors?: Error[];
117
- };
118
- type Link = {
119
- /** The URL for the link. */
120
- href: string;
121
- };
122
- type ApiKeyPage = {
123
- /** Properties of API keys in a given tenant. */
124
- data: ApiKey[];
125
- /** Navigation links to page results. */
126
- links: {
127
- next?: Link;
128
- prev?: Link;
129
- self: Link;
130
- };
131
- };
132
- /**
133
- * Lists API keys for a given tenant ID.
134
- *
135
- * @param query an object with query parameters
136
- * @throws GetApiKeysHttpError
137
- */
138
- declare const getApiKeys: (query: {
139
- /** The user ID that created the API key. */
140
- createdByUser?: string;
141
- /** Get resources with IDs that are lower than the target resource ID. Cannot be used in conjunction with startingAfter. */
142
- endingBefore?: string;
143
- /** Maximum number of API keys to retrieve. */
144
- limit?: number;
145
- /** The field to sort by, with +/- prefix indicating sort order */
146
- sort?: "createdByUser" | "+createdByUser" | "-createdByUser" | "sub" | "+sub" | "-sub" | "status" | "+status" | "-status" | "description" | "+description" | "-description" | "created" | "+created" | "-created";
147
- /** Get resources with IDs that are higher than the target resource ID. Cannot be used in conjunction with endingBefore. */
148
- startingAfter?: string;
149
- /** The status of the API key. */
150
- status?: "active" | "expired" | "revoked";
151
- /** The ID of the subject. */
152
- sub?: string;
153
- }, options?: ApiCallOptions) => Promise<GetApiKeysHttpResponse>;
154
- type GetApiKeysHttpResponse = {
155
- data: ApiKeyPage;
156
- headers: Headers;
157
- status: number;
158
- prev?: (options?: ApiCallOptions) => Promise<GetApiKeysHttpResponse>;
159
- next?: (options?: ApiCallOptions) => Promise<GetApiKeysHttpResponse>;
160
- };
161
- type GetApiKeysHttpError = {
162
- data: Errors;
163
- headers: Headers;
164
- status: number;
165
- };
166
- /**
167
- * Creates an API key resource.
168
- *
169
- * @param body an object with the body content
170
- * @throws CreateApiKeyHttpError
171
- */
172
- declare const createApiKey: (body: ApiKeyBody, options?: ApiCallOptions) => Promise<CreateApiKeyHttpResponse>;
173
- type CreateApiKeyHttpResponse = {
174
- data: ApiKeyWithToken;
175
- headers: Headers;
176
- status: number;
177
- };
178
- type CreateApiKeyHttpError = {
179
- data: Errors;
180
- headers: Headers;
181
- status: number;
182
- };
183
- /**
184
- * Gets the API keys configuration for a given tenant ID.
185
- *
186
- * @param tenantId The tenant ID of the API keys configuration to be retrieved.
187
- * @throws GetApiKeysConfigHttpError
188
- */
189
- declare const getApiKeysConfig: (tenantId: string, options?: ApiCallOptions) => Promise<GetApiKeysConfigHttpResponse>;
190
- type GetApiKeysConfigHttpResponse = {
191
- data: ApiKeysConfig;
192
- headers: Headers;
193
- status: number;
194
- };
195
- type GetApiKeysConfigHttpError = {
196
- data: Errors;
197
- headers: Headers;
198
- status: number;
199
- };
200
- /**
201
- * Updates the API keys configuration for a given tenant ID.
202
- *
203
- * @param tenantId The tenant ID of the API keys configuration to be retrieved.
204
- * @param body an object with the body content
205
- * @throws PatchApiKeysConfigHttpError
206
- */
207
- declare const patchApiKeysConfig: (tenantId: string, body: ApiKeysConfigPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeysConfigHttpResponse>;
208
- type PatchApiKeysConfigHttpResponse = {
209
- data: void;
210
- headers: Headers;
211
- status: number;
212
- };
213
- type PatchApiKeysConfigHttpError = {
214
- data: Errors;
215
- headers: Headers;
216
- status: number;
217
- };
218
- /**
219
- * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
220
- *
221
- * @param id The ID of the API key resource to be retrieved.
222
- * @throws DeleteApiKeyHttpError
223
- */
224
- declare const deleteApiKey: (id: string, options?: ApiCallOptions) => Promise<DeleteApiKeyHttpResponse>;
225
- type DeleteApiKeyHttpResponse = {
226
- data: void;
227
- headers: Headers;
228
- status: number;
229
- };
230
- type DeleteApiKeyHttpError = {
231
- data: Errors;
232
- headers: Headers;
233
- status: number;
234
- };
235
- /**
236
- * Gets the API key for a given ID.
237
- *
238
- * @param id The ID of the API key resource to be retrieved.
239
- * @throws GetApiKeyHttpError
240
- */
241
- declare const getApiKey: (id: string, options?: ApiCallOptions) => Promise<GetApiKeyHttpResponse>;
242
- type GetApiKeyHttpResponse = {
243
- data: ApiKey;
244
- headers: Headers;
245
- status: number;
246
- };
247
- type GetApiKeyHttpError = {
248
- data: Errors;
249
- headers: Headers;
250
- status: number;
251
- };
252
- /**
253
- * Updates an API key for a given ID.
254
- *
255
- * @param id The ID of the API key resource to be updated.
256
- * @param body an object with the body content
257
- * @throws PatchApiKeyHttpError
258
- */
259
- declare const patchApiKey: (id: string, body: ApiKeysPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeyHttpResponse>;
260
- type PatchApiKeyHttpResponse = {
261
- data: void;
262
- headers: Headers;
263
- status: number;
264
- };
265
- type PatchApiKeyHttpError = {
266
- data: Errors;
267
- headers: Headers;
268
- status: number;
269
- };
270
- /**
271
- * Clears the cache for api-keys api requests.
272
- */
273
- declare function clearCache(): void;
274
- interface ApiKeysAPI {
275
- /**
276
- * Lists API keys for a given tenant ID.
277
- *
278
- * @param query an object with query parameters
279
- * @throws GetApiKeysHttpError
280
- */
281
- getApiKeys: typeof getApiKeys;
282
- /**
283
- * Creates an API key resource.
284
- *
285
- * @param body an object with the body content
286
- * @throws CreateApiKeyHttpError
287
- */
288
- createApiKey: typeof createApiKey;
289
- /**
290
- * Gets the API keys configuration for a given tenant ID.
291
- *
292
- * @param tenantId The tenant ID of the API keys configuration to be retrieved.
293
- * @throws GetApiKeysConfigHttpError
294
- */
295
- getApiKeysConfig: typeof getApiKeysConfig;
296
- /**
297
- * Updates the API keys configuration for a given tenant ID.
298
- *
299
- * @param tenantId The tenant ID of the API keys configuration to be retrieved.
300
- * @param body an object with the body content
301
- * @throws PatchApiKeysConfigHttpError
302
- */
303
- patchApiKeysConfig: typeof patchApiKeysConfig;
304
- /**
305
- * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
306
- *
307
- * @param id The ID of the API key resource to be retrieved.
308
- * @throws DeleteApiKeyHttpError
309
- */
310
- deleteApiKey: typeof deleteApiKey;
311
- /**
312
- * Gets the API key for a given ID.
313
- *
314
- * @param id The ID of the API key resource to be retrieved.
315
- * @throws GetApiKeyHttpError
316
- */
317
- getApiKey: typeof getApiKey;
318
- /**
319
- * Updates an API key for a given ID.
320
- *
321
- * @param id The ID of the API key resource to be updated.
322
- * @param body an object with the body content
323
- * @throws PatchApiKeyHttpError
324
- */
325
- patchApiKey: typeof patchApiKey;
326
- /**
327
- * Clears the cache for api-keys api requests.
328
- */
329
- clearCache: typeof clearCache;
330
- }
331
- /**
332
- * Functions for the api-keys api
333
- */
334
- declare const apiKeysExport: ApiKeysAPI;
335
-
336
- export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysConfigHttpError, type GetApiKeysConfigHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, type PatchApiKeysConfigHttpError, type PatchApiKeysConfigHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeys, getApiKeysConfig, patchApiKey, patchApiKeysConfig };