@qlik/api 0.0.2 → 0.0.4

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 (171) hide show
  1. package/api-keys.d.mts +14 -0
  2. package/api-keys.d.ts +14 -0
  3. package/api-keys.js +14 -10
  4. package/api-keys.mjs +6 -2
  5. package/apps.d.mts +479 -149
  6. package/apps.d.ts +479 -149
  7. package/apps.js +100 -42
  8. package/apps.mjs +60 -2
  9. package/audits.d.mts +12 -0
  10. package/audits.d.ts +12 -0
  11. package/audits.js +10 -9
  12. package/audits.mjs +3 -2
  13. package/auth-AWZV4DPP.js +41 -0
  14. package/{auth-RTFXVSSK.mjs → auth-CPBNNC7S.mjs} +4 -1
  15. package/auth.js +4 -3
  16. package/auth.mjs +3 -2
  17. package/automations.d.mts +36 -0
  18. package/automations.d.ts +36 -0
  19. package/automations.js +28 -21
  20. package/automations.mjs +9 -2
  21. package/brands.d.mts +45 -4
  22. package/brands.d.ts +45 -4
  23. package/brands.js +20 -15
  24. package/brands.mjs +7 -2
  25. package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
  26. package/{chunk-7REWEWCX.mjs → chunk-3SVRHJII.mjs} +3 -3
  27. package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
  28. package/{chunk-M7F4JFOB.js → chunk-7RY3NO6N.js} +2 -2
  29. package/{chunk-NALKLKZS.mjs → chunk-CYRLVHU3.mjs} +316 -53
  30. package/{chunk-RMKP2BDX.js → chunk-D52VW5UN.js} +318 -55
  31. package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
  32. package/{chunk-QN23TPIE.js → chunk-GV5SRHY2.js} +4 -4
  33. package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
  34. package/chunk-P57PW2II.js +11 -0
  35. package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
  36. package/chunk-ZFXKCRJC.mjs +11 -0
  37. package/collections.d.mts +51 -17
  38. package/collections.d.ts +51 -17
  39. package/collections.js +28 -14
  40. package/collections.mjs +16 -2
  41. package/csp-origins.d.mts +16 -1
  42. package/csp-origins.d.ts +16 -1
  43. package/csp-origins.js +12 -9
  44. package/csp-origins.mjs +5 -2
  45. package/data-assets.d.mts +10 -0
  46. package/data-assets.d.ts +10 -0
  47. package/data-assets.js +13 -8
  48. package/data-assets.mjs +7 -2
  49. package/data-connections.d.mts +18 -0
  50. package/data-connections.d.ts +18 -0
  51. package/data-connections.js +19 -12
  52. package/data-connections.mjs +9 -2
  53. package/data-credentials.d.mts +8 -0
  54. package/data-credentials.d.ts +8 -0
  55. package/data-credentials.js +10 -7
  56. package/data-credentials.mjs +5 -2
  57. package/data-files.d.mts +98 -13
  58. package/data-files.d.ts +98 -13
  59. package/data-files.js +22 -15
  60. package/data-files.mjs +9 -2
  61. package/{enigma-session-VPPJMBEM.js → enigma-session-XPXDQAIV.js} +5 -4
  62. package/{enigma-session-HGXKZJVO.mjs → enigma-session-ZH6MYA54.mjs} +2 -1
  63. package/{esm-RX7B2TUN.js → esm-3VXX2GKL.js} +3 -1
  64. package/{esm-M5ZBFTVD.mjs → esm-OY4XVIJB.mjs} +3 -1
  65. package/extensions.d.mts +26 -2
  66. package/extensions.d.ts +26 -2
  67. package/extensions.js +13 -10
  68. package/extensions.mjs +5 -2
  69. package/glossaries.d.mts +55 -20
  70. package/glossaries.d.ts +55 -20
  71. package/glossaries.js +39 -27
  72. package/glossaries.mjs +14 -2
  73. package/groups.d.mts +16 -0
  74. package/groups.d.ts +16 -0
  75. package/groups.js +16 -11
  76. package/groups.mjs +7 -2
  77. package/identity-providers.d.mts +16 -0
  78. package/identity-providers.d.ts +16 -0
  79. package/identity-providers.js +14 -11
  80. package/identity-providers.mjs +5 -2
  81. package/index.js +135 -101
  82. package/index.mjs +131 -97
  83. package/{invoke-fetch-IMO4AMA3.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
  84. package/invoke-fetch-UNTAUR7O.js +17 -0
  85. package/items.d.mts +6 -6
  86. package/items.d.ts +6 -6
  87. package/items.js +14 -11
  88. package/items.mjs +5 -2
  89. package/licenses.d.mts +18 -0
  90. package/licenses.d.ts +18 -0
  91. package/licenses.js +17 -12
  92. package/licenses.mjs +7 -2
  93. package/package.json +4 -4
  94. package/{qix-K22VHZRH.js → qix-UNWXPGMA.js} +9 -8
  95. package/{qix-57WD2ZE6.mjs → qix-ZSJ4PIK3.mjs} +3 -2
  96. package/qix.d.mts +1 -1
  97. package/qix.d.ts +1 -1
  98. package/qix.js +4 -3
  99. package/qix.mjs +3 -2
  100. package/quotas.d.mts +4 -0
  101. package/quotas.d.ts +4 -0
  102. package/quotas.js +6 -5
  103. package/quotas.mjs +3 -2
  104. package/reload-tasks.js +11 -8
  105. package/reload-tasks.mjs +5 -2
  106. package/reloads.d.mts +17 -10
  107. package/reloads.d.ts +17 -10
  108. package/reloads.js +9 -7
  109. package/reloads.mjs +4 -2
  110. package/roles.d.mts +4 -0
  111. package/roles.d.ts +4 -0
  112. package/roles.js +6 -5
  113. package/roles.mjs +3 -2
  114. package/spaces.d.mts +27 -4
  115. package/spaces.d.ts +27 -4
  116. package/spaces.js +21 -15
  117. package/spaces.mjs +8 -2
  118. package/temp-contents.d.mts +8 -3
  119. package/temp-contents.d.ts +8 -3
  120. package/temp-contents.js +8 -6
  121. package/temp-contents.mjs +4 -2
  122. package/tenants.d.mts +12 -0
  123. package/tenants.d.ts +12 -0
  124. package/tenants.js +14 -9
  125. package/tenants.mjs +7 -2
  126. package/themes.d.mts +26 -2
  127. package/themes.d.ts +26 -2
  128. package/themes.js +13 -10
  129. package/themes.mjs +5 -2
  130. package/transports.d.mts +12 -0
  131. package/transports.d.ts +12 -0
  132. package/transports.js +12 -9
  133. package/transports.mjs +5 -2
  134. package/users.d.mts +48 -29
  135. package/users.d.ts +48 -29
  136. package/users.js +18 -13
  137. package/users.mjs +7 -2
  138. package/web-integrations.d.mts +10 -0
  139. package/web-integrations.d.ts +10 -0
  140. package/web-integrations.js +11 -8
  141. package/web-integrations.mjs +5 -2
  142. package/web-notifications.d.mts +12 -0
  143. package/web-notifications.d.ts +12 -0
  144. package/web-notifications.js +12 -9
  145. package/web-notifications.mjs +5 -2
  146. package/webhooks.d.mts +25 -5
  147. package/webhooks.d.ts +25 -5
  148. package/webhooks.js +17 -13
  149. package/webhooks.mjs +6 -2
  150. package/auth-CSVTXOZX.js +0 -36
  151. package/auth-OU7OTB7Y.js +0 -38
  152. package/auth-TE272Q34.mjs +0 -36
  153. package/chunk-4ES65KO3.js +0 -57
  154. package/chunk-4FLMND6T.js +0 -25
  155. package/chunk-4OMEH5SW.mjs +0 -1337
  156. package/chunk-6JERR27K.js +0 -17
  157. package/chunk-E42WUFCK.mjs +0 -57
  158. package/chunk-H7SAZYEE.js +0 -21
  159. package/chunk-KMMWJZHM.mjs +0 -25
  160. package/chunk-W4J34XGA.mjs +0 -17
  161. package/chunk-WM7FQU2U.mjs +0 -21
  162. package/chunk-XASXL2NC.js +0 -1337
  163. package/enigma-session-4L373ALV.mjs +0 -10196
  164. package/enigma-session-TEB53FAF.js +0 -10196
  165. package/esm-4X3DKK5D.js +0 -63
  166. package/esm-SOWVJKOQ.mjs +0 -63
  167. package/invoke-fetch-7PKPQ3FD.js +0 -14
  168. package/invoke-fetch-MSSJAZ7K.mjs +0 -14
  169. package/invoke-fetch-PEI54KZO.js +0 -14
  170. package/qix-EU7PXRZ6.mjs +0 -573
  171. package/qix-RLTISYTB.js +0 -573
package/data-files.d.mts CHANGED
@@ -5,7 +5,7 @@ type BatchChangeSpaceItem = {
5
5
  /** The ID of the data file whose space will be changed. */
6
6
  id: string;
7
7
  /** The ID of the new space. Passing in a null will result in the data file being moved to the user's
8
- // personal space. */
8
+ * personal space. */
9
9
  spaceId?: string;
10
10
  };
11
11
  type BatchDeleteItem = {
@@ -28,7 +28,7 @@ type ConnectionsResponse = {
28
28
  /** The name of the connection. */
29
29
  name: string;
30
30
  /** The team space that the given connection is associated with. If null, the connection is not associated
31
- // with any specific team space. */
31
+ * with any specific team space. */
32
32
  spaceId?: string;
33
33
  /** The type of the connection. */
34
34
  type: string;
@@ -112,21 +112,22 @@ type QuotaResponse = {
112
112
  /** The allowed file extensions on files that are uploaded. */
113
113
  allowedExtensions: string[];
114
114
  /** The allowed file extensions for files that are only used internally by the system (and thus not typically
115
- // shown to end users). */
115
+ * shown to end users). */
116
116
  allowedInternalExtensions: string[];
117
117
  /** Maximum allowable size of an uploaded file. */
118
118
  maxFileSize: number;
119
119
  /** Maximum allowable size for a single uploaded large data file (in bytes). This is a file that was indirectly
120
- // uploaded using the temp content service chunked upload capability. */
120
+ * uploaded using the temp content service chunked upload capability. */
121
121
  maxLargeFileSize: number;
122
122
  /** The maximum aggregate size of all files uploaded by a given user. */
123
123
  maxSize: number;
124
124
  /** The current aggregate size of all files uploaded by a given user. If the current aggregate size is greater
125
- // than the maximum aggregate size, this is a quota violation. */
125
+ * than the maximum aggregate size, this is a quota violation. */
126
126
  size: number;
127
127
  };
128
128
  /**
129
129
  * Get descriptive info for the specified data files.
130
+ *
130
131
  * @param query an object with query parameters
131
132
  * @throws GetDataFilesHttpError
132
133
  */
@@ -134,23 +135,23 @@ declare const getDataFiles: (query: {
134
135
  /** If set to false, do not return data files with internal extensions else return all the data files. */
135
136
  allowInternalFiles?: boolean;
136
137
  /** Only return files scoped to the specified app. If this parameter is not specified, only files that are not
137
- // scoped to any app are returned. "*" implies all app-scoped files are returned. */
138
+ * scoped to any app are returned. "*" implies all app-scoped files are returned. */
138
139
  appId?: string;
139
140
  /** Return files that reside in the space referenced by the specified DataFiles connection. If this parameter
140
- // is not specified, the user's personal space is implied. */
141
+ * is not specified, the user's personal space is implied. */
141
142
  connectionId?: string;
142
143
  /** If present, the maximum number of data files to return. */
143
144
  limit?: number;
144
145
  /** Filter the list of files returned to the given file name. */
145
146
  name?: string;
146
147
  /** If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the
147
- // returned list is constrained to the specified space. If connectionId is not specified, then all files owned
148
- // by the specified user are returned regardless of the personal space that a given file resides in. */
148
+ * returned list is constrained to the specified space. If connectionId is not specified, then all files owned
149
+ * by the specified user are returned regardless of the personal space that a given file resides in. */
149
150
  ownerId?: string;
150
151
  /** If present, the cursor that starts the page of data that is returned. */
151
152
  page?: string;
152
153
  /** The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on
153
- // the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
154
+ * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
154
155
  sort?: GetDataFileInfosSortField;
155
156
  }, options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
156
157
  type GetDataFilesHttpResponse = {
@@ -167,10 +168,41 @@ type GetDataFilesHttpError = {
167
168
  };
168
169
  /**
169
170
  * Upload a new data file.
171
+ *
170
172
  * @param body an object with the body content
171
173
  * @throws UploadDataFileHttpError
172
174
  */
173
- declare const uploadDataFile: (body: unknown, options?: ApiCallOptions) => Promise<UploadDataFileHttpResponse>;
175
+ declare const uploadDataFile: (body: {
176
+ /** IFormFile form multipart/form-data */
177
+ File?: BodyInit;
178
+ /** See PostDataFileRequest schema which defines request structure.
179
+ * See model. */
180
+ Json?: {
181
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
182
+ appId?: string;
183
+ /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
184
+ * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
185
+ * connection is different from the one specified when the file was last POSTed or PUT, this will result in
186
+ * a logical move of this file into the new space. */
187
+ connectionId?: string;
188
+ /** Name that will be given to the uploaded file. It should be noted that the '/' character
189
+ * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
190
+ * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
191
+ * full pathname of that file. '/' is a significant character in the data file name, and may impact the
192
+ * behavior of future APIs which take this folder hierarchy into account. */
193
+ name: string;
194
+ /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
195
+ * the specified data file. That is, instead of the file content being specified in the Data element,
196
+ * it is effectively copied from an existing, previously uploaded file. */
197
+ sourceId?: string;
198
+ /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
199
+ * content should be copied into the specified data file. That is, instead of the file content being specified
200
+ * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
201
+ * is that this file was previously uploaded to the temporary content service, and the ID specified here is
202
+ * the one returned from the temp content upload request. */
203
+ tempContentFileId?: string;
204
+ };
205
+ }, options?: ApiCallOptions) => Promise<UploadDataFileHttpResponse>;
174
206
  type UploadDataFileHttpResponse = {
175
207
  data: DataFileUploadResponse;
176
208
  headers: Headers;
@@ -186,6 +218,7 @@ type UploadDataFileHttpError = {
186
218
  * where admin users may not explicitly have been granted full access to a given space within the declared
187
219
  * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
188
220
  * personal space of the user who is the owner of the file.
221
+ *
189
222
  * @param body an object with the body content
190
223
  * @throws MoveDataFilesHttpError
191
224
  */
@@ -202,6 +235,7 @@ type MoveDataFilesHttpError = {
202
235
  };
203
236
  /**
204
237
  * Delete the specified set of data files as a single batch.
238
+ *
205
239
  * @param body an object with the body content
206
240
  * @throws DeleteDataFilesHttpError
207
241
  */
@@ -219,6 +253,7 @@ type DeleteDataFilesHttpError = {
219
253
  /**
220
254
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
221
255
  * the given user has access to.
256
+ *
222
257
  * @param query an object with query parameters
223
258
  * @throws GetDataFilesConnectionsHttpError
224
259
  */
@@ -234,7 +269,7 @@ declare const getDataFilesConnections: (query: {
234
269
  /** If true, only return the connections that access data in a personal space. Default is false. */
235
270
  personal?: boolean;
236
271
  /** The name of the field used to sort the result. By default, the sort is ascending. Putting a '+' prefix on
237
- // the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
272
+ * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
238
273
  sort?: GetConnectionsSortField;
239
274
  /** If present, only return the connection that accesses data files in the specified space. */
240
275
  spaceId?: string;
@@ -253,6 +288,7 @@ type GetDataFilesConnectionsHttpError = {
253
288
  };
254
289
  /**
255
290
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
291
+ *
256
292
  * @param id The ID of the connection.
257
293
  * @throws GetDataFileConnectionHttpError
258
294
  */
@@ -269,6 +305,7 @@ type GetDataFileConnectionHttpError = {
269
305
  };
270
306
  /**
271
307
  * Get quota information for the calling user.
308
+ *
272
309
  * @throws GetDataFilesQuotasHttpError
273
310
  */
274
311
  declare const getDataFilesQuotas: (options?: ApiCallOptions) => Promise<GetDataFilesQuotasHttpResponse>;
@@ -284,6 +321,7 @@ type GetDataFilesQuotasHttpError = {
284
321
  };
285
322
  /**
286
323
  * Delete the specified data file.
324
+ *
287
325
  * @param id The ID of the data file to delete.
288
326
  * @throws DeleteDataFileHttpError
289
327
  */
@@ -300,6 +338,7 @@ type DeleteDataFileHttpError = {
300
338
  };
301
339
  /**
302
340
  * Get descriptive info for the specified data file.
341
+ *
303
342
  * @param id The ID of the data file.
304
343
  * @throws GetDataFileHttpError
305
344
  */
@@ -316,11 +355,43 @@ type GetDataFileHttpError = {
316
355
  };
317
356
  /**
318
357
  * Re-upload an existing data file.
358
+ *
319
359
  * @param id The ID of the data file to update.
320
360
  * @param body an object with the body content
321
361
  * @throws ReuploadDataFileHttpError
322
362
  */
323
- declare const reuploadDataFile: (id: string, body: unknown, options?: ApiCallOptions) => Promise<ReuploadDataFileHttpResponse>;
363
+ declare const reuploadDataFile: (id: string, body: {
364
+ /** IFormFile form multipart/form-data */
365
+ File?: BodyInit;
366
+ /** See PutDataFileRequest schema which defines request structure.
367
+ * See model. */
368
+ Json?: {
369
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
370
+ appId?: string;
371
+ /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
372
+ * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
373
+ * connection is different from the one specified when the file was last POSTed or PUT, this will result in
374
+ * a logical move of this file into the new space. */
375
+ connectionId?: string;
376
+ /** Name that will be given to the uploaded file. If this name is different than the name used when the file
377
+ * was last POSTed or PUT, this will result in a rename of the file. It should be noted that the '/' character
378
+ * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
379
+ * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
380
+ * full pathname of that file. '/' is a significant character in the data file name, and may impact the
381
+ * behavior of future APIs that take this folder hierarchy into account. */
382
+ name?: string;
383
+ /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
384
+ * the specified data file. That is, instead of the file content being specified in the Data element,
385
+ * it is effectively copied from an existing, previously uploaded file. */
386
+ sourceId?: string;
387
+ /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
388
+ * content should be copied into the specified data file. That is, instead of the file content being specified
389
+ * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
390
+ * is that this file was previously uploaded to the temporary content service, and the ID specified here is
391
+ * the one returned from the temp content upload request. */
392
+ tempContentFileId?: string;
393
+ };
394
+ }, options?: ApiCallOptions) => Promise<ReuploadDataFileHttpResponse>;
324
395
  type ReuploadDataFileHttpResponse = {
325
396
  data: DataFileUploadResponse;
326
397
  headers: Headers;
@@ -335,6 +406,7 @@ type ReuploadDataFileHttpError = {
335
406
  * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
336
407
  * part of a data file upload. For data files that reside in a personal space, changing the owner has the
337
408
  * effect of moving the data file to the new owner's personal space.
409
+ *
338
410
  * @param id The ID of the data file whose owner will be updated.
339
411
  * @param body an object with the body content
340
412
  * @throws ChangeDataFileOwnerHttpError
@@ -355,6 +427,7 @@ type ChangeDataFileOwnerHttpError = {
355
427
  * where admin users may not explicitly have been granted full access to a given space within the declared
356
428
  * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
357
429
  * personal space of the user who is the owner of the file.
430
+ *
358
431
  * @param id The ID of the data file whose space will be updated.
359
432
  * @param body an object with the body content
360
433
  * @throws MoveDataFileHttpError
@@ -377,12 +450,14 @@ declare function clearCache(): void;
377
450
  interface DataFilesAPI {
378
451
  /**
379
452
  * Get descriptive info for the specified data files.
453
+ *
380
454
  * @param query an object with query parameters
381
455
  * @throws GetDataFilesHttpError
382
456
  */
383
457
  getDataFiles: typeof getDataFiles;
384
458
  /**
385
459
  * Upload a new data file.
460
+ *
386
461
  * @param body an object with the body content
387
462
  * @throws UploadDataFileHttpError
388
463
  */
@@ -392,12 +467,14 @@ interface DataFilesAPI {
392
467
  * where admin users may not explicitly have been granted full access to a given space within the declared
393
468
  * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
394
469
  * personal space of the user who is the owner of the file.
470
+ *
395
471
  * @param body an object with the body content
396
472
  * @throws MoveDataFilesHttpError
397
473
  */
398
474
  moveDataFiles: typeof moveDataFiles;
399
475
  /**
400
476
  * Delete the specified set of data files as a single batch.
477
+ *
401
478
  * @param body an object with the body content
402
479
  * @throws DeleteDataFilesHttpError
403
480
  */
@@ -405,35 +482,41 @@ interface DataFilesAPI {
405
482
  /**
406
483
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
407
484
  * the given user has access to.
485
+ *
408
486
  * @param query an object with query parameters
409
487
  * @throws GetDataFilesConnectionsHttpError
410
488
  */
411
489
  getDataFilesConnections: typeof getDataFilesConnections;
412
490
  /**
413
491
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
492
+ *
414
493
  * @param id The ID of the connection.
415
494
  * @throws GetDataFileConnectionHttpError
416
495
  */
417
496
  getDataFileConnection: typeof getDataFileConnection;
418
497
  /**
419
498
  * Get quota information for the calling user.
499
+ *
420
500
  * @throws GetDataFilesQuotasHttpError
421
501
  */
422
502
  getDataFilesQuotas: typeof getDataFilesQuotas;
423
503
  /**
424
504
  * Delete the specified data file.
505
+ *
425
506
  * @param id The ID of the data file to delete.
426
507
  * @throws DeleteDataFileHttpError
427
508
  */
428
509
  deleteDataFile: typeof deleteDataFile;
429
510
  /**
430
511
  * Get descriptive info for the specified data file.
512
+ *
431
513
  * @param id The ID of the data file.
432
514
  * @throws GetDataFileHttpError
433
515
  */
434
516
  getDataFile: typeof getDataFile;
435
517
  /**
436
518
  * Re-upload an existing data file.
519
+ *
437
520
  * @param id The ID of the data file to update.
438
521
  * @param body an object with the body content
439
522
  * @throws ReuploadDataFileHttpError
@@ -443,6 +526,7 @@ interface DataFilesAPI {
443
526
  * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
444
527
  * part of a data file upload. For data files that reside in a personal space, changing the owner has the
445
528
  * effect of moving the data file to the new owner's personal space.
529
+ *
446
530
  * @param id The ID of the data file whose owner will be updated.
447
531
  * @param body an object with the body content
448
532
  * @throws ChangeDataFileOwnerHttpError
@@ -453,6 +537,7 @@ interface DataFilesAPI {
453
537
  * where admin users may not explicitly have been granted full access to a given space within the declared
454
538
  * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
455
539
  * personal space of the user who is the owner of the file.
540
+ *
456
541
  * @param id The ID of the data file whose space will be updated.
457
542
  * @param body an object with the body content
458
543
  * @throws MoveDataFileHttpError
package/data-files.d.ts CHANGED
@@ -5,7 +5,7 @@ type BatchChangeSpaceItem = {
5
5
  /** The ID of the data file whose space will be changed. */
6
6
  id: string;
7
7
  /** The ID of the new space. Passing in a null will result in the data file being moved to the user's
8
- // personal space. */
8
+ * personal space. */
9
9
  spaceId?: string;
10
10
  };
11
11
  type BatchDeleteItem = {
@@ -28,7 +28,7 @@ type ConnectionsResponse = {
28
28
  /** The name of the connection. */
29
29
  name: string;
30
30
  /** The team space that the given connection is associated with. If null, the connection is not associated
31
- // with any specific team space. */
31
+ * with any specific team space. */
32
32
  spaceId?: string;
33
33
  /** The type of the connection. */
34
34
  type: string;
@@ -112,21 +112,22 @@ type QuotaResponse = {
112
112
  /** The allowed file extensions on files that are uploaded. */
113
113
  allowedExtensions: string[];
114
114
  /** The allowed file extensions for files that are only used internally by the system (and thus not typically
115
- // shown to end users). */
115
+ * shown to end users). */
116
116
  allowedInternalExtensions: string[];
117
117
  /** Maximum allowable size of an uploaded file. */
118
118
  maxFileSize: number;
119
119
  /** Maximum allowable size for a single uploaded large data file (in bytes). This is a file that was indirectly
120
- // uploaded using the temp content service chunked upload capability. */
120
+ * uploaded using the temp content service chunked upload capability. */
121
121
  maxLargeFileSize: number;
122
122
  /** The maximum aggregate size of all files uploaded by a given user. */
123
123
  maxSize: number;
124
124
  /** The current aggregate size of all files uploaded by a given user. If the current aggregate size is greater
125
- // than the maximum aggregate size, this is a quota violation. */
125
+ * than the maximum aggregate size, this is a quota violation. */
126
126
  size: number;
127
127
  };
128
128
  /**
129
129
  * Get descriptive info for the specified data files.
130
+ *
130
131
  * @param query an object with query parameters
131
132
  * @throws GetDataFilesHttpError
132
133
  */
@@ -134,23 +135,23 @@ declare const getDataFiles: (query: {
134
135
  /** If set to false, do not return data files with internal extensions else return all the data files. */
135
136
  allowInternalFiles?: boolean;
136
137
  /** Only return files scoped to the specified app. If this parameter is not specified, only files that are not
137
- // scoped to any app are returned. "*" implies all app-scoped files are returned. */
138
+ * scoped to any app are returned. "*" implies all app-scoped files are returned. */
138
139
  appId?: string;
139
140
  /** Return files that reside in the space referenced by the specified DataFiles connection. If this parameter
140
- // is not specified, the user's personal space is implied. */
141
+ * is not specified, the user's personal space is implied. */
141
142
  connectionId?: string;
142
143
  /** If present, the maximum number of data files to return. */
143
144
  limit?: number;
144
145
  /** Filter the list of files returned to the given file name. */
145
146
  name?: string;
146
147
  /** If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the
147
- // returned list is constrained to the specified space. If connectionId is not specified, then all files owned
148
- // by the specified user are returned regardless of the personal space that a given file resides in. */
148
+ * returned list is constrained to the specified space. If connectionId is not specified, then all files owned
149
+ * by the specified user are returned regardless of the personal space that a given file resides in. */
149
150
  ownerId?: string;
150
151
  /** If present, the cursor that starts the page of data that is returned. */
151
152
  page?: string;
152
153
  /** The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on
153
- // the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
154
+ * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
154
155
  sort?: GetDataFileInfosSortField;
155
156
  }, options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
156
157
  type GetDataFilesHttpResponse = {
@@ -167,10 +168,41 @@ type GetDataFilesHttpError = {
167
168
  };
168
169
  /**
169
170
  * Upload a new data file.
171
+ *
170
172
  * @param body an object with the body content
171
173
  * @throws UploadDataFileHttpError
172
174
  */
173
- declare const uploadDataFile: (body: unknown, options?: ApiCallOptions) => Promise<UploadDataFileHttpResponse>;
175
+ declare const uploadDataFile: (body: {
176
+ /** IFormFile form multipart/form-data */
177
+ File?: BodyInit;
178
+ /** See PostDataFileRequest schema which defines request structure.
179
+ * See model. */
180
+ Json?: {
181
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
182
+ appId?: string;
183
+ /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
184
+ * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
185
+ * connection is different from the one specified when the file was last POSTed or PUT, this will result in
186
+ * a logical move of this file into the new space. */
187
+ connectionId?: string;
188
+ /** Name that will be given to the uploaded file. It should be noted that the '/' character
189
+ * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
190
+ * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
191
+ * full pathname of that file. '/' is a significant character in the data file name, and may impact the
192
+ * behavior of future APIs which take this folder hierarchy into account. */
193
+ name: string;
194
+ /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
195
+ * the specified data file. That is, instead of the file content being specified in the Data element,
196
+ * it is effectively copied from an existing, previously uploaded file. */
197
+ sourceId?: string;
198
+ /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
199
+ * content should be copied into the specified data file. That is, instead of the file content being specified
200
+ * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
201
+ * is that this file was previously uploaded to the temporary content service, and the ID specified here is
202
+ * the one returned from the temp content upload request. */
203
+ tempContentFileId?: string;
204
+ };
205
+ }, options?: ApiCallOptions) => Promise<UploadDataFileHttpResponse>;
174
206
  type UploadDataFileHttpResponse = {
175
207
  data: DataFileUploadResponse;
176
208
  headers: Headers;
@@ -186,6 +218,7 @@ type UploadDataFileHttpError = {
186
218
  * where admin users may not explicitly have been granted full access to a given space within the declared
187
219
  * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
188
220
  * personal space of the user who is the owner of the file.
221
+ *
189
222
  * @param body an object with the body content
190
223
  * @throws MoveDataFilesHttpError
191
224
  */
@@ -202,6 +235,7 @@ type MoveDataFilesHttpError = {
202
235
  };
203
236
  /**
204
237
  * Delete the specified set of data files as a single batch.
238
+ *
205
239
  * @param body an object with the body content
206
240
  * @throws DeleteDataFilesHttpError
207
241
  */
@@ -219,6 +253,7 @@ type DeleteDataFilesHttpError = {
219
253
  /**
220
254
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
221
255
  * the given user has access to.
256
+ *
222
257
  * @param query an object with query parameters
223
258
  * @throws GetDataFilesConnectionsHttpError
224
259
  */
@@ -234,7 +269,7 @@ declare const getDataFilesConnections: (query: {
234
269
  /** If true, only return the connections that access data in a personal space. Default is false. */
235
270
  personal?: boolean;
236
271
  /** The name of the field used to sort the result. By default, the sort is ascending. Putting a '+' prefix on
237
- // the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
272
+ * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
238
273
  sort?: GetConnectionsSortField;
239
274
  /** If present, only return the connection that accesses data files in the specified space. */
240
275
  spaceId?: string;
@@ -253,6 +288,7 @@ type GetDataFilesConnectionsHttpError = {
253
288
  };
254
289
  /**
255
290
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
291
+ *
256
292
  * @param id The ID of the connection.
257
293
  * @throws GetDataFileConnectionHttpError
258
294
  */
@@ -269,6 +305,7 @@ type GetDataFileConnectionHttpError = {
269
305
  };
270
306
  /**
271
307
  * Get quota information for the calling user.
308
+ *
272
309
  * @throws GetDataFilesQuotasHttpError
273
310
  */
274
311
  declare const getDataFilesQuotas: (options?: ApiCallOptions) => Promise<GetDataFilesQuotasHttpResponse>;
@@ -284,6 +321,7 @@ type GetDataFilesQuotasHttpError = {
284
321
  };
285
322
  /**
286
323
  * Delete the specified data file.
324
+ *
287
325
  * @param id The ID of the data file to delete.
288
326
  * @throws DeleteDataFileHttpError
289
327
  */
@@ -300,6 +338,7 @@ type DeleteDataFileHttpError = {
300
338
  };
301
339
  /**
302
340
  * Get descriptive info for the specified data file.
341
+ *
303
342
  * @param id The ID of the data file.
304
343
  * @throws GetDataFileHttpError
305
344
  */
@@ -316,11 +355,43 @@ type GetDataFileHttpError = {
316
355
  };
317
356
  /**
318
357
  * Re-upload an existing data file.
358
+ *
319
359
  * @param id The ID of the data file to update.
320
360
  * @param body an object with the body content
321
361
  * @throws ReuploadDataFileHttpError
322
362
  */
323
- declare const reuploadDataFile: (id: string, body: unknown, options?: ApiCallOptions) => Promise<ReuploadDataFileHttpResponse>;
363
+ declare const reuploadDataFile: (id: string, body: {
364
+ /** IFormFile form multipart/form-data */
365
+ File?: BodyInit;
366
+ /** See PutDataFileRequest schema which defines request structure.
367
+ * See model. */
368
+ Json?: {
369
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
370
+ appId?: string;
371
+ /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
372
+ * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
373
+ * connection is different from the one specified when the file was last POSTed or PUT, this will result in
374
+ * a logical move of this file into the new space. */
375
+ connectionId?: string;
376
+ /** Name that will be given to the uploaded file. If this name is different than the name used when the file
377
+ * was last POSTed or PUT, this will result in a rename of the file. It should be noted that the '/' character
378
+ * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
379
+ * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
380
+ * full pathname of that file. '/' is a significant character in the data file name, and may impact the
381
+ * behavior of future APIs that take this folder hierarchy into account. */
382
+ name?: string;
383
+ /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
384
+ * the specified data file. That is, instead of the file content being specified in the Data element,
385
+ * it is effectively copied from an existing, previously uploaded file. */
386
+ sourceId?: string;
387
+ /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
388
+ * content should be copied into the specified data file. That is, instead of the file content being specified
389
+ * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
390
+ * is that this file was previously uploaded to the temporary content service, and the ID specified here is
391
+ * the one returned from the temp content upload request. */
392
+ tempContentFileId?: string;
393
+ };
394
+ }, options?: ApiCallOptions) => Promise<ReuploadDataFileHttpResponse>;
324
395
  type ReuploadDataFileHttpResponse = {
325
396
  data: DataFileUploadResponse;
326
397
  headers: Headers;
@@ -335,6 +406,7 @@ type ReuploadDataFileHttpError = {
335
406
  * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
336
407
  * part of a data file upload. For data files that reside in a personal space, changing the owner has the
337
408
  * effect of moving the data file to the new owner's personal space.
409
+ *
338
410
  * @param id The ID of the data file whose owner will be updated.
339
411
  * @param body an object with the body content
340
412
  * @throws ChangeDataFileOwnerHttpError
@@ -355,6 +427,7 @@ type ChangeDataFileOwnerHttpError = {
355
427
  * where admin users may not explicitly have been granted full access to a given space within the declared
356
428
  * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
357
429
  * personal space of the user who is the owner of the file.
430
+ *
358
431
  * @param id The ID of the data file whose space will be updated.
359
432
  * @param body an object with the body content
360
433
  * @throws MoveDataFileHttpError
@@ -377,12 +450,14 @@ declare function clearCache(): void;
377
450
  interface DataFilesAPI {
378
451
  /**
379
452
  * Get descriptive info for the specified data files.
453
+ *
380
454
  * @param query an object with query parameters
381
455
  * @throws GetDataFilesHttpError
382
456
  */
383
457
  getDataFiles: typeof getDataFiles;
384
458
  /**
385
459
  * Upload a new data file.
460
+ *
386
461
  * @param body an object with the body content
387
462
  * @throws UploadDataFileHttpError
388
463
  */
@@ -392,12 +467,14 @@ interface DataFilesAPI {
392
467
  * where admin users may not explicitly have been granted full access to a given space within the declared
393
468
  * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
394
469
  * personal space of the user who is the owner of the file.
470
+ *
395
471
  * @param body an object with the body content
396
472
  * @throws MoveDataFilesHttpError
397
473
  */
398
474
  moveDataFiles: typeof moveDataFiles;
399
475
  /**
400
476
  * Delete the specified set of data files as a single batch.
477
+ *
401
478
  * @param body an object with the body content
402
479
  * @throws DeleteDataFilesHttpError
403
480
  */
@@ -405,35 +482,41 @@ interface DataFilesAPI {
405
482
  /**
406
483
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
407
484
  * the given user has access to.
485
+ *
408
486
  * @param query an object with query parameters
409
487
  * @throws GetDataFilesConnectionsHttpError
410
488
  */
411
489
  getDataFilesConnections: typeof getDataFilesConnections;
412
490
  /**
413
491
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
492
+ *
414
493
  * @param id The ID of the connection.
415
494
  * @throws GetDataFileConnectionHttpError
416
495
  */
417
496
  getDataFileConnection: typeof getDataFileConnection;
418
497
  /**
419
498
  * Get quota information for the calling user.
499
+ *
420
500
  * @throws GetDataFilesQuotasHttpError
421
501
  */
422
502
  getDataFilesQuotas: typeof getDataFilesQuotas;
423
503
  /**
424
504
  * Delete the specified data file.
505
+ *
425
506
  * @param id The ID of the data file to delete.
426
507
  * @throws DeleteDataFileHttpError
427
508
  */
428
509
  deleteDataFile: typeof deleteDataFile;
429
510
  /**
430
511
  * Get descriptive info for the specified data file.
512
+ *
431
513
  * @param id The ID of the data file.
432
514
  * @throws GetDataFileHttpError
433
515
  */
434
516
  getDataFile: typeof getDataFile;
435
517
  /**
436
518
  * Re-upload an existing data file.
519
+ *
437
520
  * @param id The ID of the data file to update.
438
521
  * @param body an object with the body content
439
522
  * @throws ReuploadDataFileHttpError
@@ -443,6 +526,7 @@ interface DataFilesAPI {
443
526
  * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
444
527
  * part of a data file upload. For data files that reside in a personal space, changing the owner has the
445
528
  * effect of moving the data file to the new owner's personal space.
529
+ *
446
530
  * @param id The ID of the data file whose owner will be updated.
447
531
  * @param body an object with the body content
448
532
  * @throws ChangeDataFileOwnerHttpError
@@ -453,6 +537,7 @@ interface DataFilesAPI {
453
537
  * where admin users may not explicitly have been granted full access to a given space within the declared
454
538
  * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
455
539
  * personal space of the user who is the owner of the file.
540
+ *
456
541
  * @param id The ID of the data file whose space will be updated.
457
542
  * @param body an object with the body content
458
543
  * @throws MoveDataFileHttpError