@qlik/api 2.2.0 → 2.3.1

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 (232) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/auth-XusKk8IA.js +32 -0
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +5 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,860 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/data-files.d.ts
4
- type BatchChangeSpaceItem = {
5
- /** The ID of the data file whose space will be changed. */
6
- id: string;
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. */
9
- spaceId?: string;
10
- };
11
- type BatchDeleteAllBySpaceItem = {
12
- /** The ID of the space whose data files will be deleted. */
13
- id: string;
14
- };
15
- type BatchDeleteItem = {
16
- /** The ID of the data file to delete. */
17
- id: string;
18
- };
19
- type ChangeDataFileOwnerRequest = {
20
- /** The ID of the new owner. */
21
- ownerId: string;
22
- };
23
- type ChangeDataFileSpaceRequest = {
24
- /** The ID of the space. If null, this data file will be moved to the user's personal space. */
25
- spaceId?: string;
26
- };
27
- type ConnectionsResponse = {
28
- /** The connect statement that will be passed to the connector when invoked. */
29
- connectStatement: string;
30
- /** The unique identifier of the connection. */
31
- id: string;
32
- /** The name of the connection. */
33
- name: string;
34
- /** The team space that the given connection is associated with. If null, the connection is not associated
35
- * with any specific team space. */
36
- spaceId?: string;
37
- spaceStats?: SpaceStatsResponse;
38
- /** The type of the connection. */
39
- type: string;
40
- };
41
- /**
42
- * Specifies the list of data file change space operations in a single batch.
43
- */
44
- type DataFileBatchChangeSpaceRequest = {
45
- /** The list of data files to delete. */
46
- "change-space": BatchChangeSpaceItem[];
47
- };
48
- type DataFileBatchDeleteRequest = {
49
- /** If specified, the explicit list of data files to delete. */
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;
55
- };
56
- /**
57
- * <p>Members:</p><ul></ul>
58
- */
59
- type DataFilePermission = "read" | "update" | "delete" | "list" | "change_owner" | "change_space";
60
- type DataFileUploadResponse = {
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. */
64
- appId?: string;
65
- /** The name of the file or folder, not including any folder path prefix. */
66
- baseName?: string;
67
- /** If the data file's content was updated, this is the DateTime of the last content update. */
68
- contentUpdatedDate?: string;
69
- /** The date that the file or folder was created. */
70
- createdDate: string;
71
- /** Whether or not this given item represents a folder or a file. */
72
- folder?: boolean;
73
- /** If the file or folder resides in a parent folder, this is the parent folder ID. If the file or folder
74
- * does not reside in a parent folder, this value is null. */
75
- folderId?: string;
76
- /** If the file or folder resides in a parent folder, this is the parent folder path. If the file or folder
77
- * does not reside in a parent folder, this value is null. */
78
- folderPath?: string;
79
- folderStats: FolderStatsResponse;
80
- /** The ID for the file or folder. */
81
- id: string;
82
- /** The date that the updated file or folder was last modified. */
83
- modifiedDate?: string;
84
- /** The full name of the file or folder, including any folder path prefix. */
85
- name: string;
86
- /** The 'owner' of a file or folder is the user who last uploaded the item's content. */
87
- ownerId: string;
88
- /** The QRI generated from the datafile or folder's metadata. */
89
- qri?: string;
90
- /** The size of the uploaded file, in bytes. 0 if this item represents a folder */
91
- size: number;
92
- /** If the file or folder was created in a team space, this is the ID of that space. */
93
- spaceId?: string;
94
- };
95
- /**
96
- * Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
97
- * 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
98
- * 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
99
- * hierarchy depth.</li></ul>
100
- * @example
101
- * "HTTP-200"
102
- */
103
- 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";
104
- type ErrorResponse = {
105
- /** List of errors and their properties. */
106
- errors: ErrorResponseItem[];
107
- };
108
- type ErrorResponseItem = {
109
- /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
110
- * 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
111
- * 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
112
- * hierarchy depth.</li></ul> */
113
- code: ErrorCode;
114
- /** A human-readable explanation specific to this occurrence of the problem. */
115
- detail?: string;
116
- /** Summary of the problem. */
117
- title?: string;
118
- };
119
- type FolderStatsResponse = {
120
- /** The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of
121
- * the given folder and it's sub-folder hierarchy. */
122
- aggregateAppScopedFileSize: number;
123
- /** The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given
124
- * folder and it's sub-folder hierarchy. */
125
- aggregateFileSize: number;
126
- /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
127
- * the given folder and it's sub-folder hierarchy. */
128
- aggregateInternalFileSize: number;
129
- /** The number of app-scoped data files that reside as direct children of the given folder. */
130
- directAppScopedFileCount: number;
131
- /** The number of data files that reside as direct children of the given folder. */
132
- directFileCount: number;
133
- /** The number of sub-folders that reside as direct children of the given folder. */
134
- directFolderCount: number;
135
- /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
136
- * direct children of the given folder. */
137
- directInternalFileCount: number;
138
- /** The number of app-scoped data files that reside as direct and indirect children of the given folder and it's
139
- * sub-folder hierarchy. */
140
- totalAppScopedFileCount: number;
141
- /** The number of data files that reside as direct and indirect children of the given folder and it's sub-folder
142
- * hierarchy. */
143
- totalFileCount: number;
144
- /** The number of folders that reside as direct and indirect children of the given folder and it's sub-folder
145
- * hierarchy. */
146
- totalFolderCount: number;
147
- /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
148
- * direct and indirect children of the given folder and it's sub-folder hierarchy. */
149
- totalInternalFileCount: number;
150
- };
151
- type GetConnectionsResponse = {
152
- /** Properties of the connections to the tenant spaces. */
153
- data: ConnectionsResponse[];
154
- links: LinksResponse;
155
- };
156
- /**
157
- * <p>Members:</p><ul></ul>
158
- * @example
159
- * "spaceId"
160
- */
161
- type GetConnectionsSortField = "spaceId" | "+spaceId" | "-spaceId";
162
- type GetDataFileInfosResponse = {
163
- /** Properties of the uploaded data files. */
164
- data: DataFileUploadResponse[];
165
- links: LinksResponse;
166
- };
167
- /**
168
- * <p>Members:</p><ul></ul>
169
- * @example
170
- * "name"
171
- */
172
- type GetDataFileInfosSortField = "name" | "+name" | "-name" | "size" | "+size" | "-size" | "modifiedDate" | "+modifiedDate" | "-modifiedDate" | "folder" | "+folder" | "-folder" | "baseName" | "+baseName" | "-baseName";
173
- type LinkResponse = {
174
- /** The URL for the link. */
175
- href?: string;
176
- };
177
- type LinksResponse = {
178
- next: LinkResponse;
179
- prev: LinkResponse;
180
- self: LinkResponse;
181
- };
182
- type MultiStatusResponse = {
183
- /** List of individual results for the items in the specified batch. */
184
- data: MultiStatusResponseItem[];
185
- };
186
- type MultiStatusResponseItem = {
187
- /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
188
- * 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
189
- * 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
190
- * hierarchy depth.</li></ul> */
191
- code: ErrorCode;
192
- /** A human-readable explanation specific to this occurrence of the problem. */
193
- detail?: string;
194
- /** The unique identifier of the file. */
195
- id: string;
196
- /** The HTTP status code. */
197
- status: number;
198
- /** Summary of the problem. */
199
- title?: string;
200
- };
201
- /**
202
- * If a SourceId is specified, and a folder is being updated by this PUT operation, this specifies how the
203
- * source folder contents should be applied to the target folder, if the target folder is not empty. 'merge'
204
- * implies the contents of the source folder should be merged with the existing target contents. That is, all
205
- * existing direct or indirect child items in the target folder are replaced by the same items in the source folder.
206
- * All existing items in the target folder that are not present in the source folder are left, as is, in the target.
207
- * 'replace' implies the contents of the source folder should replace the contents of the target folder. That is,
208
- * all direct or indirect items in the target folder are removed before the items from the source folder are copied
209
- * over. The resulting target folder only contains the items from the source folder. If not specified, the default
210
- * behavior is 'merge'.<p>Members:</p><ul></ul>
211
- * @example
212
- * "merge"
213
- */
214
- type PutDataFileFolderMergeBehavior = "merge" | "replace";
215
- type QuotaResponse = {
216
- /** The allowed file extensions on files that are uploaded. */
217
- allowedExtensions: string[];
218
- /** The allowed file extensions for files that are only used internally by the system (and thus not typically
219
- * shown to end users). */
220
- allowedInternalExtensions: string[];
221
- /** Maximum allowable size of an uploaded file. */
222
- maxFileSize: number;
223
- /** Maximum allowable size for a single uploaded large data file (in bytes). This is a file that was indirectly
224
- * uploaded using the temp content service chunked upload capability. */
225
- maxLargeFileSize: number;
226
- /** The maximum aggregate size of all files uploaded by a given user. */
227
- maxSize: number;
228
- /** The current aggregate size of all files uploaded by a given user. If the current aggregate size is greater
229
- * than the maximum aggregate size, this is a quota violation. */
230
- size: number;
231
- };
232
- type SpaceStatsResponse = {
233
- /** The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of
234
- * the given folder and it's sub-folder hierarchy. */
235
- aggregateAppScopedFileSize: number;
236
- /** The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given
237
- * folder and it's sub-folder hierarchy. */
238
- aggregateFileSize: number;
239
- /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
240
- * the given folder and it's sub-folder hierarchy. */
241
- aggregateInternalFileSize: number;
242
- /** The number of app-scoped data files that reside as direct children of the given folder. */
243
- directAppScopedFileCount: number;
244
- /** The number of data files that reside as direct children of the given folder. */
245
- directFileCount: number;
246
- /** The number of sub-folders that reside as direct children of the given folder. */
247
- directFolderCount: number;
248
- /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
249
- * direct children of the given folder. */
250
- directInternalFileCount: number;
251
- /** The number of app-scoped data files that reside as direct and indirect children of the given folder and it's
252
- * sub-folder hierarchy. */
253
- totalAppScopedFileCount: number;
254
- /** The number of data files that reside as direct and indirect children of the given folder and it's sub-folder
255
- * hierarchy. */
256
- totalFileCount: number;
257
- /** The number of folders that reside as direct and indirect children of the given folder and it's sub-folder
258
- * hierarchy. */
259
- totalFolderCount: number;
260
- /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
261
- * direct and indirect children of the given folder and it's sub-folder hierarchy. */
262
- totalInternalFileCount: number;
263
- };
264
- /**
265
- * Get descriptive info for the specified data files.
266
- * @example
267
- * getDataFiles(
268
- * {
269
- * allowInternalFiles: false,
270
- * appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
271
- * baseNameWildcard: "*SomeFileName*",
272
- * connectionId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
273
- * excludeFiles: false,
274
- * excludeSubFolders: false,
275
- * folderId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
276
- * folderPath: "some/folder",
277
- * includeAllSpaces: false,
278
- * includeFolders: false,
279
- * includeFolderStats: false,
280
- * limit: 5,
281
- * name: "MyFile.csv",
282
- * notOwnerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
283
- * ownerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
284
- * page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1"
285
- * }
286
- * )
287
- *
288
- * @param query an object with query parameters
289
- * @throws GetDataFilesHttpError
290
- */
291
- declare function getDataFiles(query: {
292
- /** If set to false, do not return data files with internal extensions else return all the data files. */
293
- allowInternalFiles?: boolean;
294
- /** Only return files scoped to the specified app. If this parameter is not specified, only files that are not
295
- * scoped to any app are returned. "*" implies all app-scoped files are returned. */
296
- appId?: string;
297
- /** If present, return only items whose base name matches the given wildcard. Wildcards include '*' and '?'
298
- * characters to allow for multiple matches. The base name is the actual file or folder name without any
299
- * folder pathing included. */
300
- baseNameWildcard?: string;
301
- /** Return files and folders that reside in the space referenced by the specified DataFiles connection. If this
302
- * parameter is not specified, the user's personal space is implied. */
303
- connectionId?: string;
304
- /** If set to true, exclude files in the returned list (IE, only return folders). If false, include files. */
305
- excludeFiles?: boolean;
306
- /** If set to true, exclude folders and files that reside in sub-folders of the root being searched. If false,
307
- * include all items in full folder hierarchy that recursively reside under the root. That is, setting to
308
- * true results in only the direct children of the root being returned. */
309
- excludeSubFolders?: boolean;
310
- /** If present, return only items which reside under the folder specified by the given ID. If not present,
311
- * items that live at the root of the space are returned. This property is mutually exclusive with 'folderPath'. */
312
- folderId?: string;
313
- /** If present, return only items which reside under the specified folder path. If not present, items that
314
- * live at the root of the space are returned. This property is mutually exclusive with 'folderId'. */
315
- folderPath?: string;
316
- /** If set to true, and connectionId is not specified, return files and folders from all spaces the given user
317
- * has access to (including the personal space). If connectionId is specified, this parameter is ignored. */
318
- includeAllSpaces?: boolean;
319
- /** If set to true, include computed folder statistics for folders in the returned list. If false, this information
320
- * is not returned. */
321
- includeFolderStats?: boolean;
322
- /** If set to true, include folders in the returned list. If false, only return data files. */
323
- includeFolders?: boolean;
324
- /** If present, the maximum number of data files to return. */
325
- limit?: number;
326
- /** Filter the list of files returned to the given file name. */
327
- name?: string;
328
- /** If present, fetch the data files whose owner is not the specified owner. If a connectionId is specified in
329
- * this case, the returned list is constrained to the specified space. If connectionId is not specified, then
330
- * the returned list is constrained to the calling user's personal space. If includeAllSpaces is set to true,
331
- * and connectionId is not specified, the returned list is from all spaces the given user
332
- * has access to (including the personal space). */
333
- notOwnerId?: string;
334
- /** If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the
335
- * returned list is constrained to the specified space. If connectionId is not specified, then all files owned
336
- * by the specified user are returned regardless of the personal space that a given file resides in. */
337
- ownerId?: string;
338
- /** If present, the cursor that starts the page of data that is returned. */
339
- page?: string;
340
- /** The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on
341
- * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
342
- sort?: GetDataFileInfosSortField;
343
- }, options?: ApiCallOptions): Promise<GetDataFilesHttpResponse>;
344
- type GetDataFilesHttpResponse = {
345
- data: GetDataFileInfosResponse;
346
- headers: Headers;
347
- status: 200;
348
- prev?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
349
- next?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
350
- };
351
- type GetDataFilesHttpError = {
352
- data: ErrorResponse;
353
- headers: Headers;
354
- status: 400 | 403;
355
- };
356
- /**
357
- * Upload a new data file or create a new folder.
358
- *
359
- * @param body an object with the body content
360
- * @throws UploadDataFileHttpError
361
- */
362
- declare function uploadDataFile(body: {
363
- /** IFormFile form multipart/form-data */
364
- File?: BodyInit;
365
- /** See PostDataFileRequest schema which defines request structure.
366
- * See model. */
367
- Json?: {
368
- /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this
369
- * request is creating a folder, the specification of an app ID is not allowed. */
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 Personal Space DataFiles connection. If the
373
- * DataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this
374
- * will result in a logical move of this file or folder into the new space. */
375
- connectionId?: string;
376
- /** If true, a folder will be created. If false, a file is created. */
377
- folder?: boolean;
378
- /** If the specified file or folder should be moved to become a a sub-item of an existing folder, this is the ID
379
- * of this parent folder. Any additional folder path that is present on the Name property will be created
380
- * as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the
381
- * Name property (including any folder prefix on that name), will be created in the root of the space. */
382
- folderId?: string;
383
- /** Name that will be given to the file or folder. It should be noted that the '/' character
384
- * in the 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 or folder. IE, a '/' is a significant character in the name. */
387
- name: string;
388
- /** If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied
389
- * into the specified data file or folder. That is, for a file instead of the file content being specified in
390
- * the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, rather
391
- * than the new folder being empty, it's contents are copied from an existing, previously created folder. */
392
- sourceId?: string;
393
- /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
394
- * content should be copied into the specified data file. That is, instead of the file content being specified
395
- * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
396
- * is that this file was previously uploaded to the temporary content service, and the ID specified here is
397
- * the one returned from the temp content upload request. This option does not apply when POSTing a folder. */
398
- tempContentFileId?: string;
399
- };
400
- }, options?: ApiCallOptions): Promise<UploadDataFileHttpResponse>;
401
- type UploadDataFileHttpResponse = {
402
- data: DataFileUploadResponse;
403
- headers: Headers;
404
- status: 201;
405
- };
406
- type UploadDataFileHttpError = {
407
- data: ErrorResponse;
408
- headers: Headers;
409
- status: 400 | 403 | 409 | 413 | 423 | 501;
410
- };
411
- /**
412
- * This is to allow for a separate admin type of operation that is more global in terms of access in cases
413
- * where admin users may not explicitly have been granted full access to a given space within the declared
414
- * space-level permissions. If the space ID is set to null, then the data file or folder will end up residing
415
- * in the personal space of the user who is the owner of the item.
416
- *
417
- * @param body an object with the body content
418
- * @throws MoveDataFilesHttpError
419
- */
420
- declare function moveDataFiles(body: DataFileBatchChangeSpaceRequest, options?: ApiCallOptions): Promise<MoveDataFilesHttpResponse>;
421
- type MoveDataFilesHttpResponse = {
422
- data: MultiStatusResponse;
423
- headers: Headers;
424
- status: 207;
425
- };
426
- type MoveDataFilesHttpError = {
427
- data: ErrorResponse;
428
- headers: Headers;
429
- status: 400;
430
- };
431
- /**
432
- * Delete the specified set of data files and/or folders as a single batch.
433
- *
434
- * @param body an object with the body content
435
- * @throws DeleteDataFilesHttpError
436
- */
437
- declare function deleteDataFiles(body: DataFileBatchDeleteRequest, options?: ApiCallOptions): Promise<DeleteDataFilesHttpResponse>;
438
- type DeleteDataFilesHttpResponse = {
439
- data: MultiStatusResponse;
440
- headers: Headers;
441
- status: 207;
442
- };
443
- type DeleteDataFilesHttpError = {
444
- data: ErrorResponse;
445
- headers: Headers;
446
- status: 400;
447
- };
448
- /**
449
- * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
450
- * the given user has access to.
451
- * @example
452
- * getDataFilesConnections(
453
- * {
454
- * appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
455
- * includeSpaceStats: false,
456
- * limit: 5,
457
- * name: "MySenseApp",
458
- * page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
459
- * personal: true,
460
- * spaceId: "617979737a9f56e49dea2e6e"
461
- * }
462
- * )
463
- *
464
- * @param query an object with query parameters
465
- * @throws GetDataFilesConnectionsHttpError
466
- */
467
- declare function getDataFilesConnections(query: {
468
- /** If present, get connections with connection strings that are scoped to the given app ID. */
469
- appId?: string;
470
- /** If set to true, include computed space-level statistics for the spaces represented by the connections in the
471
- * returned list. If false, this information is not returned. */
472
- includeSpaceStats?: boolean;
473
- /** If present, the maximum number of data file connection records to return. */
474
- limit?: number;
475
- /** If present, only return connections with the given name. */
476
- name?: string;
477
- /** If present, the cursor that starts the page of data that is returned. */
478
- page?: string;
479
- /** If true, only return the connections that access data in a personal space. Default is false. */
480
- personal?: boolean;
481
- /** The name of the field used to sort the result. By default, the sort is ascending. Putting a '+' prefix on
482
- * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
483
- sort?: GetConnectionsSortField;
484
- /** If present, only return the connection that accesses data files in the specified space. */
485
- spaceId?: string;
486
- }, options?: ApiCallOptions): Promise<GetDataFilesConnectionsHttpResponse>;
487
- type GetDataFilesConnectionsHttpResponse = {
488
- data: GetConnectionsResponse;
489
- headers: Headers;
490
- status: 200;
491
- prev?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
492
- next?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
493
- };
494
- type GetDataFilesConnectionsHttpError = {
495
- data: ErrorResponse;
496
- headers: Headers;
497
- status: 400 | 403;
498
- };
499
- /**
500
- * Get the built-in connection used by the engine to load/write data files given a connection ID.
501
- * @example
502
- * getDataFileConnection(
503
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
504
- * )
505
- *
506
- * @param id The ID of the connection.
507
- * @throws GetDataFileConnectionHttpError
508
- */
509
- declare function getDataFileConnection(id: string, options?: ApiCallOptions): Promise<GetDataFileConnectionHttpResponse>;
510
- type GetDataFileConnectionHttpResponse = {
511
- data: ConnectionsResponse;
512
- headers: Headers;
513
- status: 200;
514
- };
515
- type GetDataFileConnectionHttpError = {
516
- data: ErrorResponse;
517
- headers: Headers;
518
- status: 403 | 404;
519
- };
520
- /**
521
- * Get quota information for the calling user.
522
- *
523
- * @throws GetDataFilesQuotasHttpError
524
- */
525
- declare function getDataFilesQuotas(options?: ApiCallOptions): Promise<GetDataFilesQuotasHttpResponse>;
526
- type GetDataFilesQuotasHttpResponse = {
527
- data: QuotaResponse;
528
- headers: Headers;
529
- status: 200;
530
- };
531
- type GetDataFilesQuotasHttpError = {
532
- data: ErrorResponse;
533
- headers: Headers;
534
- status: 400 | 403;
535
- };
536
- /**
537
- * Delete the specified data file or folder. Deleting a folder will also recursively delete all files and
538
- * subfolders that reside within the specified folder.
539
- * @example
540
- * deleteDataFile(
541
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
542
- * )
543
- *
544
- * @param id The ID of the data file or folder to delete.
545
- * @throws DeleteDataFileHttpError
546
- */
547
- declare function deleteDataFile(id: string, options?: ApiCallOptions): Promise<DeleteDataFileHttpResponse>;
548
- type DeleteDataFileHttpResponse = {
549
- data: void;
550
- headers: Headers;
551
- status: 204;
552
- };
553
- type DeleteDataFileHttpError = {
554
- data: ErrorResponse;
555
- headers: Headers;
556
- status: 400 | 403 | 404;
557
- };
558
- /**
559
- * Get descriptive info for the specified data file.
560
- * @example
561
- * getDataFile(
562
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
563
- * )
564
- *
565
- * @param id The ID of the data file.
566
- * @throws GetDataFileHttpError
567
- */
568
- declare function getDataFile(id: string, options?: ApiCallOptions): Promise<GetDataFileHttpResponse>;
569
- type GetDataFileHttpResponse = {
570
- data: DataFileUploadResponse;
571
- headers: Headers;
572
- status: 200;
573
- };
574
- type GetDataFileHttpError = {
575
- data: ErrorResponse;
576
- headers: Headers;
577
- status: 400 | 403 | 404;
578
- };
579
- /**
580
- * Re-upload an existing data file or update an existing folder.
581
- *
582
- * @param id The ID of the data file to update.
583
- * @param body an object with the body content
584
- * @throws ReuploadDataFileHttpError
585
- */
586
- declare function reuploadDataFile(id: string, body: {
587
- /** IFormFile form multipart/form-data */
588
- File?: BodyInit;
589
- /** See PutDataFileRequest schema which defines request structure.
590
- * See model. */
591
- Json?: {
592
- /** If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this
593
- * request is creating a folder, the specification of an app ID is not allowed. */
594
- appId?: string;
595
- /** If present, this is the DataFiles connection points to the space that the file or folder should reside in.
596
- * If absent, the default is that the file or folder will reside in the Personal SPce. If the DataFiles
597
- * connection is different from the one specified when the file or folder was last POSTed or PUT, this will
598
- * result in a logical move of this file or folder into the new space. */
599
- connectionId?: string;
600
- /** If the specified file or folder should be created as a sub-item of an existing folder, this is the ID
601
- * of this parent folder. Any additional folder path that is present on the Name property will be created
602
- * as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the
603
- * Name property (including any folder prefix on that name), will be created in the root of the space. */
604
- folderId?: string;
605
- /** If a SourceId is specified, and a folder is being updated by this PUT operation, this specifies how the
606
- * source folder contents should be applied to the target folder, if the target folder is not empty. 'merge'
607
- * implies the contents of the source folder should be merged with the existing target contents. That is, all
608
- * existing direct or indirect child items in the target folder are replaced by the same items in the source folder.
609
- * All existing items in the target folder that are not present in the source folder are left, as is, in the target.
610
- * 'replace' implies the contents of the source folder should replace the contents of the target folder. That is,
611
- * all direct or indirect items in the target folder are removed before the items from the source folder are copied
612
- * over. The resulting target folder only contains the items from the source folder. If not specified, the default
613
- * behavior is 'merge'.<p>Members:</p><ul></ul> */
614
- folderMergeBehavior?: PutDataFileFolderMergeBehavior;
615
- /** Name that will be given to the file or folder. If this name is different than the name used when the file
616
- * or folder was last POSTed or PUT, this will result in a rename of the file or folder. It should be noted
617
- * that the '/' character in a data file name indicates a 'path' separator in a logical folder hierarchy for
618
- * the name. Names that contain '/'s should be used with the assumption that a logical 'folder hierarchy' is
619
- * being defined for the full pathname of that file or folder.. '/' is a significant character in the data file
620
- * or folder name. */
621
- name?: string;
622
- /** If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied
623
- * into the specified data file or folder. That is, for a file instead of the file content being specified in
624
- * the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, it's
625
- * contents are copied from an existing, previously created folder. If there it existing content in the target
626
- * folder, then how the source and target folder contents are merged together is specified in the
627
- * FolderMergeBehavior option. */
628
- sourceId?: string;
629
- /** If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose
630
- * content should be copied into the specified data file. That is, instead of the file content being specified
631
- * in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation
632
- * is that this file was previously uploaded to the temporary content service, and the ID specified here is
633
- * the one returned from the temp content upload request. */
634
- tempContentFileId?: string;
635
- };
636
- }, options?: ApiCallOptions): Promise<ReuploadDataFileHttpResponse>;
637
- type ReuploadDataFileHttpResponse = {
638
- data: DataFileUploadResponse;
639
- headers: Headers;
640
- status: 201;
641
- };
642
- type ReuploadDataFileHttpError = {
643
- data: ErrorResponse;
644
- headers: Headers;
645
- status: 400 | 403 | 404 | 409 | 413 | 423;
646
- };
647
- /**
648
- * This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly
649
- * set as part of a create or update operation. For data files or folders that reside in a personal space,
650
- * changing the owner has the effect of moving the data file to the new owner's personal space. Note that,
651
- * If a given file or folder is not in the root of a personal space, this operation will not succeed, since
652
- * the parent folder does not reside in the target owner's personal space. If the owner of a folder in the
653
- * root of a personal space is changed, the owner of all subfolders and files within those subfolders will
654
- * also recursively change.
655
- *
656
- * @param id The ID of the data file or folder whose owner will be updated.
657
- * @param body an object with the body content
658
- * @throws ChangeDataFileOwnerHttpError
659
- */
660
- declare function changeDataFileOwner(id: string, body: ChangeDataFileOwnerRequest, options?: ApiCallOptions): Promise<ChangeDataFileOwnerHttpResponse>;
661
- type ChangeDataFileOwnerHttpResponse = {
662
- data: void;
663
- headers: Headers;
664
- status: 204;
665
- };
666
- type ChangeDataFileOwnerHttpError = {
667
- data: ErrorResponse;
668
- headers: Headers;
669
- status: 400 | 403 | 404 | 409 | 423;
670
- };
671
- /**
672
- * This is to allow for a separate admin type of operation that is more global in terms of access in cases
673
- * where admin users may not explicitly have been granted full access to a given space within the declared
674
- * space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing
675
- * in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not
676
- * in the root of a given space, this operation will not succeed, since the parent folder does not reside in
677
- * the target space. If the space of a folder in the root of the source space is changed, all subfolders and
678
- * files within those subfolders will also recursively be moved to the new space.
679
- *
680
- * @param id The ID of the data file or folder whose
681
- space will be updated.
682
- * @param body an object with the body content
683
- * @throws MoveDataFileHttpError
684
- */
685
- declare function moveDataFile(id: string, body: ChangeDataFileSpaceRequest, options?: ApiCallOptions): Promise<MoveDataFileHttpResponse>;
686
- type MoveDataFileHttpResponse = {
687
- data: void;
688
- headers: Headers;
689
- status: 204;
690
- };
691
- type MoveDataFileHttpError = {
692
- data: ErrorResponse;
693
- headers: Headers;
694
- status: 400 | 403 | 404 | 409 | 423;
695
- };
696
- /**
697
- * Clears the cache for data-files api requests.
698
- */
699
- declare function clearCache(): void;
700
- type DataFilesAPI = {
701
- /**
702
- * Get descriptive info for the specified data files.
703
- * @example
704
- * getDataFiles(
705
- * {
706
- * allowInternalFiles: false,
707
- * appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
708
- * baseNameWildcard: "*SomeFileName*",
709
- * connectionId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
710
- * excludeFiles: false,
711
- * excludeSubFolders: false,
712
- * folderId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
713
- * folderPath: "some/folder",
714
- * includeAllSpaces: false,
715
- * includeFolders: false,
716
- * includeFolderStats: false,
717
- * limit: 5,
718
- * name: "MyFile.csv",
719
- * notOwnerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
720
- * ownerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
721
- * page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1"
722
- * }
723
- * )
724
- *
725
- * @param query an object with query parameters
726
- * @throws GetDataFilesHttpError
727
- */
728
- getDataFiles: typeof getDataFiles;
729
- /**
730
- * Upload a new data file or create a new folder.
731
- *
732
- * @param body an object with the body content
733
- * @throws UploadDataFileHttpError
734
- */
735
- uploadDataFile: typeof uploadDataFile;
736
- /**
737
- * This is to allow for a separate admin type of operation that is more global in terms of access in cases
738
- * where admin users may not explicitly have been granted full access to a given space within the declared
739
- * space-level permissions. If the space ID is set to null, then the data file or folder will end up residing
740
- * in the personal space of the user who is the owner of the item.
741
- *
742
- * @param body an object with the body content
743
- * @throws MoveDataFilesHttpError
744
- */
745
- moveDataFiles: typeof moveDataFiles;
746
- /**
747
- * Delete the specified set of data files and/or folders as a single batch.
748
- *
749
- * @param body an object with the body content
750
- * @throws DeleteDataFilesHttpError
751
- */
752
- deleteDataFiles: typeof deleteDataFiles;
753
- /**
754
- * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
755
- * the given user has access to.
756
- * @example
757
- * getDataFilesConnections(
758
- * {
759
- * appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
760
- * includeSpaceStats: false,
761
- * limit: 5,
762
- * name: "MySenseApp",
763
- * page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
764
- * personal: true,
765
- * spaceId: "617979737a9f56e49dea2e6e"
766
- * }
767
- * )
768
- *
769
- * @param query an object with query parameters
770
- * @throws GetDataFilesConnectionsHttpError
771
- */
772
- getDataFilesConnections: typeof getDataFilesConnections;
773
- /**
774
- * Get the built-in connection used by the engine to load/write data files given a connection ID.
775
- * @example
776
- * getDataFileConnection(
777
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
778
- * )
779
- *
780
- * @param id The ID of the connection.
781
- * @throws GetDataFileConnectionHttpError
782
- */
783
- getDataFileConnection: typeof getDataFileConnection;
784
- /**
785
- * Get quota information for the calling user.
786
- *
787
- * @throws GetDataFilesQuotasHttpError
788
- */
789
- getDataFilesQuotas: typeof getDataFilesQuotas;
790
- /**
791
- * Delete the specified data file or folder. Deleting a folder will also recursively delete all files and
792
- * subfolders that reside within the specified folder.
793
- * @example
794
- * deleteDataFile(
795
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
796
- * )
797
- *
798
- * @param id The ID of the data file or folder to delete.
799
- * @throws DeleteDataFileHttpError
800
- */
801
- deleteDataFile: typeof deleteDataFile;
802
- /**
803
- * Get descriptive info for the specified data file.
804
- * @example
805
- * getDataFile(
806
- * "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
807
- * )
808
- *
809
- * @param id The ID of the data file.
810
- * @throws GetDataFileHttpError
811
- */
812
- getDataFile: typeof getDataFile;
813
- /**
814
- * Re-upload an existing data file or update an existing folder.
815
- *
816
- * @param id The ID of the data file to update.
817
- * @param body an object with the body content
818
- * @throws ReuploadDataFileHttpError
819
- */
820
- reuploadDataFile: typeof reuploadDataFile;
821
- /**
822
- * This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly
823
- * set as part of a create or update operation. For data files or folders that reside in a personal space,
824
- * changing the owner has the effect of moving the data file to the new owner's personal space. Note that,
825
- * If a given file or folder is not in the root of a personal space, this operation will not succeed, since
826
- * the parent folder does not reside in the target owner's personal space. If the owner of a folder in the
827
- * root of a personal space is changed, the owner of all subfolders and files within those subfolders will
828
- * also recursively change.
829
- *
830
- * @param id The ID of the data file or folder whose owner will be updated.
831
- * @param body an object with the body content
832
- * @throws ChangeDataFileOwnerHttpError
833
- */
834
- changeDataFileOwner: typeof changeDataFileOwner;
835
- /**
836
- * This is to allow for a separate admin type of operation that is more global in terms of access in cases
837
- * where admin users may not explicitly have been granted full access to a given space within the declared
838
- * space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing
839
- * in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not
840
- * in the root of a given space, this operation will not succeed, since the parent folder does not reside in
841
- * the target space. If the space of a folder in the root of the source space is changed, all subfolders and
842
- * files within those subfolders will also recursively be moved to the new space.
843
- *
844
- * @param id The ID of the data file or folder whose
845
- space will be updated.
846
- * @param body an object with the body content
847
- * @throws MoveDataFileHttpError
848
- */
849
- moveDataFile: typeof moveDataFile;
850
- /**
851
- * Clears the cache for data-files api requests.
852
- */
853
- clearCache: typeof clearCache;
854
- };
855
- /**
856
- * Functions for the data-files api
857
- */
858
- declare const dataFilesExport: DataFilesAPI;
859
- //#endregion
860
- export { dataFilesExport as $, GetDataFilesConnectionsHttpError as A, MoveDataFilesHttpError as B, GetConnectionsSortField as C, GetDataFileHttpResponse as D, GetDataFileHttpError as E, GetDataFilesQuotasHttpResponse as F, QuotaResponse as G, MultiStatusResponse as H, LinkResponse as I, SpaceStatsResponse as J, ReuploadDataFileHttpError as K, LinksResponse as L, GetDataFilesHttpError as M, GetDataFilesHttpResponse as N, GetDataFileInfosResponse as O, GetDataFilesQuotasHttpError as P, clearCache as Q, MoveDataFileHttpError as R, GetConnectionsResponse as S, GetDataFileConnectionHttpResponse as T, MultiStatusResponseItem as U, MoveDataFilesHttpResponse as V, PutDataFileFolderMergeBehavior as W, UploadDataFileHttpResponse as X, UploadDataFileHttpError as Y, changeDataFileOwner as Z, DeleteDataFilesHttpResponse as _, ChangeDataFileOwnerHttpResponse as a, getDataFilesConnections as at, ErrorResponseItem as b, ConnectionsResponse as c, moveDataFiles as ct, DataFilePermission as d, deleteDataFile as et, DataFileUploadResponse as f, DeleteDataFilesHttpError as g, DeleteDataFileHttpResponse as h, ChangeDataFileOwnerHttpError as i, getDataFiles as it, GetDataFilesConnectionsHttpResponse as j, GetDataFileInfosSortField as k, DataFileBatchChangeSpaceRequest as l, reuploadDataFile as lt, DeleteDataFileHttpError as m, BatchDeleteAllBySpaceItem as n, getDataFile as nt, ChangeDataFileOwnerRequest as o, getDataFilesQuotas as ot, DataFilesAPI as p, ReuploadDataFileHttpResponse as q, BatchDeleteItem as r, getDataFileConnection as rt, ChangeDataFileSpaceRequest as s, moveDataFile as st, BatchChangeSpaceItem as t, deleteDataFiles as tt, DataFileBatchDeleteRequest as u, uploadDataFile as ut, ErrorCode as v, GetDataFileConnectionHttpError as w, FolderStatsResponse as x, ErrorResponse as y, MoveDataFileHttpResponse as z };