@imagekit/nodejs 7.0.1 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -0
- package/package.json +1 -1
- package/resources/beta/v2/files.d.mts +63 -1
- package/resources/beta/v2/files.d.mts.map +1 -1
- package/resources/beta/v2/files.d.ts +63 -1
- package/resources/beta/v2/files.d.ts.map +1 -1
- package/resources/custom-metadata-fields.d.mts +13 -1
- package/resources/custom-metadata-fields.d.mts.map +1 -1
- package/resources/custom-metadata-fields.d.ts +13 -1
- package/resources/custom-metadata-fields.d.ts.map +1 -1
- package/resources/custom-metadata-fields.js +5 -0
- package/resources/custom-metadata-fields.js.map +1 -1
- package/resources/custom-metadata-fields.mjs +5 -0
- package/resources/custom-metadata-fields.mjs.map +1 -1
- package/resources/files/files.d.mts +125 -1
- package/resources/files/files.d.mts.map +1 -1
- package/resources/files/files.d.ts +125 -1
- package/resources/files/files.d.ts.map +1 -1
- package/resources/files/files.js.map +1 -1
- package/resources/files/files.mjs.map +1 -1
- package/resources/webhooks.d.mts +62 -0
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +62 -0
- package/resources/webhooks.d.ts.map +1 -1
- package/src/resources/beta/v2/files.ts +72 -0
- package/src/resources/custom-metadata-fields.ts +14 -1
- package/src/resources/files/files.ts +143 -0
- package/src/resources/webhooks.ts +71 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,45 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 7.1.0 (2025-09-30)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v7.0.1...v7.1.0](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.0.1...v7.1.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add path policy related non-breaking changes ([d50cbcf](https://github.com/imagekit-developer/imagekit-nodejs/commit/d50cbcf4cd2535e25310c635539a2ecf2f2e8201))
|
|
10
|
+
* **api:** add selectedFieldsSchema in upload and list API response ([ec8c8b8](https://github.com/imagekit-developer/imagekit-nodejs/commit/ec8c8b846e6288e6c13d4bbe4e65ca13d4059fa2))
|
|
11
|
+
* **api:** fix upload API request params ([467d77b](https://github.com/imagekit-developer/imagekit-nodejs/commit/467d77b12af3f7f0a0816bffb921b229f6c54a9b))
|
|
12
|
+
* **api:** updated docs ([962390f](https://github.com/imagekit-developer/imagekit-nodejs/commit/962390f02b179b6a34f9697c27bc67ed99ba9b99))
|
|
13
|
+
* **mcp:** add option for including docs tools ([e1a3b52](https://github.com/imagekit-developer/imagekit-nodejs/commit/e1a3b52f5691f398669cd682c57d5a6dc4e5895a))
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* **mcp:** fix cli argument parsing logic ([a8da550](https://github.com/imagekit-developer/imagekit-nodejs/commit/a8da5506c7a39462b7b02bbfec1e4e7a6fbdfdaf))
|
|
19
|
+
* **mcp:** resolve a linting issue in server code ([e805d24](https://github.com/imagekit-developer/imagekit-nodejs/commit/e805d24f1d721e1694b927c3c41c5b21a4433fb0))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Performance Improvements
|
|
23
|
+
|
|
24
|
+
* faster formatting ([7e8cfad](https://github.com/imagekit-developer/imagekit-nodejs/commit/7e8cfadd5473e55e83c6659c4033f9b852d3f91c))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Chores
|
|
28
|
+
|
|
29
|
+
* **internal:** codegen related update ([ca24cab](https://github.com/imagekit-developer/imagekit-nodejs/commit/ca24cab20bc7d4450623d67b0ebcb4e2a0ef7633))
|
|
30
|
+
* **internal:** codegen related update ([2acb106](https://github.com/imagekit-developer/imagekit-nodejs/commit/2acb106595f0642dcdb81bcd9a041a1bf059d307))
|
|
31
|
+
* **internal:** fix incremental formatting in some cases ([863e6b7](https://github.com/imagekit-developer/imagekit-nodejs/commit/863e6b7b6cff10c81fc07524b038972db2ce76b6))
|
|
32
|
+
* **internal:** ignore .eslintcache ([f991673](https://github.com/imagekit-developer/imagekit-nodejs/commit/f99167394b66562e972b54730a4cf65aed8e33fd))
|
|
33
|
+
* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([9e0e5b0](https://github.com/imagekit-developer/imagekit-nodejs/commit/9e0e5b0c46930798e8d06f553fd91a57d9692d2b))
|
|
34
|
+
* **mcp:** allow pointing `docs_search` tool at other URLs ([bbe84b3](https://github.com/imagekit-developer/imagekit-nodejs/commit/bbe84b3a9a5b30fc11c7b074cea447632740f512))
|
|
35
|
+
* update lockfile ([dcdc0b7](https://github.com/imagekit-developer/imagekit-nodejs/commit/dcdc0b74f7d809165bc0e3bce1656626d5dd1240))
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Documentation
|
|
39
|
+
|
|
40
|
+
* correct typo in default value description for custom metadata field ([a957209](https://github.com/imagekit-developer/imagekit-nodejs/commit/a9572097a933ab5d9c62fda02d4edf8c9fc47eeb))
|
|
41
|
+
* fix link to deploy template in README ([ba86045](https://github.com/imagekit-developer/imagekit-nodejs/commit/ba86045ee37ea9c03cce09f8a8028e645f263bbf))
|
|
42
|
+
|
|
3
43
|
## 7.0.1 (2025-09-21)
|
|
4
44
|
|
|
5
45
|
Full Changelog: [v7.0.0...v7.0.1](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.0.0...v7.0.1)
|
package/package.json
CHANGED
|
@@ -145,6 +145,18 @@ export interface FileUploadResponse {
|
|
|
145
145
|
* Name of the asset.
|
|
146
146
|
*/
|
|
147
147
|
name?: string;
|
|
148
|
+
/**
|
|
149
|
+
* This field is included in the response only if the Path policy feature is
|
|
150
|
+
* available in the plan. It contains schema definitions for the custom metadata
|
|
151
|
+
* fields selected for the specified file path. Field selection can only be done
|
|
152
|
+
* when the Path policy feature is enabled.
|
|
153
|
+
*
|
|
154
|
+
* Keys are the names of the custom metadata fields; the value object has details
|
|
155
|
+
* about the custom metadata schema.
|
|
156
|
+
*/
|
|
157
|
+
selectedFieldsSchema?: {
|
|
158
|
+
[key: string]: FileUploadResponse.SelectedFieldsSchema;
|
|
159
|
+
};
|
|
148
160
|
/**
|
|
149
161
|
* Size of the image file in Bytes.
|
|
150
162
|
*/
|
|
@@ -210,6 +222,56 @@ export declare namespace FileUploadResponse {
|
|
|
210
222
|
'google-auto-tagging'?: 'success' | 'pending' | 'failed';
|
|
211
223
|
'remove-bg'?: 'success' | 'pending' | 'failed';
|
|
212
224
|
}
|
|
225
|
+
interface SelectedFieldsSchema {
|
|
226
|
+
/**
|
|
227
|
+
* Type of the custom metadata field.
|
|
228
|
+
*/
|
|
229
|
+
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
230
|
+
/**
|
|
231
|
+
* The default value for this custom metadata field. The value should match the
|
|
232
|
+
* `type` of custom metadata field.
|
|
233
|
+
*/
|
|
234
|
+
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
235
|
+
/**
|
|
236
|
+
* Specifies if the custom metadata field is required or not.
|
|
237
|
+
*/
|
|
238
|
+
isValueRequired?: boolean;
|
|
239
|
+
/**
|
|
240
|
+
* Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
241
|
+
*/
|
|
242
|
+
maxLength?: number;
|
|
243
|
+
/**
|
|
244
|
+
* Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
245
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
246
|
+
* field, it will be a numeric value.
|
|
247
|
+
*/
|
|
248
|
+
maxValue?: string | number;
|
|
249
|
+
/**
|
|
250
|
+
* Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
251
|
+
*/
|
|
252
|
+
minLength?: number;
|
|
253
|
+
/**
|
|
254
|
+
* Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
255
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
256
|
+
* field, it will be a numeric value.
|
|
257
|
+
*/
|
|
258
|
+
minValue?: string | number;
|
|
259
|
+
/**
|
|
260
|
+
* Indicates whether the custom metadata field is read only. A read only field
|
|
261
|
+
* cannot be modified after being set. This field is configurable only via the
|
|
262
|
+
* **Path policy** feature.
|
|
263
|
+
*/
|
|
264
|
+
readOnly?: boolean;
|
|
265
|
+
/**
|
|
266
|
+
* An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
267
|
+
*/
|
|
268
|
+
selectOptions?: Array<string | number | boolean>;
|
|
269
|
+
/**
|
|
270
|
+
* Specifies if the selectOptions array is truncated. It is truncated when number
|
|
271
|
+
* of options are > 100.
|
|
272
|
+
*/
|
|
273
|
+
selectOptionsTruncated?: boolean;
|
|
274
|
+
}
|
|
213
275
|
/**
|
|
214
276
|
* An object containing the file or file version's `id` (versionId) and `name`.
|
|
215
277
|
*/
|
|
@@ -337,7 +399,7 @@ export interface FileUploadParams {
|
|
|
337
399
|
/**
|
|
338
400
|
* Array of response field keys to include in the API response body.
|
|
339
401
|
*/
|
|
340
|
-
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata'>;
|
|
402
|
+
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata' | 'selectedFieldsSchema'>;
|
|
341
403
|
/**
|
|
342
404
|
* Set the tags while uploading the file. Provide an array of tag strings (e.g.
|
|
343
405
|
* `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/v2/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAWzF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAErD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;;;;;;;;;OAUG;IACH,UAAiB,eAAe;QAC9B,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,kBAAkB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEtD,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAE/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,MAAM,GACN,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,UAAU,
|
|
1
|
+
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../../src/resources/beta/v2/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAWzF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAErD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,oBAAoB,CAAA;KAAE,CAAC;IAElF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;;;;;;;;;OAUG;IACH,UAAiB,eAAe;QAC9B,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,kBAAkB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEtD,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChD;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;;WAIG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAEjD;;;WAGG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAE/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,MAAM,GACN,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,UAAU,GACV,sBAAsB,CACzB,CAAC;IAEF;;;;;OAKG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC;IAEjD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;;;;;;;OAYG;IACH,UAAiB,cAAc;QAC7B;;;;WAIG;QACH,IAAI,CAAC,EAAE,KAAK,CACR,cAAc,CAAC,cAAc,GAC7B,cAAc,CAAC,UAAU,GACzB,cAAc,CAAC,SAAS,GACxB,cAAc,CAAC,GAAG,CACrB,CAAC;QAEF;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,EAAE,gBAAgB,CAAC;YAEvB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,cAAc,CAAC;YAErB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,WAAW,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,QAAQ,EAAE,KAAK,GAAG,MAAM,CAAC;YAEzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACrG"}
|
|
@@ -145,6 +145,18 @@ export interface FileUploadResponse {
|
|
|
145
145
|
* Name of the asset.
|
|
146
146
|
*/
|
|
147
147
|
name?: string;
|
|
148
|
+
/**
|
|
149
|
+
* This field is included in the response only if the Path policy feature is
|
|
150
|
+
* available in the plan. It contains schema definitions for the custom metadata
|
|
151
|
+
* fields selected for the specified file path. Field selection can only be done
|
|
152
|
+
* when the Path policy feature is enabled.
|
|
153
|
+
*
|
|
154
|
+
* Keys are the names of the custom metadata fields; the value object has details
|
|
155
|
+
* about the custom metadata schema.
|
|
156
|
+
*/
|
|
157
|
+
selectedFieldsSchema?: {
|
|
158
|
+
[key: string]: FileUploadResponse.SelectedFieldsSchema;
|
|
159
|
+
};
|
|
148
160
|
/**
|
|
149
161
|
* Size of the image file in Bytes.
|
|
150
162
|
*/
|
|
@@ -210,6 +222,56 @@ export declare namespace FileUploadResponse {
|
|
|
210
222
|
'google-auto-tagging'?: 'success' | 'pending' | 'failed';
|
|
211
223
|
'remove-bg'?: 'success' | 'pending' | 'failed';
|
|
212
224
|
}
|
|
225
|
+
interface SelectedFieldsSchema {
|
|
226
|
+
/**
|
|
227
|
+
* Type of the custom metadata field.
|
|
228
|
+
*/
|
|
229
|
+
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
230
|
+
/**
|
|
231
|
+
* The default value for this custom metadata field. The value should match the
|
|
232
|
+
* `type` of custom metadata field.
|
|
233
|
+
*/
|
|
234
|
+
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
235
|
+
/**
|
|
236
|
+
* Specifies if the custom metadata field is required or not.
|
|
237
|
+
*/
|
|
238
|
+
isValueRequired?: boolean;
|
|
239
|
+
/**
|
|
240
|
+
* Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
241
|
+
*/
|
|
242
|
+
maxLength?: number;
|
|
243
|
+
/**
|
|
244
|
+
* Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
245
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
246
|
+
* field, it will be a numeric value.
|
|
247
|
+
*/
|
|
248
|
+
maxValue?: string | number;
|
|
249
|
+
/**
|
|
250
|
+
* Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
251
|
+
*/
|
|
252
|
+
minLength?: number;
|
|
253
|
+
/**
|
|
254
|
+
* Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
255
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
256
|
+
* field, it will be a numeric value.
|
|
257
|
+
*/
|
|
258
|
+
minValue?: string | number;
|
|
259
|
+
/**
|
|
260
|
+
* Indicates whether the custom metadata field is read only. A read only field
|
|
261
|
+
* cannot be modified after being set. This field is configurable only via the
|
|
262
|
+
* **Path policy** feature.
|
|
263
|
+
*/
|
|
264
|
+
readOnly?: boolean;
|
|
265
|
+
/**
|
|
266
|
+
* An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
267
|
+
*/
|
|
268
|
+
selectOptions?: Array<string | number | boolean>;
|
|
269
|
+
/**
|
|
270
|
+
* Specifies if the selectOptions array is truncated. It is truncated when number
|
|
271
|
+
* of options are > 100.
|
|
272
|
+
*/
|
|
273
|
+
selectOptionsTruncated?: boolean;
|
|
274
|
+
}
|
|
213
275
|
/**
|
|
214
276
|
* An object containing the file or file version's `id` (versionId) and `name`.
|
|
215
277
|
*/
|
|
@@ -337,7 +399,7 @@ export interface FileUploadParams {
|
|
|
337
399
|
/**
|
|
338
400
|
* Array of response field keys to include in the API response body.
|
|
339
401
|
*/
|
|
340
|
-
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata'>;
|
|
402
|
+
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata' | 'selectedFieldsSchema'>;
|
|
341
403
|
/**
|
|
342
404
|
* Set the tags while uploading the file. Provide an array of tag strings (e.g.
|
|
343
405
|
* `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/v2/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAWzF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAErD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;;;;;;;;;OAUG;IACH,UAAiB,eAAe;QAC9B,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,kBAAkB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEtD,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAE/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,MAAM,GACN,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,UAAU,
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/resources/beta/v2/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAWzF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC;IAErD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,oBAAoB,CAAA;KAAE,CAAC;IAElF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;;;;;;;;;OAUG;IACH,UAAiB,eAAe;QAC9B,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,kBAAkB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEtD,qBAAqB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QAEzD,WAAW,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChD;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;;WAIG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAEjD;;;WAGG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAE/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,MAAM,GACN,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,UAAU,GACV,sBAAsB,CACzB,CAAC;IAEF;;;;;OAKG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,cAAc,CAAC;IAEjD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;;;;;;;OAYG;IACH,UAAiB,cAAc;QAC7B;;;;WAIG;QACH,IAAI,CAAC,EAAE,KAAK,CACR,cAAc,CAAC,cAAc,GAC7B,cAAc,CAAC,UAAU,GACzB,cAAc,CAAC,SAAS,GACxB,cAAc,CAAC,GAAG,CACrB,CAAC;QAEF;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,EAAE,gBAAgB,CAAC;YAEvB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,cAAc,CAAC;YAErB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,WAAW,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,GAAG;YAClB;;eAEG;YACH,QAAQ,EAAE,KAAK,GAAG,MAAM,CAAC;YAEzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACrG"}
|
|
@@ -45,6 +45,11 @@ export declare class CustomMetadataFields extends APIResource {
|
|
|
45
45
|
* the API returns only non deleted field objects, but you can include deleted
|
|
46
46
|
* fields in the API response.
|
|
47
47
|
*
|
|
48
|
+
* You can also filter results by a specific folder path to retrieve custom
|
|
49
|
+
* metadata fields applicable at that location. This path-specific filtering is
|
|
50
|
+
* useful when using the **Path policy** feature to determine which custom metadata
|
|
51
|
+
* fields are selected for a given path.
|
|
52
|
+
*
|
|
48
53
|
* @example
|
|
49
54
|
* ```ts
|
|
50
55
|
* const customMetadataFields =
|
|
@@ -98,7 +103,7 @@ export declare namespace CustomMetadataField {
|
|
|
98
103
|
*/
|
|
99
104
|
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
100
105
|
/**
|
|
101
|
-
* The default value for this custom metadata field.
|
|
106
|
+
* The default value for this custom metadata field. Data type of default value
|
|
102
107
|
* depends on the field type.
|
|
103
108
|
*/
|
|
104
109
|
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
@@ -263,6 +268,13 @@ export declare namespace CustomMetadataFieldUpdateParams {
|
|
|
263
268
|
}
|
|
264
269
|
}
|
|
265
270
|
export interface CustomMetadataFieldListParams {
|
|
271
|
+
/**
|
|
272
|
+
* The folder path (e.g., `/path/to/folder`) for which to retrieve applicable
|
|
273
|
+
* custom metadata fields. Useful for determining path-specific field selections
|
|
274
|
+
* when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in
|
|
275
|
+
* use.
|
|
276
|
+
*/
|
|
277
|
+
folderPath?: string;
|
|
266
278
|
/**
|
|
267
279
|
* Set it to `true` to include deleted field objects in the API response.
|
|
268
280
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"custom-metadata-fields.d.mts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC
|
|
1
|
+
{"version":3,"file":"custom-metadata-fields.d.mts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;CACpC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,MAAM,+BAA+B,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEzE,MAAM,WAAW,iCAAiC;CAAG;AAErD,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,+BAA+B,CAAC,MAAM,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,+BAA+B,CAAC,MAAM,CAAC;CACjD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -45,6 +45,11 @@ export declare class CustomMetadataFields extends APIResource {
|
|
|
45
45
|
* the API returns only non deleted field objects, but you can include deleted
|
|
46
46
|
* fields in the API response.
|
|
47
47
|
*
|
|
48
|
+
* You can also filter results by a specific folder path to retrieve custom
|
|
49
|
+
* metadata fields applicable at that location. This path-specific filtering is
|
|
50
|
+
* useful when using the **Path policy** feature to determine which custom metadata
|
|
51
|
+
* fields are selected for a given path.
|
|
52
|
+
*
|
|
48
53
|
* @example
|
|
49
54
|
* ```ts
|
|
50
55
|
* const customMetadataFields =
|
|
@@ -98,7 +103,7 @@ export declare namespace CustomMetadataField {
|
|
|
98
103
|
*/
|
|
99
104
|
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
100
105
|
/**
|
|
101
|
-
* The default value for this custom metadata field.
|
|
106
|
+
* The default value for this custom metadata field. Data type of default value
|
|
102
107
|
* depends on the field type.
|
|
103
108
|
*/
|
|
104
109
|
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
@@ -263,6 +268,13 @@ export declare namespace CustomMetadataFieldUpdateParams {
|
|
|
263
268
|
}
|
|
264
269
|
}
|
|
265
270
|
export interface CustomMetadataFieldListParams {
|
|
271
|
+
/**
|
|
272
|
+
* The folder path (e.g., `/path/to/folder`) for which to retrieve applicable
|
|
273
|
+
* custom metadata fields. Useful for determining path-specific field selections
|
|
274
|
+
* when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in
|
|
275
|
+
* use.
|
|
276
|
+
*/
|
|
277
|
+
folderPath?: string;
|
|
266
278
|
/**
|
|
267
279
|
* Set it to `true` to include deleted field objects in the API response.
|
|
268
280
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"custom-metadata-fields.d.ts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC
|
|
1
|
+
{"version":3,"file":"custom-metadata-fields.d.ts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;CACpC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,MAAM,+BAA+B,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEzE,MAAM,WAAW,iCAAiC;CAAG;AAErD,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,+BAA+B,CAAC,MAAM,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,+BAA+B,CAAC,MAAM,CAAC;CACjD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -52,6 +52,11 @@ class CustomMetadataFields extends resource_1.APIResource {
|
|
|
52
52
|
* the API returns only non deleted field objects, but you can include deleted
|
|
53
53
|
* fields in the API response.
|
|
54
54
|
*
|
|
55
|
+
* You can also filter results by a specific folder path to retrieve custom
|
|
56
|
+
* metadata fields applicable at that location. This path-specific filtering is
|
|
57
|
+
* useful when using the **Path policy** feature to determine which custom metadata
|
|
58
|
+
* fields are selected for a given path.
|
|
59
|
+
*
|
|
55
60
|
* @example
|
|
56
61
|
* ```ts
|
|
57
62
|
* const customMetadataFields =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"custom-metadata-fields.js","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"custom-metadata-fields.js","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AArFD,oDAqFC"}
|
|
@@ -49,6 +49,11 @@ export class CustomMetadataFields extends APIResource {
|
|
|
49
49
|
* the API returns only non deleted field objects, but you can include deleted
|
|
50
50
|
* fields in the API response.
|
|
51
51
|
*
|
|
52
|
+
* You can also filter results by a specific folder path to retrieve custom
|
|
53
|
+
* metadata fields applicable at that location. This path-specific filtering is
|
|
54
|
+
* useful when using the **Path policy** feature to determine which custom metadata
|
|
55
|
+
* fields are selected for a given path.
|
|
56
|
+
*
|
|
52
57
|
* @example
|
|
53
58
|
* ```ts
|
|
54
59
|
* const customMetadataFields =
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"custom-metadata-fields.mjs","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"custom-metadata-fields.mjs","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}
|
|
@@ -200,6 +200,18 @@ export interface File {
|
|
|
200
200
|
* Name of the asset.
|
|
201
201
|
*/
|
|
202
202
|
name?: string;
|
|
203
|
+
/**
|
|
204
|
+
* This field is included in the response only if the Path policy feature is
|
|
205
|
+
* available in the plan. It contains schema definitions for the custom metadata
|
|
206
|
+
* fields selected for the specified file path. Field selection can only be done
|
|
207
|
+
* when the Path policy feature is enabled.
|
|
208
|
+
*
|
|
209
|
+
* Keys are the names of the custom metadata fields; the value object has details
|
|
210
|
+
* about the custom metadata schema.
|
|
211
|
+
*/
|
|
212
|
+
selectedFieldsSchema?: {
|
|
213
|
+
[key: string]: File.SelectedFieldsSchema;
|
|
214
|
+
};
|
|
203
215
|
/**
|
|
204
216
|
* Size of the file in bytes.
|
|
205
217
|
*/
|
|
@@ -252,6 +264,56 @@ export declare namespace File {
|
|
|
252
264
|
*/
|
|
253
265
|
source?: string;
|
|
254
266
|
}
|
|
267
|
+
interface SelectedFieldsSchema {
|
|
268
|
+
/**
|
|
269
|
+
* Type of the custom metadata field.
|
|
270
|
+
*/
|
|
271
|
+
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
272
|
+
/**
|
|
273
|
+
* The default value for this custom metadata field. The value should match the
|
|
274
|
+
* `type` of custom metadata field.
|
|
275
|
+
*/
|
|
276
|
+
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
277
|
+
/**
|
|
278
|
+
* Specifies if the custom metadata field is required or not.
|
|
279
|
+
*/
|
|
280
|
+
isValueRequired?: boolean;
|
|
281
|
+
/**
|
|
282
|
+
* Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
283
|
+
*/
|
|
284
|
+
maxLength?: number;
|
|
285
|
+
/**
|
|
286
|
+
* Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
287
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
288
|
+
* field, it will be a numeric value.
|
|
289
|
+
*/
|
|
290
|
+
maxValue?: string | number;
|
|
291
|
+
/**
|
|
292
|
+
* Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
293
|
+
*/
|
|
294
|
+
minLength?: number;
|
|
295
|
+
/**
|
|
296
|
+
* Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
297
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
298
|
+
* field, it will be a numeric value.
|
|
299
|
+
*/
|
|
300
|
+
minValue?: string | number;
|
|
301
|
+
/**
|
|
302
|
+
* Indicates whether the custom metadata field is read only. A read only field
|
|
303
|
+
* cannot be modified after being set. This field is configurable only via the
|
|
304
|
+
* **Path policy** feature.
|
|
305
|
+
*/
|
|
306
|
+
readOnly?: boolean;
|
|
307
|
+
/**
|
|
308
|
+
* An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
309
|
+
*/
|
|
310
|
+
selectOptions?: Array<string | number | boolean>;
|
|
311
|
+
/**
|
|
312
|
+
* Specifies if the selectOptions array is truncated. It is truncated when number
|
|
313
|
+
* of options are > 100.
|
|
314
|
+
*/
|
|
315
|
+
selectOptionsTruncated?: boolean;
|
|
316
|
+
}
|
|
255
317
|
/**
|
|
256
318
|
* An object with details of the file version.
|
|
257
319
|
*/
|
|
@@ -656,6 +718,18 @@ export interface FileUploadResponse {
|
|
|
656
718
|
* Name of the asset.
|
|
657
719
|
*/
|
|
658
720
|
name?: string;
|
|
721
|
+
/**
|
|
722
|
+
* This field is included in the response only if the Path policy feature is
|
|
723
|
+
* available in the plan. It contains schema definitions for the custom metadata
|
|
724
|
+
* fields selected for the specified file path. Field selection can only be done
|
|
725
|
+
* when the Path policy feature is enabled.
|
|
726
|
+
*
|
|
727
|
+
* Keys are the names of the custom metadata fields; the value object has details
|
|
728
|
+
* about the custom metadata schema.
|
|
729
|
+
*/
|
|
730
|
+
selectedFieldsSchema?: {
|
|
731
|
+
[key: string]: FileUploadResponse.SelectedFieldsSchema;
|
|
732
|
+
};
|
|
659
733
|
/**
|
|
660
734
|
* Size of the image file in Bytes.
|
|
661
735
|
*/
|
|
@@ -721,6 +795,56 @@ export declare namespace FileUploadResponse {
|
|
|
721
795
|
'google-auto-tagging'?: 'success' | 'pending' | 'failed';
|
|
722
796
|
'remove-bg'?: 'success' | 'pending' | 'failed';
|
|
723
797
|
}
|
|
798
|
+
interface SelectedFieldsSchema {
|
|
799
|
+
/**
|
|
800
|
+
* Type of the custom metadata field.
|
|
801
|
+
*/
|
|
802
|
+
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
|
|
803
|
+
/**
|
|
804
|
+
* The default value for this custom metadata field. The value should match the
|
|
805
|
+
* `type` of custom metadata field.
|
|
806
|
+
*/
|
|
807
|
+
defaultValue?: string | number | boolean | Array<string | number | boolean>;
|
|
808
|
+
/**
|
|
809
|
+
* Specifies if the custom metadata field is required or not.
|
|
810
|
+
*/
|
|
811
|
+
isValueRequired?: boolean;
|
|
812
|
+
/**
|
|
813
|
+
* Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
814
|
+
*/
|
|
815
|
+
maxLength?: number;
|
|
816
|
+
/**
|
|
817
|
+
* Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
818
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
819
|
+
* field, it will be a numeric value.
|
|
820
|
+
*/
|
|
821
|
+
maxValue?: string | number;
|
|
822
|
+
/**
|
|
823
|
+
* Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
824
|
+
*/
|
|
825
|
+
minLength?: number;
|
|
826
|
+
/**
|
|
827
|
+
* Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
828
|
+
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
829
|
+
* field, it will be a numeric value.
|
|
830
|
+
*/
|
|
831
|
+
minValue?: string | number;
|
|
832
|
+
/**
|
|
833
|
+
* Indicates whether the custom metadata field is read only. A read only field
|
|
834
|
+
* cannot be modified after being set. This field is configurable only via the
|
|
835
|
+
* **Path policy** feature.
|
|
836
|
+
*/
|
|
837
|
+
readOnly?: boolean;
|
|
838
|
+
/**
|
|
839
|
+
* An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
840
|
+
*/
|
|
841
|
+
selectOptions?: Array<string | number | boolean>;
|
|
842
|
+
/**
|
|
843
|
+
* Specifies if the selectOptions array is truncated. It is truncated when number
|
|
844
|
+
* of options are > 100.
|
|
845
|
+
*/
|
|
846
|
+
selectOptionsTruncated?: boolean;
|
|
847
|
+
}
|
|
724
848
|
/**
|
|
725
849
|
* An object containing the file or file version's `id` (versionId) and `name`.
|
|
726
850
|
*/
|
|
@@ -998,7 +1122,7 @@ export interface FileUploadParams {
|
|
|
998
1122
|
/**
|
|
999
1123
|
* Array of response field keys to include in the API response body.
|
|
1000
1124
|
*/
|
|
1001
|
-
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata'>;
|
|
1125
|
+
responseFields?: Array<'tags' | 'customCoordinates' | 'isPrivateFile' | 'embeddedMetadata' | 'isPublished' | 'customMetadata' | 'metadata' | 'selectedFieldsSchema'>;
|
|
1002
1126
|
/**
|
|
1003
1127
|
* HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a
|
|
1004
1128
|
* key. Learn how to create a signature on the page below. This should be in
|