@qlik/api 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,582 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/collections.d.ts
4
- type CollectionByIdPatch = {
5
- /** The operation to be performed. */
6
- op: "replace";
7
- /** Field of collection to be patched. */
8
- path: "/name" | "/description" | "/type";
9
- /** The value to be used within the operations.
10
- * - name: The name of the collection. Must not be "".
11
- * - description: The description of the collection. Empty string "" is allowed.
12
- * - type: The type of the collection. Via this path the collection type can be toggled between "private" and "publicgoverned". */
13
- value: string;
14
- }[];
15
- type CollectionTypes = "private" | "public" | "publicgoverned";
16
- type CollectionsAddCollectionItemRequestBody = {
17
- /** The item's unique identifier. */
18
- id: string;
19
- };
20
- type CollectionsCreateCollectionRequestBody = {
21
- description?: string;
22
- /** For `public` collections (tags), if name already exists in the tenant as a `public` collection, this call will fail with a `409` response. */
23
- name: string;
24
- type: CollectionTypes;
25
- };
26
- /**
27
- * ListCollectionItemsResponseBody result type
28
- */
29
- type CollectionsListCollectionItemsResponseBody = {
30
- data: ItemResultResponseBody[];
31
- };
32
- /**
33
- * ListCollectionsResponseBody result type
34
- */
35
- type CollectionsListCollectionsResponseBody = {
36
- data: CollectionResultResponseBody[];
37
- links: CollectionsLinksResponseBody;
38
- };
39
- type CollectionsUpdateCollectionRequestBody = {
40
- description?: string;
41
- name?: string;
42
- };
43
- type ErrorResponseBody = {
44
- errors?: ServiceError[];
45
- };
46
- type Link = {
47
- href?: string;
48
- };
49
- type ServiceError = {
50
- /** Code is a unique identifier for this error class. */
51
- code?: string;
52
- /** Detail is a human-readable explanation specific to this occurrence of the problem. */
53
- detail?: string;
54
- meta?: Meta;
55
- /** Title is the name of this class of errors. */
56
- title?: string;
57
- };
58
- type CollectionLinksResponseBody = {
59
- items?: Link;
60
- self?: Link;
61
- };
62
- /**
63
- * Collection metadata and computed fields.
64
- */
65
- type CollectionMetaResponseBody = {
66
- /** Multiple items. */
67
- items?: ItemsResultResponseBody;
68
- };
69
- /**
70
- * A collection.
71
- */
72
- type CollectionResultResponseBody = {
73
- /** The RFC3339 datetime when the collection was created. */
74
- createdAt: string;
75
- /** The ID of the user who created the collection. This property is only populated if the JWT contains a userId. */
76
- creatorId?: string;
77
- description?: string;
78
- /** States if a collection has reached its items limit or not */
79
- full?: boolean;
80
- /** The collection's unique identifier. */
81
- id: string;
82
- /** The number of items that have been added to the collection that the user has access to. */
83
- itemCount: number;
84
- links: CollectionLinksResponseBody;
85
- /** Collection metadata and computed fields. */
86
- meta?: CollectionMetaResponseBody;
87
- name: string;
88
- /** The ID of the tenant that owns the collection. This property is populated by using JWT. */
89
- tenantId: string;
90
- type: "private" | "public" | "favorite" | "publicgoverned";
91
- /** The RFC3339 datetime when the collection was last updated. */
92
- updatedAt: string;
93
- /** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
94
- updaterId?: string;
95
- };
96
- type CollectionsLinksResponseBody = {
97
- item?: Link;
98
- next?: Link;
99
- prev?: Link;
100
- self?: Link;
101
- };
102
- type ItemLinksResponseBody = {
103
- collections?: Link;
104
- open?: Link;
105
- qvPlugin?: Link;
106
- self?: Link;
107
- thumbnail?: Link;
108
- };
109
- /**
110
- * Item metadata and computed fields.
111
- */
112
- type ItemMetaResponseBody = {
113
- /** The actions that the user can perform on the item. */
114
- actions: string[];
115
- /** An array of collections that the item is part of. */
116
- collections: ItemTagResponseBody[];
117
- /** The flag that indicates if item is in the user's favorites collection. */
118
- isFavorited: boolean;
119
- /** An array of tags that the item is part of. */
120
- tags: ItemTagResponseBody[];
121
- };
122
- /**
123
- * The case-sensitive string defining the item's type.
124
- */
125
- type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment" | "assistant" | "dataproduct" | "dataqualityrule" | "glossary" | "knowledgebase" | "script";
126
- /**
127
- * An item.
128
- */
129
- type ItemResultResponseBody = {
130
- /** The actions that the user can perform on the item. */
131
- actions: string[];
132
- /** The ID of the collections that the item has been added to. */
133
- collectionIds: string[];
134
- /** The RFC3339 datetime when the item was created. */
135
- createdAt: string;
136
- /** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
137
- creatorId?: string;
138
- description?: string;
139
- /** The item's unique identifier. */
140
- id: string;
141
- /** The flag that indicates if item is in the user's favorites collection. */
142
- isFavorited: boolean;
143
- itemViews?: ItemViewsResponseBody;
144
- links: ItemLinksResponseBody;
145
- /** Item metadata and computed fields. */
146
- meta: ItemMetaResponseBody;
147
- name: string;
148
- /** The ID of the user who owns the item. */
149
- ownerId?: string;
150
- resourceAttributes: unknown;
151
- /** The RFC3339 datetime when the resource that the item references was created. */
152
- resourceCreatedAt: string;
153
- resourceCustomAttributes: unknown;
154
- /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
155
- resourceId?: string;
156
- /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
157
- resourceLink?: string;
158
- /** The RFC3339 datetime when the resource last reload ended. */
159
- resourceReloadEndTime?: string;
160
- /** If the resource last reload was successful or not. */
161
- resourceReloadStatus?: string;
162
- resourceSize?: ItemsResourceSizeResponseBody;
163
- /** Optional field defining the item's subtype, if any. */
164
- resourceSubType?: string;
165
- /** The case-sensitive string defining the item's type. */
166
- resourceType: ItemResourceTypeEnum;
167
- /** The RFC3339 datetime when the resource that the item references was last updated. */
168
- resourceUpdatedAt: string;
169
- /** The space's unique identifier. */
170
- spaceId?: string;
171
- /** The ID of the tenant that owns the item. This is populated using the JWT. */
172
- tenantId: string;
173
- /** The item thumbnail's unique identifier. This is optional for internal resources. */
174
- thumbnailId?: string;
175
- /** The RFC3339 datetime when the item was last updated. */
176
- updatedAt: string;
177
- /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
178
- updaterId?: string;
179
- };
180
- /**
181
- * Holds basic information about a tag or collection.
182
- */
183
- type ItemTagResponseBody = {
184
- /** The ID of the tag/collection. */
185
- id: string;
186
- /** The name of the tag/collection. */
187
- name: string;
188
- };
189
- type ItemViewsResponseBody = {
190
- /** Total number of views the resource got during the last 28 days. */
191
- total?: number;
192
- /** Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks. */
193
- trend?: number;
194
- /** Number of unique users who viewed the resource during the last 28 days. */
195
- unique?: number;
196
- /** Number of apps this dataset is used in (datasets only). */
197
- usedBy?: number;
198
- week?: ItemViewsWeeksResponseBody[];
199
- };
200
- type ItemViewsWeeksResponseBody = {
201
- /** The RFC3339 datetime representing the start of the referenced week. */
202
- start?: string;
203
- /** Total number of views the resource got during the referenced week. */
204
- total?: number;
205
- /** Number of unique users who viewed the resource during the referenced week. */
206
- unique?: number;
207
- };
208
- type ItemsLinksResponseBody = {
209
- collection?: Link;
210
- next?: Link;
211
- prev?: Link;
212
- self?: Link;
213
- };
214
- type ItemsResourceSizeResponseBody = {
215
- /** Size of the app on disk in bytes. */
216
- appFile?: number;
217
- /** Size of the app in memory in bytes. */
218
- appMemory?: number;
219
- };
220
- /**
221
- * Multiple items.
222
- */
223
- type ItemsResultResponseBody = {
224
- data: ItemResultResponseBody[];
225
- links: ItemsLinksResponseBody;
226
- };
227
- type Meta = {
228
- /** Further explanation of the error */
229
- explain?: unknown;
230
- /** Is the error a server-side fault? */
231
- fault?: boolean;
232
- /** Is the error temporary? */
233
- temporary?: boolean;
234
- /** Is the error a timeout? */
235
- timeout?: boolean;
236
- };
237
- /**
238
- * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
239
- *
240
- * @param query an object with query parameters
241
- * @throws GetCollectionsHttpError
242
- */
243
- declare function getCollections(query: {
244
- /** The case-sensitive string used to search for a resource by creatorId. */
245
- creatorId?: string;
246
- /** The collection's unique identifier. */
247
- id?: string;
248
- /** Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets. */
249
- includeItems?: string;
250
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
251
- limit?: number;
252
- /** The case-sensitive string used to search for a collection by name. */
253
- name?: string;
254
- /** The cursor to the next page of resources. Provide either the
255
- * next or prev cursor, but not both. */
256
- next?: string;
257
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
258
- prev?: string;
259
- /** The case-insensitive string used to search for a resource by name or description. */
260
- query?: string;
261
- /** The property of a resource to sort on (default sort is +createdAt).
262
- * The supported properties are createdAt, updatedAt, and name. A property
263
- * must be prefixed by + or - to indicate ascending or descending sort order
264
- * respectively. */
265
- sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
266
- /** The case-sensitive string used to filter for a collection by type. Retrieve private collections with `private`, public collections with `publicgoverned`, and tags with `public`. */
267
- type?: CollectionTypes;
268
- /** A comma-separated case-sensitive string used to filter by multiple types. */
269
- types?: CollectionTypes[];
270
- }, options?: ApiCallOptions): Promise<GetCollectionsHttpResponse>;
271
- type GetCollectionsHttpResponse = {
272
- data: CollectionsListCollectionsResponseBody;
273
- headers: Headers;
274
- status: 200;
275
- prev?: (options?: ApiCallOptions) => Promise<GetCollectionsHttpResponse>;
276
- next?: (options?: ApiCallOptions) => Promise<GetCollectionsHttpResponse>;
277
- };
278
- type GetCollectionsHttpError = {
279
- data: ErrorResponseBody;
280
- headers: Headers;
281
- status: 400 | 401 | 500;
282
- };
283
- /**
284
- * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
285
- *
286
- * @param body an object with the body content
287
- * @throws CreateCollectionHttpError
288
- */
289
- declare function createCollection(body: CollectionsCreateCollectionRequestBody, options?: ApiCallOptions): Promise<CreateCollectionHttpResponse>;
290
- type CreateCollectionHttpResponse = {
291
- data: CollectionResultResponseBody;
292
- headers: Headers;
293
- status: 201;
294
- };
295
- type CreateCollectionHttpError = {
296
- data: ErrorResponseBody;
297
- headers: Headers;
298
- status: 400 | 401 | 403 | 409 | 500;
299
- };
300
- /**
301
- * Lists the user's favorites collection.
302
- *
303
- * @throws GetFavoritesCollectionHttpError
304
- */
305
- declare function getFavoritesCollection(options?: ApiCallOptions): Promise<GetFavoritesCollectionHttpResponse>;
306
- type GetFavoritesCollectionHttpResponse = {
307
- data: CollectionResultResponseBody;
308
- headers: Headers;
309
- status: 200;
310
- };
311
- type GetFavoritesCollectionHttpError = {
312
- data: ErrorResponseBody;
313
- headers: Headers;
314
- status: 401 | 404 | 500;
315
- };
316
- /**
317
- * Deletes a collection and removes all items from the collection.
318
- *
319
- * @param collectionId The collection's unique identifier.
320
- * @throws DeleteCollectionHttpError
321
- */
322
- declare function deleteCollection(collectionId: string, options?: ApiCallOptions): Promise<DeleteCollectionHttpResponse>;
323
- type DeleteCollectionHttpResponse = {
324
- data: void;
325
- headers: Headers;
326
- status: 204;
327
- };
328
- type DeleteCollectionHttpError = {
329
- data: ErrorResponseBody;
330
- headers: Headers;
331
- status: 401 | 404 | 500;
332
- };
333
- /**
334
- * Finds and returns a collection.
335
- *
336
- * @param collectionId The collection's unique identifier.
337
- * @throws GetCollectionHttpError
338
- */
339
- declare function getCollection(collectionId: string, options?: ApiCallOptions): Promise<GetCollectionHttpResponse>;
340
- type GetCollectionHttpResponse = {
341
- data: CollectionResultResponseBody;
342
- headers: Headers;
343
- status: 200;
344
- };
345
- type GetCollectionHttpError = {
346
- data: ErrorResponseBody;
347
- headers: Headers;
348
- status: 400 | 401 | 404 | 500;
349
- };
350
- /**
351
- * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
352
- *
353
- * @param collectionId The collection's unique identifier.
354
- * @param body an object with the body content
355
- * @throws PatchCollectionHttpError
356
- */
357
- declare function patchCollection(collectionId: string, body: CollectionByIdPatch, options?: ApiCallOptions): Promise<PatchCollectionHttpResponse>;
358
- type PatchCollectionHttpResponse = {
359
- data: CollectionResultResponseBody;
360
- headers: Headers;
361
- status: 200;
362
- };
363
- type PatchCollectionHttpError = {
364
- data: ErrorResponseBody;
365
- headers: Headers;
366
- status: 400 | 401 | 404 | 409 | 500;
367
- };
368
- /**
369
- * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
370
- *
371
- * @param collectionId The collection's unique identifier.
372
- * @param body an object with the body content
373
- * @throws UpdateCollectionHttpError
374
- */
375
- declare function updateCollection(collectionId: string, body: CollectionsUpdateCollectionRequestBody, options?: ApiCallOptions): Promise<UpdateCollectionHttpResponse>;
376
- type UpdateCollectionHttpResponse = {
377
- data: CollectionResultResponseBody;
378
- headers: Headers;
379
- status: 200;
380
- };
381
- type UpdateCollectionHttpError = {
382
- data: ErrorResponseBody;
383
- headers: Headers;
384
- status: 400 | 401 | 404 | 409 | 500;
385
- };
386
- /**
387
- * Retrieves items from a collection that the user has access to.
388
- *
389
- * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
390
-
391
- * @param query an object with query parameters
392
- * @throws GetCollectionItemsHttpError
393
- */
394
- declare function getCollectionItems(collectionId: string, query: {
395
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
396
- limit?: number;
397
- /** The case-insensitive string used to search for a resource by name. */
398
- name?: string;
399
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
400
- next?: string;
401
- /** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time). */
402
- noActions?: boolean;
403
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
404
- prev?: string;
405
- /** The case-insensitive string used to search for a resource by name or description. */
406
- query?: string;
407
- /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
408
- resourceId?: string;
409
- /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
410
- resourceLink?: string;
411
- /** The case-sensitive string used to search for an item by resourceType. */
412
- resourceType?: ItemResourceTypeEnum;
413
- /** @deprecated
414
- * Whether or not to return items in a shared space. */
415
- shared?: boolean;
416
- /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
417
- sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
418
- /** The space's unique identifier (supports \'personal\' as spaceId). */
419
- spaceId?: string;
420
- }, options?: ApiCallOptions): Promise<GetCollectionItemsHttpResponse>;
421
- type GetCollectionItemsHttpResponse = {
422
- data: CollectionsListCollectionItemsResponseBody;
423
- headers: Headers;
424
- status: 200;
425
- };
426
- type GetCollectionItemsHttpError = {
427
- data: ErrorResponseBody;
428
- headers: Headers;
429
- status: 400 | 401 | 404 | 500;
430
- };
431
- /**
432
- * Adds an item to a collection and returns the item.
433
- *
434
- * @param collectionId The collection's unique identifier.
435
- * @param body an object with the body content
436
- * @throws AddCollectionItemHttpError
437
- */
438
- declare function addCollectionItem(collectionId: string, body: CollectionsAddCollectionItemRequestBody, options?: ApiCallOptions): Promise<AddCollectionItemHttpResponse>;
439
- type AddCollectionItemHttpResponse = {
440
- data: ItemResultResponseBody;
441
- headers: Headers;
442
- status: 201;
443
- };
444
- type AddCollectionItemHttpError = {
445
- data: ErrorResponseBody;
446
- headers: Headers;
447
- status: 400 | 401 | 403 | 404 | 409 | 500;
448
- };
449
- /**
450
- * Removes an item from a collection.
451
- *
452
- * @param collectionId The collection's unique identifier.
453
- * @param itemId The item's unique identifier.
454
- * @throws DeleteCollectionItemHttpError
455
- */
456
- declare function deleteCollectionItem(collectionId: string, itemId: string, options?: ApiCallOptions): Promise<DeleteCollectionItemHttpResponse>;
457
- type DeleteCollectionItemHttpResponse = {
458
- data: void;
459
- headers: Headers;
460
- status: 204;
461
- };
462
- type DeleteCollectionItemHttpError = {
463
- data: ErrorResponseBody;
464
- headers: Headers;
465
- status: 400 | 401 | 404 | 500;
466
- };
467
- /**
468
- * Finds and returns an item in a specific collection. See GET `/items/{id}`.
469
- *
470
- * @param collectionId The collection's unique identifier.
471
- * @param itemId The item's unique identifier.
472
- * @throws GetCollectionItemHttpError
473
- */
474
- declare function getCollectionItem(collectionId: string, itemId: string, options?: ApiCallOptions): Promise<GetCollectionItemHttpResponse>;
475
- type GetCollectionItemHttpResponse = {
476
- data: ItemResultResponseBody;
477
- headers: Headers;
478
- status: 200;
479
- };
480
- type GetCollectionItemHttpError = {
481
- data: ErrorResponseBody;
482
- headers: Headers;
483
- status: 400 | 401 | 404 | 500;
484
- };
485
- /**
486
- * Clears the cache for collections api requests.
487
- */
488
- declare function clearCache(): void;
489
- type CollectionsAPI = {
490
- /**
491
- * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
492
- *
493
- * @param query an object with query parameters
494
- * @throws GetCollectionsHttpError
495
- */
496
- getCollections: typeof getCollections;
497
- /**
498
- * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
499
- *
500
- * @param body an object with the body content
501
- * @throws CreateCollectionHttpError
502
- */
503
- createCollection: typeof createCollection;
504
- /**
505
- * Lists the user's favorites collection.
506
- *
507
- * @throws GetFavoritesCollectionHttpError
508
- */
509
- getFavoritesCollection: typeof getFavoritesCollection;
510
- /**
511
- * Deletes a collection and removes all items from the collection.
512
- *
513
- * @param collectionId The collection's unique identifier.
514
- * @throws DeleteCollectionHttpError
515
- */
516
- deleteCollection: typeof deleteCollection;
517
- /**
518
- * Finds and returns a collection.
519
- *
520
- * @param collectionId The collection's unique identifier.
521
- * @throws GetCollectionHttpError
522
- */
523
- getCollection: typeof getCollection;
524
- /**
525
- * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
526
- *
527
- * @param collectionId The collection's unique identifier.
528
- * @param body an object with the body content
529
- * @throws PatchCollectionHttpError
530
- */
531
- patchCollection: typeof patchCollection;
532
- /**
533
- * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
534
- *
535
- * @param collectionId The collection's unique identifier.
536
- * @param body an object with the body content
537
- * @throws UpdateCollectionHttpError
538
- */
539
- updateCollection: typeof updateCollection;
540
- /**
541
- * Retrieves items from a collection that the user has access to.
542
- *
543
- * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
544
- * @param query an object with query parameters
545
- * @throws GetCollectionItemsHttpError
546
- */
547
- getCollectionItems: typeof getCollectionItems;
548
- /**
549
- * Adds an item to a collection and returns the item.
550
- *
551
- * @param collectionId The collection's unique identifier.
552
- * @param body an object with the body content
553
- * @throws AddCollectionItemHttpError
554
- */
555
- addCollectionItem: typeof addCollectionItem;
556
- /**
557
- * Removes an item from a collection.
558
- *
559
- * @param collectionId The collection's unique identifier.
560
- * @param itemId The item's unique identifier.
561
- * @throws DeleteCollectionItemHttpError
562
- */
563
- deleteCollectionItem: typeof deleteCollectionItem;
564
- /**
565
- * Finds and returns an item in a specific collection. See GET `/items/{id}`.
566
- *
567
- * @param collectionId The collection's unique identifier.
568
- * @param itemId The item's unique identifier.
569
- * @throws GetCollectionItemHttpError
570
- */
571
- getCollectionItem: typeof getCollectionItem;
572
- /**
573
- * Clears the cache for collections api requests.
574
- */
575
- clearCache: typeof clearCache;
576
- };
577
- /**
578
- * Functions for the collections api
579
- */
580
- declare const collectionsExport: CollectionsAPI;
581
- //#endregion
582
- export { deleteCollection as $, GetFavoritesCollectionHttpError as A, ItemsResourceSizeResponseBody as B, GetCollectionHttpResponse as C, GetCollectionItemsHttpResponse as D, GetCollectionItemsHttpError as E, ItemResultResponseBody as F, PatchCollectionHttpResponse as G, Link as H, ItemTagResponseBody as I, UpdateCollectionHttpResponse as J, ServiceError as K, ItemViewsResponseBody as L, ItemLinksResponseBody as M, ItemMetaResponseBody as N, GetCollectionsHttpError as O, ItemResourceTypeEnum as P, createCollection as Q, ItemViewsWeeksResponseBody as R, GetCollectionHttpError as S, GetCollectionItemHttpResponse as T, Meta as U, ItemsResultResponseBody as V, PatchCollectionHttpError as W, clearCache as X, addCollectionItem as Y, collectionsExport as Z, DeleteCollectionHttpError as _, CollectionMetaResponseBody as a, getFavoritesCollection as at, DeleteCollectionItemHttpResponse as b, CollectionsAPI as c, CollectionsLinksResponseBody as d, deleteCollectionItem as et, CollectionsListCollectionItemsResponseBody as f, CreateCollectionHttpResponse as g, CreateCollectionHttpError as h, CollectionLinksResponseBody as i, getCollections as it, GetFavoritesCollectionHttpResponse as j, GetCollectionsHttpResponse as k, CollectionsAddCollectionItemRequestBody as l, CollectionsUpdateCollectionRequestBody as m, AddCollectionItemHttpResponse as n, getCollectionItem as nt, CollectionResultResponseBody as o, patchCollection as ot, CollectionsListCollectionsResponseBody as p, UpdateCollectionHttpError as q, CollectionByIdPatch as r, getCollectionItems as rt, CollectionTypes as s, updateCollection as st, AddCollectionItemHttpError as t, getCollection as tt, CollectionsCreateCollectionRequestBody as u, DeleteCollectionHttpResponse as v, GetCollectionItemHttpError as w, ErrorResponseBody as x, DeleteCollectionItemHttpError as y, ItemsLinksResponseBody as z };