@imagekit/nodejs 7.0.1 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +74 -0
- package/README.md +54 -6
- package/internal/to-file.d.mts +1 -1
- package/internal/to-file.d.ts +1 -1
- package/internal/to-file.js +1 -1
- package/internal/to-file.mjs +1 -1
- package/lib/transformation-utils.d.mts.map +1 -1
- package/lib/transformation-utils.d.ts.map +1 -1
- package/lib/transformation-utils.js +1 -0
- package/lib/transformation-utils.js.map +1 -1
- package/lib/transformation-utils.mjs +1 -0
- package/lib/transformation-utils.mjs.map +1 -1
- 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/helper.d.mts.map +1 -1
- package/resources/helper.d.ts.map +1 -1
- package/resources/helper.js +22 -20
- package/resources/helper.js.map +1 -1
- package/resources/helper.mjs +22 -20
- package/resources/helper.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/internal/to-file.ts +1 -1
- package/src/lib/transformation-utils.ts +1 -0
- 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/helper.ts +28 -19
- 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,79 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 7.1.1 (2025-10-06)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v7.1.0...v7.1.1](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.1.0...v7.1.1)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** use scoped package for mcp server ([af9b0f4](https://github.com/imagekit-developer/imagekit-nodejs/commit/af9b0f4abeeef59418ae6fc2dabf65d6270c9bb1))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* add missing 'color' parameter mapping for subtitle overlays transformation. ([2c4a6d2](https://github.com/imagekit-developer/imagekit-nodejs/commit/2c4a6d20aec544c01fb29e7b2d64513527a11ccc))
|
|
15
|
+
* lint error ([b320d6f](https://github.com/imagekit-developer/imagekit-nodejs/commit/b320d6f9a03f1aefd1d9edad23618953b29d100c))
|
|
16
|
+
* linting issues ([3794fe5](https://github.com/imagekit-developer/imagekit-nodejs/commit/3794fe565330087cae39bb5e35c77b0ecc6c2a2a))
|
|
17
|
+
* update raw parameter example in README for clarity ([e86beab](https://github.com/imagekit-developer/imagekit-nodejs/commit/e86beabfa77291baaf3cd3bf6be7f1336170e51d))
|
|
18
|
+
* update serverConfig to include valid URLs and improve label descriptions ([49d048f](https://github.com/imagekit-developer/imagekit-nodejs/commit/49d048fba3d9ede0e3e92991e8829d51c04c1229))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Chores
|
|
22
|
+
|
|
23
|
+
* configure new SDK language ([33d1237](https://github.com/imagekit-developer/imagekit-nodejs/commit/33d12370088d062a282f81625c63522a5d961308))
|
|
24
|
+
* **internal:** remove .eslintcache ([ec12af7](https://github.com/imagekit-developer/imagekit-nodejs/commit/ec12af7ecad37e8f7a227b356acd0d0cc1c52255))
|
|
25
|
+
* **jsdoc:** fix [@link](https://github.com/link) annotations to refer only to parts of the package‘s public interface ([4332a7e](https://github.com/imagekit-developer/imagekit-nodejs/commit/4332a7e3680d596f508b6d2c83b1e9faab6af878))
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Documentation
|
|
29
|
+
|
|
30
|
+
* update README to enhance Table of Contents and add raw transformations parameter ([892d31c](https://github.com/imagekit-developer/imagekit-nodejs/commit/892d31c9105c1c8c9bbd08983c2a0c9a62aee883))
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Refactors
|
|
34
|
+
|
|
35
|
+
* streamline transformation string handling in URL construction ([6e99777](https://github.com/imagekit-developer/imagekit-nodejs/commit/6e99777260db5c7fe833d4e71abe5abafb95156d))
|
|
36
|
+
|
|
37
|
+
## 7.1.0 (2025-09-30)
|
|
38
|
+
|
|
39
|
+
Full Changelog: [v7.0.1...v7.1.0](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.0.1...v7.1.0)
|
|
40
|
+
|
|
41
|
+
### Features
|
|
42
|
+
|
|
43
|
+
* **api:** add path policy related non-breaking changes ([d50cbcf](https://github.com/imagekit-developer/imagekit-nodejs/commit/d50cbcf4cd2535e25310c635539a2ecf2f2e8201))
|
|
44
|
+
* **api:** add selectedFieldsSchema in upload and list API response ([ec8c8b8](https://github.com/imagekit-developer/imagekit-nodejs/commit/ec8c8b846e6288e6c13d4bbe4e65ca13d4059fa2))
|
|
45
|
+
* **api:** fix upload API request params ([467d77b](https://github.com/imagekit-developer/imagekit-nodejs/commit/467d77b12af3f7f0a0816bffb921b229f6c54a9b))
|
|
46
|
+
* **api:** updated docs ([962390f](https://github.com/imagekit-developer/imagekit-nodejs/commit/962390f02b179b6a34f9697c27bc67ed99ba9b99))
|
|
47
|
+
* **mcp:** add option for including docs tools ([e1a3b52](https://github.com/imagekit-developer/imagekit-nodejs/commit/e1a3b52f5691f398669cd682c57d5a6dc4e5895a))
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Bug Fixes
|
|
51
|
+
|
|
52
|
+
* **mcp:** fix cli argument parsing logic ([a8da550](https://github.com/imagekit-developer/imagekit-nodejs/commit/a8da5506c7a39462b7b02bbfec1e4e7a6fbdfdaf))
|
|
53
|
+
* **mcp:** resolve a linting issue in server code ([e805d24](https://github.com/imagekit-developer/imagekit-nodejs/commit/e805d24f1d721e1694b927c3c41c5b21a4433fb0))
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Performance Improvements
|
|
57
|
+
|
|
58
|
+
* faster formatting ([7e8cfad](https://github.com/imagekit-developer/imagekit-nodejs/commit/7e8cfadd5473e55e83c6659c4033f9b852d3f91c))
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Chores
|
|
62
|
+
|
|
63
|
+
* **internal:** codegen related update ([ca24cab](https://github.com/imagekit-developer/imagekit-nodejs/commit/ca24cab20bc7d4450623d67b0ebcb4e2a0ef7633))
|
|
64
|
+
* **internal:** codegen related update ([2acb106](https://github.com/imagekit-developer/imagekit-nodejs/commit/2acb106595f0642dcdb81bcd9a041a1bf059d307))
|
|
65
|
+
* **internal:** fix incremental formatting in some cases ([863e6b7](https://github.com/imagekit-developer/imagekit-nodejs/commit/863e6b7b6cff10c81fc07524b038972db2ce76b6))
|
|
66
|
+
* **internal:** ignore .eslintcache ([f991673](https://github.com/imagekit-developer/imagekit-nodejs/commit/f99167394b66562e972b54730a4cf65aed8e33fd))
|
|
67
|
+
* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([9e0e5b0](https://github.com/imagekit-developer/imagekit-nodejs/commit/9e0e5b0c46930798e8d06f553fd91a57d9692d2b))
|
|
68
|
+
* **mcp:** allow pointing `docs_search` tool at other URLs ([bbe84b3](https://github.com/imagekit-developer/imagekit-nodejs/commit/bbe84b3a9a5b30fc11c7b074cea447632740f512))
|
|
69
|
+
* update lockfile ([dcdc0b7](https://github.com/imagekit-developer/imagekit-nodejs/commit/dcdc0b74f7d809165bc0e3bce1656626d5dd1240))
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
### Documentation
|
|
73
|
+
|
|
74
|
+
* correct typo in default value description for custom metadata field ([a957209](https://github.com/imagekit-developer/imagekit-nodejs/commit/a9572097a933ab5d9c62fda02d4edf8c9fc47eeb))
|
|
75
|
+
* fix link to deploy template in README ([ba86045](https://github.com/imagekit-developer/imagekit-nodejs/commit/ba86045ee37ea9c03cce09f8a8028e645f263bbf))
|
|
76
|
+
|
|
3
77
|
## 7.0.1 (2025-09-21)
|
|
4
78
|
|
|
5
79
|
Full Changelog: [v7.0.0...v7.0.1](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.0.0...v7.0.1)
|
package/README.md
CHANGED
|
@@ -10,6 +10,36 @@ For additional details, refer to the [ImageKit REST API documentation](https://i
|
|
|
10
10
|
|
|
11
11
|
If you are looking to integrate file uploads in browsers, use one of our [frontend SDKs](https://imagekit.io/docs/quick-start-guides#front-end).
|
|
12
12
|
|
|
13
|
+
## Table of Contents
|
|
14
|
+
|
|
15
|
+
- [Installation](#installation)
|
|
16
|
+
- [Usage](#usage)
|
|
17
|
+
- [Request & Response types](#request--response-types)
|
|
18
|
+
- [File uploads](#file-uploads)
|
|
19
|
+
- [URL generation](#url-generation)
|
|
20
|
+
- [Basic URL generation](#basic-url-generation)
|
|
21
|
+
- [URL generation with transformations](#url-generation-with-transformations)
|
|
22
|
+
- [URL generation with image overlay](#url-generation-with-image-overlay)
|
|
23
|
+
- [URL generation with text overlay](#url-generation-with-text-overlay)
|
|
24
|
+
- [URL generation with multiple overlays](#url-generation-with-multiple-overlays)
|
|
25
|
+
- [Signed URLs for secure delivery](#signed-urls-for-secure-delivery)
|
|
26
|
+
- [Using Raw parameter for custom transformations](#using-raw-parameter-for-custom-transformations)
|
|
27
|
+
- [Authentication parameters for client-side uploads](#authentication-parameters-for-client-side-uploads)
|
|
28
|
+
- [Webhook verification](#webhook-verification)
|
|
29
|
+
- [Verifying webhook signatures](#verifying-webhook-signatures)
|
|
30
|
+
- [Handling errors](#handling-errors)
|
|
31
|
+
- [Retries](#retries)
|
|
32
|
+
- [Timeouts](#timeouts)
|
|
33
|
+
- [Advanced Usage](#advanced-usage)
|
|
34
|
+
- [Accessing raw Response data (e.g., headers)](#accessing-raw-response-data-eg-headers)
|
|
35
|
+
- [Logging](#logging)
|
|
36
|
+
- [Making custom/undocumented requests](#making-customundocumented-requests)
|
|
37
|
+
- [Customizing the fetch client](#customizing-the-fetch-client)
|
|
38
|
+
- [Fetch options](#fetch-options)
|
|
39
|
+
- [Semantic versioning](#semantic-versioning)
|
|
40
|
+
- [Requirements](#requirements)
|
|
41
|
+
- [Contributing](#contributing)
|
|
42
|
+
|
|
13
43
|
## Installation
|
|
14
44
|
|
|
15
45
|
```sh
|
|
@@ -98,7 +128,7 @@ Generate a simple URL without any transformations:
|
|
|
98
128
|
import ImageKit from '@imagekit/nodejs';
|
|
99
129
|
|
|
100
130
|
const client = new ImageKit({
|
|
101
|
-
privateKey: process.env['IMAGEKIT_PRIVATE_KEY']
|
|
131
|
+
privateKey: process.env['IMAGEKIT_PRIVATE_KEY'],
|
|
102
132
|
});
|
|
103
133
|
|
|
104
134
|
// Basic URL without transformations
|
|
@@ -264,6 +294,26 @@ const permanentSignedUrl = client.helper.buildSrc({
|
|
|
264
294
|
// Result: URL with signature parameter (?ik-s=signature)
|
|
265
295
|
```
|
|
266
296
|
|
|
297
|
+
### Using Raw parameter for custom transformations
|
|
298
|
+
|
|
299
|
+
ImageKit frequently adds new transformation parameters that might not yet be documented in the SDK. You can use the `raw` parameter to access these features or create custom transformation strings:
|
|
300
|
+
|
|
301
|
+
```ts
|
|
302
|
+
// Using raw parameter for custom transformations
|
|
303
|
+
const customTransformUrl = client.helper.buildSrc({
|
|
304
|
+
urlEndpoint: 'https://ik.imagekit.io/your_imagekit_id',
|
|
305
|
+
src: '/path/to/image.jpg',
|
|
306
|
+
transformation: [
|
|
307
|
+
{
|
|
308
|
+
width: 400,
|
|
309
|
+
height: 300,
|
|
310
|
+
raw: 'something-new',
|
|
311
|
+
},
|
|
312
|
+
],
|
|
313
|
+
});
|
|
314
|
+
// Result: https://ik.imagekit.io/your_imagekit_id/path/to/image.jpg?tr=w-400,h-300,something-new
|
|
315
|
+
```
|
|
316
|
+
|
|
267
317
|
## Authentication parameters for client-side uploads
|
|
268
318
|
|
|
269
319
|
Generate authentication parameters for secure client-side file uploads:
|
|
@@ -300,11 +350,11 @@ try {
|
|
|
300
350
|
// Verify and unwrap webhook payload
|
|
301
351
|
const event = client.webhooks.unwrap(
|
|
302
352
|
webhookBody, // Raw webhook payload (string)
|
|
303
|
-
{
|
|
353
|
+
{
|
|
304
354
|
headers: webhookHeaders, // Request headers containing signature
|
|
305
|
-
}
|
|
355
|
+
},
|
|
306
356
|
);
|
|
307
|
-
|
|
357
|
+
|
|
308
358
|
console.log('Webhook signature is valid');
|
|
309
359
|
console.log('Event type:', event.type);
|
|
310
360
|
console.log('Event data:', event.data);
|
|
@@ -595,8 +645,6 @@ const client = new ImageKit({
|
|
|
595
645
|
});
|
|
596
646
|
```
|
|
597
647
|
|
|
598
|
-
## Frequently Asked Questions
|
|
599
|
-
|
|
600
648
|
## Semantic versioning
|
|
601
649
|
|
|
602
650
|
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
|
package/internal/to-file.d.mts
CHANGED
|
@@ -33,7 +33,7 @@ export interface ResponseLike {
|
|
|
33
33
|
export type ToFileInput = FileLike | ResponseLike | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
|
|
34
34
|
/**
|
|
35
35
|
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
|
|
36
|
-
* @param value the raw content of the file.
|
|
36
|
+
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
|
|
37
37
|
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
|
|
38
38
|
* @param {Object=} options additional properties
|
|
39
39
|
* @param {string=} options.type the MIME type of the content
|
package/internal/to-file.d.ts
CHANGED
|
@@ -33,7 +33,7 @@ export interface ResponseLike {
|
|
|
33
33
|
export type ToFileInput = FileLike | ResponseLike | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
|
|
34
34
|
/**
|
|
35
35
|
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
|
|
36
|
-
* @param value the raw content of the file.
|
|
36
|
+
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
|
|
37
37
|
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
|
|
38
38
|
* @param {Object=} options additional properties
|
|
39
39
|
* @param {string=} options.type the MIME type of the content
|
package/internal/to-file.js
CHANGED
|
@@ -27,7 +27,7 @@ const isResponseLike = (value) => value != null &&
|
|
|
27
27
|
typeof value.blob === 'function';
|
|
28
28
|
/**
|
|
29
29
|
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
|
|
30
|
-
* @param value the raw content of the file.
|
|
30
|
+
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
|
|
31
31
|
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
|
|
32
32
|
* @param {Object=} options additional properties
|
|
33
33
|
* @param {string=} options.type the MIME type of the content
|
package/internal/to-file.mjs
CHANGED
|
@@ -24,7 +24,7 @@ const isResponseLike = (value) => value != null &&
|
|
|
24
24
|
typeof value.blob === 'function';
|
|
25
25
|
/**
|
|
26
26
|
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
|
|
27
|
-
* @param value the raw content of the file.
|
|
27
|
+
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
|
|
28
28
|
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
|
|
29
29
|
* @param {Object=} options additional properties
|
|
30
30
|
* @param {string=} options.type the MIME type of the content
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformation-utils.d.mts","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"OAGO,KAAK,EAAE,UAAU,EAA0B;AASlD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"transformation-utils.d.mts","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"OAGO,KAAK,EAAE,UAAU,EAA0B;AASlD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CA0ExD,CAAC;;mCAG+B,UAAU,KAAG,OAAO;iCAGb,MAAM,KAAG,MAAM;sCAOZ,MAAM;iCAGX,MAAM;yCAGE,MAAM;;AAjBpD,wBAoBE;AAEF,eAAO,MAAM,QAAQ,GAAa,KAAK,MAAM,KAAG,MAG/C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformation-utils.d.ts","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"OAGO,KAAK,EAAE,UAAU,EAA0B;AASlD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"transformation-utils.d.ts","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"OAGO,KAAK,EAAE,UAAU,EAA0B;AASlD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CA0ExD,CAAC;;mCAG+B,UAAU,KAAG,OAAO;iCAGb,MAAM,KAAG,MAAM;sCAOZ,MAAM;iCAGX,MAAM;yCAGE,MAAM;;AAjBpD,wBAoBE;AAEF,eAAO,MAAM,QAAQ,GAAa,KAAK,MAAM,KAAG,MAG/C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformation-utils.js","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,kEAAkE;;;AAGlE,wDAAoD;AAEpD,MAAM,6BAA6B,GAA2B,OAAO,CAAC;AACtE,MAAM,4BAA4B,GAA2B,MAAM,CAAC;AACpE,MAAM,yBAAyB,GAAW,GAAG,CAAC;AAC9C,MAAM,mBAAmB,GAAW,GAAG,CAAC;AACxC,MAAM,6BAA6B,GAAW,GAAG,CAAC;AAElD;;;GAGG;AACU,QAAA,mBAAmB,GAA8B;IAC5D,wBAAwB;IACxB,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG;IACT,QAAQ,EAAE,IAAI;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,GAAG;IACZ,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,IAAI;IAE1B,wBAAwB;IACxB,SAAS,EAAE,aAAa;IACxB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,cAAc;IAC5B,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;IAChC,0BAA0B,EAAE,eAAe;IAC3C,MAAM,EAAE,QAAQ;IAChB,eAAe,EAAE,YAAY;IAC7B,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,WAAW;IACpB,WAAW,EAAE,OAAO;IACpB,QAAQ,EAAE,YAAY;IAEtB,0BAA0B;IAC1B,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,IAAI;IAEV,+BAA+B;IAC/B,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,cAAc,EAAE,IAAI;IACpB,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAEhB,4BAA4B;IAC5B,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;
|
|
1
|
+
{"version":3,"file":"transformation-utils.js","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,kEAAkE;;;AAGlE,wDAAoD;AAEpD,MAAM,6BAA6B,GAA2B,OAAO,CAAC;AACtE,MAAM,4BAA4B,GAA2B,MAAM,CAAC;AACpE,MAAM,yBAAyB,GAAW,GAAG,CAAC;AAC9C,MAAM,mBAAmB,GAAW,GAAG,CAAC;AACxC,MAAM,6BAA6B,GAAW,GAAG,CAAC;AAElD;;;GAGG;AACU,QAAA,mBAAmB,GAA8B;IAC5D,wBAAwB;IACxB,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG;IACT,QAAQ,EAAE,IAAI;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,GAAG;IACZ,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,IAAI;IAE1B,wBAAwB;IACxB,SAAS,EAAE,aAAa;IACxB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,cAAc;IAC5B,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;IAChC,0BAA0B,EAAE,eAAe;IAC3C,MAAM,EAAE,QAAQ;IAChB,eAAe,EAAE,YAAY;IAC7B,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,WAAW;IACpB,WAAW,EAAE,OAAO;IACpB,QAAQ,EAAE,YAAY;IAEtB,0BAA0B;IAC1B,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,IAAI;IAEV,+BAA+B;IAC/B,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,cAAc,EAAE,IAAI;IACpB,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAEhB,4BAA4B;IAC5B,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,IAAI;IAEX,mBAAmB;IACnB,GAAG,EAAE,KAAK;CACX,CAAC;AAEF,kBAAe;IACb,mBAAmB,EAAE,CAAC,OAAmB,EAAW,EAAE;QACpD,OAAO,OAAO,CAAC,sBAAsB,KAAK,6BAA6B,CAAC;IAC1E,CAAC;IACD,eAAe,EAAE,UAAU,SAAiB;QAC1C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,2BAAmB,CAAC,SAAS,CAAC,IAAI,2BAAmB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAC9F,CAAC;IACD,0BAA0B,EAAE;QAC1B,OAAO,yBAAyB,CAAC;IACnC,CAAC;IACD,qBAAqB,EAAE;QACrB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,6BAA6B,EAAE;QAC7B,OAAO,6BAA6B,CAAC;IACvC,CAAC;CACF,CAAC;AAEK,MAAM,QAAQ,GAAG,UAAU,GAAW;IAC3C,iFAAiF;IACjF,OAAO,IAAA,iBAAQ,EAAC,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC;AAHW,QAAA,QAAQ,YAGnB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformation-utils.mjs","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,kEAAkE;OAG3D,EAAE,QAAQ,EAAE;AAEnB,MAAM,6BAA6B,GAA2B,OAAO,CAAC;AACtE,MAAM,4BAA4B,GAA2B,MAAM,CAAC;AACpE,MAAM,yBAAyB,GAAW,GAAG,CAAC;AAC9C,MAAM,mBAAmB,GAAW,GAAG,CAAC;AACxC,MAAM,6BAA6B,GAAW,GAAG,CAAC;AAElD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAA8B;IAC5D,wBAAwB;IACxB,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG;IACT,QAAQ,EAAE,IAAI;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,GAAG;IACZ,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,IAAI;IAE1B,wBAAwB;IACxB,SAAS,EAAE,aAAa;IACxB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,cAAc;IAC5B,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;IAChC,0BAA0B,EAAE,eAAe;IAC3C,MAAM,EAAE,QAAQ;IAChB,eAAe,EAAE,YAAY;IAC7B,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,WAAW;IACpB,WAAW,EAAE,OAAO;IACpB,QAAQ,EAAE,YAAY;IAEtB,0BAA0B;IAC1B,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,IAAI;IAEV,+BAA+B;IAC/B,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,cAAc,EAAE,IAAI;IACpB,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAEhB,4BAA4B;IAC5B,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;
|
|
1
|
+
{"version":3,"file":"transformation-utils.mjs","sourceRoot":"","sources":["../src/lib/transformation-utils.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,kEAAkE;OAG3D,EAAE,QAAQ,EAAE;AAEnB,MAAM,6BAA6B,GAA2B,OAAO,CAAC;AACtE,MAAM,4BAA4B,GAA2B,MAAM,CAAC;AACpE,MAAM,yBAAyB,GAAW,GAAG,CAAC;AAC9C,MAAM,mBAAmB,GAAW,GAAG,CAAC;AACxC,MAAM,6BAA6B,GAAW,GAAG,CAAC;AAElD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAA8B;IAC5D,wBAAwB;IACxB,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,GAAG;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG;IACT,QAAQ,EAAE,IAAI;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,GAAG;IACZ,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,CAAC,EAAE,GAAG;IACN,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,GAAG;IACX,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,IAAI;IAE1B,wBAAwB;IACxB,SAAS,EAAE,aAAa;IACxB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,cAAc;IAC5B,kBAAkB,EAAE,YAAY;IAChC,kBAAkB,EAAE,YAAY;IAChC,0BAA0B,EAAE,eAAe;IAC3C,MAAM,EAAE,QAAQ;IAChB,eAAe,EAAE,YAAY;IAC7B,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,WAAW;IACpB,WAAW,EAAE,OAAO;IACpB,QAAQ,EAAE,YAAY;IAEtB,0BAA0B;IAC1B,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,IAAI;IAEV,+BAA+B;IAC/B,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,cAAc,EAAE,IAAI;IACpB,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAEhB,4BAA4B;IAC5B,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,IAAI;IAEX,mBAAmB;IACnB,GAAG,EAAE,KAAK;CACX,CAAC;AAEF,eAAe;IACb,mBAAmB,EAAE,CAAC,OAAmB,EAAW,EAAE;QACpD,OAAO,OAAO,CAAC,sBAAsB,KAAK,6BAA6B,CAAC;IAC1E,CAAC;IACD,eAAe,EAAE,UAAU,SAAiB;QAC1C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,mBAAmB,CAAC,SAAS,CAAC,IAAI,mBAAmB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAC9F,CAAC;IACD,0BAA0B,EAAE;QAC1B,OAAO,yBAAyB,CAAC;IACnC,CAAC;IACD,qBAAqB,EAAE;QACrB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IACD,6BAA6B,EAAE;QAC7B,OAAO,6BAA6B,CAAC;IACvC,CAAC;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,GAAW;IAC3C,iFAAiF;IACjF,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC"}
|
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"}
|