@qlik/api 0.0.8 → 0.0.10

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 (157) hide show
  1. package/api-keys.d.mts +10 -1
  2. package/api-keys.d.ts +10 -1
  3. package/api-keys.js +11 -11
  4. package/api-keys.mjs +3 -3
  5. package/apps.d.mts +134 -8
  6. package/apps.d.ts +134 -8
  7. package/apps.js +47 -47
  8. package/apps.mjs +3 -3
  9. package/audits.d.mts +14 -1
  10. package/audits.d.ts +14 -1
  11. package/audits.js +10 -10
  12. package/audits.mjs +3 -3
  13. package/auth.js +4 -4
  14. package/auth.mjs +3 -3
  15. package/automations.d.mts +9 -1
  16. package/automations.d.ts +9 -1
  17. package/automations.js +22 -22
  18. package/automations.mjs +3 -3
  19. package/brands.d.mts +19 -4
  20. package/brands.d.ts +19 -4
  21. package/brands.js +16 -16
  22. package/brands.mjs +3 -3
  23. package/{enigma-session-VSFGLOYW.mjs → chunks/34FMVD4C.mjs} +165 -21
  24. package/{chunk-QTCDGPKS.js → chunks/37PLWNAN.js} +82 -60
  25. package/{chunk-GY2TAYQH.js → chunks/3MHXEHLQ.js} +2 -2
  26. package/{invoke-fetch-X42FV2FS.mjs → chunks/42LZKDDD.mjs} +2 -2
  27. package/{enigma-session-VTHT4O6N.js → chunks/AVQ3WHH7.js} +168 -24
  28. package/{chunk-BRDPNGQ7.js → chunks/FG5GDUSZ.js} +3 -3
  29. package/{chunk-4R2XCEVK.mjs → chunks/FUU5VIC4.mjs} +1 -1
  30. package/{esm-HMY2LVVZ.mjs → chunks/H32EGPZN.mjs} +1 -1
  31. package/{qix-57OF6A7B.mjs → chunks/HFNJ3ERI.mjs} +3 -3
  32. package/{chunk-4MWB2T3C.mjs → chunks/HWZC3PIL.mjs} +1 -1
  33. package/{chunk-RYBRKLOY.js → chunks/ILOY5QEA.js} +4 -4
  34. package/{chunk-YILVC32M.mjs → chunks/KEPPVUY3.mjs} +1 -1
  35. package/{auth-U6QTT3H4.mjs → chunks/MMUU2CQM.mjs} +2 -2
  36. package/{chunk-LLLEO6K6.mjs → chunks/O5POHH2Q.mjs} +3 -3
  37. package/{chunk-EALMXU6S.js → chunks/QMWU5E4D.js} +3 -3
  38. package/chunks/RMNAO4DP.js +17 -0
  39. package/chunks/SUYUL6MB.js +41 -0
  40. package/{chunk-F24SLAYP.mjs → chunks/VMS4MOCI.mjs} +79 -57
  41. package/{qix-QWSMFPQY.js → chunks/WCJ4JQHA.js} +9 -9
  42. package/{esm-PXQUPJYJ.js → chunks/WM2VCN4G.js} +1 -1
  43. package/collections.d.mts +34 -22
  44. package/collections.d.ts +34 -22
  45. package/collections.js +15 -15
  46. package/collections.mjs +3 -3
  47. package/csp-origins.d.mts +1 -1
  48. package/csp-origins.d.ts +1 -1
  49. package/csp-origins.js +10 -10
  50. package/csp-origins.mjs +3 -3
  51. package/data-assets.d.mts +1 -1
  52. package/data-assets.d.ts +1 -1
  53. package/data-assets.js +9 -9
  54. package/data-assets.mjs +3 -3
  55. package/data-connections.d.mts +13 -2
  56. package/data-connections.d.ts +13 -2
  57. package/data-connections.js +13 -13
  58. package/data-connections.mjs +3 -3
  59. package/data-credentials.d.mts +6 -1
  60. package/data-credentials.d.ts +6 -1
  61. package/data-credentials.js +8 -8
  62. package/data-credentials.mjs +3 -3
  63. package/data-files.d.mts +7 -1
  64. package/data-files.d.ts +7 -1
  65. package/data-files.js +16 -16
  66. package/data-files.mjs +3 -3
  67. package/extensions.d.mts +13 -1
  68. package/extensions.d.ts +13 -1
  69. package/extensions.js +11 -11
  70. package/extensions.mjs +3 -3
  71. package/{global.types-4jzAvW7R.d.mts → global.types-5iFvFJvX.d.mts} +5 -1
  72. package/{global.types-1rNhDH7j.d.ts → global.types-TzVhFPid.d.ts} +5 -1
  73. package/glossaries.d.mts +51 -1
  74. package/glossaries.d.ts +51 -1
  75. package/glossaries.js +28 -28
  76. package/glossaries.mjs +3 -3
  77. package/groups.d.mts +40 -1
  78. package/groups.d.ts +40 -1
  79. package/groups.js +12 -12
  80. package/groups.mjs +3 -3
  81. package/identity-providers.d.mts +43 -1
  82. package/identity-providers.d.ts +43 -1
  83. package/identity-providers.js +12 -12
  84. package/identity-providers.mjs +3 -3
  85. package/index.d.mts +1 -1
  86. package/index.d.ts +1 -1
  87. package/index.js +9 -9
  88. package/index.mjs +5 -5
  89. package/items.d.mts +33 -2
  90. package/items.d.ts +33 -2
  91. package/items.js +12 -12
  92. package/items.mjs +3 -3
  93. package/licenses.d.mts +8 -5
  94. package/licenses.d.ts +8 -5
  95. package/licenses.js +13 -13
  96. package/licenses.mjs +3 -3
  97. package/package.json +4 -1
  98. package/qix.d.mts +20 -2
  99. package/qix.d.ts +20 -2
  100. package/qix.js +4 -4
  101. package/qix.mjs +3 -3
  102. package/quotas.d.mts +4 -1
  103. package/quotas.d.ts +4 -1
  104. package/quotas.js +6 -6
  105. package/quotas.mjs +3 -3
  106. package/reload-tasks.d.mts +7 -4
  107. package/reload-tasks.d.ts +7 -4
  108. package/reload-tasks.js +9 -9
  109. package/reload-tasks.mjs +3 -3
  110. package/reloads.d.mts +10 -1
  111. package/reloads.d.ts +10 -1
  112. package/reloads.js +8 -8
  113. package/reloads.mjs +3 -3
  114. package/roles.d.mts +11 -2
  115. package/roles.d.ts +11 -2
  116. package/roles.js +6 -6
  117. package/roles.mjs +3 -3
  118. package/spaces.d.mts +38 -6
  119. package/spaces.d.ts +38 -6
  120. package/spaces.js +16 -16
  121. package/spaces.mjs +3 -3
  122. package/temp-contents.d.mts +7 -1
  123. package/temp-contents.d.ts +7 -1
  124. package/temp-contents.js +7 -7
  125. package/temp-contents.mjs +3 -3
  126. package/tenants.d.mts +18 -6
  127. package/tenants.d.ts +18 -6
  128. package/tenants.js +10 -10
  129. package/tenants.mjs +3 -3
  130. package/themes.d.mts +10 -1
  131. package/themes.d.ts +10 -1
  132. package/themes.js +11 -11
  133. package/themes.mjs +3 -3
  134. package/transports.d.mts +21 -12
  135. package/transports.d.ts +21 -12
  136. package/transports.js +10 -10
  137. package/transports.mjs +3 -3
  138. package/users.d.mts +90 -25
  139. package/users.d.ts +90 -25
  140. package/users.js +14 -14
  141. package/users.mjs +3 -3
  142. package/web-integrations.d.mts +19 -1
  143. package/web-integrations.d.ts +19 -1
  144. package/web-integrations.js +9 -9
  145. package/web-integrations.mjs +3 -3
  146. package/web-notifications.d.mts +19 -1
  147. package/web-notifications.d.ts +19 -1
  148. package/web-notifications.js +10 -10
  149. package/web-notifications.mjs +3 -3
  150. package/webhooks.d.mts +4 -1
  151. package/webhooks.d.ts +4 -1
  152. package/webhooks.js +14 -14
  153. package/webhooks.mjs +3 -3
  154. package/auth-XY6FVSVM.js +0 -41
  155. package/invoke-fetch-FRLO3CK6.js +0 -17
  156. /package/{chunk-P57PW2II.js → chunks/4HB3TAEO.js} +0 -0
  157. /package/{chunk-ZFXKCRJC.mjs → chunks/VSY5YIQY.mjs} +0 -0
package/extensions.d.mts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
1
+ import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
+ /**
5
+ * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
6
+ */
4
7
  type BundleMeta = {
5
8
  /** Description of the bundle. */
6
9
  description?: string;
@@ -9,6 +12,9 @@ type BundleMeta = {
9
12
  /** Name of the bundle. */
10
13
  name?: string;
11
14
  };
15
+ /**
16
+ * An error object.
17
+ */
12
18
  type Error = {
13
19
  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
14
20
  meta?: Meta;
@@ -19,6 +25,9 @@ type Error = {
19
25
  /** Title of the HTTP status code. */
20
26
  title: string;
21
27
  };
28
+ /**
29
+ * The extension model.
30
+ */
22
31
  type Extension = {
23
32
  /** Author of the extension. */
24
33
  author?: string;
@@ -75,6 +84,9 @@ type Extension = {
75
84
  type Extensions = {
76
85
  data: Extension[];
77
86
  };
87
+ /**
88
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
89
+ */
78
90
  type Meta = {
79
91
  /** A more detailed message explaining the error. */
80
92
  message?: string;
package/extensions.d.ts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
1
+ import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
+ /**
5
+ * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
6
+ */
4
7
  type BundleMeta = {
5
8
  /** Description of the bundle. */
6
9
  description?: string;
@@ -9,6 +12,9 @@ type BundleMeta = {
9
12
  /** Name of the bundle. */
10
13
  name?: string;
11
14
  };
15
+ /**
16
+ * An error object.
17
+ */
12
18
  type Error = {
13
19
  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
14
20
  meta?: Meta;
@@ -19,6 +25,9 @@ type Error = {
19
25
  /** Title of the HTTP status code. */
20
26
  title: string;
21
27
  };
28
+ /**
29
+ * The extension model.
30
+ */
22
31
  type Extension = {
23
32
  /** Author of the extension. */
24
33
  author?: string;
@@ -75,6 +84,9 @@ type Extension = {
75
84
  type Extensions = {
76
85
  data: Extension[];
77
86
  };
87
+ /**
88
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
89
+ */
78
90
  type Meta = {
79
91
  /** A more detailed message explaining the error. */
80
92
  message?: string;
package/extensions.js CHANGED
@@ -1,36 +1,36 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
5
- require('./chunk-BRDPNGQ7.js');
6
- require('./chunk-P57PW2II.js');
4
+ var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
5
+ require('./chunks/FG5GDUSZ.js');
6
+ require('./chunks/4HB3TAEO.js');
7
7
 
8
8
  // src/public/rest/extensions.ts
9
- var getExtensions = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
9
+ var getExtensions = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/extensions",
12
12
  options
13
13
  });
14
- var uploadExtension = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
14
+ var uploadExtension = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
15
15
  method: "post",
16
16
  pathTemplate: "/api/v1/extensions",
17
17
  body,
18
18
  contentType: "multipart/form-data",
19
19
  options
20
20
  });
21
- var deleteExtension = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
21
+ var deleteExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
22
22
  method: "delete",
23
23
  pathTemplate: "/api/v1/extensions/{id}",
24
24
  pathVariables: { id },
25
25
  options
26
26
  });
27
- var getExtension = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
27
+ var getExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
28
28
  method: "get",
29
29
  pathTemplate: "/api/v1/extensions/{id}",
30
30
  pathVariables: { id },
31
31
  options
32
32
  });
33
- var patchExtension = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
33
+ var patchExtension = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
34
34
  method: "patch",
35
35
  pathTemplate: "/api/v1/extensions/{id}",
36
36
  pathVariables: { id },
@@ -38,20 +38,20 @@ var patchExtension = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.c
38
38
  contentType: "multipart/form-data",
39
39
  options
40
40
  });
41
- var downloadExtension = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
41
+ var downloadExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
42
42
  method: "get",
43
43
  pathTemplate: "/api/v1/extensions/{id}/file",
44
44
  pathVariables: { id },
45
45
  options
46
46
  });
47
- var downloadFileFromExtension = async (id, filepath, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "extensions", {
47
+ var downloadFileFromExtension = async (id, filepath, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
48
48
  method: "get",
49
49
  pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
50
50
  pathVariables: { id, filepath },
51
51
  options
52
52
  });
53
53
  function clearCache() {
54
- return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "extensions");
54
+ return _QMWU5E4Djs.clearApiCache.call(void 0, "extensions");
55
55
  }
56
56
  var extensionsExport = {
57
57
  getExtensions,
package/extensions.mjs CHANGED
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-4MWB2T3C.mjs";
5
- import "./chunk-LLLEO6K6.mjs";
6
- import "./chunk-ZFXKCRJC.mjs";
4
+ } from "./chunks/HWZC3PIL.mjs";
5
+ import "./chunks/O5POHH2Q.mjs";
6
+ import "./chunks/VSY5YIQY.mjs";
7
7
 
8
8
  // src/public/rest/extensions.ts
9
9
  var getExtensions = async (options) => invokeFetch("extensions", {
@@ -35,6 +35,10 @@ type ApiCallOptions = {
35
35
  */
36
36
  timeoutMs?: number;
37
37
  };
38
+ type DownloadableBlob = Blob & {
39
+ /** download the blob in a using the specified filename */
40
+ download: (filename: string) => Promise<void>;
41
+ };
38
42
 
39
43
  /** ApiKey Auth Configuration for a HostConfig */
40
44
  type ApiKeyAuthConfig = {
@@ -108,4 +112,4 @@ declare global {
108
112
  } | undefined;
109
113
  }
110
114
 
111
- export type { ApiCallOptions as A };
115
+ export type { ApiCallOptions as A, DownloadableBlob as D };
@@ -35,6 +35,10 @@ type ApiCallOptions = {
35
35
  */
36
36
  timeoutMs?: number;
37
37
  };
38
+ type DownloadableBlob = Blob & {
39
+ /** download the blob in a using the specified filename */
40
+ download: (filename: string) => Promise<void>;
41
+ };
38
42
 
39
43
  /** ApiKey Auth Configuration for a HostConfig */
40
44
  type ApiKeyAuthConfig = {
@@ -108,4 +112,4 @@ declare global {
108
112
  } | undefined;
109
113
  }
110
114
 
111
- export type { ApiCallOptions as A };
115
+ export type { ApiCallOptions as A, DownloadableBlob as D };
package/glossaries.d.mts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
1
+ import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
+ /**
5
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
6
+ */
4
7
  type JSONPatch = {
5
8
  /** The operation to be performed. */
6
9
  op: "replace";
@@ -9,6 +12,9 @@ type JSONPatch = {
9
12
  /** The value to be used for this operation. */
10
13
  value: string | number;
11
14
  };
15
+ /**
16
+ * An array of JSON Patch documents
17
+ */
12
18
  type JSONPatchArray = JSONPatch[];
13
19
  type AtlanEntity = {
14
20
  attributes?: AtlanEntityAttributes;
@@ -30,6 +36,9 @@ type AtlanEntityAttributes = {
30
36
  usage?: string;
31
37
  userDescription?: string;
32
38
  };
39
+ /**
40
+ * Atlan glossary format. See https://apidocs.atlan.com/
41
+ */
33
42
  type AtlanGlossary = {
34
43
  entity?: AtlanEntity;
35
44
  referredEntities?: AtlanEntity[];
@@ -151,6 +160,28 @@ type ErrorResponse = {
151
160
  errors?: ErrorResponseCode[];
152
161
  traceId?: string;
153
162
  };
163
+ /**
164
+ * ### Custom error codes
165
+ * * BG-1 - Context JWT is missing tenantId.
166
+ * * BG-2 - Context JWT is missing userId.
167
+ * * BG-4 - Invalid or unsupported Content Type. Valid types are: application/json, application/json+qlik, application/json+atlan, application/json+atlas
168
+ * * BG-5 - Failed to decode JSON payload.
169
+ * * BG-6 - A glossary name is required.
170
+ * * BG-7 - Two categories with the same name cannot have the same parent.
171
+ * * BG-11 - Glossary validation failed - A value or parameter is invalid or not set
172
+ * * BG-12 - Category validation failed - A value or parameter is invalid or not set
173
+ * * BG-13 - Term validation failed - A value or parameter is invalid or not set
174
+ * * BG-14 - Two or more categories share Id
175
+ * * BG-15 - Two or more terms share Id
176
+ * * BG-16 - Not detecting proper Atlas format
177
+ * * BG-17 - Not detecting proper Atlan format
178
+ * * BG-18 - Not detecting proper Qlik format
179
+ * * BG-19 - Invalid format in term
180
+ * * BG-20 - Duplicate link definition
181
+ * * BG-21 - Rich text validation failed
182
+ * * BG-22 - Import cancelled
183
+ * * BG-23 - Duplicate link related
184
+ */
154
185
  type ErrorResponseBadRequest = {
155
186
  errors?: ErrorResponseCode[];
156
187
  traceId?: string;
@@ -160,10 +191,20 @@ type ErrorResponseCode = {
160
191
  detail?: string;
161
192
  title?: string;
162
193
  };
194
+ /**
195
+ * ### Custom error codes
196
+ * * BG-3 - Access denied, no read access
197
+ */
163
198
  type ErrorResponseForbidden = {
164
199
  errors?: ErrorResponseCode[];
165
200
  traceId?: string;
166
201
  };
202
+ /**
203
+ * ### Custom error codes
204
+ * * BG-8 - Glossary not found
205
+ * * BG-9 - Category not found
206
+ * * BG-10 - Term not found
207
+ */
167
208
  type ErrorResponseNotFound = {
168
209
  errors?: ErrorResponseCode[];
169
210
  traceId?: string;
@@ -324,6 +365,9 @@ type Term = {
324
365
  /** The uuid of the user who last updated the term */
325
366
  readonly updatedBy: string;
326
367
  };
368
+ /**
369
+ * Describes links to other data assets such as analytics applications or dataset.
370
+ */
327
371
  type TermCreateLinksTo = {
328
372
  resourceId: string;
329
373
  resourceType: "app" | "dataset";
@@ -332,6 +376,9 @@ type TermCreateLinksTo = {
332
376
  subResourceType?: "master_dimension" | "master_measure";
333
377
  type?: "definition" | "related";
334
378
  };
379
+ /**
380
+ * Describes links to other entities such as qlik charts, dataset columns etc.
381
+ */
335
382
  type TermLinksTo = {
336
383
  readonly createdAt?: string;
337
384
  createdBy?: string;
@@ -356,6 +403,9 @@ type TermRelatesTo = {
356
403
  /** How the term related to the other object */
357
404
  type: "isA" | "hasA" | "seeAlso" | "synonym" | "antonym" | "classifies" | "other";
358
405
  };
406
+ /**
407
+ * Terms status is used determine the status of a term
408
+ */
359
409
  type TermStatus = {
360
410
  type: "draft" | "verified" | "deprecated";
361
411
  /** Time when the state was changed */
package/glossaries.d.ts CHANGED
@@ -1,6 +1,9 @@
1
- import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
1
+ import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
+ /**
5
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
6
+ */
4
7
  type JSONPatch = {
5
8
  /** The operation to be performed. */
6
9
  op: "replace";
@@ -9,6 +12,9 @@ type JSONPatch = {
9
12
  /** The value to be used for this operation. */
10
13
  value: string | number;
11
14
  };
15
+ /**
16
+ * An array of JSON Patch documents
17
+ */
12
18
  type JSONPatchArray = JSONPatch[];
13
19
  type AtlanEntity = {
14
20
  attributes?: AtlanEntityAttributes;
@@ -30,6 +36,9 @@ type AtlanEntityAttributes = {
30
36
  usage?: string;
31
37
  userDescription?: string;
32
38
  };
39
+ /**
40
+ * Atlan glossary format. See https://apidocs.atlan.com/
41
+ */
33
42
  type AtlanGlossary = {
34
43
  entity?: AtlanEntity;
35
44
  referredEntities?: AtlanEntity[];
@@ -151,6 +160,28 @@ type ErrorResponse = {
151
160
  errors?: ErrorResponseCode[];
152
161
  traceId?: string;
153
162
  };
163
+ /**
164
+ * ### Custom error codes
165
+ * * BG-1 - Context JWT is missing tenantId.
166
+ * * BG-2 - Context JWT is missing userId.
167
+ * * BG-4 - Invalid or unsupported Content Type. Valid types are: application/json, application/json+qlik, application/json+atlan, application/json+atlas
168
+ * * BG-5 - Failed to decode JSON payload.
169
+ * * BG-6 - A glossary name is required.
170
+ * * BG-7 - Two categories with the same name cannot have the same parent.
171
+ * * BG-11 - Glossary validation failed - A value or parameter is invalid or not set
172
+ * * BG-12 - Category validation failed - A value or parameter is invalid or not set
173
+ * * BG-13 - Term validation failed - A value or parameter is invalid or not set
174
+ * * BG-14 - Two or more categories share Id
175
+ * * BG-15 - Two or more terms share Id
176
+ * * BG-16 - Not detecting proper Atlas format
177
+ * * BG-17 - Not detecting proper Atlan format
178
+ * * BG-18 - Not detecting proper Qlik format
179
+ * * BG-19 - Invalid format in term
180
+ * * BG-20 - Duplicate link definition
181
+ * * BG-21 - Rich text validation failed
182
+ * * BG-22 - Import cancelled
183
+ * * BG-23 - Duplicate link related
184
+ */
154
185
  type ErrorResponseBadRequest = {
155
186
  errors?: ErrorResponseCode[];
156
187
  traceId?: string;
@@ -160,10 +191,20 @@ type ErrorResponseCode = {
160
191
  detail?: string;
161
192
  title?: string;
162
193
  };
194
+ /**
195
+ * ### Custom error codes
196
+ * * BG-3 - Access denied, no read access
197
+ */
163
198
  type ErrorResponseForbidden = {
164
199
  errors?: ErrorResponseCode[];
165
200
  traceId?: string;
166
201
  };
202
+ /**
203
+ * ### Custom error codes
204
+ * * BG-8 - Glossary not found
205
+ * * BG-9 - Category not found
206
+ * * BG-10 - Term not found
207
+ */
167
208
  type ErrorResponseNotFound = {
168
209
  errors?: ErrorResponseCode[];
169
210
  traceId?: string;
@@ -324,6 +365,9 @@ type Term = {
324
365
  /** The uuid of the user who last updated the term */
325
366
  readonly updatedBy: string;
326
367
  };
368
+ /**
369
+ * Describes links to other data assets such as analytics applications or dataset.
370
+ */
327
371
  type TermCreateLinksTo = {
328
372
  resourceId: string;
329
373
  resourceType: "app" | "dataset";
@@ -332,6 +376,9 @@ type TermCreateLinksTo = {
332
376
  subResourceType?: "master_dimension" | "master_measure";
333
377
  type?: "definition" | "related";
334
378
  };
379
+ /**
380
+ * Describes links to other entities such as qlik charts, dataset columns etc.
381
+ */
335
382
  type TermLinksTo = {
336
383
  readonly createdAt?: string;
337
384
  createdBy?: string;
@@ -356,6 +403,9 @@ type TermRelatesTo = {
356
403
  /** How the term related to the other object */
357
404
  type: "isA" | "hasA" | "seeAlso" | "synonym" | "antonym" | "classifies" | "other";
358
405
  };
406
+ /**
407
+ * Terms status is used determine the status of a term
408
+ */
359
409
  type TermStatus = {
360
410
  type: "draft" | "verified" | "deprecated";
361
411
  /** Time when the state was changed */
package/glossaries.js CHANGED
@@ -1,25 +1,25 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
5
- require('./chunk-BRDPNGQ7.js');
6
- require('./chunk-P57PW2II.js');
4
+ var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
5
+ require('./chunks/FG5GDUSZ.js');
6
+ require('./chunks/4HB3TAEO.js');
7
7
 
8
8
  // src/public/rest/glossaries.ts
9
- var getGlossaries = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
9
+ var getGlossaries = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/glossaries",
12
12
  query,
13
13
  options
14
14
  });
15
- var createGlossary = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
15
+ var createGlossary = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
16
16
  method: "post",
17
17
  pathTemplate: "/api/v1/glossaries",
18
18
  body,
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var importGlossary = async (query, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
22
+ var importGlossary = async (query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
23
23
  method: "post",
24
24
  pathTemplate: "/api/v1/glossaries/actions/import",
25
25
  query,
@@ -27,19 +27,19 @@ var importGlossary = async (query, body, options) => _chunkEALMXU6Sjs.invokeFetc
27
27
  contentType: "application/json",
28
28
  options
29
29
  });
30
- var deleteGlossary = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
30
+ var deleteGlossary = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
31
31
  method: "delete",
32
32
  pathTemplate: "/api/v1/glossaries/{id}",
33
33
  pathVariables: { id },
34
34
  options
35
35
  });
36
- var getGlossary = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
36
+ var getGlossary = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
37
37
  method: "get",
38
38
  pathTemplate: "/api/v1/glossaries/{id}",
39
39
  pathVariables: { id },
40
40
  options
41
41
  });
42
- var patchGlossary = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
42
+ var patchGlossary = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
43
43
  method: "patch",
44
44
  pathTemplate: "/api/v1/glossaries/{id}",
45
45
  pathVariables: { id },
@@ -47,7 +47,7 @@ var patchGlossary = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.ca
47
47
  contentType: "application/json",
48
48
  options
49
49
  });
50
- var updateGlossary = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
50
+ var updateGlossary = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
51
51
  method: "put",
52
52
  pathTemplate: "/api/v1/glossaries/{id}",
53
53
  pathVariables: { id },
@@ -55,20 +55,20 @@ var updateGlossary = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.c
55
55
  contentType: "application/json",
56
56
  options
57
57
  });
58
- var exportGlossary = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
58
+ var exportGlossary = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
59
59
  method: "get",
60
60
  pathTemplate: "/api/v1/glossaries/{id}/actions/export",
61
61
  pathVariables: { id },
62
62
  options
63
63
  });
64
- var getGlossaryCategories = async (id, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
64
+ var getGlossaryCategories = async (id, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
65
65
  method: "get",
66
66
  pathTemplate: "/api/v1/glossaries/{id}/categories",
67
67
  pathVariables: { id },
68
68
  query,
69
69
  options
70
70
  });
71
- var createGlossaryCategory = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
71
+ var createGlossaryCategory = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
72
72
  method: "post",
73
73
  pathTemplate: "/api/v1/glossaries/{id}/categories",
74
74
  pathVariables: { id },
@@ -76,19 +76,19 @@ var createGlossaryCategory = async (id, body, options) => _chunkEALMXU6Sjs.invok
76
76
  contentType: "application/json",
77
77
  options
78
78
  });
79
- var deleteGlossaryCategory = async (id, categoryId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
79
+ var deleteGlossaryCategory = async (id, categoryId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
80
80
  method: "delete",
81
81
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
82
82
  pathVariables: { id, categoryId },
83
83
  options
84
84
  });
85
- var getGlossaryCategory = async (id, categoryId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
85
+ var getGlossaryCategory = async (id, categoryId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
86
86
  method: "get",
87
87
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
88
88
  pathVariables: { id, categoryId },
89
89
  options
90
90
  });
91
- var patchGlossaryCategory = async (id, categoryId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
91
+ var patchGlossaryCategory = async (id, categoryId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
92
92
  method: "patch",
93
93
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
94
94
  pathVariables: { id, categoryId },
@@ -96,7 +96,7 @@ var patchGlossaryCategory = async (id, categoryId, body, options) => _chunkEALMX
96
96
  contentType: "application/json",
97
97
  options
98
98
  });
99
- var updateGlossaryCategory = async (id, categoryId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
99
+ var updateGlossaryCategory = async (id, categoryId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
100
100
  method: "put",
101
101
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
102
102
  pathVariables: { id, categoryId },
@@ -104,14 +104,14 @@ var updateGlossaryCategory = async (id, categoryId, body, options) => _chunkEALM
104
104
  contentType: "application/json",
105
105
  options
106
106
  });
107
- var getGlossaryTerms = async (id, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
107
+ var getGlossaryTerms = async (id, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
108
108
  method: "get",
109
109
  pathTemplate: "/api/v1/glossaries/{id}/terms",
110
110
  pathVariables: { id },
111
111
  query,
112
112
  options
113
113
  });
114
- var createGlossaryTerm = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
114
+ var createGlossaryTerm = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
115
115
  method: "post",
116
116
  pathTemplate: "/api/v1/glossaries/{id}/terms",
117
117
  pathVariables: { id },
@@ -119,19 +119,19 @@ var createGlossaryTerm = async (id, body, options) => _chunkEALMXU6Sjs.invokeFet
119
119
  contentType: "application/json",
120
120
  options
121
121
  });
122
- var deleteGlossaryTerm = async (id, termId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
122
+ var deleteGlossaryTerm = async (id, termId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
123
123
  method: "delete",
124
124
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
125
125
  pathVariables: { id, termId },
126
126
  options
127
127
  });
128
- var getGlossaryTerm = async (id, termId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
128
+ var getGlossaryTerm = async (id, termId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
129
129
  method: "get",
130
130
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
131
131
  pathVariables: { id, termId },
132
132
  options
133
133
  });
134
- var patchGlossaryTerm = async (id, termId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
134
+ var patchGlossaryTerm = async (id, termId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
135
135
  method: "patch",
136
136
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
137
137
  pathVariables: { id, termId },
@@ -139,7 +139,7 @@ var patchGlossaryTerm = async (id, termId, body, options) => _chunkEALMXU6Sjs.in
139
139
  contentType: "application/json",
140
140
  options
141
141
  });
142
- var updateGlossaryTerm = async (id, termId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
142
+ var updateGlossaryTerm = async (id, termId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
143
143
  method: "put",
144
144
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
145
145
  pathVariables: { id, termId },
@@ -147,21 +147,21 @@ var updateGlossaryTerm = async (id, termId, body, options) => _chunkEALMXU6Sjs.i
147
147
  contentType: "application/json",
148
148
  options
149
149
  });
150
- var changeGlossaryTermStatus = async (id, termId, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
150
+ var changeGlossaryTermStatus = async (id, termId, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
151
151
  method: "post",
152
152
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/actions/change-status",
153
153
  pathVariables: { id, termId },
154
154
  query,
155
155
  options
156
156
  });
157
- var getGlossaryTermLinks = async (id, termId, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
157
+ var getGlossaryTermLinks = async (id, termId, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
158
158
  method: "get",
159
159
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
160
160
  pathVariables: { id, termId },
161
161
  query,
162
162
  options
163
163
  });
164
- var createGlossaryTermLink = async (id, termId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
164
+ var createGlossaryTermLink = async (id, termId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
165
165
  method: "post",
166
166
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
167
167
  pathVariables: { id, termId },
@@ -169,7 +169,7 @@ var createGlossaryTermLink = async (id, termId, body, options) => _chunkEALMXU6S
169
169
  contentType: "application/json",
170
170
  options
171
171
  });
172
- var getGlossaryTermRevisions = async (id, termId, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "glossaries", {
172
+ var getGlossaryTermRevisions = async (id, termId, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "glossaries", {
173
173
  method: "get",
174
174
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/revisions",
175
175
  pathVariables: { id, termId },
@@ -177,7 +177,7 @@ var getGlossaryTermRevisions = async (id, termId, query, options) => _chunkEALMX
177
177
  options
178
178
  });
179
179
  function clearCache() {
180
- return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "glossaries");
180
+ return _QMWU5E4Djs.clearApiCache.call(void 0, "glossaries");
181
181
  }
182
182
  var glossariesExport = {
183
183
  getGlossaries,
package/glossaries.mjs CHANGED
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-4MWB2T3C.mjs";
5
- import "./chunk-LLLEO6K6.mjs";
6
- import "./chunk-ZFXKCRJC.mjs";
4
+ } from "./chunks/HWZC3PIL.mjs";
5
+ import "./chunks/O5POHH2Q.mjs";
6
+ import "./chunks/VSY5YIQY.mjs";
7
7
 
8
8
  // src/public/rest/glossaries.ts
9
9
  var getGlossaries = async (query, options) => invokeFetch("glossaries", {