@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
package/glossaries.d.ts CHANGED
@@ -1,4 +1,1224 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { $ as GetGlossaryTermLinksHttpResponse, $t as getGlossary, A as DeleteGlossaryTermHttpError, At as TermCreateLinksTo, B as ExportGlossaryHttpResponse, Bt as UpdateGlossaryTermHttpError, C as CreateGlossaryTermLinkHttpError, Ct as PatchGlossaryHttpResponse, D as DeleteGlossaryCategoryHttpResponse, Dt as ResultMeta, E as DeleteGlossaryCategoryHttpError, Et as QlikGlossary, F as ErrorResponseForbidden, Ft as TermsResult, G as GetGlossaryCategoriesHttpResponse, Gt as createGlossaryCategory, H as GetGlossariesHttpError, Ht as changeGlossaryTermStatus, I as ErrorResponseNotFound, It as UpdateGlossaryCategoryHttpError, J as GetGlossaryHttpError, Jt as deleteGlossary, K as GetGlossaryCategoryHttpError, Kt as createGlossaryTerm, L as ExportCategory, Lt as UpdateGlossaryCategoryHttpResponse, M as ErrorResponse, Mt as TermRelatesTo, N as ErrorResponseBadRequest, Nt as TermStatus, O as DeleteGlossaryHttpError, Ot as StewardDetail, P as ErrorResponseCode, Pt as TermTemplate, Q as GetGlossaryTermLinksHttpError, Qt as getGlossaries, R as ExportGlossary, Rt as UpdateGlossaryHttpError, S as CreateGlossaryTermHttpResponse, St as PatchGlossaryHttpError, T as CreateTerm, Tt as PatchGlossaryTermHttpResponse, U as GetGlossariesHttpResponse, Ut as clearCache, V as ExportTerm, Vt as UpdateGlossaryTermHttpResponse, W as GetGlossaryCategoriesHttpError, Wt as createGlossary, X as GetGlossaryTermHttpError, Xt as deleteGlossaryTerm, Y as GetGlossaryHttpResponse, Yt as deleteGlossaryCategory, Z as GetGlossaryTermHttpResponse, Zt as exportGlossary, _ as CreateGlossaryCategoryHttpError, _t as LinksResult, a as AtlanRelationshipAttributes, an as getGlossaryTerms, at as GlossariesResult, b as CreateGlossaryHttpResponse, bt as PatchGlossaryCategoryHttpError, c as AtlasCategory, cn as patchGlossary, ct as ImportGlossary400HttpError, d as CategoriesResult, dn as updateGlossary, dt as ImportGlossaryHttpError, en as getGlossaryCategories, et as GetGlossaryTermRevisionsHttpError, f as Category, fn as updateGlossaryCategory, ft as ImportGlossaryHttpResponse, g as CreateGlossary, gt as JSONPatchArray, h as CreateCategory, ht as JSONPatch, i as AtlanRelationEntity, in as getGlossaryTermRevisions, it as GlossariesAPI, j as DeleteGlossaryTermHttpResponse, jt as TermLinksTo, k as DeleteGlossaryHttpResponse, kt as Term, l as AtlasGlossary, ln as patchGlossaryCategory, lt as ImportGlossary403HttpError, m as ChangeGlossaryTermStatusHttpResponse, mt as ImportTerm, n as AtlanEntityAttributes, nn as getGlossaryTerm, nt as GetGlossaryTermsHttpError, o as AtlanResourceLink, on as glossariesExport, ot as Glossary, p as ChangeGlossaryTermStatusHttpError, pn as updateGlossaryTerm, pt as ImportOwner, q as GetGlossaryCategoryHttpResponse, qt as createGlossaryTermLink, r as AtlanGlossary, rn as getGlossaryTermLinks, rt as GetGlossaryTermsHttpResponse, s as AtlanTermHeader, sn as importGlossary, st as ImportCategory, t as AtlanEntity, tn as getGlossaryCategory, tt as GetGlossaryTermRevisionsHttpResponse, u as AtlasTerm, un as patchGlossaryTerm, ut as ImportGlossary404HttpError, v as CreateGlossaryCategoryHttpResponse, vt as PageLink, w as CreateGlossaryTermLinkHttpResponse, wt as PatchGlossaryTermHttpError, x as CreateGlossaryTermHttpError, xt as PatchGlossaryCategoryHttpResponse, y as CreateGlossaryHttpError, yt as PageLinks, z as ExportGlossaryHttpError, zt as UpdateGlossaryHttpResponse } from "./chunks/glossaries-CIX7-KT_.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/glossaries.d.ts
5
+ /**
6
+ * A JSON Patch document as defined in https://tools.ietf.org/html/rfc6902.
7
+ */
8
+ type JSONPatch = {
9
+ /** The operation to be performed. */
10
+ op: "replace";
11
+ /** A JSON Pointer. */
12
+ path: string;
13
+ /** The value to be used for this operation. */
14
+ value: string | number;
15
+ };
16
+ /**
17
+ * An array of JSON Patch documents
18
+ * @example
19
+ * [
20
+ * {
21
+ * op: "replace",
22
+ * path: "/name",
23
+ * value: "new name"
24
+ * },
25
+ * {
26
+ * op: "replace",
27
+ * path: "/description",
28
+ * value: "new description"
29
+ * }
30
+ * ]
31
+ */
32
+ type JSONPatchArray = JSONPatch[];
33
+ type AtlanEntity = {
34
+ attributes?: AtlanEntityAttributes;
35
+ guid?: string;
36
+ labels?: string[];
37
+ relationshipAttributes?: AtlanRelationshipAttributes;
38
+ status?: string;
39
+ typeName?: string;
40
+ };
41
+ type AtlanEntityAttributes = {
42
+ abbreviation?: string;
43
+ displayText?: string;
44
+ examples?: unknown;
45
+ guid?: string;
46
+ name?: string;
47
+ parentCategory?: string;
48
+ relationGuid?: string;
49
+ relations?: AtlanResourceLink;
50
+ usage?: string;
51
+ userDescription?: string;
52
+ };
53
+ /**
54
+ * Atlan glossary format. See https://apidocs.atlan.com/
55
+ */
56
+ type AtlanGlossary = {
57
+ entity?: AtlanEntity;
58
+ referredEntities?: AtlanEntity[];
59
+ };
60
+ type AtlanRelationEntity = {
61
+ displayText?: string;
62
+ entityStatus?: string;
63
+ guid?: string;
64
+ typeName?: string;
65
+ };
66
+ type AtlanRelationshipAttributes = {
67
+ antonyms?: AtlanTermHeader;
68
+ categories?: AtlanRelationEntity;
69
+ classifies?: AtlanTermHeader;
70
+ isA?: AtlanTermHeader;
71
+ replacedBy?: AtlanTermHeader;
72
+ seeAlso?: AtlanTermHeader;
73
+ synonyms?: AtlanTermHeader;
74
+ terms?: AtlanRelationEntity;
75
+ };
76
+ type AtlanResourceLink = {
77
+ displayName?: string;
78
+ url?: string;
79
+ };
80
+ type AtlanTermHeader = {
81
+ description?: string;
82
+ displayText?: string;
83
+ entityStatus?: string;
84
+ expression?: string;
85
+ guid?: string;
86
+ relationGuid?: string;
87
+ steward?: string;
88
+ };
89
+ type AtlasCategory = {
90
+ categoryGuid?: string;
91
+ description?: string;
92
+ displayText?: string;
93
+ parentCategoryGuid?: string;
94
+ relationGuid?: string;
95
+ };
96
+ type AtlasGlossary = {
97
+ categories?: AtlasCategory[];
98
+ guid?: string;
99
+ language?: string;
100
+ longDescription?: string;
101
+ name?: string;
102
+ qualifiedName?: string;
103
+ shortDescription?: string;
104
+ terms?: AtlasTerm[];
105
+ usage?: string;
106
+ };
107
+ type AtlasTerm = {
108
+ description?: string;
109
+ displayText?: string;
110
+ expression?: string;
111
+ relationGuid?: string;
112
+ source?: string;
113
+ status?: string;
114
+ steward?: string;
115
+ termGuid?: string;
116
+ };
117
+ type CategoriesResult = {
118
+ data: Category[];
119
+ /** URLs to a resource request */
120
+ links?: PageLinks;
121
+ meta?: ResultMeta;
122
+ };
123
+ type Category = {
124
+ readonly createdAt: string;
125
+ readonly createdBy: string;
126
+ description: string;
127
+ glossaryId: string;
128
+ /** The id for resolving updates in future imports/updates.
129
+ * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
130
+ id: string;
131
+ name: string;
132
+ parentId?: string;
133
+ /** This list contains the UIDs of the stewards of the category. */
134
+ stewards?: string[];
135
+ readonly updatedAt: string;
136
+ /** The uid of the user who last updated the category */
137
+ readonly updatedBy: string;
138
+ };
139
+ type CreateCategory = {
140
+ description?: string;
141
+ /** The name of the category. May not be identical to another category belonging to the same parent. */
142
+ name?: string;
143
+ parentId?: string;
144
+ /** This list contains the UIDs of the stewards of the category. */
145
+ stewards?: string[];
146
+ };
147
+ type CreateGlossary = {
148
+ /** Description of the glossary */
149
+ description?: string;
150
+ /** Name of the glossary */
151
+ name: string;
152
+ /** Overview of the glossary content. This is a rich text field represented as a JSON string.
153
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
154
+ overview?: string;
155
+ /** Unique unique identifier of the space to contain the glossary */
156
+ spaceId?: string;
157
+ /** List of tags for glossary */
158
+ tags?: string[];
159
+ termTemplate?: TermTemplate;
160
+ };
161
+ type CreateTerm = {
162
+ abbreviation?: string;
163
+ /** Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document. */
164
+ categories?: string[];
165
+ description?: string;
166
+ linksTo?: TermCreateLinksTo[];
167
+ name: string;
168
+ /** Related information for the term. This is a rich text field represented as a JSON string.
169
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
170
+ relatedInformation?: string;
171
+ relatesTo?: TermRelatesTo[];
172
+ /** This list contain the UIDs for the term's stewards */
173
+ stewards?: string[];
174
+ tags?: string[];
175
+ };
176
+ type ErrorResponse = {
177
+ errors?: ErrorResponseCode[];
178
+ traceId?: string;
179
+ };
180
+ /**
181
+ * ### Custom error codes
182
+ * * BG-1 - Context JWT is missing tenantId.
183
+ * * BG-2 - Context JWT is missing userId.
184
+ * * BG-4 - Invalid or unsupported Content Type. Valid types are: application/json, application/json+qlik, application/json+atlan, application/json+atlas
185
+ * * BG-5 - Failed to decode JSON payload.
186
+ * * BG-6 - A glossary name is required.
187
+ * * BG-7 - Two categories with the same name cannot have the same parent.
188
+ * * BG-11 - Glossary validation failed - A value or parameter is invalid or not set
189
+ * * BG-12 - Category validation failed - A value or parameter is invalid or not set
190
+ * * BG-13 - Term validation failed - A value or parameter is invalid or not set
191
+ * * BG-14 - Two or more categories share Id
192
+ * * BG-15 - Two or more terms share Id
193
+ * * BG-16 - Not detecting proper Atlas format
194
+ * * BG-17 - Not detecting proper Atlan format
195
+ * * BG-18 - Not detecting proper Qlik format
196
+ * * BG-19 - Invalid format in term
197
+ * * BG-20 - Duplicate link definition
198
+ * * BG-21 - Rich text validation failed. Rich text fields must be valid JSON strings in the format: [{"type":"paragraph","children":[{"text":"your text here"}]}]
199
+ * * BG-22 - Import cancelled
200
+ * * BG-23 - Duplicate link related
201
+ */
202
+ type ErrorResponseBadRequest = {
203
+ errors?: ErrorResponseCode[];
204
+ traceId?: string;
205
+ };
206
+ type ErrorResponseCode = {
207
+ code?: string;
208
+ detail?: string;
209
+ title?: string;
210
+ };
211
+ /**
212
+ * ### Custom error codes
213
+ * * BG-3 - Access denied, no read access
214
+ * * BG-30 - Feature not enabled on tenant.
215
+ */
216
+ type ErrorResponseForbidden = {
217
+ errors?: ErrorResponseCode[];
218
+ traceId?: string;
219
+ };
220
+ /**
221
+ * ### Custom error codes
222
+ * * BG-8 - Glossary not found
223
+ * * BG-9 - Category not found
224
+ * * BG-10 - Term not found
225
+ */
226
+ type ErrorResponseNotFound = {
227
+ errors?: ErrorResponseCode[];
228
+ traceId?: string;
229
+ };
230
+ type ExportCategory = {
231
+ description?: string;
232
+ /** The id for resolving updates in future imports/updates.
233
+ * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
234
+ id?: string;
235
+ /** The name of the category. May not be identical to another category belonging to the same parent. */
236
+ name?: string;
237
+ parentId?: string;
238
+ stewardDetails?: StewardDetail[];
239
+ };
240
+ type ExportGlossary = {
241
+ categories?: ExportCategory[];
242
+ readonly createdAt?: string;
243
+ readonly createdBy?: string;
244
+ description?: string;
245
+ id?: string;
246
+ name?: string;
247
+ /** Overview of the glossary. This is a rich text field represented as a JSON string.
248
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
249
+ overview?: string;
250
+ ownerId?: string;
251
+ spaceId?: string;
252
+ tags?: string[];
253
+ termTemplate?: TermTemplate;
254
+ terms?: ExportTerm[];
255
+ readonly updatedAt?: string;
256
+ /** The uid of the user who last updated the glossary */
257
+ readonly updatedBy?: string;
258
+ };
259
+ type ExportTerm = {
260
+ abbreviation?: string;
261
+ /** Categories that the term belongs to. Refers to the `id` property of the category object */
262
+ categories?: string[];
263
+ description?: string;
264
+ /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
265
+ id?: string;
266
+ linksTo?: TermCreateLinksTo[];
267
+ name?: string;
268
+ owner?: ImportOwner[];
269
+ relatesTo?: TermRelatesTo[];
270
+ stewardDetails?: StewardDetail[];
271
+ stewards?: StewardDetail[];
272
+ tags?: string[];
273
+ };
274
+ type GlossariesResult = {
275
+ data?: Glossary[];
276
+ /** URLs to a resource request */
277
+ links?: PageLinks;
278
+ meta?: ResultMeta;
279
+ };
280
+ type Glossary = {
281
+ /** Datetime when the glossary was created */
282
+ readonly createdAt: string;
283
+ /** Unique identifier of the user who created the glossary */
284
+ readonly createdBy: string;
285
+ /** Description of the glossary */
286
+ description: string;
287
+ /** Unique identifier of the glossary */
288
+ id: string;
289
+ /** Name of the glossary */
290
+ name: string;
291
+ /** Overview of the glossary contents. This is a rich text field represented as a JSON string.
292
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
293
+ overview: string;
294
+ /** The unique identifier of the glossary owner */
295
+ ownerId: string;
296
+ /** The unique identifier of the space containing the glossary */
297
+ spaceId: string;
298
+ /** List of tags associated with the glossary. */
299
+ tags: string[];
300
+ termTemplate: TermTemplate;
301
+ /** Datetime when the glossary was updated */
302
+ readonly updatedAt: string;
303
+ /** The unique identifier of the user who last updated the glossary */
304
+ readonly updatedBy: string;
305
+ };
306
+ type ImportCategory = {
307
+ description?: string;
308
+ /** The id for resolving updates in future imports/updates.
309
+ * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
310
+ id?: string;
311
+ /** The name of the category. May not be identical to another category belonging to the same parent. */
312
+ name?: string;
313
+ parentId?: string;
314
+ stewardDetails?: StewardDetail[];
315
+ stewards?: string[];
316
+ };
317
+ type ImportOwner = {
318
+ email?: string;
319
+ name?: string;
320
+ userId?: string;
321
+ };
322
+ type ImportTerm = {
323
+ abbreviation?: string;
324
+ /** Categories that the term belongs to. Refers to the `id` property of the category object */
325
+ categories?: string[];
326
+ description?: string;
327
+ /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
328
+ id?: string;
329
+ linksTo?: TermCreateLinksTo[];
330
+ name?: string;
331
+ owner?: ImportOwner[];
332
+ relatesTo?: TermRelatesTo[];
333
+ stewardDetails?: StewardDetail[];
334
+ stewards?: StewardDetail[];
335
+ tags?: string[];
336
+ };
337
+ type LinksResult = {
338
+ data?: TermLinksTo[];
339
+ /** URLs to a resource request */
340
+ links?: PageLinks;
341
+ meta?: ResultMeta;
342
+ };
343
+ type PageLink = {
344
+ href?: string;
345
+ };
346
+ /**
347
+ * URLs to a resource request
348
+ */
349
+ type PageLinks = {
350
+ next?: PageLink;
351
+ prev?: PageLink;
352
+ self?: PageLink;
353
+ };
354
+ type QlikGlossary = {
355
+ categories?: ImportCategory[];
356
+ description?: string;
357
+ name?: string;
358
+ /** Overview of the glossary. This is a rich text field represented as a JSON string.
359
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
360
+ overview?: string;
361
+ spaceId?: string;
362
+ tags?: string[];
363
+ termTemplate?: TermTemplate;
364
+ terms?: ImportTerm[];
365
+ };
366
+ type ResultMeta = {
367
+ countTotal?: number;
368
+ };
369
+ type StewardDetail = {
370
+ email?: string;
371
+ name?: string;
372
+ userId?: string;
373
+ };
374
+ type Term = {
375
+ abbreviation: string;
376
+ categories?: string[];
377
+ readonly createdAt: string;
378
+ readonly createdBy: string;
379
+ description: string;
380
+ glossaryId: string;
381
+ id: string;
382
+ linksTo?: TermLinksTo[];
383
+ name: string;
384
+ /** Term relations where this term is the target of the relation. */
385
+ referredRelations?: TermRelatesTo[];
386
+ /** Related information for the term. This is a rich text field represented as a JSON string.
387
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
388
+ relatedInformation: string;
389
+ /** Term relations assigned to this term. */
390
+ relatesTo?: TermRelatesTo[];
391
+ revision: number;
392
+ /** Terms status is used determine the status of a term */
393
+ status: TermStatus;
394
+ /** This list contains the UIDs of the terms data stewards. */
395
+ stewards: string[];
396
+ tags: string[];
397
+ readonly updatedAt: string;
398
+ /** The uid of the user who last updated the term */
399
+ readonly updatedBy: string;
400
+ };
401
+ /**
402
+ * Describes links to other data assets such as analytics applications or dataset.
403
+ *
404
+ * **Note**: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset),
405
+ * all three subresource fields (`subResourceType`, `subResourceId`, and `subResourceName`) must be provided together.
406
+ * If any one subresource field is specified, all three are required.
407
+ */
408
+ type TermCreateLinksTo = {
409
+ /** The unique identifier of the resource (app or dataset) to link to the term. */
410
+ resourceId: string;
411
+ /** The type of resource being linked to the term. */
412
+ resourceType: "app" | "dataset";
413
+ /** Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. */
414
+ subResourceId?: string;
415
+ /** Required when subResourceType or subResourceId is provided. The display name of the subresource. */
416
+ subResourceName?: string;
417
+ /** Required when subResourceId or subResourceName is provided. The type of the subresource. */
418
+ subResourceType?: "master_dimension" | "master_measure" | "field";
419
+ /** The type of relationship between the term and the linked resource:
420
+ * - `definition`: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
421
+ * - `related`: Use when the term is generally related to the resource but doesn't formally define it */
422
+ type?: "definition" | "related";
423
+ };
424
+ /**
425
+ * Describes links to other entities such as qlik charts, dataset columns etc.
426
+ */
427
+ type TermLinksTo = {
428
+ readonly createdAt?: string;
429
+ createdBy?: string;
430
+ id?: string;
431
+ name?: string;
432
+ openUrl?: string;
433
+ /** Different formats based on resource type. Could be e.g. OID or UUID. */
434
+ resourceId?: string;
435
+ resourceSpaceId?: string;
436
+ resourceType?: "app" | "dataset";
437
+ /** Http status code for item during batch operation. */
438
+ status?: number;
439
+ /** Different formats based on subresource type. Could be e.g. OID or UUID. */
440
+ subResourceId?: string;
441
+ /** Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists. */
442
+ subResourceInvalid?: boolean;
443
+ subResourceName?: string;
444
+ subResourceType?: "master_dimension" | "master_measure" | "field";
445
+ /** Describes reason for item status during batch operation. E.g. why an error occurs during creation. */
446
+ title?: string;
447
+ type?: "definition" | "related";
448
+ };
449
+ type TermRelatesTo = {
450
+ /** The unique identifier of the related term. NOTE! In case of import the string refers to the index of the term in the import document. */
451
+ termId: string;
452
+ /** How the term related to the other object */
453
+ type: "isA" | "hasA" | "seeAlso" | "synonym" | "antonym" | "classifies" | "other" | "replaces" | "replacedBy" | "hasSubtype" | "preferredTerm" | "seeInstead" | "defines" | "definedBy";
454
+ };
455
+ /**
456
+ * Terms status is used determine the status of a term
457
+ */
458
+ type TermStatus = {
459
+ type: "draft" | "verified" | "deprecated";
460
+ /** Time when the state was changed */
461
+ updatedAt: string;
462
+ /** The unique identifier of the user who last changed the status of the term */
463
+ updatedBy: string;
464
+ };
465
+ type TermTemplate = {
466
+ /** Template text for new terms. This is a rich text field represented as a JSON string.
467
+ * The field is typically generated by the UI but can be set programmatically using the rich text format. */
468
+ relatedInformation?: string;
469
+ };
470
+ type TermsResult = {
471
+ data: Term[];
472
+ /** URLs to a resource request */
473
+ links?: PageLinks;
474
+ meta?: ResultMeta;
475
+ };
476
+ /**
477
+ * Returns all glossaries.
478
+ *
479
+ * @param query an object with query parameters
480
+ * @throws GetGlossariesHttpError
481
+ */
482
+ declare function getGlossaries(query: {
483
+ /** Optional parameter to request total count for query */
484
+ countTotal?: boolean;
485
+ /** The number of glossaries to get. */
486
+ limit?: number;
487
+ /** Optional parameter to request the next page. */
488
+ next?: string;
489
+ /** Optional parameter to request the previous page. */
490
+ prev?: string;
491
+ /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
492
+ sort?: "name" | "+name" | "-name" | "description" | "+description" | "-description";
493
+ }, options?: ApiCallOptions): Promise<GetGlossariesHttpResponse>;
494
+ type GetGlossariesHttpResponse = {
495
+ data: GlossariesResult;
496
+ headers: Headers;
497
+ status: 200;
498
+ prev?: (options?: ApiCallOptions) => Promise<GetGlossariesHttpResponse>;
499
+ next?: (options?: ApiCallOptions) => Promise<GetGlossariesHttpResponse>;
500
+ };
501
+ type GetGlossariesHttpError = {
502
+ data: ErrorResponse;
503
+ headers: Headers;
504
+ status: 400 | 403;
505
+ };
506
+ /**
507
+ * Only a steward can create a glossary.
508
+ *
509
+ * @param body an object with the body content
510
+ * @throws CreateGlossaryHttpError
511
+ */
512
+ declare function createGlossary(body: CreateGlossary, options?: ApiCallOptions): Promise<CreateGlossaryHttpResponse>;
513
+ type CreateGlossaryHttpResponse = {
514
+ data: Glossary;
515
+ headers: Headers;
516
+ status: 201;
517
+ };
518
+ type CreateGlossaryHttpError = {
519
+ data: ErrorResponse;
520
+ headers: Headers;
521
+ status: 400 | 403;
522
+ };
523
+ /**
524
+ * Creates a new or updates an existing glossary, including categories and terms, based on a glossary definition file.
525
+ * Supported formats are currently, qlik, atlan and atlas.
526
+ *
527
+ * @param query an object with query parameters
528
+ * @param body an object with the body content
529
+ * @throws ImportGlossaryHttpError
530
+ */
531
+ declare function importGlossary(query: {
532
+ /** Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. */
533
+ importerAsFallbackSteward?: boolean;
534
+ /** Using email in the steward fields to lookup userIds in the identity service */
535
+ lookupUserOnEmail?: boolean;
536
+ /** The spaceId (leave blank or omit for personal) */
537
+ spaceId?: string;
538
+ }, body: QlikGlossary, options?: ApiCallOptions): Promise<ImportGlossaryHttpResponse>;
539
+ type ImportGlossaryHttpResponse = {
540
+ data: Glossary;
541
+ headers: Headers;
542
+ status: 201;
543
+ };
544
+ type ImportGlossaryHttpError = ImportGlossary400HttpError | ImportGlossary403HttpError | ImportGlossary404HttpError;
545
+ type ImportGlossary400HttpError = {
546
+ data: ErrorResponseBadRequest;
547
+ headers: Headers;
548
+ status: 400;
549
+ };
550
+ type ImportGlossary403HttpError = {
551
+ data: ErrorResponseForbidden;
552
+ headers: Headers;
553
+ status: 403;
554
+ };
555
+ type ImportGlossary404HttpError = {
556
+ data: ErrorResponseNotFound;
557
+ headers: Headers;
558
+ status: 404;
559
+ };
560
+ /**
561
+ * Deletes a glossary and all of its terms.
562
+ *
563
+ * @param id The id of the glossary to delete.
564
+ * @throws DeleteGlossaryHttpError
565
+ */
566
+ declare function deleteGlossary(id: string, options?: ApiCallOptions): Promise<DeleteGlossaryHttpResponse>;
567
+ type DeleteGlossaryHttpResponse = {
568
+ data: void;
569
+ headers: Headers;
570
+ status: 204;
571
+ };
572
+ type DeleteGlossaryHttpError = {
573
+ data: ErrorResponse;
574
+ headers: Headers;
575
+ status: 400 | 403 | 404;
576
+ };
577
+ /**
578
+ * Retrieves a glossary.
579
+ *
580
+ * @param id The id of the glossary to retrieve.
581
+ * @throws GetGlossaryHttpError
582
+ */
583
+ declare function getGlossary(id: string, options?: ApiCallOptions): Promise<GetGlossaryHttpResponse>;
584
+ type GetGlossaryHttpResponse = {
585
+ data: Glossary;
586
+ headers: Headers;
587
+ status: 200;
588
+ };
589
+ type GetGlossaryHttpError = {
590
+ data: ErrorResponse;
591
+ headers: Headers;
592
+ status: 400 | 403 | 404;
593
+ };
594
+ /**
595
+ * Updates glossary properties with json-patch formatted data.
596
+ *
597
+ * @param id The glossary id.
598
+ * @param body an object with the body content
599
+ * @throws PatchGlossaryHttpError
600
+ */
601
+ declare function patchGlossary(id: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchGlossaryHttpResponse>;
602
+ type PatchGlossaryHttpResponse = {
603
+ data: void;
604
+ headers: Headers;
605
+ status: 204;
606
+ };
607
+ type PatchGlossaryHttpError = {
608
+ data: ErrorResponse;
609
+ headers: Headers;
610
+ status: 400 | 401 | 403 | 404 | 429;
611
+ };
612
+ /**
613
+ * Updates a glossary.
614
+ *
615
+ * @param id The id of the glossary to update.
616
+ * @param body an object with the body content
617
+ * @throws UpdateGlossaryHttpError
618
+ */
619
+ declare function updateGlossary(id: string, body: CreateGlossary, options?: ApiCallOptions): Promise<UpdateGlossaryHttpResponse>;
620
+ type UpdateGlossaryHttpResponse = {
621
+ data: Glossary;
622
+ headers: Headers;
623
+ status: 200;
624
+ };
625
+ type UpdateGlossaryHttpError = {
626
+ data: ErrorResponse;
627
+ headers: Headers;
628
+ status: 400 | 403 | 404;
629
+ };
630
+ /**
631
+ * Exports a glossary.
632
+ *
633
+ * @param id The glossary id.
634
+ * @throws ExportGlossaryHttpError
635
+ */
636
+ declare function exportGlossary(id: string, options?: ApiCallOptions): Promise<ExportGlossaryHttpResponse>;
637
+ type ExportGlossaryHttpResponse = {
638
+ data: ExportGlossary;
639
+ headers: Headers;
640
+ status: 200;
641
+ };
642
+ type ExportGlossaryHttpError = {
643
+ data: ErrorResponse;
644
+ headers: Headers;
645
+ status: 400 | 403 | 404;
646
+ };
647
+ /**
648
+ * Returns a list of categories for a glossary.
649
+ *
650
+ * @param id The glossary id.
651
+ * @param query an object with query parameters
652
+ * @throws GetGlossaryCategoriesHttpError
653
+ */
654
+ declare function getGlossaryCategories(id: string, query: {
655
+ /** Optional parameter to request total count for query */
656
+ countTotal?: boolean;
657
+ /** The number of terms to get. */
658
+ limit?: number;
659
+ /** Optional parameter to request the next page. */
660
+ next?: string;
661
+ /** Optional parameter to request the previous page. */
662
+ prev?: string;
663
+ /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
664
+ sort?: "description" | "+description" | "-description" | "name" | "+name" | "-name" | "update" | "+update" | "-update";
665
+ }, options?: ApiCallOptions): Promise<GetGlossaryCategoriesHttpResponse>;
666
+ type GetGlossaryCategoriesHttpResponse = {
667
+ data: CategoriesResult;
668
+ headers: Headers;
669
+ status: 200;
670
+ prev?: (options?: ApiCallOptions) => Promise<GetGlossaryCategoriesHttpResponse>;
671
+ next?: (options?: ApiCallOptions) => Promise<GetGlossaryCategoriesHttpResponse>;
672
+ };
673
+ type GetGlossaryCategoriesHttpError = {
674
+ data: ErrorResponse;
675
+ headers: Headers;
676
+ status: 400 | 403 | 404;
677
+ };
678
+ /**
679
+ * Creates a new category.
680
+ *
681
+ * @param id The glossary id.
682
+ * @param body an object with the body content
683
+ * @throws CreateGlossaryCategoryHttpError
684
+ */
685
+ declare function createGlossaryCategory(id: string, body: CreateCategory, options?: ApiCallOptions): Promise<CreateGlossaryCategoryHttpResponse>;
686
+ type CreateGlossaryCategoryHttpResponse = {
687
+ data: Category;
688
+ headers: Headers;
689
+ status: 201;
690
+ };
691
+ type CreateGlossaryCategoryHttpError = {
692
+ data: ErrorResponse;
693
+ headers: Headers;
694
+ status: 400 | 403 | 404;
695
+ };
696
+ /**
697
+ * Deletes a category.
698
+ *
699
+ * @param id The id of the glossary.
700
+ * @param categoryId The id for the category to delete. All subcategories are also deleted
701
+ * @throws DeleteGlossaryCategoryHttpError
702
+ */
703
+ declare function deleteGlossaryCategory(id: string, categoryId: string, options?: ApiCallOptions): Promise<DeleteGlossaryCategoryHttpResponse>;
704
+ type DeleteGlossaryCategoryHttpResponse = {
705
+ data: void;
706
+ headers: Headers;
707
+ status: 204;
708
+ };
709
+ type DeleteGlossaryCategoryHttpError = {
710
+ data: ErrorResponse;
711
+ headers: Headers;
712
+ status: 400 | 403 | 404;
713
+ };
714
+ /**
715
+ * Retrieves a category.
716
+ *
717
+ * @param id The glossary id.
718
+ * @param categoryId The category id.
719
+ * @throws GetGlossaryCategoryHttpError
720
+ */
721
+ declare function getGlossaryCategory(id: string, categoryId: string, options?: ApiCallOptions): Promise<GetGlossaryCategoryHttpResponse>;
722
+ type GetGlossaryCategoryHttpResponse = {
723
+ data: Category;
724
+ headers: Headers;
725
+ status: 200;
726
+ };
727
+ type GetGlossaryCategoryHttpError = {
728
+ data: ErrorResponse;
729
+ headers: Headers;
730
+ status: 400 | 403 | 404;
731
+ };
732
+ /**
733
+ * Updates category properties with json-patch formatted data.
734
+ *
735
+ * @param id The glossary id.
736
+ * @param categoryId The category id.
737
+ * @param body an object with the body content
738
+ * @throws PatchGlossaryCategoryHttpError
739
+ */
740
+ declare function patchGlossaryCategory(id: string, categoryId: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchGlossaryCategoryHttpResponse>;
741
+ type PatchGlossaryCategoryHttpResponse = {
742
+ data: void;
743
+ headers: Headers;
744
+ status: 204;
745
+ };
746
+ type PatchGlossaryCategoryHttpError = {
747
+ data: ErrorResponse;
748
+ headers: Headers;
749
+ status: 400 | 401 | 403 | 404 | 429;
750
+ };
751
+ /**
752
+ * Updates a category.
753
+ *
754
+ * @param id The glossary id.
755
+ * @param categoryId The category id.
756
+ * @param body an object with the body content
757
+ * @throws UpdateGlossaryCategoryHttpError
758
+ */
759
+ declare function updateGlossaryCategory(id: string, categoryId: string, body: CreateCategory, options?: ApiCallOptions): Promise<UpdateGlossaryCategoryHttpResponse>;
760
+ type UpdateGlossaryCategoryHttpResponse = {
761
+ data: Category;
762
+ headers: Headers;
763
+ status: 200;
764
+ };
765
+ type UpdateGlossaryCategoryHttpError = {
766
+ data: ErrorResponse;
767
+ headers: Headers;
768
+ status: 400 | 403 | 404;
769
+ };
770
+ /**
771
+ * Returns a list of terms for a glossary.
772
+ *
773
+ * @param id The glossary id.
774
+ * @param query an object with query parameters
775
+ * @throws GetGlossaryTermsHttpError
776
+ */
777
+ declare function getGlossaryTerms(id: string, query: {
778
+ /** Optional parameter to request total count for query */
779
+ countTotal?: boolean;
780
+ /** Optional SCIM filter to be used to filter terms
781
+ * Usable fields are
782
+ *
783
+ * - id
784
+ * - name
785
+ * - relatedInformation
786
+ * - description
787
+ * - abbreviation
788
+ * - tags
789
+ * - stewards
790
+ * - status
791
+ * - categories */
792
+ filter?: string;
793
+ /** The number of terms to get. */
794
+ limit?: number;
795
+ /** Optional parameter to request the next page. */
796
+ next?: string;
797
+ /** Optional parameter to request the previous page. */
798
+ prev?: string;
799
+ /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
800
+ sort?: "abbreviation" | "+abbreviation" | "-abbreviation" | "description" | "+description" | "-description" | "name" | "+name" | "-name" | "status" | "+status" | "-status" | "updated" | "+updated" | "-updated";
801
+ }, options?: ApiCallOptions): Promise<GetGlossaryTermsHttpResponse>;
802
+ type GetGlossaryTermsHttpResponse = {
803
+ data: TermsResult;
804
+ headers: Headers;
805
+ status: 200;
806
+ prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermsHttpResponse>;
807
+ next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermsHttpResponse>;
808
+ };
809
+ type GetGlossaryTermsHttpError = {
810
+ data: ErrorResponse;
811
+ headers: Headers;
812
+ status: 400 | 403 | 404;
813
+ };
814
+ /**
815
+ * Creates a new term.
816
+ *
817
+ * @param id The glossary id.
818
+ * @param body an object with the body content
819
+ * @throws CreateGlossaryTermHttpError
820
+ */
821
+ declare function createGlossaryTerm(id: string, body: CreateTerm, options?: ApiCallOptions): Promise<CreateGlossaryTermHttpResponse>;
822
+ type CreateGlossaryTermHttpResponse = {
823
+ data: Term;
824
+ headers: Headers;
825
+ status: 201;
826
+ };
827
+ type CreateGlossaryTermHttpError = {
828
+ data: ErrorResponse;
829
+ headers: Headers;
830
+ status: 400 | 403 | 404;
831
+ };
832
+ /**
833
+ * Deletes a term.
834
+ *
835
+ * @param id The glossary id.
836
+ * @param termId The term id.
837
+ * @throws DeleteGlossaryTermHttpError
838
+ */
839
+ declare function deleteGlossaryTerm(id: string, termId: string, options?: ApiCallOptions): Promise<DeleteGlossaryTermHttpResponse>;
840
+ type DeleteGlossaryTermHttpResponse = {
841
+ data: void;
842
+ headers: Headers;
843
+ status: 204;
844
+ };
845
+ type DeleteGlossaryTermHttpError = {
846
+ data: ErrorResponse;
847
+ headers: Headers;
848
+ status: 400 | 403 | 404;
849
+ };
850
+ /**
851
+ * Retrieves a term.
852
+ *
853
+ * @param id The glossary id.
854
+ * @param termId The term id.
855
+ * @throws GetGlossaryTermHttpError
856
+ */
857
+ declare function getGlossaryTerm(id: string, termId: string, options?: ApiCallOptions): Promise<GetGlossaryTermHttpResponse>;
858
+ type GetGlossaryTermHttpResponse = {
859
+ data: Term;
860
+ headers: Headers;
861
+ status: 200;
862
+ };
863
+ type GetGlossaryTermHttpError = {
864
+ data: ErrorResponse;
865
+ headers: Headers;
866
+ status: 400 | 403 | 404;
867
+ };
868
+ /**
869
+ * Updates term properties with json-patch formatted data
870
+ *
871
+ * @param id The glossary id.
872
+ * @param termId The term id.
873
+ * @param body an object with the body content
874
+ * @throws PatchGlossaryTermHttpError
875
+ */
876
+ declare function patchGlossaryTerm(id: string, termId: string, body: JSONPatchArray, options?: ApiCallOptions): Promise<PatchGlossaryTermHttpResponse>;
877
+ type PatchGlossaryTermHttpResponse = {
878
+ data: void;
879
+ headers: Headers;
880
+ status: 204;
881
+ };
882
+ type PatchGlossaryTermHttpError = {
883
+ data: ErrorResponse;
884
+ headers: Headers;
885
+ status: 400 | 401 | 403 | 404 | 412 | 429;
886
+ };
887
+ /**
888
+ * Updates a term.
889
+ *
890
+ * @param id The glossary id.
891
+ * @param termId The term id.
892
+ * @param body an object with the body content
893
+ * @throws UpdateGlossaryTermHttpError
894
+ */
895
+ declare function updateGlossaryTerm(id: string, termId: string, body: CreateTerm, options?: ApiCallOptions): Promise<UpdateGlossaryTermHttpResponse>;
896
+ type UpdateGlossaryTermHttpResponse = {
897
+ data: Term;
898
+ headers: Headers;
899
+ status: 200;
900
+ };
901
+ type UpdateGlossaryTermHttpError = {
902
+ data: ErrorResponse;
903
+ headers: Headers;
904
+ status: 400 | 403 | 404 | 412;
905
+ };
906
+ /**
907
+ * Only a steward can verify a term. Once the term is verified only a steward can modify the term. Note that links to resources are considered external relations that can be managed independently of the status of the term.
908
+ *
909
+ * @param id The glossary id.
910
+ * @param termId The term id.
911
+ * @param query an object with query parameters
912
+ * @throws ChangeGlossaryTermStatusHttpError
913
+ */
914
+ declare function changeGlossaryTermStatus(id: string, termId: string, query: {
915
+ /** The status to update to. */
916
+ status: "draft" | "verified" | "deprecated";
917
+ }, options?: ApiCallOptions): Promise<ChangeGlossaryTermStatusHttpResponse>;
918
+ type ChangeGlossaryTermStatusHttpResponse = {
919
+ data: Term;
920
+ headers: Headers;
921
+ status: 200;
922
+ };
923
+ type ChangeGlossaryTermStatusHttpError = {
924
+ data: ErrorResponse;
925
+ headers: Headers;
926
+ status: 400 | 403 | 404 | 412;
927
+ };
928
+ /**
929
+ * Returns a list of links assigned to a term.
930
+ *
931
+ * @param id The glossary id.
932
+ * @param termId The term id.
933
+ * @param query an object with query parameters
934
+ * @throws GetGlossaryTermLinksHttpError
935
+ */
936
+ declare function getGlossaryTermLinks(id: string, termId: string, query: {
937
+ /** Optional parameter to request total count for query */
938
+ countTotal?: boolean;
939
+ /** Optional SCIM filter to be used to filter terms */
940
+ filter?: string;
941
+ /** The number of terms to get. */
942
+ limit?: number;
943
+ /** Optional parameter to request the next page. */
944
+ next?: string;
945
+ /** Optional parameter to request the previous page. */
946
+ prev?: string;
947
+ /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
948
+ sort?: "type" | "+type" | "-type" | "subtype" | "+subtype" | "-subtype" | "created" | "+created" | "-created";
949
+ }, options?: ApiCallOptions): Promise<GetGlossaryTermLinksHttpResponse>;
950
+ type GetGlossaryTermLinksHttpResponse = {
951
+ data: LinksResult;
952
+ headers: Headers;
953
+ status: 200;
954
+ prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermLinksHttpResponse>;
955
+ next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermLinksHttpResponse>;
956
+ };
957
+ type GetGlossaryTermLinksHttpError = {
958
+ data: ErrorResponse;
959
+ headers: Headers;
960
+ status: 400 | 403 | 404;
961
+ };
962
+ /**
963
+ * Links to resources are not considered term properties but external relations. Links can be created for terms in any status. Permissions on term and resource determine if the link can be created.
964
+ *
965
+ * @param id The glossary id.
966
+ * @param termId The term id.
967
+ * @param body an object with the body content
968
+ * @throws CreateGlossaryTermLinkHttpError
969
+ */
970
+ declare function createGlossaryTermLink(id: string, termId: string, body: TermCreateLinksTo, options?: ApiCallOptions): Promise<CreateGlossaryTermLinkHttpResponse>;
971
+ type CreateGlossaryTermLinkHttpResponse = {
972
+ data: TermLinksTo;
973
+ headers: Headers;
974
+ status: 201;
975
+ };
976
+ type CreateGlossaryTermLinkHttpError = {
977
+ data: ErrorResponse;
978
+ headers: Headers;
979
+ status: 400 | 403 | 404 | 412;
980
+ };
981
+ /**
982
+ * Retrieves previous revisions of a term.
983
+ *
984
+ * @param id The glossary id.
985
+ * @param termId The term id.
986
+ * @param query an object with query parameters
987
+ * @throws GetGlossaryTermRevisionsHttpError
988
+ */
989
+ declare function getGlossaryTermRevisions(id: string, termId: string, query: {
990
+ /** Optional parameter to request total count for query */
991
+ countTotal?: boolean;
992
+ /** The number of terms to get. */
993
+ limit?: number;
994
+ /** Optional parameter to request the next page. */
995
+ next?: string;
996
+ /** Optional parameter to request the previous page. */
997
+ prev?: string;
998
+ /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
999
+ sort?: "update" | "+update" | "-update";
1000
+ }, options?: ApiCallOptions): Promise<GetGlossaryTermRevisionsHttpResponse>;
1001
+ type GetGlossaryTermRevisionsHttpResponse = {
1002
+ data: TermsResult;
1003
+ headers: Headers;
1004
+ status: 200;
1005
+ prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermRevisionsHttpResponse>;
1006
+ next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermRevisionsHttpResponse>;
1007
+ };
1008
+ type GetGlossaryTermRevisionsHttpError = {
1009
+ data: ErrorResponse;
1010
+ headers: Headers;
1011
+ status: 400 | 403 | 404;
1012
+ };
1013
+ /**
1014
+ * Clears the cache for glossaries api requests.
1015
+ */
1016
+ declare function clearCache(): void;
1017
+ type GlossariesAPI = {
1018
+ /**
1019
+ * Returns all glossaries.
1020
+ *
1021
+ * @param query an object with query parameters
1022
+ * @throws GetGlossariesHttpError
1023
+ */
1024
+ getGlossaries: typeof getGlossaries;
1025
+ /**
1026
+ * Only a steward can create a glossary.
1027
+ *
1028
+ * @param body an object with the body content
1029
+ * @throws CreateGlossaryHttpError
1030
+ */
1031
+ createGlossary: typeof createGlossary;
1032
+ /**
1033
+ * Creates a new or updates an existing glossary, including categories and terms, based on a glossary definition file.
1034
+ * Supported formats are currently, qlik, atlan and atlas.
1035
+ *
1036
+ * @param query an object with query parameters
1037
+ * @param body an object with the body content
1038
+ * @throws ImportGlossaryHttpError
1039
+ */
1040
+ importGlossary: typeof importGlossary;
1041
+ /**
1042
+ * Deletes a glossary and all of its terms.
1043
+ *
1044
+ * @param id The id of the glossary to delete.
1045
+ * @throws DeleteGlossaryHttpError
1046
+ */
1047
+ deleteGlossary: typeof deleteGlossary;
1048
+ /**
1049
+ * Retrieves a glossary.
1050
+ *
1051
+ * @param id The id of the glossary to retrieve.
1052
+ * @throws GetGlossaryHttpError
1053
+ */
1054
+ getGlossary: typeof getGlossary;
1055
+ /**
1056
+ * Updates glossary properties with json-patch formatted data.
1057
+ *
1058
+ * @param id The glossary id.
1059
+ * @param body an object with the body content
1060
+ * @throws PatchGlossaryHttpError
1061
+ */
1062
+ patchGlossary: typeof patchGlossary;
1063
+ /**
1064
+ * Updates a glossary.
1065
+ *
1066
+ * @param id The id of the glossary to update.
1067
+ * @param body an object with the body content
1068
+ * @throws UpdateGlossaryHttpError
1069
+ */
1070
+ updateGlossary: typeof updateGlossary;
1071
+ /**
1072
+ * Exports a glossary.
1073
+ *
1074
+ * @param id The glossary id.
1075
+ * @throws ExportGlossaryHttpError
1076
+ */
1077
+ exportGlossary: typeof exportGlossary;
1078
+ /**
1079
+ * Returns a list of categories for a glossary.
1080
+ *
1081
+ * @param id The glossary id.
1082
+ * @param query an object with query parameters
1083
+ * @throws GetGlossaryCategoriesHttpError
1084
+ */
1085
+ getGlossaryCategories: typeof getGlossaryCategories;
1086
+ /**
1087
+ * Creates a new category.
1088
+ *
1089
+ * @param id The glossary id.
1090
+ * @param body an object with the body content
1091
+ * @throws CreateGlossaryCategoryHttpError
1092
+ */
1093
+ createGlossaryCategory: typeof createGlossaryCategory;
1094
+ /**
1095
+ * Deletes a category.
1096
+ *
1097
+ * @param id The id of the glossary.
1098
+ * @param categoryId The id for the category to delete. All subcategories are also deleted
1099
+ * @throws DeleteGlossaryCategoryHttpError
1100
+ */
1101
+ deleteGlossaryCategory: typeof deleteGlossaryCategory;
1102
+ /**
1103
+ * Retrieves a category.
1104
+ *
1105
+ * @param id The glossary id.
1106
+ * @param categoryId The category id.
1107
+ * @throws GetGlossaryCategoryHttpError
1108
+ */
1109
+ getGlossaryCategory: typeof getGlossaryCategory;
1110
+ /**
1111
+ * Updates category properties with json-patch formatted data.
1112
+ *
1113
+ * @param id The glossary id.
1114
+ * @param categoryId The category id.
1115
+ * @param body an object with the body content
1116
+ * @throws PatchGlossaryCategoryHttpError
1117
+ */
1118
+ patchGlossaryCategory: typeof patchGlossaryCategory;
1119
+ /**
1120
+ * Updates a category.
1121
+ *
1122
+ * @param id The glossary id.
1123
+ * @param categoryId The category id.
1124
+ * @param body an object with the body content
1125
+ * @throws UpdateGlossaryCategoryHttpError
1126
+ */
1127
+ updateGlossaryCategory: typeof updateGlossaryCategory;
1128
+ /**
1129
+ * Returns a list of terms for a glossary.
1130
+ *
1131
+ * @param id The glossary id.
1132
+ * @param query an object with query parameters
1133
+ * @throws GetGlossaryTermsHttpError
1134
+ */
1135
+ getGlossaryTerms: typeof getGlossaryTerms;
1136
+ /**
1137
+ * Creates a new term.
1138
+ *
1139
+ * @param id The glossary id.
1140
+ * @param body an object with the body content
1141
+ * @throws CreateGlossaryTermHttpError
1142
+ */
1143
+ createGlossaryTerm: typeof createGlossaryTerm;
1144
+ /**
1145
+ * Deletes a term.
1146
+ *
1147
+ * @param id The glossary id.
1148
+ * @param termId The term id.
1149
+ * @throws DeleteGlossaryTermHttpError
1150
+ */
1151
+ deleteGlossaryTerm: typeof deleteGlossaryTerm;
1152
+ /**
1153
+ * Retrieves a term.
1154
+ *
1155
+ * @param id The glossary id.
1156
+ * @param termId The term id.
1157
+ * @throws GetGlossaryTermHttpError
1158
+ */
1159
+ getGlossaryTerm: typeof getGlossaryTerm;
1160
+ /**
1161
+ * Updates term properties with json-patch formatted data
1162
+ *
1163
+ * @param id The glossary id.
1164
+ * @param termId The term id.
1165
+ * @param body an object with the body content
1166
+ * @throws PatchGlossaryTermHttpError
1167
+ */
1168
+ patchGlossaryTerm: typeof patchGlossaryTerm;
1169
+ /**
1170
+ * Updates a term.
1171
+ *
1172
+ * @param id The glossary id.
1173
+ * @param termId The term id.
1174
+ * @param body an object with the body content
1175
+ * @throws UpdateGlossaryTermHttpError
1176
+ */
1177
+ updateGlossaryTerm: typeof updateGlossaryTerm;
1178
+ /**
1179
+ * Only a steward can verify a term. Once the term is verified only a steward can modify the term. Note that links to resources are considered external relations that can be managed independently of the status of the term.
1180
+ *
1181
+ * @param id The glossary id.
1182
+ * @param termId The term id.
1183
+ * @param query an object with query parameters
1184
+ * @throws ChangeGlossaryTermStatusHttpError
1185
+ */
1186
+ changeGlossaryTermStatus: typeof changeGlossaryTermStatus;
1187
+ /**
1188
+ * Returns a list of links assigned to a term.
1189
+ *
1190
+ * @param id The glossary id.
1191
+ * @param termId The term id.
1192
+ * @param query an object with query parameters
1193
+ * @throws GetGlossaryTermLinksHttpError
1194
+ */
1195
+ getGlossaryTermLinks: typeof getGlossaryTermLinks;
1196
+ /**
1197
+ * Links to resources are not considered term properties but external relations. Links can be created for terms in any status. Permissions on term and resource determine if the link can be created.
1198
+ *
1199
+ * @param id The glossary id.
1200
+ * @param termId The term id.
1201
+ * @param body an object with the body content
1202
+ * @throws CreateGlossaryTermLinkHttpError
1203
+ */
1204
+ createGlossaryTermLink: typeof createGlossaryTermLink;
1205
+ /**
1206
+ * Retrieves previous revisions of a term.
1207
+ *
1208
+ * @param id The glossary id.
1209
+ * @param termId The term id.
1210
+ * @param query an object with query parameters
1211
+ * @throws GetGlossaryTermRevisionsHttpError
1212
+ */
1213
+ getGlossaryTermRevisions: typeof getGlossaryTermRevisions;
1214
+ /**
1215
+ * Clears the cache for glossaries api requests.
1216
+ */
1217
+ clearCache: typeof clearCache;
1218
+ };
1219
+ /**
1220
+ * Functions for the glossaries api
1221
+ */
1222
+ declare const glossariesExport: GlossariesAPI;
1223
+ //#endregion
4
1224
  export { AtlanEntity, AtlanEntityAttributes, AtlanGlossary, AtlanRelationEntity, AtlanRelationshipAttributes, AtlanResourceLink, AtlanTermHeader, AtlasCategory, AtlasGlossary, AtlasTerm, CategoriesResult, Category, ChangeGlossaryTermStatusHttpError, ChangeGlossaryTermStatusHttpResponse, CreateCategory, CreateGlossary, CreateGlossaryCategoryHttpError, CreateGlossaryCategoryHttpResponse, CreateGlossaryHttpError, CreateGlossaryHttpResponse, CreateGlossaryTermHttpError, CreateGlossaryTermHttpResponse, CreateGlossaryTermLinkHttpError, CreateGlossaryTermLinkHttpResponse, CreateTerm, DeleteGlossaryCategoryHttpError, DeleteGlossaryCategoryHttpResponse, DeleteGlossaryHttpError, DeleteGlossaryHttpResponse, DeleteGlossaryTermHttpError, DeleteGlossaryTermHttpResponse, ErrorResponse, ErrorResponseBadRequest, ErrorResponseCode, ErrorResponseForbidden, ErrorResponseNotFound, ExportCategory, ExportGlossary, ExportGlossaryHttpError, ExportGlossaryHttpResponse, ExportTerm, GetGlossariesHttpError, GetGlossariesHttpResponse, GetGlossaryCategoriesHttpError, GetGlossaryCategoriesHttpResponse, GetGlossaryCategoryHttpError, GetGlossaryCategoryHttpResponse, GetGlossaryHttpError, GetGlossaryHttpResponse, GetGlossaryTermHttpError, GetGlossaryTermHttpResponse, GetGlossaryTermLinksHttpError, GetGlossaryTermLinksHttpResponse, GetGlossaryTermRevisionsHttpError, GetGlossaryTermRevisionsHttpResponse, GetGlossaryTermsHttpError, GetGlossaryTermsHttpResponse, GlossariesAPI, GlossariesResult, Glossary, ImportCategory, ImportGlossary400HttpError, ImportGlossary403HttpError, ImportGlossary404HttpError, ImportGlossaryHttpError, ImportGlossaryHttpResponse, ImportOwner, ImportTerm, JSONPatch, JSONPatchArray, LinksResult, PageLink, PageLinks, PatchGlossaryCategoryHttpError, PatchGlossaryCategoryHttpResponse, PatchGlossaryHttpError, PatchGlossaryHttpResponse, PatchGlossaryTermHttpError, PatchGlossaryTermHttpResponse, QlikGlossary, ResultMeta, StewardDetail, Term, TermCreateLinksTo, TermLinksTo, TermRelatesTo, TermStatus, TermTemplate, TermsResult, UpdateGlossaryCategoryHttpError, UpdateGlossaryCategoryHttpResponse, UpdateGlossaryHttpError, UpdateGlossaryHttpResponse, UpdateGlossaryTermHttpError, UpdateGlossaryTermHttpResponse, changeGlossaryTermStatus, clearCache, createGlossary, createGlossaryCategory, createGlossaryTerm, createGlossaryTermLink, glossariesExport as default, deleteGlossary, deleteGlossaryCategory, deleteGlossaryTerm, exportGlossary, getGlossaries, getGlossary, getGlossaryCategories, getGlossaryCategory, getGlossaryTerm, getGlossaryTermLinks, getGlossaryTermRevisions, getGlossaryTerms, importGlossary, patchGlossary, patchGlossaryCategory, patchGlossaryTerm, updateGlossary, updateGlossaryCategory, updateGlossaryTerm };