@qlik/api 1.16.0 → 1.18.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 (81) hide show
  1. package/api-keys.d.ts +32 -28
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +4 -4
  4. package/apps.js +2 -2
  5. package/audits.d.ts +2 -2
  6. package/audits.js +2 -2
  7. package/{auth-types-BU5EGt_9.d.ts → auth-types-PkN9CAF_.d.ts} +3 -0
  8. package/auth.d.ts +2 -2
  9. package/auth.js +2 -2
  10. package/automations.d.ts +2 -2
  11. package/automations.js +2 -2
  12. package/brands.d.ts +2 -2
  13. package/brands.js +2 -2
  14. package/chunks/{PESPSFQN.js → 2B3EPESP.js} +1 -1
  15. package/chunks/{MFNOHOWH.js → 2NXPFUPZ.js} +2 -2
  16. package/chunks/{O3XVX7VQ.js → 4FZ45I6G.js} +1 -1
  17. package/chunks/{GXMVBX45.js → GKEPTI44.js} +1 -1
  18. package/chunks/{TBHMVTOT.js → GLS4DAZ4.js} +1 -1
  19. package/chunks/{6O3XBOLZ.js → H7WWFWBM.js} +1 -1
  20. package/chunks/{YHKRUQRS.js → QLFOH4GP.js} +120 -11
  21. package/chunks/{ECWQX4IH.js → URFSYYRS.js} +1 -1
  22. package/chunks/{3XRP5N4L.js → YEHZGXQV.js} +141 -73
  23. package/chunks/{7IMOYFWE.js → ZLPAS7FC.js} +3 -3
  24. package/collections.d.ts +18 -17
  25. package/collections.js +2 -2
  26. package/csp-origins.d.ts +2 -2
  27. package/csp-origins.js +2 -2
  28. package/data-assets.d.ts +2 -2
  29. package/data-assets.js +2 -2
  30. package/data-connections.d.ts +2 -2
  31. package/data-connections.js +2 -2
  32. package/data-credentials.d.ts +2 -2
  33. package/data-credentials.js +2 -2
  34. package/data-files.d.ts +274 -76
  35. package/data-files.js +2 -2
  36. package/extensions.d.ts +18 -18
  37. package/extensions.js +2 -2
  38. package/{global.types-z1p6A9D-.d.ts → global.types--37uwGji.d.ts} +4 -1
  39. package/glossaries.d.ts +2 -2
  40. package/glossaries.js +2 -2
  41. package/groups.d.ts +2 -2
  42. package/groups.js +2 -2
  43. package/identity-providers.d.ts +2 -2
  44. package/identity-providers.js +2 -2
  45. package/index.d.ts +2 -2
  46. package/index.js +4 -4
  47. package/items.d.ts +11 -11
  48. package/items.js +2 -2
  49. package/licenses.d.ts +2 -2
  50. package/licenses.js +2 -2
  51. package/package.json +2 -2
  52. package/qix.d.ts +7 -4
  53. package/qix.js +2 -2
  54. package/quotas.d.ts +2 -2
  55. package/quotas.js +2 -2
  56. package/reload-tasks.d.ts +12 -12
  57. package/reload-tasks.js +2 -2
  58. package/reloads.d.ts +4 -4
  59. package/reloads.js +2 -2
  60. package/reports.d.ts +5 -3
  61. package/reports.js +2 -2
  62. package/roles.d.ts +2 -2
  63. package/roles.js +2 -2
  64. package/spaces.d.ts +2 -2
  65. package/spaces.js +2 -2
  66. package/temp-contents.d.ts +2 -2
  67. package/temp-contents.js +2 -2
  68. package/tenants.d.ts +2 -2
  69. package/tenants.js +2 -2
  70. package/themes.d.ts +18 -18
  71. package/themes.js +2 -2
  72. package/transports.d.ts +2 -2
  73. package/transports.js +2 -2
  74. package/users.d.ts +2 -2
  75. package/users.js +2 -2
  76. package/web-integrations.d.ts +2 -2
  77. package/web-integrations.js +2 -2
  78. package/web-notifications.d.ts +2 -2
  79. package/web-notifications.js +2 -2
  80. package/webhooks.d.ts +2 -2
  81. package/webhooks.js +2 -2
package/data-files.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-z1p6A9D-.js';
2
- import './auth-types-BU5EGt_9.js';
1
+ import { A as ApiCallOptions } from './global.types--37uwGji.js';
2
+ import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type BatchChangeSpaceItem = {
5
5
  /** The ID of the data file whose space will be changed. */
@@ -8,6 +8,10 @@ type BatchChangeSpaceItem = {
8
8
  * personal space. */
9
9
  spaceId?: string;
10
10
  };
11
+ type BatchDeleteAllBySpaceItem = {
12
+ /** The ID of the space whose data files will be deleted. */
13
+ id: string;
14
+ };
11
15
  type BatchDeleteItem = {
12
16
  /** The ID of the data file to delete. */
13
17
  id: string;
@@ -30,6 +34,7 @@ type ConnectionsResponse = {
30
34
  /** The team space that the given connection is associated with. If null, the connection is not associated
31
35
  * with any specific team space. */
32
36
  spaceId?: string;
37
+ spaceStats?: SpaceStatsResponse;
33
38
  /** The type of the connection. */
34
39
  type: string;
35
40
  };
@@ -40,55 +45,123 @@ type DataFileBatchChangeSpaceRequest = {
40
45
  /** The list of data files to delete. */
41
46
  "change-space": BatchChangeSpaceItem[];
42
47
  };
43
- /**
44
- * Specifies the list of data files to be deleted in a single batch.
45
- */
46
48
  type DataFileBatchDeleteRequest = {
47
- /** The list of data files to delete. */
49
+ /** If specified, the explicit list of data files to delete. */
48
50
  delete: BatchDeleteItem[];
51
+ /** If specified, attempt to delete all of the data files from the specified shared spaces. */
52
+ deleteAllBySpace?: BatchDeleteAllBySpaceItem[];
53
+ /** If specified, attempt to delete all of the datafiles from ther user's personal space. */
54
+ deleteAllFromPersonalSpace?: boolean;
49
55
  };
56
+ /**
57
+ * <p>Members:</p><ul></ul>
58
+ */
59
+ type DataFilePermission = "read" | "update" | "delete" | "list" | "change_owner" | "change_space";
50
60
  type DataFileUploadResponse = {
51
- /** If this file is bound to the lifecycle of a specific app, this is the ID of this app. */
61
+ /** The CRUD actions that are allowed on the given data file. */
62
+ actions: DataFilePermission[];
63
+ /** If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app. */
52
64
  appId?: string;
53
- /** The date that the uploaded file was created. */
65
+ /** The name of the file or folder, not including any folder path prefix. */
66
+ baseName?: string;
67
+ /** The date that the file or folder was created. */
54
68
  createdDate: string;
55
- /** The ID for the uploaded file. */
69
+ /** Whether or not this given item represents a folder or a file. */
70
+ folder?: boolean;
71
+ /** If the file or folder resides in a parent folder, this is the parent folder ID. If the file or folder
72
+ * does not reside in a parent folder, this value is null. */
73
+ folderId?: string;
74
+ /** If the file or folder resides in a parent folder, this is the parent folder path. If the file or folder
75
+ * does not reside in a parent folder, this value is null. */
76
+ folderPath?: string;
77
+ folderStats: FolderStatsResponse;
78
+ /** The ID for the file or folder. */
56
79
  id: string;
57
- /** The date that the updated file was last modified. */
80
+ /** The date that the updated file or folder was last modified. */
58
81
  modifiedDate?: string;
59
- /** The name of the uploaded file. */
82
+ /** The full name of the file or folder, including any folder path prefix. */
60
83
  name: string;
61
- /** The 'owner' of a file is the user who last uploaded the file's content. */
84
+ /** The 'owner' of a file or folder is the user who last uploaded the item's content. */
62
85
  ownerId: string;
63
- /** The size of the uploaded file, in bytes. */
86
+ /** The QRI generated from the datafile or folder's metadata. */
87
+ qri?: string;
88
+ /** The size of the uploaded file, in bytes. 0 if this item represents a folder */
64
89
  size: number;
65
- /** If the file was uploaded to a team space, this is the ID of that space. */
90
+ /** If the file or folder was created in a team space, this is the ID of that space. */
66
91
  spaceId?: string;
67
92
  };
93
+ /**
94
+ * Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
95
+ * error code, the error code is set to the HTTP status code.<p>Members:</p><ul><li><i>DF-001</i> - The page cursor passed as a parameter to the GET operation is invalid.</li><li><i>DF-002</i> - The sort specification passed as a parameter to the GET operation is invalid.</li><li><i>DF-003</i> - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.</li><li><i>DF-004</i> - The provided FolderPath must be in canonical form.</li><li><i>DF-005</i> - The specified parent folder cannot be found.</li><li><i>DF-006</i> - The specified owner cannot be found.</li><li><i>DF-007</i> - A connection corresponding to the specified space cannot be found.</li><li><i>DF-008</i> - THe specified ID must correspond to a folder, not a file.</li><li><i>DF-009</i> - The specified space cannot be found.</li><li><i>DF-010</i> - The specified file name contains an invalid file extension.</li><li><i>DF-011</i> - The specified file name is missing a file extension.</li><li><i>DF-012</i> - The specified temporary content file could not be found.</li><li><i>DF-013</i> - Access to the specified space is forbidden.</li><li><i>DF-014</i> - The specified connection cannot be found.</li><li><i>DF-015</i> - The provided filename must be in canonical form.</li><li><i>DF-016</i> - The datafile size quota for the given personal space has been exceeded.</li><li><i>DF-017</i> - The specified source file or folder could not be found.</li><li><i>DF-018</i> - The source and target of a datafile operation must either both be folders or both be files, but they are
96
+ * not.</li><li><i>DF-019</i> - The specified target folder is a child of the specified source folder, which is not allowed.</li><li><i>DF-020</i> - The specified folder does not exist in the specified space.</li><li><i>DF-021</i> - The specified source file or folder is already locked.</li><li><i>DF-022</i> - The automatic creation of a missing parent folder failed.</li><li><i>DF-023</i> - An attempt to lock a parent folder of a given data file item failed.</li><li><i>DF-024</i> - The attempt to copy a source file or folder to a target failed.</li><li><i>DF-025</i> - The specified target file or folder is already locked.</li><li><i>DF-026</i> - The request results in the creation of a folder hierarchy which is beyond the max allowed folder
97
+ * hierarchy depth.</li></ul>
98
+ */
99
+ type ErrorCode = "HTTP-200" | "HTTP-201" | "HTTP-204" | "HTTP-400" | "HTTP-403" | "HTTP-404" | "HTTP-409" | "HTTP-413" | "HTTP-423" | "HTTP-500" | "HTTP-501" | "HTTP-503" | "DF-001" | "DF-002" | "DF-003" | "DF-004" | "DF-005" | "DF-006" | "DF-007" | "DF-008" | "DF-009" | "DF-010" | "DF-011" | "DF-012" | "DF-013" | "DF-014" | "DF-015" | "DF-016" | "DF-017" | "DF-018" | "DF-019" | "DF-020" | "DF-021" | "DF-022" | "DF-023" | "DF-024" | "DF-025" | "DF-026";
68
100
  type ErrorResponse = {
69
101
  /** List of errors and their properties. */
70
102
  errors: ErrorResponseItem[];
71
103
  };
72
104
  type ErrorResponseItem = {
73
- /** The error code. */
74
- code: string;
105
+ /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
106
+ * error code, the error code is set to the HTTP status code.<p>Members:</p><ul><li><i>DF-001</i> - The page cursor passed as a parameter to the GET operation is invalid.</li><li><i>DF-002</i> - The sort specification passed as a parameter to the GET operation is invalid.</li><li><i>DF-003</i> - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.</li><li><i>DF-004</i> - The provided FolderPath must be in canonical form.</li><li><i>DF-005</i> - The specified parent folder cannot be found.</li><li><i>DF-006</i> - The specified owner cannot be found.</li><li><i>DF-007</i> - A connection corresponding to the specified space cannot be found.</li><li><i>DF-008</i> - THe specified ID must correspond to a folder, not a file.</li><li><i>DF-009</i> - The specified space cannot be found.</li><li><i>DF-010</i> - The specified file name contains an invalid file extension.</li><li><i>DF-011</i> - The specified file name is missing a file extension.</li><li><i>DF-012</i> - The specified temporary content file could not be found.</li><li><i>DF-013</i> - Access to the specified space is forbidden.</li><li><i>DF-014</i> - The specified connection cannot be found.</li><li><i>DF-015</i> - The provided filename must be in canonical form.</li><li><i>DF-016</i> - The datafile size quota for the given personal space has been exceeded.</li><li><i>DF-017</i> - The specified source file or folder could not be found.</li><li><i>DF-018</i> - The source and target of a datafile operation must either both be folders or both be files, but they are
107
+ * not.</li><li><i>DF-019</i> - The specified target folder is a child of the specified source folder, which is not allowed.</li><li><i>DF-020</i> - The specified folder does not exist in the specified space.</li><li><i>DF-021</i> - The specified source file or folder is already locked.</li><li><i>DF-022</i> - The automatic creation of a missing parent folder failed.</li><li><i>DF-023</i> - An attempt to lock a parent folder of a given data file item failed.</li><li><i>DF-024</i> - The attempt to copy a source file or folder to a target failed.</li><li><i>DF-025</i> - The specified target file or folder is already locked.</li><li><i>DF-026</i> - The request results in the creation of a folder hierarchy which is beyond the max allowed folder
108
+ * hierarchy depth.</li></ul> */
109
+ code: ErrorCode;
75
110
  /** A human-readable explanation specific to this occurrence of the problem. */
76
111
  detail?: string;
77
112
  /** Summary of the problem. */
78
113
  title?: string;
79
114
  };
115
+ type FolderStatsResponse = {
116
+ /** The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of
117
+ * the given folder and it's sub-folder hierarchy. */
118
+ aggregateAppScopedFileSize: number;
119
+ /** The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given
120
+ * folder and it's sub-folder hierarchy. */
121
+ aggregateFileSize: number;
122
+ /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
123
+ * the given folder and it's sub-folder hierarchy. */
124
+ aggregateInternalFileSize: number;
125
+ /** The number of app-scoped data files that reside as direct children of the given folder. */
126
+ directAppScopedFileCount: number;
127
+ /** The number of data files that reside as direct children of the given folder. */
128
+ directFileCount: number;
129
+ /** The number of sub-folders that reside as direct children of the given folder. */
130
+ directFolderCount: number;
131
+ /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
132
+ * direct children of the given folder. */
133
+ directInternalFileCount: number;
134
+ /** The number of app-scoped data files that reside as direct and indirect children of the given folder and it's
135
+ * sub-folder hierarchy. */
136
+ totalAppScopedFileCount: number;
137
+ /** The number of data files that reside as direct and indirect children of the given folder and it's sub-folder
138
+ * hierarchy. */
139
+ totalFileCount: number;
140
+ /** The number of folders that reside as direct and indirect children of the given folder and it's sub-folder
141
+ * hierarchy. */
142
+ totalFolderCount: number;
143
+ /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
144
+ * direct and indirect children of the given folder and it's sub-folder hierarchy. */
145
+ totalInternalFileCount: number;
146
+ };
80
147
  type GetConnectionsResponse = {
81
148
  /** Properties of the connections to the tenant spaces. */
82
149
  data: ConnectionsResponse[];
83
150
  links: LinksResponse;
84
151
  };
152
+ /**
153
+ * <p>Members:</p><ul></ul>
154
+ */
85
155
  type GetConnectionsSortField = "spaceId" | "+spaceId" | "-spaceId";
86
156
  type GetDataFileInfosResponse = {
87
157
  /** Properties of the uploaded data files. */
88
158
  data: DataFileUploadResponse[];
89
159
  links: LinksResponse;
90
160
  };
91
- type GetDataFileInfosSortField = "name" | "+name" | "-name" | "size" | "+size" | "-size" | "modifiedDate" | "+modifiedDate" | "-modifiedDate";
161
+ /**
162
+ * <p>Members:</p><ul></ul>
163
+ */
164
+ type GetDataFileInfosSortField = "name" | "+name" | "-name" | "size" | "+size" | "-size" | "modifiedDate" | "+modifiedDate" | "-modifiedDate" | "folder" | "+folder" | "-folder" | "baseName" | "+baseName" | "-baseName";
92
165
  type LinkResponse = {
93
166
  /** The URL for the link. */
94
167
  href?: string;
@@ -103,8 +176,11 @@ type MultiStatusResponse = {
103
176
  data: MultiStatusResponseItem[];
104
177
  };
105
178
  type MultiStatusResponseItem = {
106
- /** The error code. */
107
- code: string;
179
+ /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
180
+ * error code, the error code is set to the HTTP status code.<p>Members:</p><ul><li><i>DF-001</i> - The page cursor passed as a parameter to the GET operation is invalid.</li><li><i>DF-002</i> - The sort specification passed as a parameter to the GET operation is invalid.</li><li><i>DF-003</i> - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.</li><li><i>DF-004</i> - The provided FolderPath must be in canonical form.</li><li><i>DF-005</i> - The specified parent folder cannot be found.</li><li><i>DF-006</i> - The specified owner cannot be found.</li><li><i>DF-007</i> - A connection corresponding to the specified space cannot be found.</li><li><i>DF-008</i> - THe specified ID must correspond to a folder, not a file.</li><li><i>DF-009</i> - The specified space cannot be found.</li><li><i>DF-010</i> - The specified file name contains an invalid file extension.</li><li><i>DF-011</i> - The specified file name is missing a file extension.</li><li><i>DF-012</i> - The specified temporary content file could not be found.</li><li><i>DF-013</i> - Access to the specified space is forbidden.</li><li><i>DF-014</i> - The specified connection cannot be found.</li><li><i>DF-015</i> - The provided filename must be in canonical form.</li><li><i>DF-016</i> - The datafile size quota for the given personal space has been exceeded.</li><li><i>DF-017</i> - The specified source file or folder could not be found.</li><li><i>DF-018</i> - The source and target of a datafile operation must either both be folders or both be files, but they are
181
+ * not.</li><li><i>DF-019</i> - The specified target folder is a child of the specified source folder, which is not allowed.</li><li><i>DF-020</i> - The specified folder does not exist in the specified space.</li><li><i>DF-021</i> - The specified source file or folder is already locked.</li><li><i>DF-022</i> - The automatic creation of a missing parent folder failed.</li><li><i>DF-023</i> - An attempt to lock a parent folder of a given data file item failed.</li><li><i>DF-024</i> - The attempt to copy a source file or folder to a target failed.</li><li><i>DF-025</i> - The specified target file or folder is already locked.</li><li><i>DF-026</i> - The request results in the creation of a folder hierarchy which is beyond the max allowed folder
182
+ * hierarchy depth.</li></ul> */
183
+ code: ErrorCode;
108
184
  /** A human-readable explanation specific to this occurrence of the problem. */
109
185
  detail?: string;
110
186
  /** The unique identifier of the file. */
@@ -114,6 +190,18 @@ type MultiStatusResponseItem = {
114
190
  /** Summary of the problem. */
115
191
  title?: string;
116
192
  };
193
+ /**
194
+ * If a SourceId is specified, and a folder is being updated by this PUT operation, this specifies how the
195
+ * source folder contents should be applied to the target folder, if the target folder is not empty. 'merge'
196
+ * implies the contents of the source folder should be merged with the existing target contents. That is, all
197
+ * existing direct or indirect child items in the target folder are replaced by the same items in the source folder.
198
+ * All existing items in the target folder that are not present in the source folder are left, as is, in the target.
199
+ * 'replace' implies the contents of the source folder should replace the contents of the target folder. That is,
200
+ * all direct or indirect items in the target folder are removed before the items from the source folder are copied
201
+ * over. The resulting target folder only contains the items from the source folder. If not specified, the default
202
+ * behavior is 'merge'.<p>Members:</p><ul></ul>
203
+ */
204
+ type PutDataFileFolderMergeBehavior = "merge" | "replace";
117
205
  type QuotaResponse = {
118
206
  /** The allowed file extensions on files that are uploaded. */
119
207
  allowedExtensions: string[];
@@ -131,6 +219,38 @@ type QuotaResponse = {
131
219
  * than the maximum aggregate size, this is a quota violation. */
132
220
  size: number;
133
221
  };
222
+ type SpaceStatsResponse = {
223
+ /** The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of
224
+ * the given folder and it's sub-folder hierarchy. */
225
+ aggregateAppScopedFileSize: number;
226
+ /** The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given
227
+ * folder and it's sub-folder hierarchy. */
228
+ aggregateFileSize: number;
229
+ /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
230
+ * the given folder and it's sub-folder hierarchy. */
231
+ aggregateInternalFileSize: number;
232
+ /** The number of app-scoped data files that reside as direct children of the given folder. */
233
+ directAppScopedFileCount: number;
234
+ /** The number of data files that reside as direct children of the given folder. */
235
+ directFileCount: number;
236
+ /** The number of sub-folders that reside as direct children of the given folder. */
237
+ directFolderCount: number;
238
+ /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
239
+ * direct children of the given folder. */
240
+ directInternalFileCount: number;
241
+ /** The number of app-scoped data files that reside as direct and indirect children of the given folder and it's
242
+ * sub-folder hierarchy. */
243
+ totalAppScopedFileCount: number;
244
+ /** The number of data files that reside as direct and indirect children of the given folder and it's sub-folder
245
+ * hierarchy. */
246
+ totalFileCount: number;
247
+ /** The number of folders that reside as direct and indirect children of the given folder and it's sub-folder
248
+ * hierarchy. */
249
+ totalFolderCount: number;
250
+ /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
251
+ * direct and indirect children of the given folder and it's sub-folder hierarchy. */
252
+ totalInternalFileCount: number;
253
+ };
134
254
  /**
135
255
  * Get descriptive info for the specified data files.
136
256
  *
@@ -143,13 +263,43 @@ declare const getDataFiles: (query: {
143
263
  /** Only return files scoped to the specified app. If this parameter is not specified, only files that are not
144
264
  * scoped to any app are returned. "*" implies all app-scoped files are returned. */
145
265
  appId?: string;
146
- /** Return files that reside in the space referenced by the specified DataFiles connection. If this parameter
147
- * is not specified, the user's personal space is implied. */
266
+ /** If present, return only items whose base name matches the given wildcard. Wildcards include '*' and '?'
267
+ * characters to allow for multiple matches. The base name is the actual file or folder name without any
268
+ * folder pathing included. */
269
+ baseNameWildcard?: string;
270
+ /** Return files and folders that reside in the space referenced by the specified DataFiles connection. If this
271
+ * parameter is not specified, the user's personal space is implied. */
148
272
  connectionId?: string;
273
+ /** If set to true, exclude files in the returned list (IE, only return folders). If false, include files. */
274
+ excludeFiles?: boolean;
275
+ /** If set to true, exclude folders and files that reside in sub-folders of the root being searched. If false,
276
+ * include all items in full folder hierarchy that recursively reside under the root. That is, setting to
277
+ * true results in only the direct children of the root being returned. */
278
+ excludeSubFolders?: boolean;
279
+ /** If present, return only items which reside under the folder specified by the given ID. If not present,
280
+ * items that live at the root of the space are returned. This property is mutually exclusive with 'folderPath'. */
281
+ folderId?: string;
282
+ /** If present, return only items which reside under the specified folder path. If not present, items that
283
+ * live at the root of the space are returned. This property is mutually exclusive with 'folderId'. */
284
+ folderPath?: string;
285
+ /** If set to true, and connectionId is not specified, return files and folders from all spaces the given user
286
+ * has access to (including the personal space). If connectionId is specified, this parameter is ignored. */
287
+ includeAllSpaces?: boolean;
288
+ /** If set to true, include computed folder statistics for folders in the returned list. If false, this information
289
+ * is not returned. */
290
+ includeFolderStats?: boolean;
291
+ /** If set to true, include folders in the returned list. If false, only return data files. */
292
+ includeFolders?: boolean;
149
293
  /** If present, the maximum number of data files to return. */
150
294
  limit?: number;
151
295
  /** Filter the list of files returned to the given file name. */
152
296
  name?: string;
297
+ /** If present, fetch the data files whose owner is not the specified owner. If a connectionId is specified in
298
+ * this case, the returned list is constrained to the specified space. If connectionId is not specified, then
299
+ * the returned list is constrained to the calling user's personal space. If includeAllSpaces is set to true,
300
+ * and connectionId is not specified, the returned list is from all spaces the given user
301
+ * has access to (including the personal space). */
302
+ notOwnerId?: string;
153
303
  /** If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the
154
304
  * returned list is constrained to the specified space. If connectionId is not specified, then all files owned
155
305
  * by the specified user are returned regardless of the personal space that a given file resides in. */
@@ -173,7 +323,7 @@ type GetDataFilesHttpError = {
173
323
  status: number;
174
324
  };
175
325
  /**
176
- * Upload a new data file.
326
+ * Upload a new data file or create a new folder.
177
327
  *
178
328
  * @param body an object with the body content
179
329
  * @throws UploadDataFileHttpError
@@ -184,28 +334,36 @@ declare const uploadDataFile: (body: {
184
334
  /** See PostDataFileRequest schema which defines request structure.
185
335
  * See model. */
186
336
  Json?: {
187
- /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
337
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this
338
+ * request is creating a folder, the specification of an app ID is not allowed. */
188
339
  appId?: string;
189
340
  /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
190
- * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
191
- * connection is different from the one specified when the file was last POSTed or PUT, this will result in
192
- * a logical move of this file into the new space. */
341
+ * the default is that the upload will occur in the context of the Personal Space DataFiles connection. If the
342
+ * DataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this
343
+ * will result in a logical move of this file or folder into the new space. */
193
344
  connectionId?: string;
194
- /** Name that will be given to the uploaded file. It should be noted that the '/' character
195
- * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
345
+ /** If true, a folder will be created. If false, a file is created. */
346
+ folder?: boolean;
347
+ /** If the specified file or folder should be moved to become a a sub-item of an existing folder, this is the ID
348
+ * of this parent folder. Any additional folder path that is present on the Name property will be created
349
+ * as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the
350
+ * Name property (including any folder prefix on that name), will be created in the root of the space. */
351
+ folderId?: string;
352
+ /** Name that will be given to the file or folder. It should be noted that the '/' character
353
+ * in the name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
196
354
  * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
197
- * full pathname of that file. '/' is a significant character in the data file name, and may impact the
198
- * behavior of future APIs which take this folder hierarchy into account. */
355
+ * full pathname of that file or folder. IE, a '/' is a significant character in the name. */
199
356
  name: string;
200
- /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
201
- * the specified data file. That is, instead of the file content being specified in the Data element,
202
- * it is effectively copied from an existing, previously uploaded file. */
357
+ /** If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied
358
+ * into the specified data file or folder. That is, for a file instead of the file content being specified in
359
+ * the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, rather
360
+ * than the new folder being empty, it's contents are copied from an existing, previously created folder. */
203
361
  sourceId?: string;
204
362
  /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
205
363
  * content should be copied into the specified data file. That is, instead of the file content being specified
206
364
  * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
207
365
  * is that this file was previously uploaded to the temporary content service, and the ID specified here is
208
- * the one returned from the temp content upload request. */
366
+ * the one returned from the temp content upload request. This option does not apply when POSTing a folder. */
209
367
  tempContentFileId?: string;
210
368
  };
211
369
  }, options?: ApiCallOptions) => Promise<UploadDataFileHttpResponse>;
@@ -222,8 +380,8 @@ type UploadDataFileHttpError = {
222
380
  /**
223
381
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
224
382
  * where admin users may not explicitly have been granted full access to a given space within the declared
225
- * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
226
- * personal space of the user who is the owner of the file.
383
+ * space-level permissions. If the space ID is set to null, then the data file or folder will end up residing
384
+ * in the personal space of the user who is the owner of the item.
227
385
  *
228
386
  * @param body an object with the body content
229
387
  * @throws MoveDataFilesHttpError
@@ -240,7 +398,7 @@ type MoveDataFilesHttpError = {
240
398
  status: number;
241
399
  };
242
400
  /**
243
- * Delete the specified set of data files as a single batch.
401
+ * Delete the specified set of data files and/or folders as a single batch.
244
402
  *
245
403
  * @param body an object with the body content
246
404
  * @throws DeleteDataFilesHttpError
@@ -266,6 +424,9 @@ type DeleteDataFilesHttpError = {
266
424
  declare const getDataFilesConnections: (query: {
267
425
  /** If present, get connections with connection strings that are scoped to the given app ID. */
268
426
  appId?: string;
427
+ /** If set to true, include computed space-level statistics for the spaces represented by the connections in the
428
+ * returned list. If false, this information is not returned. */
429
+ includeSpaceStats?: boolean;
269
430
  /** If present, the maximum number of data file connection records to return. */
270
431
  limit?: number;
271
432
  /** If present, only return connections with the given name. */
@@ -326,9 +487,10 @@ type GetDataFilesQuotasHttpError = {
326
487
  status: number;
327
488
  };
328
489
  /**
329
- * Delete the specified data file.
490
+ * Delete the specified data file or folder. Deleting a folder will also recursively delete all files and
491
+ * subfolders that reside within the specified folder.
330
492
  *
331
- * @param id The ID of the data file to delete.
493
+ * @param id The ID of the data file or folder to delete.
332
494
  * @throws DeleteDataFileHttpError
333
495
  */
334
496
  declare const deleteDataFile: (id: string, options?: ApiCallOptions) => Promise<DeleteDataFileHttpResponse>;
@@ -360,7 +522,7 @@ type GetDataFileHttpError = {
360
522
  status: number;
361
523
  };
362
524
  /**
363
- * Re-upload an existing data file.
525
+ * Re-upload an existing data file or update an existing folder.
364
526
  *
365
527
  * @param id The ID of the data file to update.
366
528
  * @param body an object with the body content
@@ -372,23 +534,42 @@ declare const reuploadDataFile: (id: string, body: {
372
534
  /** See PutDataFileRequest schema which defines request structure.
373
535
  * See model. */
374
536
  Json?: {
375
- /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. */
537
+ /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this
538
+ * request is creating a folder, the specification of an app ID is not allowed. */
376
539
  appId?: string;
377
- /** If present, this is the DataFiles connection that the upload should occur in the context of. If absent,
378
- * the default is that the upload will occur in the context of the MyDataFiles connection. If the DataFiles
379
- * connection is different from the one specified when the file was last POSTed or PUT, this will result in
380
- * a logical move of this file into the new space. */
540
+ /** If present, this is the DataFiles connection points to the space that the file or folder should reside in.
541
+ * If absent, the default is that the file or folder will reside in the Personal SPce. If the DataFiles
542
+ * connection is different from the one specified when the file or folder was last POSTed or PUT, this will
543
+ * result in a logical move of this file or folder into the new space. */
381
544
  connectionId?: string;
382
- /** Name that will be given to the uploaded file. If this name is different than the name used when the file
383
- * was last POSTed or PUT, this will result in a rename of the file. It should be noted that the '/' character
384
- * in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that
385
- * contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the
386
- * full pathname of that file. '/' is a significant character in the data file name, and may impact the
387
- * behavior of future APIs that take this folder hierarchy into account. */
545
+ /** If the specified file or folder should be created as a sub-item of an existing folder, this is the ID
546
+ * of this parent folder. Any additional folder path that is present on the Name property will be created
547
+ * as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the
548
+ * Name property (including any folder prefix on that name), will be created in the root of the space. */
549
+ folderId?: string;
550
+ /** If a SourceId is specified, and a folder is being updated by this PUT operation, this specifies how the
551
+ * source folder contents should be applied to the target folder, if the target folder is not empty. 'merge'
552
+ * implies the contents of the source folder should be merged with the existing target contents. That is, all
553
+ * existing direct or indirect child items in the target folder are replaced by the same items in the source folder.
554
+ * All existing items in the target folder that are not present in the source folder are left, as is, in the target.
555
+ * 'replace' implies the contents of the source folder should replace the contents of the target folder. That is,
556
+ * all direct or indirect items in the target folder are removed before the items from the source folder are copied
557
+ * over. The resulting target folder only contains the items from the source folder. If not specified, the default
558
+ * behavior is 'merge'.<p>Members:</p><ul></ul> */
559
+ folderMergeBehavior?: PutDataFileFolderMergeBehavior;
560
+ /** Name that will be given to the file or folder. If this name is different than the name used when the file
561
+ * or folder was last POSTed or PUT, this will result in a rename of the file or folder. It should be noted
562
+ * that the '/' character in a data file name indicates a 'path' separator in a logical folder hierarchy for
563
+ * the name. Names that contain '/'s should be used with the assumption that a logical 'folder hierarchy' is
564
+ * being defined for the full pathname of that file or folder.. '/' is a significant character in the data file
565
+ * or folder name. */
388
566
  name?: string;
389
- /** If a SourceId is specified, this is the ID of the existing data file whose content should be copied into
390
- * the specified data file. That is, instead of the file content being specified in the Data element,
391
- * it is effectively copied from an existing, previously uploaded file. */
567
+ /** If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied
568
+ * into the specified data file or folder. That is, for a file instead of the file content being specified in
569
+ * the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, it's
570
+ * contents are copied from an existing, previously created folder. If there it existing content in the target
571
+ * folder, then how the source and target folder contents are merged together is specified in the
572
+ * FolderMergeBehavior option. */
392
573
  sourceId?: string;
393
574
  /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
394
575
  * content should be copied into the specified data file. That is, instead of the file content being specified
@@ -409,11 +590,15 @@ type ReuploadDataFileHttpError = {
409
590
  status: number;
410
591
  };
411
592
  /**
412
- * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
413
- * part of a data file upload. For data files that reside in a personal space, changing the owner has the
414
- * effect of moving the data file to the new owner's personal space.
593
+ * This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly
594
+ * set as part of a create or update operation. For data files or folders that reside in a personal space,
595
+ * changing the owner has the effect of moving the data file to the new owner's personal space. Note that,
596
+ * If a given file or folder is not in the root of a personal space, this operation will not succeed, since
597
+ * the parent folder does not reside in the target owner's personal space. If the owner of a folder in the
598
+ * root of a personal space is changed, the owner of all subfolders and files within those subfolders will
599
+ * also recursively change.
415
600
  *
416
- * @param id The ID of the data file whose owner will be updated.
601
+ * @param id The ID of the data file or folder whose owner will be updated.
417
602
  * @param body an object with the body content
418
603
  * @throws ChangeDataFileOwnerHttpError
419
604
  */
@@ -431,10 +616,14 @@ type ChangeDataFileOwnerHttpError = {
431
616
  /**
432
617
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
433
618
  * where admin users may not explicitly have been granted full access to a given space within the declared
434
- * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
435
- * personal space of the user who is the owner of the file.
619
+ * space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing
620
+ * in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not
621
+ * in the root of a given space, this operation will not succeed, since the parent folder does not reside in
622
+ * the target space. If the space of a folder in the root of the source space is changed, all subfolders and
623
+ * files within those subfolders will also recursively be moved to the new space.
436
624
  *
437
- * @param id The ID of the data file whose space will be updated.
625
+ * @param id The ID of the data file or folder whose
626
+ space will be updated.
438
627
  * @param body an object with the body content
439
628
  * @throws MoveDataFileHttpError
440
629
  */
@@ -462,7 +651,7 @@ interface DataFilesAPI {
462
651
  */
463
652
  getDataFiles: typeof getDataFiles;
464
653
  /**
465
- * Upload a new data file.
654
+ * Upload a new data file or create a new folder.
466
655
  *
467
656
  * @param body an object with the body content
468
657
  * @throws UploadDataFileHttpError
@@ -471,15 +660,15 @@ interface DataFilesAPI {
471
660
  /**
472
661
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
473
662
  * where admin users may not explicitly have been granted full access to a given space within the declared
474
- * space-level permissions. If the space ID is set to null, then the data file will end up residing in the
475
- * personal space of the user who is the owner of the file.
663
+ * space-level permissions. If the space ID is set to null, then the data file or folder will end up residing
664
+ * in the personal space of the user who is the owner of the item.
476
665
  *
477
666
  * @param body an object with the body content
478
667
  * @throws MoveDataFilesHttpError
479
668
  */
480
669
  moveDataFiles: typeof moveDataFiles;
481
670
  /**
482
- * Delete the specified set of data files as a single batch.
671
+ * Delete the specified set of data files and/or folders as a single batch.
483
672
  *
484
673
  * @param body an object with the body content
485
674
  * @throws DeleteDataFilesHttpError
@@ -507,9 +696,10 @@ interface DataFilesAPI {
507
696
  */
508
697
  getDataFilesQuotas: typeof getDataFilesQuotas;
509
698
  /**
510
- * Delete the specified data file.
699
+ * Delete the specified data file or folder. Deleting a folder will also recursively delete all files and
700
+ * subfolders that reside within the specified folder.
511
701
  *
512
- * @param id The ID of the data file to delete.
702
+ * @param id The ID of the data file or folder to delete.
513
703
  * @throws DeleteDataFileHttpError
514
704
  */
515
705
  deleteDataFile: typeof deleteDataFile;
@@ -521,7 +711,7 @@ interface DataFilesAPI {
521
711
  */
522
712
  getDataFile: typeof getDataFile;
523
713
  /**
524
- * Re-upload an existing data file.
714
+ * Re-upload an existing data file or update an existing folder.
525
715
  *
526
716
  * @param id The ID of the data file to update.
527
717
  * @param body an object with the body content
@@ -529,11 +719,15 @@ interface DataFilesAPI {
529
719
  */
530
720
  reuploadDataFile: typeof reuploadDataFile;
531
721
  /**
532
- * This is primarily an admin type of operation. In general, the owner of a data file is implicitly set as
533
- * part of a data file upload. For data files that reside in a personal space, changing the owner has the
534
- * effect of moving the data file to the new owner's personal space.
722
+ * This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly
723
+ * set as part of a create or update operation. For data files or folders that reside in a personal space,
724
+ * changing the owner has the effect of moving the data file to the new owner's personal space. Note that,
725
+ * If a given file or folder is not in the root of a personal space, this operation will not succeed, since
726
+ * the parent folder does not reside in the target owner's personal space. If the owner of a folder in the
727
+ * root of a personal space is changed, the owner of all subfolders and files within those subfolders will
728
+ * also recursively change.
535
729
  *
536
- * @param id The ID of the data file whose owner will be updated.
730
+ * @param id The ID of the data file or folder whose owner will be updated.
537
731
  * @param body an object with the body content
538
732
  * @throws ChangeDataFileOwnerHttpError
539
733
  */
@@ -541,10 +735,14 @@ interface DataFilesAPI {
541
735
  /**
542
736
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
543
737
  * where admin users may not explicitly have been granted full access to a given space within the declared
544
- * space-level permissions. If the space ID is set to null, then the datafile will end up residing in the
545
- * personal space of the user who is the owner of the file.
738
+ * space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing
739
+ * in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not
740
+ * in the root of a given space, this operation will not succeed, since the parent folder does not reside in
741
+ * the target space. If the space of a folder in the root of the source space is changed, all subfolders and
742
+ * files within those subfolders will also recursively be moved to the new space.
546
743
  *
547
- * @param id The ID of the data file whose space will be updated.
744
+ * @param id The ID of the data file or folder whose
745
+ space will be updated.
548
746
  * @param body an object with the body content
549
747
  * @throws MoveDataFileHttpError
550
748
  */
@@ -559,4 +757,4 @@ interface DataFilesAPI {
559
757
  */
560
758
  declare const dataFilesExport: DataFilesAPI;
561
759
 
562
- export { type BatchChangeSpaceItem, type BatchDeleteItem, type ChangeDataFileOwnerHttpError, type ChangeDataFileOwnerHttpResponse, type ChangeDataFileOwnerRequest, type ChangeDataFileSpaceRequest, type ConnectionsResponse, type DataFileBatchChangeSpaceRequest, type DataFileBatchDeleteRequest, type DataFileUploadResponse, type DataFilesAPI, type DeleteDataFileHttpError, type DeleteDataFileHttpResponse, type DeleteDataFilesHttpError, type DeleteDataFilesHttpResponse, type ErrorResponse, type ErrorResponseItem, type GetConnectionsResponse, type GetConnectionsSortField, type GetDataFileConnectionHttpError, type GetDataFileConnectionHttpResponse, type GetDataFileHttpError, type GetDataFileHttpResponse, type GetDataFileInfosResponse, type GetDataFileInfosSortField, type GetDataFilesConnectionsHttpError, type GetDataFilesConnectionsHttpResponse, type GetDataFilesHttpError, type GetDataFilesHttpResponse, type GetDataFilesQuotasHttpError, type GetDataFilesQuotasHttpResponse, type LinkResponse, type LinksResponse, type MoveDataFileHttpError, type MoveDataFileHttpResponse, type MoveDataFilesHttpError, type MoveDataFilesHttpResponse, type MultiStatusResponse, type MultiStatusResponseItem, type QuotaResponse, type ReuploadDataFileHttpError, type ReuploadDataFileHttpResponse, type UploadDataFileHttpError, type UploadDataFileHttpResponse, changeDataFileOwner, clearCache, dataFilesExport as default, deleteDataFile, deleteDataFiles, getDataFile, getDataFileConnection, getDataFiles, getDataFilesConnections, getDataFilesQuotas, moveDataFile, moveDataFiles, reuploadDataFile, uploadDataFile };
760
+ export { type BatchChangeSpaceItem, type BatchDeleteAllBySpaceItem, type BatchDeleteItem, type ChangeDataFileOwnerHttpError, type ChangeDataFileOwnerHttpResponse, type ChangeDataFileOwnerRequest, type ChangeDataFileSpaceRequest, type ConnectionsResponse, type DataFileBatchChangeSpaceRequest, type DataFileBatchDeleteRequest, type DataFilePermission, type DataFileUploadResponse, type DataFilesAPI, type DeleteDataFileHttpError, type DeleteDataFileHttpResponse, type DeleteDataFilesHttpError, type DeleteDataFilesHttpResponse, type ErrorCode, type ErrorResponse, type ErrorResponseItem, type FolderStatsResponse, type GetConnectionsResponse, type GetConnectionsSortField, type GetDataFileConnectionHttpError, type GetDataFileConnectionHttpResponse, type GetDataFileHttpError, type GetDataFileHttpResponse, type GetDataFileInfosResponse, type GetDataFileInfosSortField, type GetDataFilesConnectionsHttpError, type GetDataFilesConnectionsHttpResponse, type GetDataFilesHttpError, type GetDataFilesHttpResponse, type GetDataFilesQuotasHttpError, type GetDataFilesQuotasHttpResponse, type LinkResponse, type LinksResponse, type MoveDataFileHttpError, type MoveDataFileHttpResponse, type MoveDataFilesHttpError, type MoveDataFilesHttpResponse, type MultiStatusResponse, type MultiStatusResponseItem, type PutDataFileFolderMergeBehavior, type QuotaResponse, type ReuploadDataFileHttpError, type ReuploadDataFileHttpResponse, type SpaceStatsResponse, type UploadDataFileHttpError, type UploadDataFileHttpResponse, changeDataFileOwner, clearCache, dataFilesExport as default, deleteDataFile, deleteDataFiles, getDataFile, getDataFileConnection, getDataFiles, getDataFilesConnections, getDataFilesQuotas, moveDataFile, moveDataFiles, reuploadDataFile, uploadDataFile };
package/data-files.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/MFNOHOWH.js";
5
- import "./chunks/7IMOYFWE.js";
4
+ } from "./chunks/2NXPFUPZ.js";
5
+ import "./chunks/ZLPAS7FC.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/data-files.ts