@qlik/api 2.3.1 → 2.4.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 (167) hide show
  1. package/analytics/change-stores.d.ts +40 -76
  2. package/analytics/change-stores.js +9 -10
  3. package/analytics.d.ts +1 -2
  4. package/analytics.js +5 -6
  5. package/api-keys.d.ts +46 -100
  6. package/api-keys.js +3 -4
  7. package/apps.d.ts +334 -461
  8. package/apps.js +74 -6
  9. package/assistants.d.ts +172 -337
  10. package/assistants.js +3 -4
  11. package/audits.d.ts +41 -85
  12. package/audits.js +3 -4
  13. package/auth-types.d.ts +110 -1
  14. package/auth-types.js +22 -1
  15. package/auth.d.ts +1 -2
  16. package/auth.js +1 -1
  17. package/automation-connections.d.ts +44 -95
  18. package/automation-connections.js +3 -4
  19. package/automation-connectors.d.ts +10 -20
  20. package/automation-connectors.js +3 -4
  21. package/automations.d.ts +54 -112
  22. package/automations.js +3 -4
  23. package/automl-deployments.d.ts +17 -36
  24. package/automl-deployments.js +3 -4
  25. package/automl-predictions.d.ts +12 -24
  26. package/automl-predictions.js +3 -4
  27. package/banners.d.ts +8 -14
  28. package/banners.js +3 -4
  29. package/brands.d.ts +19 -39
  30. package/brands.js +3 -4
  31. package/chunks/auth-B8lJw7rm.js +31 -0
  32. package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
  40. package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
  41. package/collections.d.ts +67 -144
  42. package/collections.js +3 -4
  43. package/conditions.d.ts +87 -190
  44. package/conditions.js +3 -4
  45. package/consumption.d.ts +35 -72
  46. package/consumption.js +3 -4
  47. package/core/ip-policies.d.ts +43 -93
  48. package/core/ip-policies.js +5 -6
  49. package/core.d.ts +1 -2
  50. package/core.js +5 -6
  51. package/csp-origins.d.ts +42 -85
  52. package/csp-origins.js +3 -4
  53. package/csrf-token.d.ts +6 -11
  54. package/csrf-token.js +3 -4
  55. package/data-alerts.d.ts +152 -325
  56. package/data-alerts.js +3 -4
  57. package/data-assets.d.ts +16 -31
  58. package/data-assets.js +3 -4
  59. package/data-connections.d.ts +123 -257
  60. package/data-connections.js +3 -4
  61. package/data-credentials.d.ts +36 -76
  62. package/data-credentials.js +3 -4
  63. package/data-files.d.ts +60 -121
  64. package/data-files.js +3 -4
  65. package/data-governance/data-products.d.ts +429 -0
  66. package/data-governance/data-products.js +212 -0
  67. package/data-governance.d.ts +13 -0
  68. package/data-governance.js +12 -0
  69. package/data-qualities.d.ts +11 -25
  70. package/data-qualities.js +3 -4
  71. package/data-sets.d.ts +28 -57
  72. package/data-sets.js +3 -4
  73. package/data-sources.d.ts +45 -97
  74. package/data-sources.js +3 -4
  75. package/data-stores.d.ts +53 -107
  76. package/data-stores.js +3 -4
  77. package/dcaas.d.ts +32 -67
  78. package/dcaas.js +3 -4
  79. package/di-projects.d.ts +111 -136
  80. package/di-projects.js +25 -4
  81. package/direct-access-agents.d.ts +29 -63
  82. package/direct-access-agents.js +3 -4
  83. package/encryption.d.ts +28 -59
  84. package/encryption.js +3 -4
  85. package/extensions.d.ts +35 -73
  86. package/extensions.js +3 -4
  87. package/global-types.d.ts +139 -1
  88. package/glossaries.d.ts +75 -158
  89. package/glossaries.js +3 -4
  90. package/groups.d.ts +58 -125
  91. package/groups.js +3 -4
  92. package/identity-providers.d.ts +148 -324
  93. package/identity-providers.js +3 -4
  94. package/index.d.ts +18 -4
  95. package/index.js +64 -19
  96. package/interceptors.d.ts +2 -3
  97. package/interceptors.js +104 -2
  98. package/invoke-fetch-types.d.ts +97 -1
  99. package/items.d.ts +85 -181
  100. package/items.js +3 -4
  101. package/knowledgebases.d.ts +137 -270
  102. package/knowledgebases.js +3 -4
  103. package/licenses.d.ts +71 -153
  104. package/licenses.js +3 -4
  105. package/lineage-graphs.d.ts +39 -85
  106. package/lineage-graphs.js +3 -4
  107. package/ml.d.ts +290 -621
  108. package/ml.js +3 -4
  109. package/notes.d.ts +9 -18
  110. package/notes.js +3 -4
  111. package/notifications.d.ts +14 -30
  112. package/notifications.js +3 -4
  113. package/oauth-clients.d.ts +98 -159
  114. package/oauth-clients.js +4 -5
  115. package/oauth-tokens.d.ts +16 -33
  116. package/oauth-tokens.js +3 -4
  117. package/package.json +6 -3
  118. package/qix.d.ts +46 -2
  119. package/qix.js +2 -3
  120. package/questions.d.ts +53 -110
  121. package/questions.js +3 -4
  122. package/quotas.d.ts +13 -26
  123. package/quotas.js +3 -4
  124. package/reload-tasks.d.ts +23 -46
  125. package/reload-tasks.js +3 -4
  126. package/reloads.d.ts +26 -52
  127. package/reloads.js +3 -4
  128. package/report-templates.d.ts +30 -63
  129. package/report-templates.js +3 -4
  130. package/reports.d.ts +111 -238
  131. package/reports.js +3 -4
  132. package/roles.d.ts +36 -77
  133. package/roles.js +3 -4
  134. package/sharing-tasks.d.ts +201 -427
  135. package/sharing-tasks.js +3 -4
  136. package/spaces.d.ts +71 -157
  137. package/spaces.js +3 -4
  138. package/tasks.d.ts +76 -164
  139. package/tasks.js +3 -4
  140. package/temp-contents.d.ts +17 -35
  141. package/temp-contents.js +3 -4
  142. package/tenant-settings.d.ts +298 -0
  143. package/tenant-settings.js +107 -0
  144. package/tenants.d.ts +31 -67
  145. package/tenants.js +3 -4
  146. package/themes.d.ts +27 -55
  147. package/themes.js +3 -4
  148. package/transports.d.ts +46 -106
  149. package/transports.js +3 -4
  150. package/ui-config.d.ts +8 -17
  151. package/ui-config.js +3 -4
  152. package/users.d.ts +80 -170
  153. package/users.js +3 -4
  154. package/web-integrations.d.ts +38 -83
  155. package/web-integrations.js +3 -4
  156. package/web-notifications.d.ts +14 -29
  157. package/web-notifications.js +3 -4
  158. package/webhooks.d.ts +77 -162
  159. package/webhooks.js +3 -4
  160. package/chunks/auth-XusKk8IA.js +0 -32
  161. package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
  162. package/chunks/auth-types-h43TVDpB.js +0 -24
  163. package/chunks/global-types-CEVAJebk.js +0 -1
  164. /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
  165. /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
  166. /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
  167. /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/data-connections.ts
5
5
  /**
@@ -208,7 +208,6 @@ const dataConnectionsExport = {
208
208
  updateDataConnection,
209
209
  clearCache
210
210
  };
211
- var data_connections_default = dataConnectionsExport;
212
211
 
213
212
  //#endregion
214
- export { clearCache, createDataConnection, data_connections_default as default, deleteDataConnection, deleteDataConnections, duplicateDataAConnection, getDataConnection, getDataConnections, patchDataConnection, updateDataConnection, updateDataConnections };
213
+ export { clearCache, createDataConnection, dataConnectionsExport as default, deleteDataConnection, deleteDataConnections, duplicateDataAConnection, getDataConnection, getDataConnections, patchDataConnection, updateDataConnection, updateDataConnections };
@@ -1,103 +1,67 @@
1
- import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/data-credentials.d.ts
5
5
  type ActionFilterOrphanRequest = {
6
- /** Filtering on datasource ID of credentials */
7
- datasourceID?: string;
8
- /** Filtering on separate status of credentials: * 0 - embedded credential * 1 - separated credential */
9
- qSeparated?: 0 | 1;
10
- /** Filtering on type of credentials */
6
+ /** Filtering on datasource ID of credentials */datasourceID?: string; /** Filtering on separate status of credentials: * 0 - embedded credential * 1 - separated credential */
7
+ qSeparated?: 0 | 1; /** Filtering on type of credentials */
11
8
  qType?: string;
12
9
  };
13
10
  type ActionFilterOrphanResponse = {
14
- /** Number of orphan credentials found */
15
- count: number;
11
+ /** Number of orphan credentials found */count: number;
16
12
  data: OrphanCredentialResItem[];
17
13
  };
18
14
  type Credential = {
19
- /** Datetime when the credential was created */
20
- created?: string;
21
- /** ID datasource that the credential is created for */
15
+ /** Datetime when the credential was created */created?: string; /** ID datasource that the credential is created for */
22
16
  datasourceID?: string;
23
- links?: Link;
24
- /** Number of linked connections */
25
- qConnCount: number;
26
- /** UUID of the credential */
27
- qID: string;
28
- /** Name of the credential */
29
- qName: string;
30
- /** Reference key of credential in redis */
31
- qReferenceKey?: string;
32
- /** Type of credential */
33
- qType: string;
34
- /** Datetime when the credential was last updated */
17
+ links?: Link; /** Number of linked connections */
18
+ qConnCount: number; /** UUID of the credential */
19
+ qID: string; /** Name of the credential */
20
+ qName: string; /** Reference key of credential in redis */
21
+ qReferenceKey?: string; /** Type of credential */
22
+ qType: string; /** Datetime when the credential was last updated */
35
23
  updated?: string;
36
24
  };
37
25
  /**
38
26
  * Credential
39
27
  */
40
28
  type CredentialCreate = {
41
- /** ID of connection that will be associated with the credential */
42
- connectionId?: string;
43
- /** ID datasource that the credential is created for */
44
- datasourceID?: string;
45
- /** UUID of the credential */
46
- qID?: string;
47
- /** Name of the credential */
48
- qName: string;
49
- /** Password */
50
- qPassword: string;
51
- /** Type of credential (i.e. connector provider of the corresponding connection) */
52
- qType: string;
53
- /** User name */
29
+ /** ID of connection that will be associated with the credential */connectionId?: string; /** ID datasource that the credential is created for */
30
+ datasourceID?: string; /** UUID of the credential */
31
+ qID?: string; /** Name of the credential */
32
+ qName: string; /** Password */
33
+ qPassword: string; /** Type of credential (i.e. connector provider of the corresponding connection) */
34
+ qType: string; /** User name */
54
35
  qUsername: string;
55
36
  };
56
37
  type Error = {
57
- /** Unique internal error code */
58
- code?: string;
59
- /** More concrete details */
60
- detail?: string;
61
- /** HTTP status code */
62
- status?: number;
63
- /** A summary in english explaining what went wrong */
38
+ /** Unique internal error code */code?: string; /** More concrete details */
39
+ detail?: string; /** HTTP status code */
40
+ status?: number; /** A summary in english explaining what went wrong */
64
41
  title?: string;
65
42
  };
66
43
  type Errors = Error[];
67
44
  type Link = {
68
- /** Link to current query */
69
- self: {
70
- /** URL pointing to the resource */
71
- href: string;
45
+ /** Link to current query */self: {
46
+ /** URL pointing to the resource */href: string;
72
47
  };
73
48
  };
74
49
  /**
75
50
  * Orphan credential
76
51
  */
77
52
  type OrphanCredentialResItem = {
78
- /** Datetime when the credential was created */
79
- created: string;
80
- /** ID datasource that the credential is created for */
81
- datasourceID?: string;
82
- /** UUID of the credential */
83
- qID: string;
84
- /** Name of the credential */
85
- qName: string;
86
- /** Type of credential (i.e. connector provider of the corresponding connection) */
87
- qType: string;
88
- /** Tenant ID of the credential's owner */
89
- tenant?: string;
90
- /** Datetime when the credential was last updated */
91
- updated: string;
92
- /** User ID of the credential's owner */
53
+ /** Datetime when the credential was created */created: string; /** ID datasource that the credential is created for */
54
+ datasourceID?: string; /** UUID of the credential */
55
+ qID: string; /** Name of the credential */
56
+ qName: string; /** Type of credential (i.e. connector provider of the corresponding connection) */
57
+ qType: string; /** Tenant ID of the credential's owner */
58
+ tenant?: string; /** Datetime when the credential was last updated */
59
+ updated: string; /** User ID of the credential's owner */
93
60
  user?: string;
94
61
  };
95
62
  type PatchRequest = {
96
- /** Operation type */
97
- op: "add" | "replace" | "remove";
98
- /** Path to the target field to be patched */
99
- path: string;
100
- /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
63
+ /** Operation type */op: "add" | "replace" | "remove"; /** Path to the target field to be patched */
64
+ path: string; /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
101
65
  value?: string | boolean | number | unknown[];
102
66
  }[];
103
67
  type ResponseErrors = {
@@ -135,8 +99,7 @@ type FilterOrphanedDataCredentialsHttpError = {
135
99
  * @throws DeleteDataCredentialHttpError
136
100
  */
137
101
  declare function deleteDataCredential(qID: string, query: {
138
- /** If set to true, credentialId in the query will be interpreted as credential's name */
139
- byCredentialName?: boolean;
102
+ /** If set to true, credentialId in the query will be interpreted as credential's name */byCredentialName?: boolean;
140
103
  }, options?: ApiCallOptions): Promise<DeleteDataCredentialHttpResponse>;
141
104
  type DeleteDataCredentialHttpResponse = {
142
105
  data: void;
@@ -163,8 +126,7 @@ type DeleteDataCredentialHttpError = {
163
126
  * @throws GetDataCredentialHttpError
164
127
  */
165
128
  declare function getDataCredential(qID: string, query: {
166
- /** If set to true, credentialId in the query will be interpreted as credential's name */
167
- byCredentialName?: boolean;
129
+ /** If set to true, credentialId in the query will be interpreted as credential's name */byCredentialName?: boolean;
168
130
  }, options?: ApiCallOptions): Promise<GetDataCredentialHttpResponse>;
169
131
  type GetDataCredentialHttpResponse = {
170
132
  data: Credential;
@@ -185,8 +147,7 @@ type GetDataCredentialHttpError = {
185
147
  * @throws PatchDataCredentialHttpError
186
148
  */
187
149
  declare function patchDataCredential(qID: string, query: {
188
- /** If set to true, credentialId in the query will be interpreted as credential's name */
189
- byCredentialName?: boolean;
150
+ /** If set to true, credentialId in the query will be interpreted as credential's name */byCredentialName?: boolean;
190
151
  }, body: PatchRequest, options?: ApiCallOptions): Promise<PatchDataCredentialHttpResponse>;
191
152
  type PatchDataCredentialHttpResponse = {
192
153
  data: void;
@@ -207,8 +168,7 @@ type PatchDataCredentialHttpError = {
207
168
  * @throws UpdateDataCredentialHttpError
208
169
  */
209
170
  declare function updateDataCredential(qID: string, query: {
210
- /** If set to true, credentialId in the query will be interpreted as credential's name */
211
- byCredentialName?: boolean;
171
+ /** If set to true, credentialId in the query will be interpreted as credential's name */byCredentialName?: boolean;
212
172
  }, body: CredentialCreate, options?: ApiCallOptions): Promise<UpdateDataCredentialHttpResponse>;
213
173
  type UpdateDataCredentialHttpResponse = {
214
174
  data: void;
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/data-credentials.ts
5
5
  /**
@@ -118,7 +118,6 @@ const dataCredentialsExport = {
118
118
  updateDataCredential,
119
119
  clearCache
120
120
  };
121
- var data_credentials_default = dataCredentialsExport;
122
121
 
123
122
  //#endregion
124
- export { clearCache, data_credentials_default as default, deleteDataCredential, filterOrphanedDataCredentials, getDataCredential, patchDataCredential, updateDataCredential };
123
+ export { clearCache, dataCredentialsExport as default, deleteDataCredential, filterOrphanedDataCredentials, getDataCredential, patchDataCredential, updateDataCredential };
package/data-files.d.ts CHANGED
@@ -1,57 +1,44 @@
1
- import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/data-files.d.ts
5
5
  type BatchChangeSpaceItem = {
6
- /** The ID of the data file whose space will be changed. */
7
- id: string;
6
+ /** The ID of the data file whose space will be changed. */id: string;
8
7
  /** The ID of the new space. Passing in a null will result in the data file being moved to the user's
9
8
  * personal space. */
10
9
  spaceId?: string;
11
10
  };
12
11
  type BatchDeleteAllBySpaceItem = {
13
- /** The ID of the space whose data files will be deleted. */
14
- id: string;
12
+ /** The ID of the space whose data files will be deleted. */id: string;
15
13
  };
16
14
  type BatchDeleteItem = {
17
- /** The ID of the data file to delete. */
18
- id: string;
15
+ /** The ID of the data file to delete. */id: string;
19
16
  };
20
17
  type ChangeDataFileOwnerRequest = {
21
- /** The ID of the new owner. */
22
- ownerId: string;
18
+ /** The ID of the new owner. */ownerId: string;
23
19
  };
24
20
  type ChangeDataFileSpaceRequest = {
25
- /** The ID of the space. If null, this data file will be moved to the user's personal space. */
26
- spaceId?: string;
21
+ /** The ID of the space. If null, this data file will be moved to the user's personal space. */spaceId?: string;
27
22
  };
28
23
  type ConnectionsResponse = {
29
- /** The connect statement that will be passed to the connector when invoked. */
30
- connectStatement: string;
31
- /** The unique identifier of the connection. */
32
- id: string;
33
- /** The name of the connection. */
24
+ /** The connect statement that will be passed to the connector when invoked. */connectStatement: string; /** The unique identifier of the connection. */
25
+ id: string; /** The name of the connection. */
34
26
  name: string;
35
27
  /** The team space that the given connection is associated with. If null, the connection is not associated
36
28
  * with any specific team space. */
37
29
  spaceId?: string;
38
- spaceStats?: SpaceStatsResponse;
39
- /** The type of the connection. */
30
+ spaceStats?: SpaceStatsResponse; /** The type of the connection. */
40
31
  type: string;
41
32
  };
42
33
  /**
43
34
  * Specifies the list of data file change space operations in a single batch.
44
35
  */
45
36
  type DataFileBatchChangeSpaceRequest = {
46
- /** The list of data files to delete. */
47
- "change-space": BatchChangeSpaceItem[];
37
+ /** The list of data files to delete. */"change-space": BatchChangeSpaceItem[];
48
38
  };
49
39
  type DataFileBatchDeleteRequest = {
50
- /** If specified, the explicit list of data files to delete. */
51
- delete: BatchDeleteItem[];
52
- /** If specified, attempt to delete all of the data files from the specified shared spaces. */
53
- deleteAllBySpace?: BatchDeleteAllBySpaceItem[];
54
- /** If specified, attempt to delete all of the datafiles from ther user's personal space. */
40
+ /** If specified, the explicit list of data files to delete. */delete: BatchDeleteItem[]; /** If specified, attempt to delete all of the data files from the specified shared spaces. */
41
+ deleteAllBySpace?: BatchDeleteAllBySpaceItem[]; /** If specified, attempt to delete all of the datafiles from ther user's personal space. */
55
42
  deleteAllFromPersonalSpace?: boolean;
56
43
  };
57
44
  /**
@@ -59,17 +46,11 @@ type DataFileBatchDeleteRequest = {
59
46
  */
60
47
  type DataFilePermission = "read" | "update" | "delete" | "list" | "change_owner" | "change_space";
61
48
  type DataFileUploadResponse = {
62
- /** The CRUD actions that are allowed on the given data file. */
63
- actions: DataFilePermission[];
64
- /** If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app. */
65
- appId?: string;
66
- /** The name of the file or folder, not including any folder path prefix. */
67
- baseName?: string;
68
- /** If the data file's content was updated, this is the DateTime of the last content update. */
69
- contentUpdatedDate?: string;
70
- /** The date that the file or folder was created. */
71
- createdDate: string;
72
- /** Whether or not this given item represents a folder or a file. */
49
+ /** The CRUD actions that are allowed on the given data file. */actions: DataFilePermission[]; /** If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app. */
50
+ appId?: string; /** The name of the file or folder, not including any folder path prefix. */
51
+ baseName?: string; /** If the data file's content was updated, this is the DateTime of the last content update. */
52
+ contentUpdatedDate?: string; /** The date that the file or folder was created. */
53
+ createdDate: string; /** Whether or not this given item represents a folder or a file. */
73
54
  folder?: boolean;
74
55
  /** If the file or folder resides in a parent folder, this is the parent folder ID. If the file or folder
75
56
  * does not reside in a parent folder, this value is null. */
@@ -77,20 +58,13 @@ type DataFileUploadResponse = {
77
58
  /** If the file or folder resides in a parent folder, this is the parent folder path. If the file or folder
78
59
  * does not reside in a parent folder, this value is null. */
79
60
  folderPath?: string;
80
- folderStats: FolderStatsResponse;
81
- /** The ID for the file or folder. */
82
- id: string;
83
- /** The date that the updated file or folder was last modified. */
84
- modifiedDate?: string;
85
- /** The full name of the file or folder, including any folder path prefix. */
86
- name: string;
87
- /** The 'owner' of a file or folder is the user who last uploaded the item's content. */
88
- ownerId: string;
89
- /** The QRI generated from the datafile or folder's metadata. */
90
- qri?: string;
91
- /** The size of the uploaded file, in bytes. 0 if this item represents a folder */
92
- size: number;
93
- /** If the file or folder was created in a team space, this is the ID of that space. */
61
+ folderStats: FolderStatsResponse; /** The ID for the file or folder. */
62
+ id: string; /** The date that the updated file or folder was last modified. */
63
+ modifiedDate?: string; /** The full name of the file or folder, including any folder path prefix. */
64
+ name: string; /** The 'owner' of a file or folder is the user who last uploaded the item's content. */
65
+ ownerId: string; /** The QRI generated from the datafile or folder's metadata. */
66
+ qri?: string; /** The size of the uploaded file, in bytes. 0 if this item represents a folder */
67
+ size: number; /** If the file or folder was created in a team space, this is the ID of that space. */
94
68
  spaceId?: string;
95
69
  };
96
70
  /**
@@ -103,18 +77,15 @@ type DataFileUploadResponse = {
103
77
  */
104
78
  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";
105
79
  type ErrorResponse = {
106
- /** List of errors and their properties. */
107
- errors: ErrorResponseItem[];
80
+ /** List of errors and their properties. */errors: ErrorResponseItem[];
108
81
  };
109
82
  type ErrorResponseItem = {
110
83
  /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
111
84
  * 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
112
85
  * 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
113
86
  * hierarchy depth.</li></ul> */
114
- code: ErrorCode;
115
- /** A human-readable explanation specific to this occurrence of the problem. */
116
- detail?: string;
117
- /** Summary of the problem. */
87
+ code: ErrorCode; /** A human-readable explanation specific to this occurrence of the problem. */
88
+ detail?: string; /** Summary of the problem. */
118
89
  title?: string;
119
90
  };
120
91
  type FolderStatsResponse = {
@@ -126,12 +97,9 @@ type FolderStatsResponse = {
126
97
  aggregateFileSize: number;
127
98
  /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
128
99
  * the given folder and it's sub-folder hierarchy. */
129
- aggregateInternalFileSize: number;
130
- /** The number of app-scoped data files that reside as direct children of the given folder. */
131
- directAppScopedFileCount: number;
132
- /** The number of data files that reside as direct children of the given folder. */
133
- directFileCount: number;
134
- /** The number of sub-folders that reside as direct children of the given folder. */
100
+ aggregateInternalFileSize: number; /** The number of app-scoped data files that reside as direct children of the given folder. */
101
+ directAppScopedFileCount: number; /** The number of data files that reside as direct children of the given folder. */
102
+ directFileCount: number; /** The number of sub-folders that reside as direct children of the given folder. */
135
103
  directFolderCount: number;
136
104
  /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
137
105
  * direct children of the given folder. */
@@ -150,8 +118,7 @@ type FolderStatsResponse = {
150
118
  totalInternalFileCount: number;
151
119
  };
152
120
  type GetConnectionsResponse = {
153
- /** Properties of the connections to the tenant spaces. */
154
- data: ConnectionsResponse[];
121
+ /** Properties of the connections to the tenant spaces. */data: ConnectionsResponse[];
155
122
  links: LinksResponse;
156
123
  };
157
124
  /**
@@ -161,8 +128,7 @@ type GetConnectionsResponse = {
161
128
  */
162
129
  type GetConnectionsSortField = "spaceId" | "+spaceId" | "-spaceId";
163
130
  type GetDataFileInfosResponse = {
164
- /** Properties of the uploaded data files. */
165
- data: DataFileUploadResponse[];
131
+ /** Properties of the uploaded data files. */data: DataFileUploadResponse[];
166
132
  links: LinksResponse;
167
133
  };
168
134
  /**
@@ -172,8 +138,7 @@ type GetDataFileInfosResponse = {
172
138
  */
173
139
  type GetDataFileInfosSortField = "name" | "+name" | "-name" | "size" | "+size" | "-size" | "modifiedDate" | "+modifiedDate" | "-modifiedDate" | "folder" | "+folder" | "-folder" | "baseName" | "+baseName" | "-baseName";
174
140
  type LinkResponse = {
175
- /** The URL for the link. */
176
- href?: string;
141
+ /** The URL for the link. */href?: string;
177
142
  };
178
143
  type LinksResponse = {
179
144
  next: LinkResponse;
@@ -181,22 +146,17 @@ type LinksResponse = {
181
146
  self: LinkResponse;
182
147
  };
183
148
  type MultiStatusResponse = {
184
- /** List of individual results for the items in the specified batch. */
185
- data: MultiStatusResponseItem[];
149
+ /** List of individual results for the items in the specified batch. */data: MultiStatusResponseItem[];
186
150
  };
187
151
  type MultiStatusResponseItem = {
188
152
  /** Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained
189
153
  * 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
190
154
  * 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
191
155
  * hierarchy depth.</li></ul> */
192
- code: ErrorCode;
193
- /** A human-readable explanation specific to this occurrence of the problem. */
194
- detail?: string;
195
- /** The unique identifier of the file. */
196
- id: string;
197
- /** The HTTP status code. */
198
- status: number;
199
- /** Summary of the problem. */
156
+ code: ErrorCode; /** A human-readable explanation specific to this occurrence of the problem. */
157
+ detail?: string; /** The unique identifier of the file. */
158
+ id: string; /** The HTTP status code. */
159
+ status: number; /** Summary of the problem. */
200
160
  title?: string;
201
161
  };
202
162
  /**
@@ -214,17 +174,14 @@ type MultiStatusResponseItem = {
214
174
  */
215
175
  type PutDataFileFolderMergeBehavior = "merge" | "replace";
216
176
  type QuotaResponse = {
217
- /** The allowed file extensions on files that are uploaded. */
218
- allowedExtensions: string[];
177
+ /** The allowed file extensions on files that are uploaded. */allowedExtensions: string[];
219
178
  /** The allowed file extensions for files that are only used internally by the system (and thus not typically
220
179
  * shown to end users). */
221
- allowedInternalExtensions: string[];
222
- /** Maximum allowable size of an uploaded file. */
180
+ allowedInternalExtensions: string[]; /** Maximum allowable size of an uploaded file. */
223
181
  maxFileSize: number;
224
182
  /** Maximum allowable size for a single uploaded large data file (in bytes). This is a file that was indirectly
225
183
  * uploaded using the temp content service chunked upload capability. */
226
- maxLargeFileSize: number;
227
- /** The maximum aggregate size of all files uploaded by a given user. */
184
+ maxLargeFileSize: number; /** The maximum aggregate size of all files uploaded by a given user. */
228
185
  maxSize: number;
229
186
  /** The current aggregate size of all files uploaded by a given user. If the current aggregate size is greater
230
187
  * than the maximum aggregate size, this is a quota violation. */
@@ -239,12 +196,9 @@ type SpaceStatsResponse = {
239
196
  aggregateFileSize: number;
240
197
  /** The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of
241
198
  * the given folder and it's sub-folder hierarchy. */
242
- aggregateInternalFileSize: number;
243
- /** The number of app-scoped data files that reside as direct children of the given folder. */
244
- directAppScopedFileCount: number;
245
- /** The number of data files that reside as direct children of the given folder. */
246
- directFileCount: number;
247
- /** The number of sub-folders that reside as direct children of the given folder. */
199
+ aggregateInternalFileSize: number; /** The number of app-scoped data files that reside as direct children of the given folder. */
200
+ directAppScopedFileCount: number; /** The number of data files that reside as direct children of the given folder. */
201
+ directFileCount: number; /** The number of sub-folders that reside as direct children of the given folder. */
248
202
  directFolderCount: number;
249
203
  /** The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as
250
204
  * direct children of the given folder. */
@@ -290,8 +244,7 @@ type SpaceStatsResponse = {
290
244
  * @throws GetDataFilesHttpError
291
245
  */
292
246
  declare function getDataFiles(query: {
293
- /** If set to false, do not return data files with internal extensions else return all the data files. */
294
- allowInternalFiles?: boolean;
247
+ /** If set to false, do not return data files with internal extensions else return all the data files. */allowInternalFiles?: boolean;
295
248
  /** Only return files scoped to the specified app. If this parameter is not specified, only files that are not
296
249
  * scoped to any app are returned. "*" implies all app-scoped files are returned. */
297
250
  appId?: string;
@@ -301,8 +254,7 @@ declare function getDataFiles(query: {
301
254
  baseNameWildcard?: string;
302
255
  /** Return files and folders that reside in the space referenced by the specified DataFiles connection. If this
303
256
  * parameter is not specified, the user's personal space is implied. */
304
- connectionId?: string;
305
- /** If set to true, exclude files in the returned list (IE, only return folders). If false, include files. */
257
+ connectionId?: string; /** If set to true, exclude files in the returned list (IE, only return folders). If false, include files. */
306
258
  excludeFiles?: boolean;
307
259
  /** If set to true, exclude folders and files that reside in sub-folders of the root being searched. If false,
308
260
  * include all items in full folder hierarchy that recursively reside under the root. That is, setting to
@@ -319,12 +271,9 @@ declare function getDataFiles(query: {
319
271
  includeAllSpaces?: boolean;
320
272
  /** If set to true, include computed folder statistics for folders in the returned list. If false, this information
321
273
  * is not returned. */
322
- includeFolderStats?: boolean;
323
- /** If set to true, include folders in the returned list. If false, only return data files. */
324
- includeFolders?: boolean;
325
- /** If present, the maximum number of data files to return. */
326
- limit?: number;
327
- /** Filter the list of files returned to the given file name. */
274
+ includeFolderStats?: boolean; /** If set to true, include folders in the returned list. If false, only return data files. */
275
+ includeFolders?: boolean; /** If present, the maximum number of data files to return. */
276
+ limit?: number; /** Filter the list of files returned to the given file name. */
328
277
  name?: string;
329
278
  /** If present, fetch the data files whose owner is not the specified owner. If a connectionId is specified in
330
279
  * this case, the returned list is constrained to the specified space. If connectionId is not specified, then
@@ -335,8 +284,7 @@ declare function getDataFiles(query: {
335
284
  /** If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the
336
285
  * returned list is constrained to the specified space. If connectionId is not specified, then all files owned
337
286
  * by the specified user are returned regardless of the personal space that a given file resides in. */
338
- ownerId?: string;
339
- /** If present, the cursor that starts the page of data that is returned. */
287
+ ownerId?: string; /** If present, the cursor that starts the page of data that is returned. */
340
288
  page?: string;
341
289
  /** The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on
342
290
  * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
@@ -361,8 +309,7 @@ type GetDataFilesHttpError = {
361
309
  * @throws UploadDataFileHttpError
362
310
  */
363
311
  declare function uploadDataFile(body: {
364
- /** IFormFile form multipart/form-data */
365
- File?: BodyInit;
312
+ /** IFormFile form multipart/form-data */File?: BodyInit;
366
313
  /** See PostDataFileRequest schema which defines request structure.
367
314
  * See model. */
368
315
  Json?: {
@@ -373,8 +320,7 @@ declare function uploadDataFile(body: {
373
320
  * the default is that the upload will occur in the context of the Personal Space DataFiles connection. If the
374
321
  * DataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this
375
322
  * will result in a logical move of this file or folder into the new space. */
376
- connectionId?: string;
377
- /** If true, a folder will be created. If false, a file is created. */
323
+ connectionId?: string; /** If true, a folder will be created. If false, a file is created. */
378
324
  folder?: boolean;
379
325
  /** If the specified file or folder should be moved to become a a sub-item of an existing folder, this is the ID
380
326
  * of this parent folder. Any additional folder path that is present on the Name property will be created
@@ -466,23 +412,17 @@ type DeleteDataFilesHttpError = {
466
412
  * @throws GetDataFilesConnectionsHttpError
467
413
  */
468
414
  declare function getDataFilesConnections(query: {
469
- /** If present, get connections with connection strings that are scoped to the given app ID. */
470
- appId?: string;
415
+ /** If present, get connections with connection strings that are scoped to the given app ID. */appId?: string;
471
416
  /** If set to true, include computed space-level statistics for the spaces represented by the connections in the
472
417
  * returned list. If false, this information is not returned. */
473
- includeSpaceStats?: boolean;
474
- /** If present, the maximum number of data file connection records to return. */
475
- limit?: number;
476
- /** If present, only return connections with the given name. */
477
- name?: string;
478
- /** If present, the cursor that starts the page of data that is returned. */
479
- page?: string;
480
- /** If true, only return the connections that access data in a personal space. Default is false. */
418
+ includeSpaceStats?: boolean; /** If present, the maximum number of data file connection records to return. */
419
+ limit?: number; /** If present, only return connections with the given name. */
420
+ name?: string; /** If present, the cursor that starts the page of data that is returned. */
421
+ page?: string; /** If true, only return the connections that access data in a personal space. Default is false. */
481
422
  personal?: boolean;
482
423
  /** The name of the field used to sort the result. By default, the sort is ascending. Putting a '+' prefix on
483
424
  * the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order. */
484
- sort?: GetConnectionsSortField;
485
- /** If present, only return the connection that accesses data files in the specified space. */
425
+ sort?: GetConnectionsSortField; /** If present, only return the connection that accesses data files in the specified space. */
486
426
  spaceId?: string;
487
427
  }, options?: ApiCallOptions): Promise<GetDataFilesConnectionsHttpResponse>;
488
428
  type GetDataFilesConnectionsHttpResponse = {
@@ -585,8 +525,7 @@ type GetDataFileHttpError = {
585
525
  * @throws ReuploadDataFileHttpError
586
526
  */
587
527
  declare function reuploadDataFile(id: string, body: {
588
- /** IFormFile form multipart/form-data */
589
- File?: BodyInit;
528
+ /** IFormFile form multipart/form-data */File?: BodyInit;
590
529
  /** See PutDataFileRequest schema which defines request structure.
591
530
  * See model. */
592
531
  Json?: {
package/data-files.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/data-files.ts
5
5
  /**
@@ -267,7 +267,6 @@ const dataFilesExport = {
267
267
  moveDataFile,
268
268
  clearCache
269
269
  };
270
- var data_files_default = dataFilesExport;
271
270
 
272
271
  //#endregion
273
- export { changeDataFileOwner, clearCache, data_files_default as default, deleteDataFile, deleteDataFiles, getDataFile, getDataFileConnection, getDataFiles, getDataFilesConnections, getDataFilesQuotas, moveDataFile, moveDataFiles, reuploadDataFile, uploadDataFile };
272
+ export { changeDataFileOwner, clearCache, dataFilesExport as default, deleteDataFile, deleteDataFiles, getDataFile, getDataFileConnection, getDataFiles, getDataFilesConnections, getDataFilesQuotas, moveDataFile, moveDataFiles, reuploadDataFile, uploadDataFile };