@vidispine/api 24.2.0 → 24.3.0-pre.2

package/dist/index.d.ts

@@ -1054,7 +1054,7 @@ export declare const Collection: {
      *
      * Get Collection Deletion Lock List Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -2635,7 +2635,7 @@ export declare const Collection: {
      *
      * Get Collection Deletion Lock Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -5483,7 +5483,7 @@ export declare const Component: {
      *
      * Get Component Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -5595,23 +5595,23 @@ export declare const Component: {
  */
 export declare const Configportal: {
     /**
-     * `GET /APInoauth/configportal/{filename}`
+     * `GET /APInoauth/configportal/{type}`
      *
-     * Get Configportal Schema No Auth
+     * Get Configportal Schema By Type No Auth
      *
      *
      * - accept: `application/json`
      *
      * @param {object} options
      * @param {object} options.pathParams - Path parameters
-     * @param {string} options.pathParams.filename
+     * @param {string} options.pathParams.type
      * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
      */
-    getConfigportalSchemaNoAuth: ({ pathParams: { filename }, headers, requestConfig, }: {
+    getConfigportalSchemaByTypeNoAuth: ({ pathParams: { type }, headers, requestConfig, }: {
         pathParams: {
-            filename: string;
+            type: string;
         };
         headers?: VidiCoreRequestHeaderConfig;
         requestConfig?: AxiosRequestConfig;
@@ -7063,7 +7063,7 @@ export declare const DeletionLock: {
      *
      * Get Deletion Lock Deletion Lock Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -8272,7 +8272,7 @@ export declare const ExportLocation: {
      *
      * Get Export Location Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -9029,7 +9029,7 @@ export declare const FieldGroup: {
      *
      * Get Field Group Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -10160,7 +10160,7 @@ declare const File_2: {
     /**
      * `GET /API/file/path/{path}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get File Deletion Lock All Metadata By Path Prefix
+     * Get File Deletion Lock Metadata By Path Prefix
      *
      *
      * - accept: `application/json`
@@ -10174,7 +10174,7 @@ declare const File_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getFileDeletionLockAllMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
+    getFileDeletionLockMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             path: string;
             deletionLockId: string;
@@ -10487,7 +10487,7 @@ declare const File_2: {
     /**
      * `GET /API/file/path/{path}/metadata/{prefix}`
      *
-     * Get File All Metadata By Path Prefix
+     * Get File Metadata By Path Prefix
      *
      *
      * - accept: `application/json`
@@ -10500,7 +10500,7 @@ declare const File_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getFileAllMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
+    getFileMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
         pathParams: {
             path: string;
             prefix: string;
@@ -10599,6 +10599,7 @@ declare const File_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename]
+     * @param {string} [options.queryParams.fxpMode='none']
      * @param {boolean} [options.queryParams.hardlink]
      * @param {boolean} [options.queryParams.holdJob]
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -10622,6 +10623,7 @@ declare const File_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -11161,7 +11163,7 @@ declare const File_2: {
     /**
      * `GET /API/file/uri/{uri}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get File Deletion Lock All Metadata With Uri Prefix
+     * Get File Deletion Lock Metadata With Uri Prefix
      *
      *
      * - accept: `application/json`
@@ -11175,7 +11177,7 @@ declare const File_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getFileDeletionLockAllMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
+    getFileDeletionLockMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             uri: string;
             deletionLockId: string;
@@ -11488,7 +11490,7 @@ declare const File_2: {
     /**
      * `GET /API/file/uri/{uri}/metadata/{prefix}`
      *
-     * Get File All Metadata With Uri Prefix
+     * Get File Metadata With Uri Prefix
      *
      *
      * - accept: `application/json`
@@ -11501,7 +11503,7 @@ declare const File_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getFileAllMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
+    getFileMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
         pathParams: {
             uri: string;
             prefix: string;
@@ -11633,6 +11635,7 @@ declare const File_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename]
+     * @param {string} [options.queryParams.fxpMode='none']
      * @param {boolean} [options.queryParams.hardlink]
      * @param {boolean} [options.queryParams.holdJob]
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -11656,6 +11659,7 @@ declare const File_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -12667,6 +12671,7 @@ declare const File_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -12690,6 +12695,7 @@ declare const File_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -13400,7 +13406,7 @@ export declare const Group: {
      *
      * Get Group Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -14154,7 +14160,7 @@ export declare const Import: {
      *
      * Post Import Placeholder Passkey
      *
-     * Creates a new passkey for a specific placeholder item, that can be used to perform imports to this item without requiring authentication.
+     * Creates a new passkey for a specific placeholder item, that can be used to perform imports to this item without requiring authentication.This method was superseded by POST /import/placeholder/(item-id)/(component-type)/raw-passkey.
      *
      *
      * - accept: `application/json`
@@ -14162,19 +14168,14 @@ export declare const Import: {
      * @param {object} options
      * @param {object} options.pathParams - Path parameters
      * @param {string} options.pathParams.itemId
-     * @param {object} [options.queryParams] - Query parameters
-     * @param {string} [options.queryParams.shapeId] - Shape id for which shape to receive the content.
      * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<URIListDocument>>} Promise&lt;AxiosResponse&lt;URIListDocument&gt;&gt;
      */
-    postImportPlaceholderPasskey: ({ pathParams: { itemId }, queryParams, headers, requestConfig, }: {
+    postImportPlaceholderPasskey: ({ pathParams: { itemId }, headers, requestConfig, }: {
         pathParams: {
             itemId: string;
         };
-        queryParams?: {
-            shapeId?: string;
-        };
         headers?: VidiCoreRequestHeaderConfig;
         requestConfig?: AxiosRequestConfig;
     }) => Promise<AxiosResponse<URIListDocument>>;
@@ -14367,6 +14368,83 @@ export declare const Import: {
         headers?: VidiCoreRequestHeaderConfig;
         requestConfig?: AxiosRequestConfig;
     }) => Promise<AxiosResponse<JobDocument>>;
+    /**
+     * `POST /API/import/placeholder/{itemId}/{componentType}/raw-passkey`
+     *
+     * Post Import Placeholder Raw Passkey
+     *
+     * Create a job and generates a passkey that can later be used to import a file into a placeholder without being authenticated.Imports the file and extracts component data based on what type is specified (container, audio, video, binary, subtitle). No transcoding will take place until all files have been imported.
+     *
+     *
+     * - accept: `application/json`
+     *
+     * @param {object} options
+     * @param {object} options.pathParams - Path parameters
+     * @param {string} options.pathParams.itemId
+     * @param {string} options.pathParams.componentType
+     * @param {object} [options.queryParams] - Query parameters
+     * @param {boolean} [options.queryParams.ccFromVideo] - New in version 22.1. true - Extract closed captions from video tracks as well as data tracks. false (default) - Extract closed captions from data tracks only.
+     * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
+     * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
+     * @param {string} [options.queryParams.extractCc] - Extract closed captions as metadata. Allowed values: true and mcc New in version 22.1. Extract WebVTT subtitle as metadata. Allowed value: webvtt New in version 22.4.
+     * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
+     * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
+     * @param {number} [options.queryParams.index] - Index (order) of the component.
+     * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
+     * @param {boolean} [options.queryParams.noTranscode] - true - Will disable transcoding even if the tags parameter is set. Rather, the specified tag will be used to determine cropping, scaling etc. of thumbnails. false (default) - Normal transcode.
+     * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
+     * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
+     * @param {string} [options.queryParams.original] - If specified, should be one of the tags specified in the tag parameter. Specifies that the original shape tag will be reset to the shape created to this tag.
+     * @param {string} [options.queryParams.originalFilename] - The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
+     * @param {boolean} [options.queryParams.overrideFastStart] - true (default) - Use transcoder's estimate of the duration for allocating header space in MOV files and similar files. false - Do not use the transcoder's estimate of the duration.
+     * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
+     * @param {boolean} [options.queryParams.requireFastStart=true] - true (default) - Try to put the index tables (header) in front of the file. false - Put header at end of file.
+     * @param {string} [options.queryParams.resourceId] - The transcoder resource to use to execute the transcode.
+     * @param {string} [options.queryParams.resourceTag] - New in version 24.3. If storageId is not specified, the resource tag criteria are used to select the storage for uploading the file. Once the storage is known and the storage is managed by a VSA, the resource tag criteria are used to select the VSA to use for direct file upload. The actual endpoint to use for sending the raw file data to VidiCore is returned in the key-value entry noAuthImportUri in the produced JobDocument. The resource tag criteria are also used to select transcoders for the job. Boolean operators - AND, OR, NOT - are supported. Examples: resourceTag=location:stockholm, resourceTag=location:stockhom OR location:berlin, resourceTag=(location:stockhom OR location:berlin) AND (type:blue OR NOT type:red).
+     * @param {string} [options.queryParams.shapeId] - Shape id for which shape to receive the content.
+     * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
+     * @param {string[]} [options.queryParams.tag] - A list of shape tags to use for transcoding.
+     * @param {string} [options.queryParams.thumbnailService] - Identifies which thumbnail resource that should be used.
+     * @param {string} [options.queryParams.transferId] - An id to assign the transfer to be able to refer to it.
+     * @param {number} [options.queryParams.transferPriority=1] - An integer between 1 and 1000 that indicates what priority the transfer should be given in relation to other transfers. A transfer with a high priority value is considered more important than a transfer with a low priority value.
+     * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
+     * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
+     * @returns {Promise<AxiosResponse<JobDocument>>} Promise&lt;AxiosResponse&lt;JobDocument&gt;&gt;
+     */
+    postImportPlaceholderRawPasskey: ({ pathParams: { itemId, componentType }, queryParams, headers, requestConfig, }: {
+        pathParams: {
+            itemId: string;
+            componentType: string;
+        };
+        queryParams?: {
+            ccFromVideo?: boolean;
+            createPosters?: string;
+            createThumbnails?: boolean;
+            extractCc?: string;
+            fastStartLength?: string;
+            holdJob?: boolean;
+            index?: number;
+            jobmetadata?: KeyValueObjectQueryParam;
+            noTranscode?: boolean;
+            notification?: string;
+            notificationData?: KeyValueObjectQueryParam;
+            original?: string;
+            originalFilename?: string;
+            overrideFastStart?: boolean;
+            priority?: string;
+            requireFastStart?: boolean;
+            resourceId?: string;
+            resourceTag?: string;
+            shapeId?: string;
+            storageId?: string;
+            tag?: string[];
+            thumbnailService?: string;
+            transferId?: string;
+            transferPriority?: number;
+        };
+        headers?: VidiCoreRequestHeaderConfig;
+        requestConfig?: AxiosRequestConfig;
+    }) => Promise<AxiosResponse<JobDocument>>;
     /**
      * `POST /API/import/project`
      *
@@ -14537,6 +14615,7 @@ export declare const Import: {
      * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
      * @param {boolean} [options.queryParams.requireFastStart=true] - true (default) - Try to put the index tables (header) in front of the file. false - Put header at end of file.
      * @param {string} [options.queryParams.resourceId] - The transcoder resource to use to execute the transcode.
+     * @param {string} [options.queryParams.resourceTag] - New in version 24.3. If storageId is not specified, the resource tag criteria are used to select the storage for uploading the file. Once the storage is known and the storage is managed by a VSA, the resource tag criteria are used to select the VSA to use for direct file upload. The actual endpoint to use for sending the raw file data to VidiCore is returned in the key-value entry noAuthImportUri in the produced JobDocument. The resource tag criteria are also used to select transcoders for the job. Boolean operators - AND, OR, NOT - are supported. Examples: resourceTag=location:stockholm, resourceTag=location:stockhom OR location:berlin, resourceTag=(location:stockhom OR location:berlin) AND (type:blue OR NOT type:red).
      * @param {string} [options.queryParams.settings] - Pre-configured import settings.
      * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
      * @param {string[]} [options.queryParams.tag] - A list of shape tags to use for transcoding.
@@ -14567,6 +14646,7 @@ export declare const Import: {
             priority?: string;
             requireFastStart?: boolean;
             resourceId?: string;
+            resourceTag?: string;
             settings?: string;
             storageId?: string;
             tag?: string[];
@@ -14972,22 +15052,24 @@ export declare const Import: {
      *
      * @param {object} options
      * @param {object} [options.queryParams] - Query parameters
-     * @param {string} [options.queryParams.originalFilename] - The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
      * @param {string} [options.queryParams.passkey]
-     * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
      * @param {string} [options.queryParams.transferId] - An id to assign the transfer to be able to refer to it.
      * @param {number} [options.queryParams.transferPriority=1] - An integer between 1 and 1000 that indicates what priority the transfer should be given in relation to other transfers. A transfer with a high priority value is considered more important than a transfer with a low priority value.
+     * @param {number} [options.queryParams.vxaContentLength]
+     * @param {string} [options.queryParams.vxaUpload]
+     * @param {string} [options.queryParams.vxaUuid]
      * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
      */
     postRawImportNoAuth: ({ queryParams, headers, requestConfig, }: {
         queryParams?: {
-            originalFilename?: string;
             passkey?: string;
-            storageId?: string;
             transferId?: string;
             transferPriority?: number;
+            vxaContentLength?: number;
+            vxaUpload?: string;
+            vxaUuid?: string;
         };
         headers?: VidiCoreRequestHeaderConfig;
         requestConfig?: AxiosRequestConfig;
@@ -15569,7 +15651,7 @@ export declare const Item: {
      *
      * Get Item Deletion Lock List Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -16824,7 +16906,7 @@ export declare const Item: {
      *
      * Get Item Deletion Lock Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -21431,7 +21513,7 @@ export declare const Library: {
      *
      * Get Library Deletion Lock List Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -22176,7 +22258,7 @@ export declare const Library: {
      *
      * Get Library Deletion Lock Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -22669,7 +22751,7 @@ export declare const Library: {
      *
      * Get Library Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -24204,7 +24286,7 @@ export declare const MetadataField: {
      *
      * Get Metadata Field Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -28885,7 +28967,7 @@ export declare const Shape: {
      *
      * Get Shape Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -30164,7 +30246,7 @@ export declare const ShapeTag: {
      *
      * Get Shape Tag Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -30468,7 +30550,7 @@ export declare const Site: {
      *
      * Get Site Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -31011,7 +31093,7 @@ declare const Storage_2: {
      *
      * Get Storage Deletion Lock File List Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -31965,9 +32047,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/file/path/{path}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get Storage Deletion Lock All Metadata By Path Prefix
+     * Get Storage Deletion Lock Metadata By Path Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -31981,7 +32063,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageDeletionLockAllMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
+    getStorageDeletionLockMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             path: string;
             deletionLockId: string;
@@ -32312,9 +32394,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/file/path/{path}/metadata/{prefix}`
      *
-     * Get Storage All Metadata By Path Prefix
+     * Get Storage Metadata By Path Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -32327,7 +32409,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageAllMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
+    getStorageMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
         pathParams: {
             path: string;
             prefix: string;
@@ -32434,6 +32516,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -32457,6 +32540,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -33032,9 +33116,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/file/uri/{uri}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get Storage Deletion Lock All Metadata With Uri Prefix
+     * Get Storage Deletion Lock Metadata With Uri Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -33048,7 +33132,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageDeletionLockAllMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
+    getStorageDeletionLockMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             uri: string;
             deletionLockId: string;
@@ -33379,9 +33463,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/file/uri/{uri}/metadata/{prefix}`
      *
-     * Get Storage All Metadata With Uri Prefix
+     * Get Storage Metadata With Uri Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -33394,7 +33478,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageAllMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
+    getStorageMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
         pathParams: {
             uri: string;
             prefix: string;
@@ -33536,6 +33620,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -33559,6 +33644,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -34572,6 +34658,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -34595,6 +34682,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -35210,7 +35298,7 @@ declare const Storage_2: {
      *
      * Get Storage Group Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -36081,7 +36169,7 @@ declare const Storage_2: {
      *
      * Get Storage Deletion Lock By Id File List Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -36855,9 +36943,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/{storageId}/file/path/{path}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get Storage Deletion Lock By Id File All Metadata By Path Prefix
+     * Get Storage Deletion Lock By Id File Metadata By Path Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -36872,7 +36960,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageDeletionLockByIdFileAllMetadataByPathPrefix: ({ pathParams: { storageId, path, deletionLockId, prefix }, headers, requestConfig, }: {
+    getStorageDeletionLockByIdFileMetadataByPathPrefix: ({ pathParams: { storageId, path, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             storageId: string;
             path: string;
@@ -37222,9 +37310,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/{storageId}/file/path/{path}/metadata/{prefix}`
      *
-     * Get Storage By Id File All Metadata By Path Prefix
+     * Get Storage By Id File Metadata By Path Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -37238,7 +37326,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageByIdFileAllMetadataByPathPrefix: ({ pathParams: { storageId, path, prefix }, headers, requestConfig, }: {
+    getStorageByIdFileMetadataByPathPrefix: ({ pathParams: { storageId, path, prefix }, headers, requestConfig, }: {
         pathParams: {
             storageId: string;
             path: string;
@@ -37353,6 +37441,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -37377,6 +37466,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -37988,9 +38078,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/{storageId}/file/uri/{uri}/deletion-lock/{deletionLockId}/metadata/{prefix}`
      *
-     * Get Storage Deletion Lock By Id File All Metadata With Uri Prefix
+     * Get Storage Deletion Lock By Id File Metadata With Uri Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -38005,7 +38095,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageDeletionLockByIdFileAllMetadataWithUriPrefix: ({ pathParams: { storageId, uri, deletionLockId, prefix }, headers, requestConfig, }: {
+    getStorageDeletionLockByIdFileMetadataWithUriPrefix: ({ pathParams: { storageId, uri, deletionLockId, prefix }, headers, requestConfig, }: {
         pathParams: {
             storageId: string;
             uri: string;
@@ -38355,9 +38445,9 @@ declare const Storage_2: {
     /**
      * `GET /API/storage/{storageId}/file/uri/{uri}/metadata/{prefix}`
      *
-     * Get Storage By Id File All Metadata With Uri Prefix
+     * Get Storage By Id File Metadata With Uri Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -38371,7 +38461,7 @@ declare const Storage_2: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
      */
-    getStorageByIdFileAllMetadataWithUriPrefix: ({ pathParams: { storageId, uri, prefix }, headers, requestConfig, }: {
+    getStorageByIdFileMetadataWithUriPrefix: ({ pathParams: { storageId, uri, prefix }, headers, requestConfig, }: {
         pathParams: {
             storageId: string;
             uri: string;
@@ -38523,6 +38613,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -38547,6 +38638,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -39627,6 +39719,7 @@ declare const Storage_2: {
      * @param {string} options.pathParams.targetStorageId
      * @param {object} [options.queryParams] - Query parameters
      * @param {string} [options.queryParams.filename] - The desired target filename.
+     * @param {string} [options.queryParams.fxpMode='none'] - New in version 24.3. Usage of FXP transfer if configured for FTP storage methods . none - Used transfer mode depends on storage method priorities. prefer - FXP transfer is used if configured. enforce - FTP transfer fails if FXP is not configured.
      * @param {boolean} [options.queryParams.hardlink] - true - Create a hard link instead of a copy. Only supported for local file system storage methods. false - Just copy the file.
      * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
      * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -39651,6 +39744,7 @@ declare const Storage_2: {
         };
         queryParams?: {
             filename?: string;
+            fxpMode?: string;
             hardlink?: boolean;
             holdJob?: boolean;
             jobmetadata?: KeyValueObjectQueryParam;
@@ -39934,7 +40028,7 @@ declare const Storage_2: {
      *
      * Get Storage Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -40288,7 +40382,7 @@ declare const Storage_2: {
      *
      * Get Storage Method Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -41076,7 +41170,7 @@ export declare const TaskDefinition: {
      *
      * Get Task Definition Metadata Prefix By Step By Type
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -41380,7 +41474,7 @@ export declare const TaskDefinition: {
      *
      * Get Task Definition Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -41730,7 +41824,7 @@ export declare const TaskGroup: {
      *
      * Get Task Group Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`
@@ -42145,7 +42239,7 @@ export declare const Token: {
     /**
      * `GET /API/token`
      *
-     * Get Token String
+     * Get Token
      *
      * Creates a authentication token for the calling user. This token can be used for calling the API without specifying username or password.Useful when users authenticate using an alias and the actual username of the user is not known.
      *
@@ -42160,7 +42254,7 @@ export declare const Token: {
      * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
      * @returns {Promise<AxiosResponse<AuthenticationTokenDocument>>} Promise&lt;AxiosResponse&lt;AuthenticationTokenDocument&gt;&gt;
      */
-    getTokenString: ({ queryParams, headers, requestConfig, }: {
+    getToken: ({ queryParams, headers, requestConfig, }: {
         queryParams?: {
             autoRefresh?: boolean;
             seconds?: number;
@@ -42955,7 +43049,7 @@ export declare const User: {
      *
      * Get User Metadata Prefix
      *
-     * Retrieves all key-value pairs associated with the specified key path. The key path can contain \* for a wildcard segment, or \*\* for any number of arbitrary segments.
+     * Retrieves the value of a specific key. If a key path is specified, exactly one key-value pair must match the key path, else an error is returned.Key paths can also be specified as well as specific keys.
      *
      *
      * - accept: `application/json`