@qlik/api 0.0.16 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/README.md +1 -1
  2. package/api-keys.js +25 -25
  3. package/apps.js +97 -97
  4. package/audits.js +23 -23
  5. package/auth.js +14 -14
  6. package/automations.js +47 -47
  7. package/brands.js +35 -35
  8. package/chunks/4HB3TAEO.js +4 -4
  9. package/chunks/{EHAANYDL.mjs → 4V5AAWUI.js} +3 -3
  10. package/chunks/{O4EAKEIN.mjs → D62LI5YU.js} +1 -1
  11. package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
  12. package/chunks/{3YV6X7S6.mjs → LHCJKIEO.js} +1 -1
  13. package/chunks/OPRGGO4C.js +8 -8
  14. package/chunks/{HHOVS7QC.mjs → RNLZBOJU.js} +3 -3
  15. package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
  16. package/chunks/{6AD3HYSF.mjs → TFSRDRRS.js} +1 -1
  17. package/chunks/{HOCTJESP.mjs → VK2CODYY.js} +2 -2
  18. package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
  19. package/collections.js +33 -33
  20. package/csp-origins.js +23 -23
  21. package/data-assets.js +21 -21
  22. package/data-connections.js +29 -29
  23. package/data-credentials.js +19 -19
  24. package/data-files.js +35 -35
  25. package/docs/authentication.md +5 -5
  26. package/docs/examples/fetch-spaces.md +1 -15
  27. package/docs/examples/show-sheet-list.md +1 -1
  28. package/docs/features.md +1 -1
  29. package/extensions.js +25 -25
  30. package/glossaries.js +59 -59
  31. package/groups.d.ts +0 -3
  32. package/groups.js +27 -27
  33. package/identity-providers.js +27 -27
  34. package/index.js +53 -53
  35. package/items.js +27 -27
  36. package/licenses.js +29 -29
  37. package/package.json +36 -232
  38. package/qix.d.ts +1 -1
  39. package/qix.js +10 -10
  40. package/quotas.js +15 -15
  41. package/reload-tasks.js +21 -21
  42. package/reloads.js +19 -19
  43. package/roles.js +15 -15
  44. package/spaces.js +35 -35
  45. package/temp-contents.js +17 -17
  46. package/tenants.js +23 -23
  47. package/themes.js +25 -25
  48. package/transports.js +23 -23
  49. package/users.d.ts +1 -3
  50. package/users.js +31 -31
  51. package/web-integrations.js +21 -21
  52. package/web-notifications.js +23 -23
  53. package/webhooks.js +31 -31
  54. package/api-keys.d.mts +0 -336
  55. package/api-keys.mjs +0 -80
  56. package/apps.d.mts +0 -2431
  57. package/apps.mjs +0 -398
  58. package/audits.d.mts +0 -286
  59. package/audits.mjs +0 -64
  60. package/auth-types-nnUcWhuU.d.mts +0 -98
  61. package/auth.d.mts +0 -26
  62. package/auth.mjs +0 -14
  63. package/automations.d.mts +0 -682
  64. package/automations.mjs +0 -173
  65. package/brands.d.mts +0 -670
  66. package/brands.mjs +0 -123
  67. package/chunks/2YWCEGTS.js +0 -21
  68. package/chunks/34ZKUFEA.js +0 -41
  69. package/chunks/4WHZ4EIW.js +0 -57
  70. package/chunks/B4VPD3ZT.js +0 -574
  71. package/chunks/BM4OSDRZ.js +0 -17
  72. package/chunks/DCXUEDOW.mjs +0 -67
  73. package/chunks/MTAQE4WC.js +0 -10411
  74. package/chunks/PLOSYUG2.js +0 -25
  75. package/chunks/URIW2U5M.js +0 -17
  76. package/chunks/VSY5YIQY.mjs +0 -11
  77. package/chunks/WOYJLK4Y.js +0 -1623
  78. package/collections.d.mts +0 -581
  79. package/collections.mjs +0 -114
  80. package/csp-origins.d.mts +0 -273
  81. package/csp-origins.mjs +0 -69
  82. package/data-assets.d.mts +0 -205
  83. package/data-assets.mjs +0 -66
  84. package/data-connections.d.mts +0 -594
  85. package/data-connections.mjs +0 -103
  86. package/data-credentials.d.mts +0 -204
  87. package/data-credentials.mjs +0 -59
  88. package/data-files.d.mts +0 -562
  89. package/data-files.mjs +0 -123
  90. package/extensions.d.mts +0 -293
  91. package/extensions.mjs +0 -77
  92. package/global.types-5iFvFJvX.d.mts +0 -115
  93. package/glossaries.d.mts +0 -1173
  94. package/glossaries.mjs +0 -237
  95. package/groups.d.mts +0 -434
  96. package/groups.mjs +0 -88
  97. package/identity-providers.d.mts +0 -550
  98. package/identity-providers.mjs +0 -83
  99. package/index.d.mts +0 -142
  100. package/index.mjs +0 -716
  101. package/items.d.mts +0 -535
  102. package/items.mjs +0 -87
  103. package/licenses.d.mts +0 -459
  104. package/licenses.mjs +0 -92
  105. package/qix.d.mts +0 -11629
  106. package/qix.mjs +0 -10
  107. package/quotas.d.mts +0 -112
  108. package/quotas.mjs +0 -32
  109. package/reload-tasks.d.mts +0 -227
  110. package/reload-tasks.mjs +0 -62
  111. package/reloads.d.mts +0 -207
  112. package/reloads.mjs +0 -46
  113. package/roles.d.mts +0 -175
  114. package/roles.mjs +0 -31
  115. package/spaces.d.mts +0 -562
  116. package/spaces.mjs +0 -124
  117. package/temp-contents.d.mts +0 -167
  118. package/temp-contents.mjs +0 -41
  119. package/tenants.d.mts +0 -300
  120. package/tenants.mjs +0 -73
  121. package/themes.d.mts +0 -268
  122. package/themes.mjs +0 -77
  123. package/transports.d.mts +0 -319
  124. package/transports.mjs +0 -65
  125. package/users.d.mts +0 -631
  126. package/users.mjs +0 -104
  127. package/web-integrations.d.mts +0 -274
  128. package/web-integrations.mjs +0 -62
  129. package/web-notifications.d.mts +0 -250
  130. package/web-notifications.mjs +0 -69
  131. package/webhooks.d.mts +0 -445
  132. package/webhooks.mjs +0 -104
package/items.d.mts DELETED
@@ -1,535 +0,0 @@
1
- import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
2
- import './auth-types-nnUcWhuU.mjs';
3
-
4
- type CollectionTypes = "private" | "public" | "publicgoverned";
5
- type ErrorResponseBody = {
6
- errors?: ServiceError[];
7
- };
8
- /**
9
- * ListItemCollectionsResponseBody result type
10
- */
11
- type ItemsListItemCollectionsResponseBody = {
12
- data: CollectionResultResponseBody[];
13
- links: CollectionsLinksResponseBody;
14
- };
15
- /**
16
- * ListItemsResponseBody result type
17
- */
18
- type ItemsListItemsResponseBody = {
19
- data: ItemResultResponseBody[];
20
- links: ItemsLinksResponseBody;
21
- };
22
- type ItemsSettingsPatch = {
23
- /** The operation to be performed. Only "replace" is supported. */
24
- op: "replace";
25
- /** Field of Settings to be patched (updated). */
26
- path: "/usageMetricsEnabled";
27
- /** The value to be used within the operations. */
28
- value: boolean;
29
- }[];
30
- type ItemsSettingsResponseBody = {
31
- /** Decides if the usage metrics will be shown in the hub UI. */
32
- usageMetricsEnabled: boolean;
33
- };
34
- type ItemsUpdateItemRequestBody = {
35
- description?: string;
36
- name?: string;
37
- resourceAttributes?: unknown;
38
- resourceCustomAttributes?: unknown;
39
- /** 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. */
40
- resourceId?: string;
41
- /** 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. */
42
- resourceLink?: string;
43
- /** Optional field defining the item's subtype, if any. */
44
- resourceSubType?: string;
45
- /** The case-sensitive string defining the item's type. */
46
- resourceType: ItemResourceTypeEnum;
47
- /** The RFC3339 datetime when the resource that the item references was last updated. */
48
- resourceUpdatedAt?: string;
49
- /** The space's unique identifier. */
50
- spaceId?: string;
51
- /** The item thumbnail's unique identifier. This is optional for internal resources. */
52
- thumbnailId?: string;
53
- };
54
- type Link = {
55
- href?: string;
56
- };
57
- type ServiceError = {
58
- /** Code is a unique identifier for this error class. */
59
- code?: string;
60
- /** Detail is a human-readable explanation specific to this occurrence of the problem. */
61
- detail?: string;
62
- meta?: Meta;
63
- /** Title is the name of this class of errors. */
64
- title?: string;
65
- };
66
- type CollectionLinksResponseBody = {
67
- items?: Link;
68
- self?: Link;
69
- };
70
- /**
71
- * Collection metadata and computed fields.
72
- */
73
- type CollectionMetaResponseBody = {
74
- /** Multiple items. */
75
- items?: ItemsResultResponseBody;
76
- };
77
- /**
78
- * A collection.
79
- */
80
- type CollectionResultResponseBody = {
81
- /** The RFC3339 datetime when the collection was created. */
82
- createdAt: string;
83
- /** The ID of the user who created the collection. This property is only populated if the JWT contains a userId. */
84
- creatorId?: string;
85
- description?: string;
86
- /** States if a collection has reached its items limit or not */
87
- full?: boolean;
88
- /** The collection's unique identifier. */
89
- id: string;
90
- /** The number of items that have been added to the collection that the user has access to. */
91
- itemCount: number;
92
- links: CollectionLinksResponseBody;
93
- /** Collection metadata and computed fields. */
94
- meta?: CollectionMetaResponseBody;
95
- name: string;
96
- /** The ID of the tenant that owns the collection. This property is populated by using JWT. */
97
- tenantId: string;
98
- type: "private" | "public" | "favorite" | "publicgoverned";
99
- /** The RFC3339 datetime when the collection was last updated. */
100
- updatedAt: string;
101
- /** The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. */
102
- updaterId?: string;
103
- };
104
- type CollectionsLinksResponseBody = {
105
- item?: Link;
106
- next?: Link;
107
- prev?: Link;
108
- self?: Link;
109
- };
110
- type ItemLinksResponseBody = {
111
- collections?: Link;
112
- open?: Link;
113
- self?: Link;
114
- thumbnail?: Link;
115
- };
116
- /**
117
- * Item metadata and computed fields.
118
- */
119
- type ItemMetaResponseBody = {
120
- /** The actions that the user can perform on the item. */
121
- actions: string[];
122
- /** An array of collections that the item is part of. */
123
- collections: ItemTagResponseBody[];
124
- /** The flag that indicates if item is in the user's favorites collection. */
125
- isFavorited: boolean;
126
- /** An array of tags that the item is part of. */
127
- tags: ItemTagResponseBody[];
128
- };
129
- /**
130
- * The case-sensitive string defining the item's type.
131
- */
132
- type ItemResourceTypeEnum = "app" | "collection" | "qlikview" | "insight" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
133
- /**
134
- * An item.
135
- */
136
- type ItemResultResponseBody = {
137
- /** The actions that the user can perform on the item. */
138
- actions: string[];
139
- /** The ID of the collections that the item has been added to. */
140
- collectionIds: string[];
141
- /** The RFC3339 datetime when the item was created. */
142
- createdAt: string;
143
- /** The ID of the user who created the item. This is only populated if the JWT contains a userId. */
144
- creatorId?: string;
145
- description?: string;
146
- /** The item's unique identifier. */
147
- id: string;
148
- /** The flag that indicates if item is in the user's favorites collection. */
149
- isFavorited: boolean;
150
- itemViews?: ItemViewsResponseBody;
151
- links: ItemLinksResponseBody;
152
- /** Item metadata and computed fields. */
153
- meta: ItemMetaResponseBody;
154
- name: string;
155
- /** The ID of the user who owns the item. */
156
- ownerId?: string;
157
- resourceAttributes: unknown;
158
- /** The RFC3339 datetime when the resource that the item references was created. */
159
- resourceCreatedAt: string;
160
- resourceCustomAttributes: unknown;
161
- /** 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. */
162
- resourceId?: string;
163
- /** 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. */
164
- resourceLink?: string;
165
- /** The RFC3339 datetime when the resource last reload ended. */
166
- resourceReloadEndTime?: string;
167
- /** If the resource last reload was successful or not. */
168
- resourceReloadStatus?: string;
169
- resourceSize?: ItemsResourceSizeResponseBody;
170
- /** Optional field defining the item's subtype, if any. */
171
- resourceSubType?: string;
172
- /** The case-sensitive string defining the item's type. */
173
- resourceType: ItemResourceTypeEnum;
174
- /** The RFC3339 datetime when the resource that the item references was last updated. */
175
- resourceUpdatedAt: string;
176
- /** The space's unique identifier. */
177
- spaceId?: string;
178
- /** The ID of the tenant that owns the item. This is populated using the JWT. */
179
- tenantId: string;
180
- /** The item thumbnail's unique identifier. This is optional for internal resources. */
181
- thumbnailId?: string;
182
- /** The RFC3339 datetime when the item was last updated. */
183
- updatedAt: string;
184
- /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
185
- updaterId?: string;
186
- };
187
- /**
188
- * Holds basic information about a tag or collection.
189
- */
190
- type ItemTagResponseBody = {
191
- /** The ID of the tag/collection. */
192
- id: string;
193
- /** The name of the tag/collection. */
194
- name: string;
195
- };
196
- type ItemViewsResponseBody = {
197
- /** Total number of views the resource got during the last 28 days. */
198
- total?: number;
199
- /** 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. */
200
- trend?: number;
201
- /** Number of unique users who viewed the resource during the last 28 days. */
202
- unique?: number;
203
- /** Number of apps this dataset is used in (datasets only). */
204
- usedBy?: number;
205
- week?: ItemViewsWeeksResponseBody[];
206
- };
207
- type ItemViewsWeeksResponseBody = {
208
- /** The RFC3339 datetime representing the start of the referenced week. */
209
- start?: string;
210
- /** Total number of views the resource got during the referenced week. */
211
- total?: number;
212
- /** Number of unique users who viewed the resource during the referenced week. */
213
- unique?: number;
214
- };
215
- type ItemsLinksResponseBody = {
216
- collection?: Link;
217
- next?: Link;
218
- prev?: Link;
219
- self?: Link;
220
- };
221
- type ItemsResourceSizeResponseBody = {
222
- /** Size of the app on disk in bytes. */
223
- appFile?: number;
224
- /** Size of the app in memory in bytes. */
225
- appMemory?: number;
226
- };
227
- /**
228
- * Multiple items.
229
- */
230
- type ItemsResultResponseBody = {
231
- data: ItemResultResponseBody[];
232
- links: ItemsLinksResponseBody;
233
- };
234
- type Meta = {
235
- /** Further explanation of the error */
236
- explain?: unknown;
237
- /** Is the error a server-side fault? */
238
- fault?: boolean;
239
- /** Is the error temporary? */
240
- temporary?: boolean;
241
- /** Is the error a timeout? */
242
- timeout?: boolean;
243
- };
244
- /**
245
- * The case-sensitive string defining the space type.
246
- */
247
- type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
248
- /**
249
- * Finds and returns items that the user has access to.
250
- *
251
- * @param query an object with query parameters
252
- * @throws GetItemsHttpError
253
- */
254
- declare const getItems: (query: {
255
- /** The collection's unique identifier. */
256
- collectionId?: string | undefined;
257
- /** User's unique identifier. */
258
- createdByUserId?: string | undefined;
259
- /** The item's unique identifier. */
260
- id?: string | undefined;
261
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
262
- limit?: number | undefined;
263
- /** The case-insensitive string used to search for a resource by name. */
264
- name?: string | undefined;
265
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
266
- next?: string | undefined;
267
- /** 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). */
268
- noActions?: boolean | undefined;
269
- /** User's unique identifier. */
270
- notCreatedByUserId?: string | undefined;
271
- /** Owner identifier. */
272
- notOwnerId?: string | undefined;
273
- /** Owner identifier. */
274
- ownerId?: string | undefined;
275
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
276
- prev?: string | undefined;
277
- /** The case-insensitive string used to search for a resource by name or description. */
278
- query?: string | undefined;
279
- /** 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. */
280
- resourceId?: string | undefined;
281
- /** The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2' */
282
- resourceIds?: string | undefined;
283
- /** 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. */
284
- resourceLink?: string | undefined;
285
- /** the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter. */
286
- resourceSubType?: string | undefined;
287
- /** The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error. */
288
- resourceType?: ItemResourceTypeEnum | undefined;
289
- /** @deprecated
290
- * Whether or not to return items in a shared space. */
291
- shared?: boolean | undefined;
292
- /** 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. */
293
- sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
294
- /** The space's unique identifier (supports \'personal\' as spaceId). */
295
- spaceId?: string | undefined;
296
- /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
297
- spaceType?: SpaceTypeEnum | undefined;
298
- }, options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
299
- type GetItemsHttpResponse = {
300
- data: ItemsListItemsResponseBody;
301
- headers: Headers;
302
- status: number;
303
- prev?: (options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
304
- next?: (options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
305
- };
306
- type GetItemsHttpError = {
307
- data: ErrorResponseBody;
308
- headers: Headers;
309
- status: number;
310
- };
311
- /**
312
- * Finds and returns the settings for the current tenant.
313
- *
314
- * @throws GetItemsSettingsHttpError
315
- */
316
- declare const getItemsSettings: (options?: ApiCallOptions) => Promise<GetItemsSettingsHttpResponse>;
317
- type GetItemsSettingsHttpResponse = {
318
- data: ItemsSettingsResponseBody;
319
- headers: Headers;
320
- status: number;
321
- };
322
- type GetItemsSettingsHttpError = {
323
- data: ErrorResponseBody;
324
- headers: Headers;
325
- status: number;
326
- };
327
- /**
328
- * Updates the settings provided in the patch body.
329
- *
330
- * @param body an object with the body content
331
- * @throws PatchItemsSettingsHttpError
332
- */
333
- declare const patchItemsSettings: (body: ItemsSettingsPatch, options?: ApiCallOptions) => Promise<PatchItemsSettingsHttpResponse>;
334
- type PatchItemsSettingsHttpResponse = {
335
- data: ItemsSettingsResponseBody;
336
- headers: Headers;
337
- status: number;
338
- };
339
- type PatchItemsSettingsHttpError = {
340
- data: ErrorResponseBody;
341
- headers: Headers;
342
- status: number;
343
- };
344
- /**
345
- * Deletes an item and removes the item from all collections.
346
- *
347
- * @param itemId The item's unique identifier.
348
- * @throws DeleteItemHttpError
349
- */
350
- declare const deleteItem: (itemId: string, options?: ApiCallOptions) => Promise<DeleteItemHttpResponse>;
351
- type DeleteItemHttpResponse = {
352
- data: void;
353
- headers: Headers;
354
- status: number;
355
- };
356
- type DeleteItemHttpError = {
357
- data: ErrorResponseBody;
358
- headers: Headers;
359
- status: number;
360
- };
361
- /**
362
- * Finds and returns an item.
363
- *
364
- * @param itemId The item's unique identifier
365
- * @throws GetItemHttpError
366
- */
367
- declare const getItem: (itemId: string, options?: ApiCallOptions) => Promise<GetItemHttpResponse>;
368
- type GetItemHttpResponse = {
369
- data: ItemResultResponseBody;
370
- headers: Headers;
371
- status: number;
372
- };
373
- type GetItemHttpError = {
374
- data: ErrorResponseBody;
375
- headers: Headers;
376
- status: number;
377
- };
378
- /**
379
- * Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
380
- *
381
- * @param itemId The item's unique identifier.
382
- * @param body an object with the body content
383
- * @throws UpdateItemHttpError
384
- */
385
- declare const updateItem: (itemId: string, body: ItemsUpdateItemRequestBody, options?: ApiCallOptions) => Promise<UpdateItemHttpResponse>;
386
- type UpdateItemHttpResponse = {
387
- data: ItemResultResponseBody;
388
- headers: Headers;
389
- status: number;
390
- };
391
- type UpdateItemHttpError = {
392
- data: ErrorResponseBody;
393
- headers: Headers;
394
- status: number;
395
- };
396
- /**
397
- * Finds and returns the collections of an item. This endpoint does not return the user's favorites collection.
398
- *
399
- * @param itemId The item's unique identifier.
400
- * @param query an object with query parameters
401
- * @throws GetItemCollectionsHttpError
402
- */
403
- declare const getItemCollections: (itemId: string, query: {
404
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
405
- limit?: number | undefined;
406
- /** The case-sensitive string used to search for a collection by name. */
407
- name?: string | undefined;
408
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
409
- next?: string | undefined;
410
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
411
- prev?: string | undefined;
412
- /** The case-insensitive string used to search for a resource by name or description. */
413
- query?: string | undefined;
414
- /** 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. */
415
- sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
416
- /** The case-sensitive string used to search for a collection by type. */
417
- type?: CollectionTypes | undefined;
418
- }, options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
419
- type GetItemCollectionsHttpResponse = {
420
- data: ItemsListItemCollectionsResponseBody;
421
- headers: Headers;
422
- status: number;
423
- prev?: (options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
424
- next?: (options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
425
- };
426
- type GetItemCollectionsHttpError = {
427
- data: ErrorResponseBody;
428
- headers: Headers;
429
- status: number;
430
- };
431
- /**
432
- * Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
433
- *
434
- * @param itemId The item's unique identifier
435
- * @param query an object with query parameters
436
- * @throws GetPublishedItemsHttpError
437
- */
438
- declare const getPublishedItems: (itemId: string, query: {
439
- /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
440
- limit?: number;
441
- /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
442
- next?: string;
443
- /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
444
- prev?: string;
445
- /** The case-sensitive string used to search for an item by resourceType. */
446
- resourceType?: ItemResourceTypeEnum;
447
- /** 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. */
448
- sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
449
- }, options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
450
- type GetPublishedItemsHttpResponse = {
451
- data: ItemsListItemCollectionsResponseBody;
452
- headers: Headers;
453
- status: number;
454
- prev?: (options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
455
- next?: (options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
456
- };
457
- type GetPublishedItemsHttpError = {
458
- data: ErrorResponseBody;
459
- headers: Headers;
460
- status: number;
461
- };
462
- /**
463
- * Clears the cache for items api requests.
464
- */
465
- declare function clearCache(): void;
466
- interface ItemsAPI {
467
- /**
468
- * Finds and returns items that the user has access to.
469
- *
470
- * @param query an object with query parameters
471
- * @throws GetItemsHttpError
472
- */
473
- getItems: typeof getItems;
474
- /**
475
- * Finds and returns the settings for the current tenant.
476
- *
477
- * @throws GetItemsSettingsHttpError
478
- */
479
- getItemsSettings: typeof getItemsSettings;
480
- /**
481
- * Updates the settings provided in the patch body.
482
- *
483
- * @param body an object with the body content
484
- * @throws PatchItemsSettingsHttpError
485
- */
486
- patchItemsSettings: typeof patchItemsSettings;
487
- /**
488
- * Deletes an item and removes the item from all collections.
489
- *
490
- * @param itemId The item's unique identifier.
491
- * @throws DeleteItemHttpError
492
- */
493
- deleteItem: typeof deleteItem;
494
- /**
495
- * Finds and returns an item.
496
- *
497
- * @param itemId The item's unique identifier
498
- * @throws GetItemHttpError
499
- */
500
- getItem: typeof getItem;
501
- /**
502
- * Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
503
- *
504
- * @param itemId The item's unique identifier.
505
- * @param body an object with the body content
506
- * @throws UpdateItemHttpError
507
- */
508
- updateItem: typeof updateItem;
509
- /**
510
- * Finds and returns the collections of an item. This endpoint does not return the user's favorites collection.
511
- *
512
- * @param itemId The item's unique identifier.
513
- * @param query an object with query parameters
514
- * @throws GetItemCollectionsHttpError
515
- */
516
- getItemCollections: typeof getItemCollections;
517
- /**
518
- * Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
519
- *
520
- * @param itemId The item's unique identifier
521
- * @param query an object with query parameters
522
- * @throws GetPublishedItemsHttpError
523
- */
524
- getPublishedItems: typeof getPublishedItems;
525
- /**
526
- * Clears the cache for items api requests.
527
- */
528
- clearCache: typeof clearCache;
529
- }
530
- /**
531
- * Functions for the items api
532
- */
533
- declare const itemsExport: ItemsAPI;
534
-
535
- export { type CollectionLinksResponseBody, type CollectionMetaResponseBody, type CollectionResultResponseBody, type CollectionTypes, type CollectionsLinksResponseBody, type DeleteItemHttpError, type DeleteItemHttpResponse, type ErrorResponseBody, type GetItemCollectionsHttpError, type GetItemCollectionsHttpResponse, type GetItemHttpError, type GetItemHttpResponse, type GetItemsHttpError, type GetItemsHttpResponse, type GetItemsSettingsHttpError, type GetItemsSettingsHttpResponse, type GetPublishedItemsHttpError, type GetPublishedItemsHttpResponse, type ItemLinksResponseBody, type ItemMetaResponseBody, type ItemResourceTypeEnum, type ItemResultResponseBody, type ItemTagResponseBody, type ItemViewsResponseBody, type ItemViewsWeeksResponseBody, type ItemsAPI, type ItemsLinksResponseBody, type ItemsListItemCollectionsResponseBody, type ItemsListItemsResponseBody, type ItemsResourceSizeResponseBody, type ItemsResultResponseBody, type ItemsSettingsPatch, type ItemsSettingsResponseBody, type ItemsUpdateItemRequestBody, type Link, type Meta, type PatchItemsSettingsHttpError, type PatchItemsSettingsHttpResponse, type ServiceError, type SpaceTypeEnum, type UpdateItemHttpError, type UpdateItemHttpResponse, clearCache, itemsExport as default, deleteItem, getItem, getItemCollections, getItems, getItemsSettings, getPublishedItems, patchItemsSettings, updateItem };
package/items.mjs DELETED
@@ -1,87 +0,0 @@
1
- import {
2
- clearApiCache,
3
- invokeFetch
4
- } from "./chunks/3YV6X7S6.mjs";
5
- import "./chunks/EHAANYDL.mjs";
6
- import "./chunks/VSY5YIQY.mjs";
7
-
8
- // src/public/rest/items.ts
9
- var getItems = async (query, options) => invokeFetch("items", {
10
- method: "get",
11
- pathTemplate: "/api/v1/items",
12
- query,
13
- options
14
- });
15
- var getItemsSettings = async (options) => invokeFetch("items", {
16
- method: "get",
17
- pathTemplate: "/api/v1/items/settings",
18
- options
19
- });
20
- var patchItemsSettings = async (body, options) => invokeFetch("items", {
21
- method: "patch",
22
- pathTemplate: "/api/v1/items/settings",
23
- body,
24
- contentType: "application/json",
25
- options
26
- });
27
- var deleteItem = async (itemId, options) => invokeFetch("items", {
28
- method: "delete",
29
- pathTemplate: "/api/v1/items/{itemId}",
30
- pathVariables: { itemId },
31
- options
32
- });
33
- var getItem = async (itemId, options) => invokeFetch("items", {
34
- method: "get",
35
- pathTemplate: "/api/v1/items/{itemId}",
36
- pathVariables: { itemId },
37
- options
38
- });
39
- var updateItem = async (itemId, body, options) => invokeFetch("items", {
40
- method: "put",
41
- pathTemplate: "/api/v1/items/{itemId}",
42
- pathVariables: { itemId },
43
- body,
44
- contentType: "application/json",
45
- options
46
- });
47
- var getItemCollections = async (itemId, query, options) => invokeFetch("items", {
48
- method: "get",
49
- pathTemplate: "/api/v1/items/{itemId}/collections",
50
- pathVariables: { itemId },
51
- query,
52
- options
53
- });
54
- var getPublishedItems = async (itemId, query, options) => invokeFetch("items", {
55
- method: "get",
56
- pathTemplate: "/api/v1/items/{itemId}/publisheditems",
57
- pathVariables: { itemId },
58
- query,
59
- options
60
- });
61
- function clearCache() {
62
- return clearApiCache("items");
63
- }
64
- var itemsExport = {
65
- getItems,
66
- getItemsSettings,
67
- patchItemsSettings,
68
- deleteItem,
69
- getItem,
70
- updateItem,
71
- getItemCollections,
72
- getPublishedItems,
73
- clearCache
74
- };
75
- var items_default = itemsExport;
76
- export {
77
- clearCache,
78
- items_default as default,
79
- deleteItem,
80
- getItem,
81
- getItemCollections,
82
- getItems,
83
- getItemsSettings,
84
- getPublishedItems,
85
- patchItemsSettings,
86
- updateItem
87
- };