@vidispine/api 24.1.0-pre.1 → 24.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -21,6 +21,8 @@ import type { BulkyMetadataConfigurationDocument } from '@vidispine/types';
21
21
  import type { BulkyMetadataDocument } from '@vidispine/types';
22
22
  import type { CollectionDocument } from '@vidispine/types';
23
23
  import type { CollectionListDocument } from '@vidispine/types';
24
+ import type { CollectionRelationDocument } from '@vidispine/types';
25
+ import type { CollectionRelationListDocument } from '@vidispine/types';
24
26
  import type { CollectionReorderDocument } from '@vidispine/types';
25
27
  import type { ComplexJobDocument } from '@vidispine/types';
26
28
  import type { ComponentDocument } from '@vidispine/types';
@@ -164,6 +166,8 @@ import type { TransferDocument } from '@vidispine/types';
164
166
  import type { TransferListDocument } from '@vidispine/types';
165
167
  import type { TransferLogListDocument } from '@vidispine/types';
166
168
  import type { URIListDocument } from '@vidispine/types';
169
+ import type { UsageCollectorDocument } from '@vidispine/types';
170
+ import type { UsageCollectorListDocument } from '@vidispine/types';
167
171
  import type { UserDocument } from '@vidispine/types';
168
172
  import type { UserListDocument } from '@vidispine/types';
169
173
  import type { UserSearchDocument } from '@vidispine/types';
@@ -1064,6 +1068,29 @@ export declare const Collection: {
1064
1068
  headers?: VidiCoreRequestHeaderConfig;
1065
1069
  requestConfig?: AxiosRequestConfig;
1066
1070
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
1071
+ /**
1072
+ * Get Collection Deletion Lock List All Metadata Prefix
1073
+ *
1074
+ * 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.
1075
+ *
1076
+ * - accept: `text/plain`
1077
+ *
1078
+ * @param {object} options
1079
+ * @param {object} options.pathParams - Path parameters
1080
+ * @param {string} options.pathParams.deletionLockId
1081
+ * @param {string} options.pathParams.prefix
1082
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1083
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1084
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
1085
+ */
1086
+ getCollectionDeletionLockListAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
1087
+ pathParams: {
1088
+ deletionLockId: string;
1089
+ prefix: string;
1090
+ };
1091
+ headers?: VidiCoreRequestHeaderConfig;
1092
+ requestConfig?: AxiosRequestConfig;
1093
+ }) => Promise<AxiosResponse<string>>;
1067
1094
  /**
1068
1095
  * Get Collection List Search History
1069
1096
  *
@@ -1090,7 +1117,7 @@ export declare const Collection: {
1090
1117
  requestConfig?: AxiosRequestConfig;
1091
1118
  }) => Promise<AxiosResponse<SearchHistoryDocument>>;
1092
1119
  /**
1093
- * Search Collection List Item By Metadata Group
1120
+ * Search Collection List By Metadata Group
1094
1121
  *
1095
1122
  * Search the metadata groups within collections, and group the results by their owner collections.
1096
1123
  *
@@ -1100,9 +1127,8 @@ export declare const Collection: {
1100
1127
  * @param {object} options
1101
1128
  * @param {object} [options.queryParams] - Query parameters
1102
1129
  * @param {string} [options.queryParams.baseUri] - Which base URI to use for the thumbnail URLs.
1103
- * @param {boolean} [options.queryParams.closedFiles=true] - A URI parameter: true (default) - Return only URIs that point to closed files. false - Return all URIs.
1104
1130
  * @param {boolean} [options.queryParams.conflict=true] - yes (default) - Include all metadata conflicts, unresolved. no - Return conflicts resolved according to field rules.
1105
- * @param {SingleOrArrayGenericQueryParam} [options.queryParams.content] - Comma-separated list of the types of content to retrieve. Valid values are metadata, uri, shape, poster, thumbnail, access, merged-access, external.
1131
+ * @param {SingleOrArrayGenericQueryParam} [options.queryParams.content] - Comma-separated list of additional content to retrieve. Valid values are: metadata, merged-access, external.
1106
1132
  * @param {boolean} [options.queryParams.count=true] - true (default) - Return hits in result. false - Do not return hits in result, in order to produce results faster.
1107
1133
  * @param {boolean} [options.queryParams.defaultValue] - true - For unset fields, return default values. false (default) - Do not return default values.
1108
1134
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.field] - Comma-separated list. field-name - Return specified field. field-name ":" new-name - Return specified field, renamed to a new name in return value. "-" field-name - Exclude specified field. (default) - Return all fields.
@@ -1116,30 +1142,19 @@ export declare const Collection: {
1116
1142
  * @param {string} [options.queryParams.mergedExtradata] - Any possible extra data.
1117
1143
  * @param {string} [options.queryParams.mergedPermission='NONE'] - The lowest required permission level.
1118
1144
  * @param {string} [options.queryParams.mergedType='GENERIC'] - The type of operation to check for.
1119
- * @param {KeyValueObjectQueryParam} [options.queryParams.methodMetadata] - Metadata used with storage method.
1120
- * @param {string} [options.queryParams.methodType] - Access method. AUTO - Gives an APInoauth URI to the media. Access to file is tunneled through Vidispine. AZURE_SAS - If the storage schema is azure:// you can get direct access to the media. The resulting URI will not tunnel through Vidispine but rather point directly to the media location at the azure storage.
1121
1145
  * @param {boolean} [options.queryParams.noauthUrl] - true Return URIs that do not need authentication. false (default) Return normal URIs
1122
1146
  * @param {number} [options.queryParams.number=100] - The number of entities to fetch. Default is 100.
1123
- * @param {SingleOrArrayGenericQueryParam} [options.queryParams.p] - Comma-separated list of paths specifying the content to include. Overrides the content and filter parameters.
1124
- * @param {string} [options.queryParams.revision] - Specifying which metadata revision to display. Only used if requesting a single item or collection.
1147
+ * @param {string} [options.queryParams.revision] - Specifying what revision of metadata to display. Only used if requesting a single item or collection.
1125
1148
  * @param {string} [options.queryParams.sampleRate] - Convert all outgoing time instants to specified rate. NB! Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision.
1126
- * @param {string} [options.queryParams.scheme] - URI scheme to return.
1127
- * @param {string[]} [options.queryParams.storage] - List of storage ids. Return only files from specific storages. Can be specified multiple times.
1128
- * @param {string} [options.queryParams.storageGroup] - Storage group id. Return only files from storages specified in the storage group.
1129
- * @param {string} [options.queryParams.storageType] - Only return URIs for files from storages of this type.
1130
- * @param {SingleOrArrayGenericQueryParam} [options.queryParams.tag] - A URI parameter: Comma-separated list of shape tags to return.
1131
1149
  * @param {boolean} [options.queryParams.terse] - yes - Return metadata in terse format. no (default) - Return metadata in verbose format.
1132
1150
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.track] - Comma-separated list. track-type track-number - Return metadata for specified track. Example of track is A2. track-type t1 - t2 - Return metadata for specified track interval, e.g. A2-4. track-type * - Return metadata for all tracks of specified type, e.g. A*. generic - Return all non-tracked metadata. all (default) - All metadata, with or without track specification, are returned.
1133
- * @param {SingleOrArrayGenericQueryParam} [options.queryParams.uriType] - Comma-separated list of format types (container format) to return.
1134
- * @param {string} [options.queryParams.version='latest'] - Specifying which essence version to return for shapes. If special value all, display all versions. If special value latest (default), display latest version of shapes.
1135
1151
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1136
1152
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1137
1153
  * @returns {Promise<AxiosResponse<SearchResultDocument>>} Promise&lt;AxiosResponse&lt;SearchResultDocument&gt;&gt;
1138
1154
  */
1139
- searchCollectionListItemByMetadataGroup: ({ queryParams, data, headers, requestConfig, }: {
1155
+ searchCollectionListByMetadataGroup: ({ queryParams, data, headers, requestConfig, }: {
1140
1156
  queryParams?: {
1141
1157
  baseUri?: string;
1142
- closedFiles?: boolean;
1143
1158
  conflict?: boolean;
1144
1159
  content?: SingleOrArrayGenericQueryParam;
1145
1160
  count?: boolean;
@@ -1155,22 +1170,12 @@ export declare const Collection: {
1155
1170
  mergedExtradata?: string;
1156
1171
  mergedPermission?: string;
1157
1172
  mergedType?: string;
1158
- methodMetadata?: KeyValueObjectQueryParam;
1159
- methodType?: string;
1160
1173
  noauthUrl?: boolean;
1161
1174
  number?: number;
1162
- p?: SingleOrArrayGenericQueryParam;
1163
1175
  revision?: string;
1164
1176
  sampleRate?: string;
1165
- scheme?: string;
1166
- storage?: string[];
1167
- storageGroup?: string;
1168
- storageType?: string;
1169
- tag?: SingleOrArrayGenericQueryParam;
1170
1177
  terse?: boolean;
1171
1178
  track?: SingleOrArrayGenericQueryParam;
1172
- uriType?: SingleOrArrayGenericQueryParam;
1173
- version?: string;
1174
1179
  };
1175
1180
  data: MetadataGroupSearchDocument;
1176
1181
  headers?: VidiCoreRequestHeaderConfig;
@@ -1417,6 +1422,96 @@ export declare const Collection: {
1417
1422
  headers?: VidiCoreRequestHeaderConfig;
1418
1423
  requestConfig?: AxiosRequestConfig;
1419
1424
  }) => Promise<AxiosResponse<ProjectFileDocument>>;
1425
+ /**
1426
+ * Create Collection List Relations
1427
+ *
1428
+ * Generates multiple relations at once. Each relation has a source and a target, and the direction can take the value U, if not set it generates a directional relation from source to target.For example:
1429
+ *
1430
+ * - contentType: `application/json`
1431
+ * - accept: `application/json`
1432
+ *
1433
+ * @param {object} options
1434
+ * @param {object} [options.queryParams] - Query parameters
1435
+ * @param {boolean} [options.queryParams.allowDuplicate=true] - true (default) - Allow duplicate relations. false - Avoid adding duplicate relations.
1436
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1437
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1438
+ * @returns {Promise<AxiosResponse<CollectionRelationListDocument>>} Promise&lt;AxiosResponse&lt;CollectionRelationListDocument&gt;&gt;
1439
+ */
1440
+ createCollectionListRelations: ({ queryParams, data, headers, requestConfig, }: {
1441
+ queryParams?: {
1442
+ allowDuplicate?: boolean;
1443
+ };
1444
+ data: CollectionRelationListDocument;
1445
+ headers?: VidiCoreRequestHeaderConfig;
1446
+ requestConfig?: AxiosRequestConfig;
1447
+ }) => Promise<AxiosResponse<CollectionRelationListDocument>>;
1448
+ /**
1449
+ * Delete Collection List Relation
1450
+ *
1451
+ * Deletes the relation with the id relation-id.
1452
+ *
1453
+ *
1454
+ * @param {object} options
1455
+ * @param {object} options.pathParams - Path parameters
1456
+ * @param {string} options.pathParams.relationId
1457
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1458
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1459
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
1460
+ */
1461
+ deleteCollectionListRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
1462
+ pathParams: {
1463
+ relationId: string;
1464
+ };
1465
+ headers?: VidiCoreRequestHeaderConfig;
1466
+ requestConfig?: AxiosRequestConfig;
1467
+ }) => Promise<AxiosResponse<any>>;
1468
+ /**
1469
+ * Get Collection List Relation
1470
+ *
1471
+ * Retrieves the relation with the id relation-id.
1472
+ *
1473
+ * - accept: `application/json`
1474
+ *
1475
+ * @param {object} options
1476
+ * @param {object} options.pathParams - Path parameters
1477
+ * @param {string} options.pathParams.relationId
1478
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1479
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1480
+ * @returns {Promise<AxiosResponse<CollectionRelationDocument>>} Promise&lt;AxiosResponse&lt;CollectionRelationDocument&gt;&gt;
1481
+ */
1482
+ getCollectionListRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
1483
+ pathParams: {
1484
+ relationId: string;
1485
+ };
1486
+ headers?: VidiCoreRequestHeaderConfig;
1487
+ requestConfig?: AxiosRequestConfig;
1488
+ }) => Promise<AxiosResponse<CollectionRelationDocument>>;
1489
+ /**
1490
+ * Update Collection List Relation
1491
+ *
1492
+ * Updates the relation metadata for a relation with the id relation-id.Query parameters of the form key=value are used to modify the metadata of the relation.
1493
+ *
1494
+ * - accept: `application/json`
1495
+ *
1496
+ * @param {object} options
1497
+ * @param {object} options.pathParams - Path parameters
1498
+ * @param {string} options.pathParams.relationId
1499
+ * @param {object} [options.queryParams] - Query parameters
1500
+ * @param {string} [options.queryParams.direction] - U - Set the direction of the relation as undirectional. S - Set the direction as the first collection of the relation being the source and the second one being the target. T - Set the direction as the second collection of the relation being the source and the first one being the target.
1501
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
1502
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
1503
+ * @returns {Promise<AxiosResponse<CollectionRelationDocument>>} Promise&lt;AxiosResponse&lt;CollectionRelationDocument&gt;&gt;
1504
+ */
1505
+ updateCollectionListRelation: ({ pathParams: { relationId }, queryParams, headers, requestConfig, }: {
1506
+ pathParams: {
1507
+ relationId: string;
1508
+ };
1509
+ queryParams?: {
1510
+ direction?: string;
1511
+ };
1512
+ headers?: VidiCoreRequestHeaderConfig;
1513
+ requestConfig?: AxiosRequestConfig;
1514
+ }) => Promise<AxiosResponse<CollectionRelationDocument>>;
1420
1515
  /**
1421
1516
  * List Collection List Site Rules
1422
1517
  *
@@ -2515,6 +2610,31 @@ export declare const Collection: {
2515
2610
  headers?: VidiCoreRequestHeaderConfig;
2516
2611
  requestConfig?: AxiosRequestConfig;
2517
2612
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
2613
+ /**
2614
+ * Get Collection Deletion Lock All Metadata Prefix
2615
+ *
2616
+ * 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.
2617
+ *
2618
+ * - accept: `text/plain`
2619
+ *
2620
+ * @param {object} options
2621
+ * @param {object} options.pathParams - Path parameters
2622
+ * @param {string} options.pathParams.collectionId
2623
+ * @param {string} options.pathParams.deletionLockId
2624
+ * @param {string} options.pathParams.prefix
2625
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
2626
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
2627
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
2628
+ */
2629
+ getCollectionDeletionLockAllMetadataPrefix: ({ pathParams: { collectionId, deletionLockId, prefix }, headers, requestConfig, }: {
2630
+ pathParams: {
2631
+ collectionId: string;
2632
+ deletionLockId: string;
2633
+ prefix: string;
2634
+ };
2635
+ headers?: VidiCoreRequestHeaderConfig;
2636
+ requestConfig?: AxiosRequestConfig;
2637
+ }) => Promise<AxiosResponse<string>>;
2518
2638
  /**
2519
2639
  * Start Collection Export
2520
2640
  *
@@ -2527,6 +2647,7 @@ export declare const Collection: {
2527
2647
  * @param {string} options.pathParams.collectionId
2528
2648
  * @param {object} [options.queryParams] - Query parameters
2529
2649
  * @param {boolean} [options.queryParams.all=true] - true (default) - Fail the job if not all files from the selected shapes could be exported. false - Don't export lost or unavailable files.
2650
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
2530
2651
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
2531
2652
  * @param {string} [options.queryParams.locationName] - The name of an export location.
2532
2653
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -2551,6 +2672,7 @@ export declare const Collection: {
2551
2672
  };
2552
2673
  queryParams?: {
2553
2674
  all?: boolean;
2675
+ holdJob?: boolean;
2554
2676
  jobmetadata?: KeyValueObjectQueryParam;
2555
2677
  locationName?: string;
2556
2678
  metadata?: boolean;
@@ -2683,7 +2805,7 @@ export declare const Collection: {
2683
2805
  /**
2684
2806
  * Search Collection Get Items
2685
2807
  *
2686
- * Retrieves only the items of the collection.Queries on collection items will now return items in creation order by default. See indexCollectionItemOrder on how to revert back to using the insert/custom collection item ordering.
2808
+ * List all items of the collection.Queries on collection items will now return items in creation order by default. See indexCollectionItemOrder on how to revert back to using the insert/custom collection item ordering.
2687
2809
  *
2688
2810
  * - accept: `application/json`
2689
2811
  *
@@ -2919,6 +3041,7 @@ export declare const Collection: {
2919
3041
  * @param {string} [options.queryParams.data] - Specifies any additional data that should be included with the metadata fields.
2920
3042
  * @param {string} [options.queryParams.destinationUri] - Required. The URI to output the CSV file to.
2921
3043
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.field] - Comma-separated list of metadata fields to include in the result. Default is title
3044
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
2922
3045
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
2923
3046
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
2924
3047
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -2939,6 +3062,7 @@ export declare const Collection: {
2939
3062
  data?: string;
2940
3063
  destinationUri?: string;
2941
3064
  field?: SingleOrArrayGenericQueryParam;
3065
+ holdJob?: boolean;
2942
3066
  jobmetadata?: KeyValueObjectQueryParam;
2943
3067
  notification?: string;
2944
3068
  notificationData?: KeyValueObjectQueryParam;
@@ -3884,6 +4008,114 @@ export declare const Collection: {
3884
4008
  headers?: VidiCoreRequestHeaderConfig;
3885
4009
  requestConfig?: AxiosRequestConfig;
3886
4010
  }) => Promise<AxiosResponse<CollectionDocument>>;
4011
+ /**
4012
+ * Delete All Relations To Collection
4013
+ *
4014
+ * Deletes the relations with the specified direction or all relations.
4015
+ *
4016
+ *
4017
+ * @param {object} options
4018
+ * @param {object} options.pathParams - Path parameters
4019
+ * @param {string} options.pathParams.collectionId
4020
+ * @param {object} [options.queryParams] - Query parameters
4021
+ * @param {string} [options.queryParams.direction='A'] - A - This is the default value. Deletes all relations collection-id is involved in. U - Deletes only the relations with the direction as undirectional. S - Deletes only the relations where collection-id is the source. T - Deletes only the relations where collection-id is the target.
4022
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
4023
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
4024
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
4025
+ */
4026
+ deleteAllRelationsToCollection: ({ pathParams: { collectionId }, queryParams, headers, requestConfig, }: {
4027
+ pathParams: {
4028
+ collectionId: string;
4029
+ };
4030
+ queryParams?: {
4031
+ direction?: string;
4032
+ };
4033
+ headers?: VidiCoreRequestHeaderConfig;
4034
+ requestConfig?: AxiosRequestConfig;
4035
+ }) => Promise<AxiosResponse<any>>;
4036
+ /**
4037
+ * List Collection Relations
4038
+ *
4039
+ * Returns a list of relations that matches the search criteria. Collection id can be an identifier, that is libraries can be used.In addition, extra query parameters of the form key=value can be added, to only return relations that matches the key-value pair(s).
4040
+ *
4041
+ * - accept: `text/plain`
4042
+ *
4043
+ * @param {object} options
4044
+ * @param {object} options.pathParams - Path parameters
4045
+ * @param {string} options.pathParams.collectionId
4046
+ * @param {object} [options.queryParams] - Query parameters
4047
+ * @param {string} [options.queryParams.direction='A'] - U - Only return undirectional relations where collection-id is part of. S - Only return directional relations where collection-id is the source collection. T - Only return directional relations where collection-id is the target collection. D - Only return directional relations where collection-id is the source or target collection. A (default) - Return all relations that collection-id is a part of.
4048
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
4049
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
4050
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
4051
+ */
4052
+ listCollectionRelations: ({ pathParams: { collectionId }, queryParams, headers, requestConfig, }: {
4053
+ pathParams: {
4054
+ collectionId: string;
4055
+ };
4056
+ queryParams?: {
4057
+ direction?: string;
4058
+ };
4059
+ headers?: VidiCoreRequestHeaderConfig;
4060
+ requestConfig?: AxiosRequestConfig;
4061
+ }) => Promise<AxiosResponse<string>>;
4062
+ /**
4063
+ * Delete All Relations Between Collections
4064
+ *
4065
+ * Deletes the relations with the specified direction or all relations between collection-id and id.
4066
+ *
4067
+ *
4068
+ * @param {object} options
4069
+ * @param {object} options.pathParams - Path parameters
4070
+ * @param {string} options.pathParams.collectionId
4071
+ * @param {string} options.pathParams.relationId
4072
+ * @param {object} [options.queryParams] - Query parameters
4073
+ * @param {string} [options.queryParams.direction='A'] - A - This is the default value. Deletes all relations between collection-id and id. U - Deletes only the relations with the direction as undirectional. S - Deletes only the relations where collection-id is the source and id is the target. T - Deletes only the relations where id is the source and collection-id is the target.
4074
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
4075
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
4076
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
4077
+ */
4078
+ deleteAllRelationsBetweenCollections: ({ pathParams: { collectionId, relationId }, queryParams, headers, requestConfig, }: {
4079
+ pathParams: {
4080
+ collectionId: string;
4081
+ relationId: string;
4082
+ };
4083
+ queryParams?: {
4084
+ direction?: string;
4085
+ };
4086
+ headers?: VidiCoreRequestHeaderConfig;
4087
+ requestConfig?: AxiosRequestConfig;
4088
+ }) => Promise<AxiosResponse<any>>;
4089
+ /**
4090
+ * Post Collection Relation
4091
+ *
4092
+ * Generates a new relation between the two collections with the given ids, collection-id and id, with the given parameters.In addition, extra query parameters of the form key=value can be added, to set metadata of the collection-to-collection relation.
4093
+ *
4094
+ * - accept: `application/json`
4095
+ *
4096
+ * @param {object} options
4097
+ * @param {object} options.pathParams - Path parameters
4098
+ * @param {string} options.pathParams.collectionId
4099
+ * @param {string} options.pathParams.relationId
4100
+ * @param {object} [options.queryParams] - Query parameters
4101
+ * @param {boolean} [options.queryParams.allowDuplicate=true] - true (default) - Allow duplicate relations. false - Avoid adding duplicate relations.
4102
+ * @param {string} [options.queryParams.direction] - Required. U - Set the direction of the relation as undirectional. S - Set the direction as collection-id being the source and id being the target. T - Set the direction as id being the source and collection-id being the target.
4103
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
4104
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
4105
+ * @returns {Promise<AxiosResponse<CollectionRelationDocument>>} Promise&lt;AxiosResponse&lt;CollectionRelationDocument&gt;&gt;
4106
+ */
4107
+ postCollectionRelation: ({ pathParams: { collectionId, relationId }, queryParams, headers, requestConfig, }: {
4108
+ pathParams: {
4109
+ collectionId: string;
4110
+ relationId: string;
4111
+ };
4112
+ queryParams?: {
4113
+ allowDuplicate?: boolean;
4114
+ direction?: string;
4115
+ };
4116
+ headers?: VidiCoreRequestHeaderConfig;
4117
+ requestConfig?: AxiosRequestConfig;
4118
+ }) => Promise<AxiosResponse<CollectionRelationDocument>>;
3887
4119
  /**
3888
4120
  * Rename Collection
3889
4121
  *
@@ -4167,6 +4399,7 @@ export declare const Collection: {
4167
4399
  * @param {string} options.pathParams.collectionId
4168
4400
  * @param {object} [options.queryParams] - Query parameters
4169
4401
  * @param {string} [options.queryParams.callbackId] - Required. The callback resource id to use for finding and running callback scripts.
4402
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
4170
4403
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
4171
4404
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
4172
4405
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -4182,6 +4415,7 @@ export declare const Collection: {
4182
4415
  };
4183
4416
  queryParams?: {
4184
4417
  callbackId?: string;
4418
+ holdJob?: boolean;
4185
4419
  jobmetadata?: KeyValueObjectQueryParam;
4186
4420
  notification?: string;
4187
4421
  notificationData?: KeyValueObjectQueryParam;
@@ -4406,6 +4640,7 @@ export declare const Component: {
4406
4640
  * @param {object} [options.queryParams] - Query parameters
4407
4641
  * @param {boolean} [options.queryParams.allowReimport] - true - Import the file to this shape even if the file is already importing or is already part of another item. false (default) Reject the request if the file with the given id has already been imported or is currently importing.
4408
4642
  * @param {string} [options.queryParams.fileId] - The id of the file that contains the new shape.
4643
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
4409
4644
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
4410
4645
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
4411
4646
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -4423,6 +4658,7 @@ export declare const Component: {
4423
4658
  queryParams?: {
4424
4659
  allowReimport?: boolean;
4425
4660
  fileId?: string;
4661
+ holdJob?: boolean;
4426
4662
  jobmetadata?: KeyValueObjectQueryParam;
4427
4663
  notification?: string;
4428
4664
  notificationData?: KeyValueObjectQueryParam;
@@ -4536,6 +4772,7 @@ export declare const Component: {
4536
4772
  * @param {string} options.pathParams.componentId
4537
4773
  * @param {object} [options.queryParams] - Query parameters
4538
4774
  * @param {string} [options.queryParams.callbackId] - The callback resource id to use for finding and running callback scripts.
4775
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
4539
4776
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
4540
4777
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
4541
4778
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -4555,6 +4792,7 @@ export declare const Component: {
4555
4792
  };
4556
4793
  queryParams?: {
4557
4794
  callbackId?: string;
4795
+ holdJob?: boolean;
4558
4796
  jobmetadata?: KeyValueObjectQueryParam;
4559
4797
  notification?: string;
4560
4798
  notificationData?: KeyValueObjectQueryParam;
@@ -5080,6 +5318,33 @@ export declare const Component: {
5080
5318
  headers?: VidiCoreRequestHeaderConfig;
5081
5319
  requestConfig?: AxiosRequestConfig;
5082
5320
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
5321
+ /**
5322
+ * Get Component All Metadata Prefix
5323
+ *
5324
+ * 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.
5325
+ *
5326
+ * - accept: `text/plain`
5327
+ *
5328
+ * @param {object} options
5329
+ * @param {object} options.pathParams - Path parameters
5330
+ * @param {string} options.pathParams.itemId
5331
+ * @param {string} options.pathParams.shapeId
5332
+ * @param {string} options.pathParams.componentId
5333
+ * @param {string} options.pathParams.prefix
5334
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
5335
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
5336
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
5337
+ */
5338
+ getComponentAllMetadataPrefix: ({ pathParams: { itemId, shapeId, componentId, prefix }, headers, requestConfig, }: {
5339
+ pathParams: {
5340
+ itemId: string;
5341
+ shapeId: string;
5342
+ componentId: string;
5343
+ prefix: string;
5344
+ };
5345
+ headers?: VidiCoreRequestHeaderConfig;
5346
+ requestConfig?: AxiosRequestConfig;
5347
+ }) => Promise<AxiosResponse<string>>;
5083
5348
  /**
5084
5349
  * Move Component
5085
5350
  *
@@ -5156,6 +5421,31 @@ export declare const Component: {
5156
5421
  }) => Promise<AxiosResponse<ShapeDocument>>;
5157
5422
  };
5158
5423
 
5424
+ /**
5425
+ * @namespace
5426
+ */
5427
+ export declare const Configportal: {
5428
+ /**
5429
+ * Get Configportal Schema No Auth
5430
+ *
5431
+ * - accept: `application/json`
5432
+ *
5433
+ * @param {object} options
5434
+ * @param {object} options.pathParams - Path parameters
5435
+ * @param {string} options.pathParams.filename
5436
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
5437
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
5438
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
5439
+ */
5440
+ getConfigportalSchemaNoAuth: ({ pathParams: { filename }, headers, requestConfig, }: {
5441
+ pathParams: {
5442
+ filename: string;
5443
+ };
5444
+ headers?: VidiCoreRequestHeaderConfig;
5445
+ requestConfig?: AxiosRequestConfig;
5446
+ }) => Promise<AxiosResponse<string>>;
5447
+ };
5448
+
5159
5449
  /**
5160
5450
  * @namespace
5161
5451
  */
@@ -5748,6 +6038,108 @@ export declare const Configuration: {
5748
6038
  headers?: VidiCoreRequestHeaderConfig;
5749
6039
  requestConfig?: AxiosRequestConfig;
5750
6040
  }) => Promise<AxiosResponse<any>>;
6041
+ /**
6042
+ * List Usage,Collector Configuration Usage Collectors
6043
+ *
6044
+ * Returns a list of all usage collectors.
6045
+ *
6046
+ * - accept: `application/json`
6047
+ *
6048
+ * @param {object} options
6049
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6050
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6051
+ * @returns {Promise<AxiosResponse<UsageCollectorListDocument>>} Promise&lt;AxiosResponse&lt;UsageCollectorListDocument&gt;&gt;
6052
+ */
6053
+ listUsageCollectorConfigurationUsageCollectors: ({ headers, requestConfig, }: {
6054
+ headers?: VidiCoreRequestHeaderConfig;
6055
+ requestConfig?: AxiosRequestConfig;
6056
+ }) => Promise<AxiosResponse<UsageCollectorListDocument>>;
6057
+ /**
6058
+ * Get Usage,Collector Configuration Usage Collector
6059
+ *
6060
+ * Returns a specific usage collector.
6061
+ *
6062
+ * - accept: `application/json`
6063
+ *
6064
+ * @param {object} options
6065
+ * @param {object} options.pathParams - Path parameters
6066
+ * @param {string} options.pathParams.name
6067
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6068
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6069
+ * @returns {Promise<AxiosResponse<UsageCollectorDocument>>} Promise&lt;AxiosResponse&lt;UsageCollectorDocument&gt;&gt;
6070
+ */
6071
+ getUsageCollectorConfigurationUsageCollector: ({ pathParams: { name }, headers, requestConfig, }: {
6072
+ pathParams: {
6073
+ name: string;
6074
+ };
6075
+ headers?: VidiCoreRequestHeaderConfig;
6076
+ requestConfig?: AxiosRequestConfig;
6077
+ }) => Promise<AxiosResponse<UsageCollectorDocument>>;
6078
+ /**
6079
+ * Disable Usage,Collector Configuration Usage Collector
6080
+ *
6081
+ * Disable a specific usage collector.
6082
+ *
6083
+ * - accept: `application/json`
6084
+ *
6085
+ * @param {object} options
6086
+ * @param {object} options.pathParams - Path parameters
6087
+ * @param {string} options.pathParams.name
6088
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6089
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6090
+ * @returns {Promise<AxiosResponse<UsageCollectorDocument>>} Promise&lt;AxiosResponse&lt;UsageCollectorDocument&gt;&gt;
6091
+ */
6092
+ disableUsageCollectorConfigurationUsageCollector: ({ pathParams: { name }, headers, requestConfig, }: {
6093
+ pathParams: {
6094
+ name: string;
6095
+ };
6096
+ headers?: VidiCoreRequestHeaderConfig;
6097
+ requestConfig?: AxiosRequestConfig;
6098
+ }) => Promise<AxiosResponse<UsageCollectorDocument>>;
6099
+ /**
6100
+ * Enable Usage,Collector Configuration Usage Collector
6101
+ *
6102
+ * Enable a specific usage collector.
6103
+ *
6104
+ * - accept: `application/json`
6105
+ *
6106
+ * @param {object} options
6107
+ * @param {object} options.pathParams - Path parameters
6108
+ * @param {string} options.pathParams.name
6109
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6110
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6111
+ * @returns {Promise<AxiosResponse<UsageCollectorDocument>>} Promise&lt;AxiosResponse&lt;UsageCollectorDocument&gt;&gt;
6112
+ */
6113
+ enableUsageCollectorConfigurationUsageCollector: ({ pathParams: { name }, headers, requestConfig, }: {
6114
+ pathParams: {
6115
+ name: string;
6116
+ };
6117
+ headers?: VidiCoreRequestHeaderConfig;
6118
+ requestConfig?: AxiosRequestConfig;
6119
+ }) => Promise<AxiosResponse<UsageCollectorDocument>>;
6120
+ /**
6121
+ * Set Usage,Collector Configuration Usage Collector Interval
6122
+ *
6123
+ * Sets the interval (in seconds) of the frequency for collecting usages.
6124
+ *
6125
+ * - contentType: `text/plain`
6126
+ * - accept: `application/json`
6127
+ *
6128
+ * @param {object} options
6129
+ * @param {object} options.pathParams - Path parameters
6130
+ * @param {string} options.pathParams.name
6131
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6132
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6133
+ * @returns {Promise<AxiosResponse<UsageCollectorDocument>>} Promise&lt;AxiosResponse&lt;UsageCollectorDocument&gt;&gt;
6134
+ */
6135
+ setUsageCollectorConfigurationUsageCollectorInterval: ({ pathParams: { name }, data, headers, requestConfig, }: {
6136
+ pathParams: {
6137
+ name: string;
6138
+ };
6139
+ data: string;
6140
+ headers?: VidiCoreRequestHeaderConfig;
6141
+ requestConfig?: AxiosRequestConfig;
6142
+ }) => Promise<AxiosResponse<UsageCollectorDocument>>;
5751
6143
  };
5752
6144
 
5753
6145
  /**
@@ -5768,6 +6160,7 @@ export declare const Conform: {
5768
6160
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
5769
6161
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Creates thumbnails according to default transcoder rules. false - No thumbnails will be created.
5770
6162
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
6163
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
5771
6164
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
5772
6165
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
5773
6166
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -5788,6 +6181,7 @@ export declare const Conform: {
5788
6181
  createPosters?: string;
5789
6182
  createThumbnails?: boolean;
5790
6183
  destinationItem?: string;
6184
+ holdJob?: boolean;
5791
6185
  jobmetadata?: KeyValueObjectQueryParam;
5792
6186
  notification?: string;
5793
6187
  notificationData?: KeyValueObjectQueryParam;
@@ -6325,6 +6719,29 @@ export declare const DeletionLock: {
6325
6719
  headers?: VidiCoreRequestHeaderConfig;
6326
6720
  requestConfig?: AxiosRequestConfig;
6327
6721
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
6722
+ /**
6723
+ * Get Deletion Lock Deletion Lock All Metadata Prefix
6724
+ *
6725
+ * 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.
6726
+ *
6727
+ * - accept: `text/plain`
6728
+ *
6729
+ * @param {object} options
6730
+ * @param {object} options.pathParams - Path parameters
6731
+ * @param {string} options.pathParams.deletionLockId
6732
+ * @param {string} options.pathParams.prefix
6733
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
6734
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
6735
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
6736
+ */
6737
+ getDeletionLockDeletionLockAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
6738
+ pathParams: {
6739
+ deletionLockId: string;
6740
+ prefix: string;
6741
+ };
6742
+ headers?: VidiCoreRequestHeaderConfig;
6743
+ requestConfig?: AxiosRequestConfig;
6744
+ }) => Promise<AxiosResponse<string>>;
6328
6745
  /**
6329
6746
  * Delete Deletion Lock Notifications
6330
6747
  *
@@ -7642,6 +8059,29 @@ export declare const ExportLocation: {
7642
8059
  headers?: VidiCoreRequestHeaderConfig;
7643
8060
  requestConfig?: AxiosRequestConfig;
7644
8061
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
8062
+ /**
8063
+ * Get Export Location All Metadata Prefix
8064
+ *
8065
+ * 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.
8066
+ *
8067
+ * - accept: `text/plain`
8068
+ *
8069
+ * @param {object} options
8070
+ * @param {object} options.pathParams - Path parameters
8071
+ * @param {string} options.pathParams.name
8072
+ * @param {string} options.pathParams.prefix
8073
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
8074
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
8075
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
8076
+ */
8077
+ getExportLocationAllMetadataPrefix: ({ pathParams: { name, prefix }, headers, requestConfig, }: {
8078
+ pathParams: {
8079
+ name: string;
8080
+ prefix: string;
8081
+ };
8082
+ headers?: VidiCoreRequestHeaderConfig;
8083
+ requestConfig?: AxiosRequestConfig;
8084
+ }) => Promise<AxiosResponse<string>>;
7645
8085
  /**
7646
8086
  * Get Export Location Script
7647
8087
  *
@@ -8576,6 +9016,29 @@ export declare const FieldGroup: {
8576
9016
  headers?: VidiCoreRequestHeaderConfig;
8577
9017
  requestConfig?: AxiosRequestConfig;
8578
9018
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
9019
+ /**
9020
+ * Get Field Group All Metadata Prefix
9021
+ *
9022
+ * 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.
9023
+ *
9024
+ * - accept: `text/plain`
9025
+ *
9026
+ * @param {object} options
9027
+ * @param {object} options.pathParams - Path parameters
9028
+ * @param {string} options.pathParams.groupName
9029
+ * @param {string} options.pathParams.prefix
9030
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
9031
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
9032
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
9033
+ */
9034
+ getFieldGroupAllMetadataPrefix: ({ pathParams: { groupName, prefix }, headers, requestConfig, }: {
9035
+ pathParams: {
9036
+ groupName: string;
9037
+ prefix: string;
9038
+ };
9039
+ headers?: VidiCoreRequestHeaderConfig;
9040
+ requestConfig?: AxiosRequestConfig;
9041
+ }) => Promise<AxiosResponse<string>>;
8579
9042
  /**
8580
9043
  * Delete Field Group Field
8581
9044
  *
@@ -8707,6 +9170,7 @@ declare const File_2: {
8707
9170
  * @param {object} [options.queryParams] - Query parameters
8708
9171
  * @param {boolean} [options.queryParams.createOnly=true]
8709
9172
  * @param {string} [options.queryParams.path]
9173
+ * @param {string} [options.queryParams.range]
8710
9174
  * @param {string} [options.queryParams.state]
8711
9175
  * @param {string} [options.queryParams.uri]
8712
9176
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
@@ -8717,6 +9181,7 @@ declare const File_2: {
8717
9181
  queryParams?: {
8718
9182
  createOnly?: boolean;
8719
9183
  path?: string;
9184
+ range?: string;
8720
9185
  state?: string;
8721
9186
  uri?: string;
8722
9187
  };
@@ -8955,9 +9420,9 @@ declare const File_2: {
8955
9420
  requestConfig?: AxiosRequestConfig;
8956
9421
  }) => Promise<AxiosResponse<any>>;
8957
9422
  /**
8958
- * Get File Deletion Lock List Metadata Prefix
9423
+ * Get File Deletion Lock List All Metadata Prefix
8959
9424
  *
8960
- * - accept: `application/json`
9425
+ * - accept: `text/plain`
8961
9426
  *
8962
9427
  * @param {object} options
8963
9428
  * @param {object} options.pathParams - Path parameters
@@ -8965,16 +9430,16 @@ declare const File_2: {
8965
9430
  * @param {string} options.pathParams.prefix
8966
9431
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
8967
9432
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
8968
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
9433
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
8969
9434
  */
8970
- getFileDeletionLockListMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
9435
+ getFileDeletionLockListAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
8971
9436
  pathParams: {
8972
9437
  deletionLockId: string;
8973
9438
  prefix: string;
8974
9439
  };
8975
9440
  headers?: VidiCoreRequestHeaderConfig;
8976
9441
  requestConfig?: AxiosRequestConfig;
8977
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
9442
+ }) => Promise<AxiosResponse<string>>;
8978
9443
  /**
8979
9444
  * Post File Import
8980
9445
  *
@@ -8992,6 +9457,7 @@ declare const File_2: {
8992
9457
  * @param {string} [options.queryParams.fastStartLength]
8993
9458
  * @param {string} [options.queryParams.filename]
8994
9459
  * @param {string} [options.queryParams.frameRate]
9460
+ * @param {boolean} [options.queryParams.holdJob]
8995
9461
  * @param {string} [options.queryParams.id]
8996
9462
  * @param {string[]} [options.queryParams.importTag]
8997
9463
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -9026,6 +9492,7 @@ declare const File_2: {
9026
9492
  fastStartLength?: string;
9027
9493
  filename?: string;
9028
9494
  frameRate?: string;
9495
+ holdJob?: boolean;
9029
9496
  id?: string;
9030
9497
  importTag?: string[];
9031
9498
  jobmetadata?: KeyValueObjectQueryParam;
@@ -9063,6 +9530,7 @@ declare const File_2: {
9063
9530
  * @param {string} [options.queryParams.createPosters]
9064
9531
  * @param {boolean} [options.queryParams.createThumbnails]
9065
9532
  * @param {string} [options.queryParams.fastStartLength]
9533
+ * @param {boolean} [options.queryParams.holdJob]
9066
9534
  * @param {string} [options.queryParams.id]
9067
9535
  * @param {string[]} [options.queryParams.importTag]
9068
9536
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -9091,6 +9559,7 @@ declare const File_2: {
9091
9559
  createPosters?: string;
9092
9560
  createThumbnails?: boolean;
9093
9561
  fastStartLength?: string;
9562
+ holdJob?: boolean;
9094
9563
  id?: string;
9095
9564
  importTag?: string[];
9096
9565
  jobmetadata?: KeyValueObjectQueryParam;
@@ -9152,6 +9621,7 @@ declare const File_2: {
9152
9621
  * @param {object} options.pathParams - Path parameters
9153
9622
  * @param {string} options.pathParams.path
9154
9623
  * @param {object} [options.queryParams] - Query parameters
9624
+ * @param {boolean} [options.queryParams.holdJob]
9155
9625
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
9156
9626
  * @param {string} [options.queryParams.notification]
9157
9627
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -9166,6 +9636,7 @@ declare const File_2: {
9166
9636
  path: string;
9167
9637
  };
9168
9638
  queryParams?: {
9639
+ holdJob?: boolean;
9169
9640
  jobmetadata?: KeyValueObjectQueryParam;
9170
9641
  notification?: string;
9171
9642
  notificationData?: KeyValueObjectQueryParam;
@@ -9241,6 +9712,7 @@ declare const File_2: {
9241
9712
  * @param {object} options.pathParams - Path parameters
9242
9713
  * @param {string} options.pathParams.path
9243
9714
  * @param {object} [options.queryParams] - Query parameters
9715
+ * @param {boolean} [options.queryParams.holdJob]
9244
9716
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
9245
9717
  * @param {string} [options.queryParams.notification]
9246
9718
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -9255,6 +9727,7 @@ declare const File_2: {
9255
9727
  path: string;
9256
9728
  };
9257
9729
  queryParams?: {
9730
+ holdJob?: boolean;
9258
9731
  jobmetadata?: KeyValueObjectQueryParam;
9259
9732
  notification?: string;
9260
9733
  notificationData?: KeyValueObjectQueryParam;
@@ -9273,6 +9746,7 @@ declare const File_2: {
9273
9746
  * @param {object} options.pathParams - Path parameters
9274
9747
  * @param {string} options.pathParams.path
9275
9748
  * @param {object} [options.queryParams] - Query parameters
9749
+ * @param {boolean} [options.queryParams.holdJob]
9276
9750
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
9277
9751
  * @param {string} [options.queryParams.notification]
9278
9752
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -9287,6 +9761,7 @@ declare const File_2: {
9287
9761
  path: string;
9288
9762
  };
9289
9763
  queryParams?: {
9764
+ holdJob?: boolean;
9290
9765
  jobmetadata?: KeyValueObjectQueryParam;
9291
9766
  notification?: string;
9292
9767
  notificationData?: KeyValueObjectQueryParam;
@@ -9572,9 +10047,9 @@ declare const File_2: {
9572
10047
  requestConfig?: AxiosRequestConfig;
9573
10048
  }) => Promise<AxiosResponse<any>>;
9574
10049
  /**
9575
- * Get File Deletion Lock Metadata By Path Prefix
10050
+ * Get File Deletion Lock All Metadata By Path Prefix
9576
10051
  *
9577
- * - accept: `application/json`
10052
+ * - accept: `text/plain`
9578
10053
  *
9579
10054
  * @param {object} options
9580
10055
  * @param {object} options.pathParams - Path parameters
@@ -9583,9 +10058,9 @@ declare const File_2: {
9583
10058
  * @param {string} options.pathParams.prefix
9584
10059
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
9585
10060
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
9586
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
10061
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
9587
10062
  */
9588
- getFileDeletionLockMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
10063
+ getFileDeletionLockAllMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
9589
10064
  pathParams: {
9590
10065
  path: string;
9591
10066
  deletionLockId: string;
@@ -9593,7 +10068,7 @@ declare const File_2: {
9593
10068
  };
9594
10069
  headers?: VidiCoreRequestHeaderConfig;
9595
10070
  requestConfig?: AxiosRequestConfig;
9596
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
10071
+ }) => Promise<AxiosResponse<string>>;
9597
10072
  /**
9598
10073
  * Delete File Entity By Path
9599
10074
  *
@@ -9655,6 +10130,7 @@ declare const File_2: {
9655
10130
  * @param {string} [options.queryParams.fastStartLength]
9656
10131
  * @param {string} [options.queryParams.filename]
9657
10132
  * @param {string} [options.queryParams.frameRate]
10133
+ * @param {boolean} [options.queryParams.holdJob]
9658
10134
  * @param {string} [options.queryParams.id]
9659
10135
  * @param {string[]} [options.queryParams.importTag]
9660
10136
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -9688,6 +10164,7 @@ declare const File_2: {
9688
10164
  fastStartLength?: string;
9689
10165
  filename?: string;
9690
10166
  frameRate?: string;
10167
+ holdJob?: boolean;
9691
10168
  id?: string;
9692
10169
  importTag?: string[];
9693
10170
  jobmetadata?: KeyValueObjectQueryParam;
@@ -9723,6 +10200,7 @@ declare const File_2: {
9723
10200
  * @param {string} [options.queryParams.createPosters]
9724
10201
  * @param {boolean} [options.queryParams.createThumbnails]
9725
10202
  * @param {string} [options.queryParams.fastStartLength]
10203
+ * @param {boolean} [options.queryParams.holdJob]
9726
10204
  * @param {string} [options.queryParams.id]
9727
10205
  * @param {string[]} [options.queryParams.importTag]
9728
10206
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -9750,6 +10228,7 @@ declare const File_2: {
9750
10228
  createPosters?: string;
9751
10229
  createThumbnails?: boolean;
9752
10230
  fastStartLength?: string;
10231
+ holdJob?: boolean;
9753
10232
  id?: string;
9754
10233
  importTag?: string[];
9755
10234
  jobmetadata?: KeyValueObjectQueryParam;
@@ -9869,9 +10348,9 @@ declare const File_2: {
9869
10348
  requestConfig?: AxiosRequestConfig;
9870
10349
  }) => Promise<AxiosResponse<any>>;
9871
10350
  /**
9872
- * Get File Metadata By Path Prefix
10351
+ * Get File All Metadata By Path Prefix
9873
10352
  *
9874
- * - accept: `application/json`
10353
+ * - accept: `text/plain`
9875
10354
  *
9876
10355
  * @param {object} options
9877
10356
  * @param {object} options.pathParams - Path parameters
@@ -9879,16 +10358,16 @@ declare const File_2: {
9879
10358
  * @param {string} options.pathParams.prefix
9880
10359
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
9881
10360
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
9882
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
10361
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
9883
10362
  */
9884
- getFileMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
10363
+ getFileAllMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
9885
10364
  pathParams: {
9886
10365
  path: string;
9887
10366
  prefix: string;
9888
10367
  };
9889
10368
  headers?: VidiCoreRequestHeaderConfig;
9890
10369
  requestConfig?: AxiosRequestConfig;
9891
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
10370
+ }) => Promise<AxiosResponse<string>>;
9892
10371
  /**
9893
10372
  * Reindex File By Path
9894
10373
  *
@@ -9968,6 +10447,7 @@ declare const File_2: {
9968
10447
  * @param {string} options.pathParams.targetStorageId
9969
10448
  * @param {object} [options.queryParams] - Query parameters
9970
10449
  * @param {string} [options.queryParams.filename]
10450
+ * @param {boolean} [options.queryParams.holdJob]
9971
10451
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
9972
10452
  * @param {number} [options.queryParams.limitRate]
9973
10453
  * @param {boolean} [options.queryParams.move]
@@ -9989,6 +10469,7 @@ declare const File_2: {
9989
10469
  };
9990
10470
  queryParams?: {
9991
10471
  filename?: string;
10472
+ holdJob?: boolean;
9992
10473
  jobmetadata?: KeyValueObjectQueryParam;
9993
10474
  limitRate?: number;
9994
10475
  move?: boolean;
@@ -10044,6 +10525,7 @@ declare const File_2: {
10044
10525
  * @param {object} options.pathParams - Path parameters
10045
10526
  * @param {string} options.pathParams.uri
10046
10527
  * @param {object} [options.queryParams] - Query parameters
10528
+ * @param {boolean} [options.queryParams.holdJob]
10047
10529
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
10048
10530
  * @param {string} [options.queryParams.notification]
10049
10531
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -10058,6 +10540,7 @@ declare const File_2: {
10058
10540
  uri: string;
10059
10541
  };
10060
10542
  queryParams?: {
10543
+ holdJob?: boolean;
10061
10544
  jobmetadata?: KeyValueObjectQueryParam;
10062
10545
  notification?: string;
10063
10546
  notificationData?: KeyValueObjectQueryParam;
@@ -10133,6 +10616,7 @@ declare const File_2: {
10133
10616
  * @param {object} options.pathParams - Path parameters
10134
10617
  * @param {string} options.pathParams.uri
10135
10618
  * @param {object} [options.queryParams] - Query parameters
10619
+ * @param {boolean} [options.queryParams.holdJob]
10136
10620
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
10137
10621
  * @param {string} [options.queryParams.notification]
10138
10622
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -10147,6 +10631,7 @@ declare const File_2: {
10147
10631
  uri: string;
10148
10632
  };
10149
10633
  queryParams?: {
10634
+ holdJob?: boolean;
10150
10635
  jobmetadata?: KeyValueObjectQueryParam;
10151
10636
  notification?: string;
10152
10637
  notificationData?: KeyValueObjectQueryParam;
@@ -10165,6 +10650,7 @@ declare const File_2: {
10165
10650
  * @param {object} options.pathParams - Path parameters
10166
10651
  * @param {string} options.pathParams.uri
10167
10652
  * @param {object} [options.queryParams] - Query parameters
10653
+ * @param {boolean} [options.queryParams.holdJob]
10168
10654
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
10169
10655
  * @param {string} [options.queryParams.notification]
10170
10656
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -10179,6 +10665,7 @@ declare const File_2: {
10179
10665
  uri: string;
10180
10666
  };
10181
10667
  queryParams?: {
10668
+ holdJob?: boolean;
10182
10669
  jobmetadata?: KeyValueObjectQueryParam;
10183
10670
  notification?: string;
10184
10671
  notificationData?: KeyValueObjectQueryParam;
@@ -10464,9 +10951,9 @@ declare const File_2: {
10464
10951
  requestConfig?: AxiosRequestConfig;
10465
10952
  }) => Promise<AxiosResponse<any>>;
10466
10953
  /**
10467
- * Get File Deletion Lock Metadata With Uri Prefix
10954
+ * Get File Deletion Lock All Metadata With Uri Prefix
10468
10955
  *
10469
- * - accept: `application/json`
10956
+ * - accept: `text/plain`
10470
10957
  *
10471
10958
  * @param {object} options
10472
10959
  * @param {object} options.pathParams - Path parameters
@@ -10475,9 +10962,9 @@ declare const File_2: {
10475
10962
  * @param {string} options.pathParams.prefix
10476
10963
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
10477
10964
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
10478
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
10965
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
10479
10966
  */
10480
- getFileDeletionLockMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
10967
+ getFileDeletionLockAllMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
10481
10968
  pathParams: {
10482
10969
  uri: string;
10483
10970
  deletionLockId: string;
@@ -10485,7 +10972,7 @@ declare const File_2: {
10485
10972
  };
10486
10973
  headers?: VidiCoreRequestHeaderConfig;
10487
10974
  requestConfig?: AxiosRequestConfig;
10488
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
10975
+ }) => Promise<AxiosResponse<string>>;
10489
10976
  /**
10490
10977
  * Delete File Entity With Uri
10491
10978
  *
@@ -10547,6 +11034,7 @@ declare const File_2: {
10547
11034
  * @param {string} [options.queryParams.fastStartLength]
10548
11035
  * @param {string} [options.queryParams.filename]
10549
11036
  * @param {string} [options.queryParams.frameRate]
11037
+ * @param {boolean} [options.queryParams.holdJob]
10550
11038
  * @param {string} [options.queryParams.id]
10551
11039
  * @param {string[]} [options.queryParams.importTag]
10552
11040
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -10580,6 +11068,7 @@ declare const File_2: {
10580
11068
  fastStartLength?: string;
10581
11069
  filename?: string;
10582
11070
  frameRate?: string;
11071
+ holdJob?: boolean;
10583
11072
  id?: string;
10584
11073
  importTag?: string[];
10585
11074
  jobmetadata?: KeyValueObjectQueryParam;
@@ -10615,6 +11104,7 @@ declare const File_2: {
10615
11104
  * @param {string} [options.queryParams.createPosters]
10616
11105
  * @param {boolean} [options.queryParams.createThumbnails]
10617
11106
  * @param {string} [options.queryParams.fastStartLength]
11107
+ * @param {boolean} [options.queryParams.holdJob]
10618
11108
  * @param {string} [options.queryParams.id]
10619
11109
  * @param {string[]} [options.queryParams.importTag]
10620
11110
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
@@ -10642,6 +11132,7 @@ declare const File_2: {
10642
11132
  createPosters?: string;
10643
11133
  createThumbnails?: boolean;
10644
11134
  fastStartLength?: string;
11135
+ holdJob?: boolean;
10645
11136
  id?: string;
10646
11137
  importTag?: string[];
10647
11138
  jobmetadata?: KeyValueObjectQueryParam;
@@ -10761,9 +11252,9 @@ declare const File_2: {
10761
11252
  requestConfig?: AxiosRequestConfig;
10762
11253
  }) => Promise<AxiosResponse<any>>;
10763
11254
  /**
10764
- * Get File Metadata With Uri Prefix
11255
+ * Get File All Metadata With Uri Prefix
10765
11256
  *
10766
- * - accept: `application/json`
11257
+ * - accept: `text/plain`
10767
11258
  *
10768
11259
  * @param {object} options
10769
11260
  * @param {object} options.pathParams - Path parameters
@@ -10771,16 +11262,16 @@ declare const File_2: {
10771
11262
  * @param {string} options.pathParams.prefix
10772
11263
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
10773
11264
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
10774
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
11265
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
10775
11266
  */
10776
- getFileMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
11267
+ getFileAllMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
10777
11268
  pathParams: {
10778
11269
  uri: string;
10779
11270
  prefix: string;
10780
11271
  };
10781
11272
  headers?: VidiCoreRequestHeaderConfig;
10782
11273
  requestConfig?: AxiosRequestConfig;
10783
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
11274
+ }) => Promise<AxiosResponse<string>>;
10784
11275
  /**
10785
11276
  * Post File New Path With Uri
10786
11277
  *
@@ -10890,6 +11381,7 @@ declare const File_2: {
10890
11381
  * @param {string} options.pathParams.targetStorageId
10891
11382
  * @param {object} [options.queryParams] - Query parameters
10892
11383
  * @param {string} [options.queryParams.filename]
11384
+ * @param {boolean} [options.queryParams.holdJob]
10893
11385
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
10894
11386
  * @param {number} [options.queryParams.limitRate]
10895
11387
  * @param {boolean} [options.queryParams.move]
@@ -10911,6 +11403,7 @@ declare const File_2: {
10911
11403
  };
10912
11404
  queryParams?: {
10913
11405
  filename?: string;
11406
+ holdJob?: boolean;
10914
11407
  jobmetadata?: KeyValueObjectQueryParam;
10915
11408
  limitRate?: number;
10916
11409
  move?: boolean;
@@ -10966,6 +11459,7 @@ declare const File_2: {
10966
11459
  * @param {object} options.pathParams - Path parameters
10967
11460
  * @param {string} options.pathParams.fileId
10968
11461
  * @param {object} [options.queryParams] - Query parameters
11462
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
10969
11463
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
10970
11464
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
10971
11465
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -10980,6 +11474,7 @@ declare const File_2: {
10980
11474
  fileId: string;
10981
11475
  };
10982
11476
  queryParams?: {
11477
+ holdJob?: boolean;
10983
11478
  jobmetadata?: KeyValueObjectQueryParam;
10984
11479
  notification?: string;
10985
11480
  notificationData?: KeyValueObjectQueryParam;
@@ -11055,6 +11550,7 @@ declare const File_2: {
11055
11550
  * @param {object} options.pathParams - Path parameters
11056
11551
  * @param {string} options.pathParams.fileId
11057
11552
  * @param {object} [options.queryParams] - Query parameters
11553
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
11058
11554
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
11059
11555
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
11060
11556
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -11069,6 +11565,7 @@ declare const File_2: {
11069
11565
  fileId: string;
11070
11566
  };
11071
11567
  queryParams?: {
11568
+ holdJob?: boolean;
11072
11569
  jobmetadata?: KeyValueObjectQueryParam;
11073
11570
  notification?: string;
11074
11571
  notificationData?: KeyValueObjectQueryParam;
@@ -11087,6 +11584,7 @@ declare const File_2: {
11087
11584
  * @param {object} options.pathParams - Path parameters
11088
11585
  * @param {string} options.pathParams.fileId
11089
11586
  * @param {object} [options.queryParams] - Query parameters
11587
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
11090
11588
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
11091
11589
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
11092
11590
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -11101,6 +11599,7 @@ declare const File_2: {
11101
11599
  fileId: string;
11102
11600
  };
11103
11601
  queryParams?: {
11602
+ holdJob?: boolean;
11104
11603
  jobmetadata?: KeyValueObjectQueryParam;
11105
11604
  notification?: string;
11106
11605
  notificationData?: KeyValueObjectQueryParam;
@@ -11386,9 +11885,9 @@ declare const File_2: {
11386
11885
  requestConfig?: AxiosRequestConfig;
11387
11886
  }) => Promise<AxiosResponse<any>>;
11388
11887
  /**
11389
- * Get File Deletion Lock Metadata Prefix
11888
+ * Get File Deletion Lock All Metadata Prefix
11390
11889
  *
11391
- * - accept: `application/json`
11890
+ * - accept: `text/plain`
11392
11891
  *
11393
11892
  * @param {object} options
11394
11893
  * @param {object} options.pathParams - Path parameters
@@ -11397,9 +11896,9 @@ declare const File_2: {
11397
11896
  * @param {string} options.pathParams.prefix
11398
11897
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
11399
11898
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
11400
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
11899
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
11401
11900
  */
11402
- getFileDeletionLockMetadataPrefix: ({ pathParams: { fileId, deletionLockId, prefix }, headers, requestConfig, }: {
11901
+ getFileDeletionLockAllMetadataPrefix: ({ pathParams: { fileId, deletionLockId, prefix }, headers, requestConfig, }: {
11403
11902
  pathParams: {
11404
11903
  fileId: string;
11405
11904
  deletionLockId: string;
@@ -11407,7 +11906,7 @@ declare const File_2: {
11407
11906
  };
11408
11907
  headers?: VidiCoreRequestHeaderConfig;
11409
11908
  requestConfig?: AxiosRequestConfig;
11410
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
11909
+ }) => Promise<AxiosResponse<string>>;
11411
11910
  /**
11412
11911
  * Delete File Entity
11413
11912
  *
@@ -11469,6 +11968,7 @@ declare const File_2: {
11469
11968
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
11470
11969
  * @param {string} [options.queryParams.filename] - The original filename of the file.
11471
11970
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
11971
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
11472
11972
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
11473
11973
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
11474
11974
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -11502,6 +12002,7 @@ declare const File_2: {
11502
12002
  fastStartLength?: string;
11503
12003
  filename?: string;
11504
12004
  frameRate?: string;
12005
+ holdJob?: boolean;
11505
12006
  id?: SingleOrArrayGenericQueryParam;
11506
12007
  importTag?: string[];
11507
12008
  jobmetadata?: KeyValueObjectQueryParam;
@@ -11537,6 +12038,7 @@ declare const File_2: {
11537
12038
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
11538
12039
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
11539
12040
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
12041
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
11540
12042
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
11541
12043
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
11542
12044
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -11564,6 +12066,7 @@ declare const File_2: {
11564
12066
  createPosters?: string;
11565
12067
  createThumbnails?: boolean;
11566
12068
  fastStartLength?: string;
12069
+ holdJob?: boolean;
11567
12070
  id?: SingleOrArrayGenericQueryParam;
11568
12071
  importTag?: string[];
11569
12072
  jobmetadata?: KeyValueObjectQueryParam;
@@ -11683,9 +12186,9 @@ declare const File_2: {
11683
12186
  requestConfig?: AxiosRequestConfig;
11684
12187
  }) => Promise<AxiosResponse<any>>;
11685
12188
  /**
11686
- * Get File Metadata Prefix
12189
+ * Get File All Metadata Prefix
11687
12190
  *
11688
- * - accept: `application/json`
12191
+ * - accept: `text/plain`
11689
12192
  *
11690
12193
  * @param {object} options
11691
12194
  * @param {object} options.pathParams - Path parameters
@@ -11693,16 +12196,16 @@ declare const File_2: {
11693
12196
  * @param {string} options.pathParams.prefix
11694
12197
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
11695
12198
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
11696
- * @returns {Promise<AxiosResponse<SimpleMetadataDocument>>} Promise&lt;AxiosResponse&lt;SimpleMetadataDocument&gt;&gt;
12199
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
11697
12200
  */
11698
- getFileMetadataPrefix: ({ pathParams: { fileId, prefix }, headers, requestConfig, }: {
12201
+ getFileAllMetadataPrefix: ({ pathParams: { fileId, prefix }, headers, requestConfig, }: {
11699
12202
  pathParams: {
11700
12203
  fileId: string;
11701
12204
  prefix: string;
11702
12205
  };
11703
12206
  headers?: VidiCoreRequestHeaderConfig;
11704
12207
  requestConfig?: AxiosRequestConfig;
11705
- }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
12208
+ }) => Promise<AxiosResponse<string>>;
11706
12209
  /**
11707
12210
  * Post File New Path
11708
12211
  *
@@ -11812,6 +12315,7 @@ declare const File_2: {
11812
12315
  * @param {string} options.pathParams.targetStorageId
11813
12316
  * @param {object} [options.queryParams] - Query parameters
11814
12317
  * @param {string} [options.queryParams.filename] - The desired target filename.
12318
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
11815
12319
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
11816
12320
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
11817
12321
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -11833,6 +12337,7 @@ declare const File_2: {
11833
12337
  };
11834
12338
  queryParams?: {
11835
12339
  filename?: string;
12340
+ holdJob?: boolean;
11836
12341
  jobmetadata?: KeyValueObjectQueryParam;
11837
12342
  limitRate?: number;
11838
12343
  move?: boolean;
@@ -12581,6 +13086,29 @@ export declare const Group: {
12581
13086
  headers?: VidiCoreRequestHeaderConfig;
12582
13087
  requestConfig?: AxiosRequestConfig;
12583
13088
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
13089
+ /**
13090
+ * Get Group All Metadata Prefix
13091
+ *
13092
+ * 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.
13093
+ *
13094
+ * - accept: `text/plain`
13095
+ *
13096
+ * @param {object} options
13097
+ * @param {object} options.pathParams - Path parameters
13098
+ * @param {string} options.pathParams.groupName
13099
+ * @param {string} options.pathParams.prefix
13100
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
13101
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
13102
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
13103
+ */
13104
+ getGroupAllMetadataPrefix: ({ pathParams: { groupName, prefix }, headers, requestConfig, }: {
13105
+ pathParams: {
13106
+ groupName: string;
13107
+ prefix: string;
13108
+ };
13109
+ headers?: VidiCoreRequestHeaderConfig;
13110
+ requestConfig?: AxiosRequestConfig;
13111
+ }) => Promise<AxiosResponse<string>>;
12584
13112
  /**
12585
13113
  * Delete Group Notifications
12586
13114
  *
@@ -13062,6 +13590,7 @@ export declare const Import: {
13062
13590
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13063
13591
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
13064
13592
  * @param {boolean} [options.queryParams.growing] - true - Specifies that the input file is still written to, so enables growing file support. false (default) - No growing file handling of import file.
13593
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13065
13594
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
13066
13595
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13067
13596
  * @param {boolean} [options.queryParams.noMediacheck] - Only for for import of mpeg-dash mpd, skip media check to speed up import. true - Will disable media check. false (default) - Normal media check.
@@ -13096,6 +13625,7 @@ export declare const Import: {
13096
13625
  fastStartLength?: string;
13097
13626
  frameRate?: string;
13098
13627
  growing?: boolean;
13628
+ holdJob?: boolean;
13099
13629
  importTag?: string[];
13100
13630
  jobmetadata?: KeyValueObjectQueryParam;
13101
13631
  noMediacheck?: boolean;
@@ -13197,6 +13727,7 @@ export declare const Import: {
13197
13727
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
13198
13728
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13199
13729
  * @param {boolean} [options.queryParams.growing] - true - Specifies that the input file is still written to, so enables growing file support. false (default) - No growing file handling of import file.
13730
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13200
13731
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
13201
13732
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13202
13733
  * @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.
@@ -13226,6 +13757,7 @@ export declare const Import: {
13226
13757
  createThumbnails?: boolean;
13227
13758
  fastStartLength?: string;
13228
13759
  growing?: boolean;
13760
+ holdJob?: boolean;
13229
13761
  importTag?: string[];
13230
13762
  jobmetadata?: KeyValueObjectQueryParam;
13231
13763
  noTranscode?: boolean;
@@ -13307,6 +13839,7 @@ export declare const Import: {
13307
13839
  * @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.
13308
13840
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13309
13841
  * @param {boolean} [options.queryParams.growing] - true - Specifies that the input file is still written to, so enables growing file support. false (default) - No growing file handling of import file.
13842
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13310
13843
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
13311
13844
  * @param {number} [options.queryParams.index] - The component index (track) of new component.
13312
13845
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -13335,6 +13868,7 @@ export declare const Import: {
13335
13868
  extractCc?: string;
13336
13869
  fastStartLength?: string;
13337
13870
  growing?: boolean;
13871
+ holdJob?: boolean;
13338
13872
  importTag?: string[];
13339
13873
  index?: number;
13340
13874
  jobmetadata?: KeyValueObjectQueryParam;
@@ -13401,6 +13935,7 @@ export declare const Import: {
13401
13935
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13402
13936
  * @param {string} [options.queryParams.fileId] - The id of the file that contains the essence. Must be specified unless uri is specified.
13403
13937
  * @param {boolean} [options.queryParams.growing] - true - Specifies that the input file is still written to, so enables growing file support. false (default) - No growing file handling of import file.
13938
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13404
13939
  * @param {number} [options.queryParams.index] - The component index (track) of new component.
13405
13940
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13406
13941
  * @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.
@@ -13436,6 +13971,7 @@ export declare const Import: {
13436
13971
  fastStartLength?: string;
13437
13972
  fileId?: string;
13438
13973
  growing?: boolean;
13974
+ holdJob?: boolean;
13439
13975
  index?: number;
13440
13976
  jobmetadata?: KeyValueObjectQueryParam;
13441
13977
  noTranscode?: boolean;
@@ -13505,13 +14041,15 @@ export declare const Import: {
13505
14041
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
13506
14042
  * @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.
13507
14043
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13508
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
14044
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
14045
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13509
14046
  * @param {number} [options.queryParams.index] - Index (order) of the component.
13510
14047
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13511
14048
  * @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.
13512
14049
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
13513
14050
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
13514
14051
  * @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.
14052
+ * @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.
13515
14053
  * @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.
13516
14054
  * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
13517
14055
  * @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.
@@ -13539,12 +14077,14 @@ export declare const Import: {
13539
14077
  extractCc?: string;
13540
14078
  fastStartLength?: string;
13541
14079
  filename?: string;
14080
+ holdJob?: boolean;
13542
14081
  index?: number;
13543
14082
  jobmetadata?: KeyValueObjectQueryParam;
13544
14083
  noTranscode?: boolean;
13545
14084
  notification?: string;
13546
14085
  notificationData?: KeyValueObjectQueryParam;
13547
14086
  original?: string;
14087
+ originalFilename?: string;
13548
14088
  overrideFastStart?: boolean;
13549
14089
  priority?: string;
13550
14090
  requireFastStart?: boolean;
@@ -13635,7 +14175,8 @@ export declare const Import: {
13635
14175
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
13636
14176
  * @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.
13637
14177
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13638
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
14178
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
14179
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13639
14180
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.ids] - Comma-separated list of external ids to assign to the item.
13640
14181
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
13641
14182
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -13643,6 +14184,7 @@ export declare const Import: {
13643
14184
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
13644
14185
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
13645
14186
  * @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.
14187
+ * @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.
13646
14188
  * @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.
13647
14189
  * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
13648
14190
  * @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.
@@ -13667,6 +14209,7 @@ export declare const Import: {
13667
14209
  extractCc?: string;
13668
14210
  fastStartLength?: string;
13669
14211
  filename?: string;
14212
+ holdJob?: boolean;
13670
14213
  ids?: SingleOrArrayGenericQueryParam;
13671
14214
  importTag?: string[];
13672
14215
  jobmetadata?: KeyValueObjectQueryParam;
@@ -13674,6 +14217,7 @@ export declare const Import: {
13674
14217
  notification?: string;
13675
14218
  notificationData?: KeyValueObjectQueryParam;
13676
14219
  original?: string;
14220
+ originalFilename?: string;
13677
14221
  overrideFastStart?: boolean;
13678
14222
  priority?: string;
13679
14223
  requireFastStart?: boolean;
@@ -13706,7 +14250,8 @@ export declare const Import: {
13706
14250
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
13707
14251
  * @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.
13708
14252
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
13709
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
14253
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
14254
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13710
14255
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.ids] - Comma-separated list of external ids to assign to the item.
13711
14256
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
13712
14257
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -13714,6 +14259,7 @@ export declare const Import: {
13714
14259
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
13715
14260
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
13716
14261
  * @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.
14262
+ * @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.
13717
14263
  * @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.
13718
14264
  * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
13719
14265
  * @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.
@@ -13737,6 +14283,7 @@ export declare const Import: {
13737
14283
  extractCc?: string;
13738
14284
  fastStartLength?: string;
13739
14285
  filename?: string;
14286
+ holdJob?: boolean;
13740
14287
  ids?: SingleOrArrayGenericQueryParam;
13741
14288
  importTag?: string[];
13742
14289
  jobmetadata?: KeyValueObjectQueryParam;
@@ -13744,6 +14291,7 @@ export declare const Import: {
13744
14291
  notification?: string;
13745
14292
  notificationData?: KeyValueObjectQueryParam;
13746
14293
  original?: string;
14294
+ originalFilename?: string;
13747
14295
  overrideFastStart?: boolean;
13748
14296
  priority?: string;
13749
14297
  requireFastStart?: boolean;
@@ -13869,6 +14417,7 @@ export declare const Import: {
13869
14417
  * @param {string} options.pathParams.itemId
13870
14418
  * @param {object} [options.queryParams] - Query parameters
13871
14419
  * @param {boolean} [options.queryParams.componentImport] - New in version 23.2. true - Import sidecar file as a subtitle component. false (default) - Only save data from the sidecar file in the item metadata.
14420
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13872
14421
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13873
14422
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
13874
14423
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -13885,6 +14434,7 @@ export declare const Import: {
13885
14434
  };
13886
14435
  queryParams?: {
13887
14436
  componentImport?: boolean;
14437
+ holdJob?: boolean;
13888
14438
  jobmetadata?: KeyValueObjectQueryParam;
13889
14439
  notification?: string;
13890
14440
  notificationData?: KeyValueObjectQueryParam;
@@ -13908,6 +14458,7 @@ export declare const Import: {
13908
14458
  * @param {object} [options.queryParams] - Query parameters
13909
14459
  * @param {boolean} [options.queryParams.componentImport] - New in version 23.2. true - Import sidecar file as a subtitle component. false (default) - Only save data from the sidecar file in the item metadata.
13910
14460
  * @param {string} [options.queryParams.fileExtension] - The extension of the file that this sidecar data is from. Used to identify the sidecar media type. Example: srt.
14461
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
13911
14462
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
13912
14463
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
13913
14464
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -13925,6 +14476,7 @@ export declare const Import: {
13925
14476
  queryParams?: {
13926
14477
  componentImport?: boolean;
13927
14478
  fileExtension?: string;
14479
+ holdJob?: boolean;
13928
14480
  jobmetadata?: KeyValueObjectQueryParam;
13929
14481
  notification?: string;
13930
14482
  notificationData?: KeyValueObjectQueryParam;
@@ -13975,6 +14527,7 @@ export declare const Import: {
13975
14527
  * @param {number} [options.queryParams.index]
13976
14528
  * @param {boolean} [options.queryParams.noTranscode]
13977
14529
  * @param {string} [options.queryParams.original]
14530
+ * @param {string} [options.queryParams.originalFilename]
13978
14531
  * @param {string} [options.queryParams.passkey]
13979
14532
  * @param {string} [options.queryParams.shapeId]
13980
14533
  * @param {string} [options.queryParams.storageId]
@@ -13996,6 +14549,7 @@ export declare const Import: {
13996
14549
  index?: number;
13997
14550
  noTranscode?: boolean;
13998
14551
  original?: string;
14552
+ originalFilename?: string;
13999
14553
  passkey?: string;
14000
14554
  shapeId?: string;
14001
14555
  storageId?: string;
@@ -14021,6 +14575,7 @@ export declare const Import: {
14021
14575
  * @param {number} [options.queryParams.index]
14022
14576
  * @param {boolean} [options.queryParams.noTranscode]
14023
14577
  * @param {string} [options.queryParams.original]
14578
+ * @param {string} [options.queryParams.originalFilename]
14024
14579
  * @param {string} [options.queryParams.passkey]
14025
14580
  * @param {string} [options.queryParams.shapeId]
14026
14581
  * @param {string} [options.queryParams.storageId]
@@ -14042,6 +14597,7 @@ export declare const Import: {
14042
14597
  index?: number;
14043
14598
  noTranscode?: boolean;
14044
14599
  original?: string;
14600
+ originalFilename?: string;
14045
14601
  passkey?: string;
14046
14602
  shapeId?: string;
14047
14603
  storageId?: string;
@@ -14067,6 +14623,7 @@ export declare const Import: {
14067
14623
  * @param {number} [options.queryParams.index]
14068
14624
  * @param {boolean} [options.queryParams.noTranscode]
14069
14625
  * @param {string} [options.queryParams.original]
14626
+ * @param {string} [options.queryParams.originalFilename]
14070
14627
  * @param {string} [options.queryParams.passkey]
14071
14628
  * @param {string} [options.queryParams.shapeId]
14072
14629
  * @param {string} [options.queryParams.storageId]
@@ -14088,6 +14645,7 @@ export declare const Import: {
14088
14645
  index?: number;
14089
14646
  noTranscode?: boolean;
14090
14647
  original?: string;
14648
+ originalFilename?: string;
14091
14649
  passkey?: string;
14092
14650
  shapeId?: string;
14093
14651
  storageId?: string;
@@ -14108,7 +14666,8 @@ export declare const Import: {
14108
14666
  *
14109
14667
  * @param {object} options
14110
14668
  * @param {object} [options.queryParams] - Query parameters
14111
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
14669
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
14670
+ * @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.
14112
14671
  * @param {string} [options.queryParams.passkey]
14113
14672
  * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
14114
14673
  * @param {string} [options.queryParams.transferId] - An id to assign the transfer to be able to refer to it.
@@ -14120,6 +14679,7 @@ export declare const Import: {
14120
14679
  postRawImportNoAuth: ({ queryParams, headers, requestConfig, }: {
14121
14680
  queryParams?: {
14122
14681
  filename?: string;
14682
+ originalFilename?: string;
14123
14683
  passkey?: string;
14124
14684
  storageId?: string;
14125
14685
  transferId?: string;
@@ -14675,6 +15235,29 @@ export declare const Item: {
14675
15235
  headers?: VidiCoreRequestHeaderConfig;
14676
15236
  requestConfig?: AxiosRequestConfig;
14677
15237
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
15238
+ /**
15239
+ * Get Item Deletion Lock List All Metadata Prefix
15240
+ *
15241
+ * 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.
15242
+ *
15243
+ * - accept: `text/plain`
15244
+ *
15245
+ * @param {object} options
15246
+ * @param {object} options.pathParams - Path parameters
15247
+ * @param {string} options.pathParams.deletionLockId
15248
+ * @param {string} options.pathParams.prefix
15249
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
15250
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
15251
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
15252
+ */
15253
+ getItemDeletionLockListAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
15254
+ pathParams: {
15255
+ deletionLockId: string;
15256
+ prefix: string;
15257
+ };
15258
+ headers?: VidiCoreRequestHeaderConfig;
15259
+ requestConfig?: AxiosRequestConfig;
15260
+ }) => Promise<AxiosResponse<string>>;
14678
15261
  /**
14679
15262
  * Get Item Search History
14680
15263
  *
@@ -14714,6 +15297,7 @@ export declare const Item: {
14714
15297
  * @param {string} [options.queryParams.destinationUri] - Required. The URI to output the CSV file to.
14715
15298
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.field] - Comma-separated list of metadata fields to include in the result. Default is title
14716
15299
  * @param {string} [options.queryParams.groupname] - Filter items according to the access of the specified group.
15300
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
14717
15301
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
14718
15302
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
14719
15303
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -14731,6 +15315,7 @@ export declare const Item: {
14731
15315
  destinationUri?: string;
14732
15316
  field?: SingleOrArrayGenericQueryParam;
14733
15317
  groupname?: string;
15318
+ holdJob?: boolean;
14734
15319
  jobmetadata?: KeyValueObjectQueryParam;
14735
15320
  notification?: string;
14736
15321
  notificationData?: KeyValueObjectQueryParam;
@@ -15028,6 +15613,96 @@ export declare const Item: {
15028
15613
  headers?: VidiCoreRequestHeaderConfig;
15029
15614
  requestConfig?: AxiosRequestConfig;
15030
15615
  }) => Promise<AxiosResponse<any>>;
15616
+ /**
15617
+ * Create Item Relations
15618
+ *
15619
+ * This request supersedes the deprecated request POST /relation available since version 4.16.Generates multiple relations at once. Each relation has a source and a target, and the direction can take the value U, if not set it generates a directional relation from source to target. For example:
15620
+ *
15621
+ * - contentType: `application/json`
15622
+ * - accept: `application/json`
15623
+ *
15624
+ * @param {object} options
15625
+ * @param {object} [options.queryParams] - Query parameters
15626
+ * @param {boolean} [options.queryParams.allowDuplicate=true] - true (default) - Allow duplicate relations. false - Avoid adding duplicate relations.
15627
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
15628
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
15629
+ * @returns {Promise<AxiosResponse<ItemRelationListDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationListDocument&gt;&gt;
15630
+ */
15631
+ createItemRelations: ({ queryParams, data, headers, requestConfig, }: {
15632
+ queryParams?: {
15633
+ allowDuplicate?: boolean;
15634
+ };
15635
+ data: ItemRelationListDocument;
15636
+ headers?: VidiCoreRequestHeaderConfig;
15637
+ requestConfig?: AxiosRequestConfig;
15638
+ }) => Promise<AxiosResponse<ItemRelationListDocument>>;
15639
+ /**
15640
+ * Delete Item Relation
15641
+ *
15642
+ * This request supersedes the deprecated request DELETE /relation/(relation-id) available since version 4.16.Deletes the relation with the id relation-id.
15643
+ *
15644
+ *
15645
+ * @param {object} options
15646
+ * @param {object} options.pathParams - Path parameters
15647
+ * @param {string} options.pathParams.relationId
15648
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
15649
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
15650
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
15651
+ */
15652
+ deleteItemRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
15653
+ pathParams: {
15654
+ relationId: string;
15655
+ };
15656
+ headers?: VidiCoreRequestHeaderConfig;
15657
+ requestConfig?: AxiosRequestConfig;
15658
+ }) => Promise<AxiosResponse<any>>;
15659
+ /**
15660
+ * Get Item Relation
15661
+ *
15662
+ * This request supersedes the deprecated request GET /relation/(relation-id) available since version 4.16.Retrieves the relation with the id relation-id.
15663
+ *
15664
+ * - accept: `application/json`
15665
+ *
15666
+ * @param {object} options
15667
+ * @param {object} options.pathParams - Path parameters
15668
+ * @param {string} options.pathParams.relationId
15669
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
15670
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
15671
+ * @returns {Promise<AxiosResponse<ItemRelationDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationDocument&gt;&gt;
15672
+ */
15673
+ getItemRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
15674
+ pathParams: {
15675
+ relationId: string;
15676
+ };
15677
+ headers?: VidiCoreRequestHeaderConfig;
15678
+ requestConfig?: AxiosRequestConfig;
15679
+ }) => Promise<AxiosResponse<ItemRelationDocument>>;
15680
+ /**
15681
+ * Update Item Relation
15682
+ *
15683
+ * This request supersedes the deprecated request PUT /relation/(relation-id) available since version 4.16.Updates the relation metadata for a relation with the id relation-id. Query parameters of the form key=value are used to modify the metadata of the relation.
15684
+ *
15685
+ * - accept: `application/json`
15686
+ *
15687
+ * @param {object} options
15688
+ * @param {object} options.pathParams - Path parameters
15689
+ * @param {string} options.pathParams.relationId
15690
+ * @param {object} [options.queryParams] - Query parameters
15691
+ * @param {string} [options.queryParams.direction] - U - Set the direction of the relation as undirectional. S - Set the direction as the first item of the relation being the source and the second one being the target. T - Set the direction as the second item of the relation being the source and the first one being the target.
15692
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
15693
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
15694
+ * @returns {Promise<AxiosResponse<ItemRelationDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationDocument&gt;&gt;
15695
+ */
15696
+ updateItemRelation: ({ pathParams: { relationId }, queryParams, headers, requestConfig, }: {
15697
+ pathParams: {
15698
+ relationId: string;
15699
+ };
15700
+ queryParams?: {
15701
+ direction?: string;
15702
+ };
15703
+ headers?: VidiCoreRequestHeaderConfig;
15704
+ requestConfig?: AxiosRequestConfig;
15705
+ }) => Promise<AxiosResponse<ItemRelationDocument>>;
15031
15706
  /**
15032
15707
  * List Item List Site Rules
15033
15708
  *
@@ -15490,6 +16165,7 @@ export declare const Item: {
15490
16165
  * @param {string} options.pathParams.itemId
15491
16166
  * @param {object} [options.queryParams] - Query parameters
15492
16167
  * @param {string} [options.queryParams.callbackId] - The callback resource id to use for finding and running callback scripts.
16168
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
15493
16169
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
15494
16170
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
15495
16171
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -15507,6 +16183,7 @@ export declare const Item: {
15507
16183
  };
15508
16184
  queryParams?: {
15509
16185
  callbackId?: string;
16186
+ holdJob?: boolean;
15510
16187
  jobmetadata?: KeyValueObjectQueryParam;
15511
16188
  notification?: string;
15512
16189
  notificationData?: KeyValueObjectQueryParam;
@@ -15813,6 +16490,31 @@ export declare const Item: {
15813
16490
  headers?: VidiCoreRequestHeaderConfig;
15814
16491
  requestConfig?: AxiosRequestConfig;
15815
16492
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
16493
+ /**
16494
+ * Get Item Deletion Lock All Metadata Prefix
16495
+ *
16496
+ * 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.
16497
+ *
16498
+ * - accept: `text/plain`
16499
+ *
16500
+ * @param {object} options
16501
+ * @param {object} options.pathParams - Path parameters
16502
+ * @param {string} options.pathParams.itemId
16503
+ * @param {string} options.pathParams.deletionLockId
16504
+ * @param {string} options.pathParams.prefix
16505
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
16506
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
16507
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
16508
+ */
16509
+ getItemDeletionLockAllMetadataPrefix: ({ pathParams: { itemId, deletionLockId, prefix }, headers, requestConfig, }: {
16510
+ pathParams: {
16511
+ itemId: string;
16512
+ deletionLockId: string;
16513
+ prefix: string;
16514
+ };
16515
+ headers?: VidiCoreRequestHeaderConfig;
16516
+ requestConfig?: AxiosRequestConfig;
16517
+ }) => Promise<AxiosResponse<string>>;
15816
16518
  /**
15817
16519
  * Sync Item Eidr Metadata
15818
16520
  *
@@ -15855,6 +16557,7 @@ export declare const Item: {
15855
16557
  * @param {boolean} [options.queryParams.allowMissing=true] - true (default) - Job will be started and the missing files will be ignored. false - Job will fail if there are missing files and the files could not be generated by transcoding. A shape tag should be specified.
15856
16558
  * @param {string} [options.queryParams.end] - Defines an end time code for the media.
15857
16559
  * @param {boolean} [options.queryParams.exportDashMpd] - If set to true the dash-mpd manifest is exported together with the selected representations specified in tag. If no tags is specified all representations will be exported. The representation files is exported to the original filename. (New in 5.3.)
16560
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
15858
16561
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
15859
16562
  * @param {string} [options.queryParams.locationName] - The name of an export location.
15860
16563
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -15882,6 +16585,7 @@ export declare const Item: {
15882
16585
  allowMissing?: boolean;
15883
16586
  end?: string;
15884
16587
  exportDashMpd?: boolean;
16588
+ holdJob?: boolean;
15885
16589
  jobmetadata?: KeyValueObjectQueryParam;
15886
16590
  locationName?: string;
15887
16591
  metadata?: boolean;
@@ -15915,6 +16619,7 @@ export declare const Item: {
15915
16619
  * @param {boolean} [options.queryParams.allowMissing=true] - true (default) - Job will be started and the missing files will be ignored. false - Job will fail if there are missing files and the files could not be generated by transcoding. A shape tag should be specified.
15916
16620
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.cplTrack] - Comma-separated list of item track ids to include in the CPL. Can include wildcards, e.g. A*. Can also contain component ids. Since 4.17.8, can also be on the format {shape}:track, where shape is identified by shape id or shape tag. Default is the same as the track parameter.
15917
16621
  * @param {string} [options.queryParams.end] - Defines an end time_code for the media.
16622
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
15918
16623
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
15919
16624
  * @param {string} [options.queryParams.locationName] - The name of an export location.
15920
16625
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -15942,6 +16647,7 @@ export declare const Item: {
15942
16647
  allowMissing?: boolean;
15943
16648
  cplTrack?: SingleOrArrayGenericQueryParam;
15944
16649
  end?: string;
16650
+ holdJob?: boolean;
15945
16651
  jobmetadata?: KeyValueObjectQueryParam;
15946
16652
  locationName?: string;
15947
16653
  metadata?: boolean;
@@ -16122,6 +16828,31 @@ export declare const Item: {
16122
16828
  headers?: VidiCoreRequestHeaderConfig;
16123
16829
  requestConfig?: AxiosRequestConfig;
16124
16830
  }) => Promise<AxiosResponse<URIListDocument>>;
16831
+ /**
16832
+ * Update Item
16833
+ *
16834
+ * If the indexed query parameter is set to false the item is permanently removed from the search index. To add the item back to the search index again, set the indexed query parameter to true
16835
+ *
16836
+ *
16837
+ * @param {object} options
16838
+ * @param {object} options.pathParams - Path parameters
16839
+ * @param {string} options.pathParams.itemId
16840
+ * @param {object} [options.queryParams] - Query parameters
16841
+ * @param {boolean} [options.queryParams.indexed] - Specifies if the item should be added or removed from the search index.
16842
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
16843
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
16844
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
16845
+ */
16846
+ updateItem: ({ pathParams: { itemId }, queryParams, headers, requestConfig, }: {
16847
+ pathParams: {
16848
+ itemId: string;
16849
+ };
16850
+ queryParams?: {
16851
+ indexed?: boolean;
16852
+ };
16853
+ headers?: VidiCoreRequestHeaderConfig;
16854
+ requestConfig?: AxiosRequestConfig;
16855
+ }) => Promise<AxiosResponse<any>>;
16125
16856
  /**
16126
16857
  * List Item Libraries
16127
16858
  *
@@ -17571,7 +18302,7 @@ export declare const Item: {
17571
18302
  * @param {object} options.pathParams - Path parameters
17572
18303
  * @param {string} options.pathParams.itemId
17573
18304
  * @param {object} [options.queryParams] - Query parameters
17574
- * @param {string} [options.queryParams.direction='A'] - A - This is the default value. Deletes all relations id1 is involved in. U - Deletes only the relations with the direction as undirectional. S - Deletes only the relations where id1 is the source and id2 is the target. T - Deletes only the relations where id2 is the source and id1 is the target.
18305
+ * @param {string} [options.queryParams.direction='A'] - A - This is the default value. Deletes all relations id is involved in. U - Deletes only the relations with the direction as undirectional. S - Deletes only the relations where id is the source. T - Deletes only the relations where id is the target.
17575
18306
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
17576
18307
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
17577
18308
  * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
@@ -17612,6 +18343,32 @@ export declare const Item: {
17612
18343
  headers?: VidiCoreRequestHeaderConfig;
17613
18344
  requestConfig?: AxiosRequestConfig;
17614
18345
  }) => Promise<AxiosResponse<ItemRelationListDocument>>;
18346
+ /**
18347
+ * List Item Relations
18348
+ *
18349
+ * Returns a list of relations that matches the search criteria. Item id can be an identifier, that is libraries can be used.In addition, extra query parameters of the form key=value can be added, to only return relations that matches the key-value pair(s).
18350
+ *
18351
+ * - accept: `text/plain`
18352
+ *
18353
+ * @param {object} options
18354
+ * @param {object} options.pathParams - Path parameters
18355
+ * @param {string} options.pathParams.itemId
18356
+ * @param {object} [options.queryParams] - Query parameters
18357
+ * @param {string} [options.queryParams.direction='A'] - U - Only return undirectional relations where id is part of. S - Only return directional relations where id is the source item. T - Only return directional relations where id is the target item. D - Only return directional relations where id is the source or target item. A (default) - Return all relations that id is a part of.
18358
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
18359
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
18360
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
18361
+ */
18362
+ listItemRelations: ({ pathParams: { itemId }, queryParams, headers, requestConfig, }: {
18363
+ pathParams: {
18364
+ itemId: string;
18365
+ };
18366
+ queryParams?: {
18367
+ direction?: string;
18368
+ };
18369
+ headers?: VidiCoreRequestHeaderConfig;
18370
+ requestConfig?: AxiosRequestConfig;
18371
+ }) => Promise<AxiosResponse<string>>;
17615
18372
  /**
17616
18373
  * Delete All Relations Between Items
17617
18374
  *
@@ -17805,6 +18562,7 @@ export declare const Item: {
17805
18562
  * @param {string} options.pathParams.itemId
17806
18563
  * @param {object} [options.queryParams] - Query parameters
17807
18564
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
18565
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
17808
18566
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
17809
18567
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
17810
18568
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -17827,6 +18585,7 @@ export declare const Item: {
17827
18585
  };
17828
18586
  queryParams?: {
17829
18587
  destinationItem?: string;
18588
+ holdJob?: boolean;
17830
18589
  jobmetadata?: KeyValueObjectQueryParam;
17831
18590
  notification?: string;
17832
18591
  notificationData?: KeyValueObjectQueryParam;
@@ -18175,6 +18934,7 @@ export declare const Item: {
18175
18934
  * @param {object} [options.queryParams] - Query parameters
18176
18935
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
18177
18936
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.createThumbnails] - true - Creates thumbnails according to default transcoder rules. t1, ... - Thumbnails will be created on the specified, comma-separated, time codes. false (default) - No thumbnails will be created.
18937
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
18178
18938
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
18179
18939
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
18180
18940
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -18201,6 +18961,7 @@ export declare const Item: {
18201
18961
  queryParams?: {
18202
18962
  createPosters?: string;
18203
18963
  createThumbnails?: SingleOrArrayGenericQueryParam;
18964
+ holdJob?: boolean;
18204
18965
  jobmetadata?: KeyValueObjectQueryParam;
18205
18966
  notification?: string;
18206
18967
  notificationData?: KeyValueObjectQueryParam;
@@ -18418,6 +19179,7 @@ export declare const Item: {
18418
19179
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Creates thumbnails according to default transcoder rules. false - No thumbnails will be created.
18419
19180
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
18420
19181
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
19182
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
18421
19183
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
18422
19184
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
18423
19185
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -18445,6 +19207,7 @@ export declare const Item: {
18445
19207
  createThumbnails?: boolean;
18446
19208
  destinationItem?: string;
18447
19209
  fastStartLength?: string;
19210
+ holdJob?: boolean;
18448
19211
  jobmetadata?: KeyValueObjectQueryParam;
18449
19212
  notification?: string;
18450
19213
  notificationData?: KeyValueObjectQueryParam;
@@ -18476,6 +19239,7 @@ export declare const Item: {
18476
19239
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Creates thumbnails according to default transcoder rules. false - No thumbnails will be created.
18477
19240
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
18478
19241
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
19242
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
18479
19243
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
18480
19244
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
18481
19245
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -18502,6 +19266,7 @@ export declare const Item: {
18502
19266
  createThumbnails?: boolean;
18503
19267
  destinationItem?: string;
18504
19268
  fastStartLength?: string;
19269
+ holdJob?: boolean;
18505
19270
  jobmetadata?: KeyValueObjectQueryParam;
18506
19271
  notification?: string;
18507
19272
  notificationData?: KeyValueObjectQueryParam;
@@ -19020,6 +19785,7 @@ export declare const Job: {
19020
19785
  *
19021
19786
  * @param {object} options
19022
19787
  * @param {object} [options.queryParams] - Query parameters
19788
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
19023
19789
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
19024
19790
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
19025
19791
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -19031,6 +19797,7 @@ export declare const Job: {
19031
19797
  */
19032
19798
  startJob: ({ queryParams, data, headers, requestConfig, }: {
19033
19799
  queryParams?: {
19800
+ holdJob?: boolean;
19034
19801
  jobmetadata?: KeyValueObjectQueryParam;
19035
19802
  notification?: string;
19036
19803
  notificationData?: KeyValueObjectQueryParam;
@@ -19747,6 +20514,28 @@ export declare const Job: {
19747
20514
  headers?: VidiCoreRequestHeaderConfig;
19748
20515
  requestConfig?: AxiosRequestConfig;
19749
20516
  }) => Promise<AxiosResponse<JobDocument>>;
20517
+ /**
20518
+ * Run Job Step
20519
+ *
20520
+ * Start a job step. The job must be in HOLD state.
20521
+ *
20522
+ *
20523
+ * @param {object} options
20524
+ * @param {object} options.pathParams - Path parameters
20525
+ * @param {string} options.pathParams.jobId
20526
+ * @param {number} options.pathParams.step
20527
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
20528
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
20529
+ * @returns {Promise<AxiosResponse<any>>} Promise&lt;AxiosResponse&lt;any&gt;&gt;
20530
+ */
20531
+ runJobStep: ({ pathParams: { jobId, step }, headers, requestConfig, }: {
20532
+ pathParams: {
20533
+ jobId: string;
20534
+ step: number;
20535
+ };
20536
+ headers?: VidiCoreRequestHeaderConfig;
20537
+ requestConfig?: AxiosRequestConfig;
20538
+ }) => Promise<AxiosResponse<any>>;
19750
20539
  };
19751
20540
 
19752
20541
  /**
@@ -19789,6 +20578,7 @@ export declare const Library: {
19789
20578
  * @param {object} options
19790
20579
  * @param {object} [options.queryParams] - Query parameters
19791
20580
  * @param {boolean} [options.queryParams.async] - true - Start a DELETE_LIBRARY job that removes the libraries. false (default) - Remove the libraries immediately.
20581
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
19792
20582
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Required. Comma-separated list of library ids or external ids.
19793
20583
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
19794
20584
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
@@ -19801,6 +20591,7 @@ export declare const Library: {
19801
20591
  deleteLibraryLibraries: ({ queryParams, headers, requestConfig, }: {
19802
20592
  queryParams?: {
19803
20593
  async?: boolean;
20594
+ holdJob?: boolean;
19804
20595
  id?: SingleOrArrayGenericQueryParam;
19805
20596
  jobmetadata?: KeyValueObjectQueryParam;
19806
20597
  notification?: string;
@@ -20109,6 +20900,29 @@ export declare const Library: {
20109
20900
  headers?: VidiCoreRequestHeaderConfig;
20110
20901
  requestConfig?: AxiosRequestConfig;
20111
20902
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
20903
+ /**
20904
+ * Get Library Deletion Lock List All Metadata Prefix
20905
+ *
20906
+ * 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.
20907
+ *
20908
+ * - accept: `text/plain`
20909
+ *
20910
+ * @param {object} options
20911
+ * @param {object} options.pathParams - Path parameters
20912
+ * @param {string} options.pathParams.deletionLockId
20913
+ * @param {string} options.pathParams.prefix
20914
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
20915
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
20916
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
20917
+ */
20918
+ getLibraryDeletionLockListAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
20919
+ pathParams: {
20920
+ deletionLockId: string;
20921
+ prefix: string;
20922
+ };
20923
+ headers?: VidiCoreRequestHeaderConfig;
20924
+ requestConfig?: AxiosRequestConfig;
20925
+ }) => Promise<AxiosResponse<string>>;
20112
20926
  /**
20113
20927
  * Reindex Library
20114
20928
  *
@@ -20235,6 +21049,7 @@ export declare const Library: {
20235
21049
  * @param {string} options.pathParams.libraryId
20236
21050
  * @param {object} [options.queryParams] - Query parameters
20237
21051
  * @param {boolean} [options.queryParams.async] - true - Start a DELETE_LIBRARY job that removes the library. false (default) - Remove the library immediately.
21052
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
20238
21053
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
20239
21054
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
20240
21055
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -20249,6 +21064,7 @@ export declare const Library: {
20249
21064
  };
20250
21065
  queryParams?: {
20251
21066
  async?: boolean;
21067
+ holdJob?: boolean;
20252
21068
  jobmetadata?: KeyValueObjectQueryParam;
20253
21069
  notification?: string;
20254
21070
  notificationData?: KeyValueObjectQueryParam;
@@ -20880,6 +21696,31 @@ export declare const Library: {
20880
21696
  headers?: VidiCoreRequestHeaderConfig;
20881
21697
  requestConfig?: AxiosRequestConfig;
20882
21698
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
21699
+ /**
21700
+ * Get Library Deletion Lock All Metadata Prefix
21701
+ *
21702
+ * 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.
21703
+ *
21704
+ * - accept: `text/plain`
21705
+ *
21706
+ * @param {object} options
21707
+ * @param {object} options.pathParams - Path parameters
21708
+ * @param {string} options.pathParams.libraryId
21709
+ * @param {string} options.pathParams.deletionLockId
21710
+ * @param {string} options.pathParams.prefix
21711
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
21712
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
21713
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
21714
+ */
21715
+ getLibraryDeletionLockAllMetadataPrefix: ({ pathParams: { libraryId, deletionLockId, prefix }, headers, requestConfig, }: {
21716
+ pathParams: {
21717
+ libraryId: string;
21718
+ deletionLockId: string;
21719
+ prefix: string;
21720
+ };
21721
+ headers?: VidiCoreRequestHeaderConfig;
21722
+ requestConfig?: AxiosRequestConfig;
21723
+ }) => Promise<AxiosResponse<string>>;
20883
21724
  /**
20884
21725
  * Sync Library Eidr Metadata
20885
21726
  *
@@ -20920,6 +21761,7 @@ export declare const Library: {
20920
21761
  * @param {string} options.pathParams.libraryId
20921
21762
  * @param {object} [options.queryParams] - Query parameters
20922
21763
  * @param {boolean} [options.queryParams.all=true] - true (default) - Fail the job if not all files from the selected shapes could be exported. false - Don't export lost or unavailable files.
21764
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
20923
21765
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
20924
21766
  * @param {string} [options.queryParams.locationName] - The name of an export location.
20925
21767
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -20944,6 +21786,7 @@ export declare const Library: {
20944
21786
  };
20945
21787
  queryParams?: {
20946
21788
  all?: boolean;
21789
+ holdJob?: boolean;
20947
21790
  jobmetadata?: KeyValueObjectQueryParam;
20948
21791
  locationName?: string;
20949
21792
  metadata?: boolean;
@@ -21059,6 +21902,7 @@ export declare const Library: {
21059
21902
  * @param {object} options.pathParams - Path parameters
21060
21903
  * @param {string} options.pathParams.libraryId
21061
21904
  * @param {object} [options.queryParams] - Query parameters
21905
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
21062
21906
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
21063
21907
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
21064
21908
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -21072,6 +21916,7 @@ export declare const Library: {
21072
21916
  libraryId: string;
21073
21917
  };
21074
21918
  queryParams?: {
21919
+ holdJob?: boolean;
21075
21920
  jobmetadata?: KeyValueObjectQueryParam;
21076
21921
  notification?: string;
21077
21922
  notificationData?: KeyValueObjectQueryParam;
@@ -21096,6 +21941,7 @@ export declare const Library: {
21096
21941
  * @param {string} [options.queryParams.data] - Specifies any additional data that should be included with the metadata fields.
21097
21942
  * @param {string} [options.queryParams.destinationUri] - Required. The URI to output the CSV file to.
21098
21943
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.field] - Comma-separated list of metadata fields to include in the result. Default is title
21944
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
21099
21945
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
21100
21946
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
21101
21947
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -21114,6 +21960,7 @@ export declare const Library: {
21114
21960
  data?: string;
21115
21961
  destinationUri?: string;
21116
21962
  field?: SingleOrArrayGenericQueryParam;
21963
+ holdJob?: boolean;
21117
21964
  jobmetadata?: KeyValueObjectQueryParam;
21118
21965
  notification?: string;
21119
21966
  notificationData?: KeyValueObjectQueryParam;
@@ -21317,6 +22164,29 @@ export declare const Library: {
21317
22164
  headers?: VidiCoreRequestHeaderConfig;
21318
22165
  requestConfig?: AxiosRequestConfig;
21319
22166
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
22167
+ /**
22168
+ * Get Library All Metadata Prefix
22169
+ *
22170
+ * 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.
22171
+ *
22172
+ * - accept: `text/plain`
22173
+ *
22174
+ * @param {object} options
22175
+ * @param {object} options.pathParams - Path parameters
22176
+ * @param {string} options.pathParams.libraryId
22177
+ * @param {string} options.pathParams.prefix
22178
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
22179
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
22180
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
22181
+ */
22182
+ getLibraryAllMetadataPrefix: ({ pathParams: { libraryId, prefix }, headers, requestConfig, }: {
22183
+ pathParams: {
22184
+ libraryId: string;
22185
+ prefix: string;
22186
+ };
22187
+ headers?: VidiCoreRequestHeaderConfig;
22188
+ requestConfig?: AxiosRequestConfig;
22189
+ }) => Promise<AxiosResponse<string>>;
21320
22190
  /**
21321
22191
  * Reindex Library By Id
21322
22192
  *
@@ -22181,6 +23051,27 @@ export declare const Metadata: {
22181
23051
  headers?: VidiCoreRequestHeaderConfig;
22182
23052
  requestConfig?: AxiosRequestConfig;
22183
23053
  }) => Promise<AxiosResponse<string>>;
23054
+ /**
23055
+ * Get Metadata Model Text
23056
+ *
23057
+ * Retrieves the metadata dataset with the specified name. The returned serialization format of the RDF model is RDF/XML or TURTLE depending on the request header.
23058
+ *
23059
+ * - accept: `application/ld+json`
23060
+ *
23061
+ * @param {object} options
23062
+ * @param {object} options.pathParams - Path parameters
23063
+ * @param {string} options.pathParams.name
23064
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
23065
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
23066
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
23067
+ */
23068
+ getMetadataModelText: ({ pathParams: { name }, headers, requestConfig, }: {
23069
+ pathParams: {
23070
+ name: string;
23071
+ };
23072
+ headers?: VidiCoreRequestHeaderConfig;
23073
+ requestConfig?: AxiosRequestConfig;
23074
+ }) => Promise<AxiosResponse<string>>;
22184
23075
  /**
22185
23076
  * Create Metadata Dataset
22186
23077
  *
@@ -22800,6 +23691,29 @@ export declare const MetadataField: {
22800
23691
  headers?: VidiCoreRequestHeaderConfig;
22801
23692
  requestConfig?: AxiosRequestConfig;
22802
23693
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
23694
+ /**
23695
+ * Get Metadata Field All Metadata Prefix
23696
+ *
23697
+ * 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.
23698
+ *
23699
+ * - accept: `text/plain`
23700
+ *
23701
+ * @param {object} options
23702
+ * @param {object} options.pathParams - Path parameters
23703
+ * @param {string} options.pathParams.name
23704
+ * @param {string} options.pathParams.prefix
23705
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
23706
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
23707
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
23708
+ */
23709
+ getMetadataFieldAllMetadataPrefix: ({ pathParams: { name, prefix }, headers, requestConfig, }: {
23710
+ pathParams: {
23711
+ name: string;
23712
+ prefix: string;
23713
+ };
23714
+ headers?: VidiCoreRequestHeaderConfig;
23715
+ requestConfig?: AxiosRequestConfig;
23716
+ }) => Promise<AxiosResponse<string>>;
22803
23717
  /**
22804
23718
  * Get Metadata Field Values
22805
23719
  *
@@ -23326,6 +24240,7 @@ export declare const Otif: {
23326
24240
  *
23327
24241
  * @param {object} options
23328
24242
  * @param {object} [options.queryParams] - Query parameters
24243
+ * @param {boolean} [options.queryParams.holdJob]
23329
24244
  * @param {string} [options.queryParams.instance]
23330
24245
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
23331
24246
  * @param {string} [options.queryParams.notification]
@@ -23337,6 +24252,7 @@ export declare const Otif: {
23337
24252
  */
23338
24253
  startOtifJob: ({ queryParams, data, headers, requestConfig, }: {
23339
24254
  queryParams?: {
24255
+ holdJob?: boolean;
23340
24256
  instance?: string;
23341
24257
  jobmetadata?: KeyValueObjectQueryParam;
23342
24258
  notification?: string;
@@ -23952,6 +24868,7 @@ export declare const Poster: {
23952
24868
  * @param {string} options.pathParams.time
23953
24869
  * @param {object} [options.queryParams] - Query parameters
23954
24870
  * @param {string} [options.queryParams.format] - Image format of destination. E.g. tiff.
24871
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
23955
24872
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
23956
24873
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
23957
24874
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -23969,6 +24886,7 @@ export declare const Poster: {
23969
24886
  };
23970
24887
  queryParams?: {
23971
24888
  format?: string;
24889
+ holdJob?: boolean;
23972
24890
  jobmetadata?: KeyValueObjectQueryParam;
23973
24891
  notification?: string;
23974
24892
  notificationData?: KeyValueObjectQueryParam;
@@ -24844,8 +25762,12 @@ export declare const Reindex: {
24844
25762
  * @param {object} options.pathParams - Path parameters
24845
25763
  * @param {string} options.pathParams.index
24846
25764
  * @param {object} [options.queryParams] - Query parameters
25765
+ * @param {string} [options.queryParams.createdtimeFrom] - ISO 8601 timestamp. Rebuild index for entities created after and at the given timestamp. Apply to index item, collection, file or thumbnail.
25766
+ * @param {string} [options.queryParams.createdtimeTo] - ISO 8601 timestamp. Rebuild index for entities created before and at the given timestamp. Apply to index item, collection, file or thumbnail.
24847
25767
  * @param {number} [options.queryParams.priority=500] - The priority of this reindex request compare to other request. Requests with a larger/higher priority will be processed first. Default is 500.
24848
25768
  * @param {string} [options.queryParams.status='IN_QUEUE'] - If current status is FINISHED or ABORTED then PAUSED, ABORTED and IN_PROGRESS are no-ops. IN_QUEUE (default) - To start or restart reindex. PAUSED - To pause reindex. ABORTED - To cancel reindex. IN_PROGRESS/IN PROGRESS - To resume a paused reindex.
25769
+ * @param {string} [options.queryParams.updatedtimeFrom] - ISO 8601 timestamp. Rebuild index for entities updated after and at the given timestamp. Not Apply to index thumbnail.
25770
+ * @param {string} [options.queryParams.updatedtimeTo] - ISO 8601 timestamp. Rebuild index for entities updated before and at the given timestamp. Not Apply to index thumbnail.
24849
25771
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
24850
25772
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
24851
25773
  * @returns {Promise<AxiosResponse<ReindexRequestDocument>>} Promise&lt;AxiosResponse&lt;ReindexRequestDocument&gt;&gt;
@@ -24855,8 +25777,12 @@ export declare const Reindex: {
24855
25777
  index: string;
24856
25778
  };
24857
25779
  queryParams?: {
25780
+ createdtimeFrom?: string;
25781
+ createdtimeTo?: string;
24858
25782
  priority?: number;
24859
25783
  status?: string;
25784
+ updatedtimeFrom?: string;
25785
+ updatedtimeTo?: string;
24860
25786
  };
24861
25787
  headers?: VidiCoreRequestHeaderConfig;
24862
25788
  requestConfig?: AxiosRequestConfig;
@@ -24870,14 +25796,12 @@ export declare const Relation: {
24870
25796
  /**
24871
25797
  * Add Item Relations
24872
25798
  *
24873
- * Generates multiple relations at once. Each relation has a source and a target, and the direction can take the value U, if not set it generates a directional relation from source to target.For example:
24874
- *
24875
25799
  * - contentType: `application/json`
24876
25800
  * - accept: `application/json`
24877
25801
  *
24878
25802
  * @param {object} options
24879
25803
  * @param {object} [options.queryParams] - Query parameters
24880
- * @param {boolean} [options.queryParams.allowDuplicate=true] - true (default) - Allow duplicate relations. false - Avoid adding duplicate relations.
25804
+ * @param {boolean} [options.queryParams.allowDuplicate=true]
24881
25805
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
24882
25806
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
24883
25807
  * @returns {Promise<AxiosResponse<ItemRelationListDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationListDocument&gt;&gt;
@@ -24893,8 +25817,6 @@ export declare const Relation: {
24893
25817
  /**
24894
25818
  * Delete Relation
24895
25819
  *
24896
- * Deletes the relation with the id relation-id.
24897
- *
24898
25820
  *
24899
25821
  * @param {object} options
24900
25822
  * @param {object} options.pathParams - Path parameters
@@ -24911,9 +25833,7 @@ export declare const Relation: {
24911
25833
  requestConfig?: AxiosRequestConfig;
24912
25834
  }) => Promise<AxiosResponse<any>>;
24913
25835
  /**
24914
- * Get Item Relation
24915
- *
24916
- * Retrieves the relation with the id relation-id.
25836
+ * Get Relation
24917
25837
  *
24918
25838
  * - accept: `application/json`
24919
25839
  *
@@ -24924,7 +25844,7 @@ export declare const Relation: {
24924
25844
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
24925
25845
  * @returns {Promise<AxiosResponse<ItemRelationDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationDocument&gt;&gt;
24926
25846
  */
24927
- getItemRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
25847
+ getRelation: ({ pathParams: { relationId }, headers, requestConfig, }: {
24928
25848
  pathParams: {
24929
25849
  relationId: string;
24930
25850
  };
@@ -24934,15 +25854,13 @@ export declare const Relation: {
24934
25854
  /**
24935
25855
  * Put Relation Update
24936
25856
  *
24937
- * Updates the relation metadata for a relation with the id relation-id.Query parameters of the form key=value are used to modify the metadata of the relation.
24938
- *
24939
25857
  * - accept: `application/json`
24940
25858
  *
24941
25859
  * @param {object} options
24942
25860
  * @param {object} options.pathParams - Path parameters
24943
25861
  * @param {string} options.pathParams.relationId
24944
25862
  * @param {object} [options.queryParams] - Query parameters
24945
- * @param {string} [options.queryParams.direction] - U - Set the direction of the relation as undirectional. S - Set the direction as id1 being the source and id2 being the target. T - Set the direction as id2 being the source and id1 being the target.
25863
+ * @param {string} [options.queryParams.direction]
24946
25864
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
24947
25865
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
24948
25866
  * @returns {Promise<AxiosResponse<ItemRelationDocument>>} Promise&lt;AxiosResponse&lt;ItemRelationDocument&gt;&gt;
@@ -26283,6 +27201,7 @@ export declare const Sequence: {
26283
27201
  * @param {object} options
26284
27202
  * @param {object} [options.queryParams] - Query parameters
26285
27203
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
27204
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26286
27205
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26287
27206
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26288
27207
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -26292,6 +27211,7 @@ export declare const Sequence: {
26292
27211
  * @param {string} [options.queryParams.sequenceIn] - Specifies where to start the rendering for partial rendering New in version 22.3.
26293
27212
  * @param {string} [options.queryParams.sequenceOut] - Specifies where to end the rendering for partial rendering New in version 22.3.
26294
27213
  * @param {string} [options.queryParams.sourceTag] - The shape tag specifying the shapes to use as input.
27214
+ * @param {string} [options.queryParams.subtitleLanguage] - The language code specifying the subtitle language to use.
26295
27215
  * @param {string[]} [options.queryParams.tag] - The shape tag specifying the format of the rendered sequence.
26296
27216
  * @param {boolean} [options.queryParams.useLegacyScaling] - true - Segments without scaling effect are scaled to fit the canvas resolution. For segments that have a scaling effect set, those parameters are applied to the source clip resolution. false (default) - Segments are always scaled to fit the canvas resolution, while keeping the aspect ratio, and without cropping. If there is a scaling effect set for the segment, those parameters are then applied to the new resolution after first scaling to fit the canvas resolution. New in version 21.4.
26297
27217
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
@@ -26301,6 +27221,7 @@ export declare const Sequence: {
26301
27221
  postSequenceRender: ({ queryParams, data, headers, requestConfig, }: {
26302
27222
  queryParams?: {
26303
27223
  destinationItem?: string;
27224
+ holdJob?: boolean;
26304
27225
  jobmetadata?: KeyValueObjectQueryParam;
26305
27226
  notification?: string;
26306
27227
  notificationData?: KeyValueObjectQueryParam;
@@ -26310,6 +27231,7 @@ export declare const Sequence: {
26310
27231
  sequenceIn?: string;
26311
27232
  sequenceOut?: string;
26312
27233
  sourceTag?: string;
27234
+ subtitleLanguage?: string;
26313
27235
  tag?: string[];
26314
27236
  useLegacyScaling?: boolean;
26315
27237
  };
@@ -26459,6 +27381,7 @@ export declare const Shape: {
26459
27381
  * @param {object} [options.queryParams] - Query parameters
26460
27382
  * @param {boolean} [options.queryParams.allowReimport] - true - Import the file to this shape even if the file is already importing or is already part of another item. false (default) Reject the request if the file with the given id has already been imported or is currently importing.
26461
27383
  * @param {string} [options.queryParams.fileId] - The id of the file that contains the essence. Must be specified unless uri is specified.
27384
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26462
27385
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26463
27386
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26464
27387
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -26477,6 +27400,7 @@ export declare const Shape: {
26477
27400
  queryParams?: {
26478
27401
  allowReimport?: boolean;
26479
27402
  fileId?: string;
27403
+ holdJob?: boolean;
26480
27404
  jobmetadata?: KeyValueObjectQueryParam;
26481
27405
  notification?: string;
26482
27406
  notificationData?: KeyValueObjectQueryParam;
@@ -26532,6 +27456,7 @@ export declare const Shape: {
26532
27456
  * @param {boolean} [options.queryParams.allowReimport] - true - Import the file to this shape even if the file is already importing or is already part of another item. false (default) Reject the request if the file with the given id has already been imported or is currently importing.
26533
27457
  * @param {string} [options.queryParams.fileId] - The id of the file that contains the essence. Must be specified unless uri is specified.
26534
27458
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
27459
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26535
27460
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26536
27461
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26537
27462
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -26552,6 +27477,7 @@ export declare const Shape: {
26552
27477
  allowReimport?: boolean;
26553
27478
  fileId?: string;
26554
27479
  frameRate?: string;
27480
+ holdJob?: boolean;
26555
27481
  jobmetadata?: KeyValueObjectQueryParam;
26556
27482
  notification?: string;
26557
27483
  notificationData?: KeyValueObjectQueryParam;
@@ -26575,10 +27501,12 @@ export declare const Shape: {
26575
27501
  * @param {object} options.pathParams - Path parameters
26576
27502
  * @param {string} options.pathParams.itemId
26577
27503
  * @param {object} [options.queryParams] - Query parameters
26578
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
27504
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
27505
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26579
27506
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26580
27507
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26581
27508
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
27509
+ * @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.
26582
27510
  * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
26583
27511
  * @param {string} [options.queryParams.resourceId] - The transcoder resource to use to execute the transcode.
26584
27512
  * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
@@ -26595,9 +27523,11 @@ export declare const Shape: {
26595
27523
  };
26596
27524
  queryParams?: {
26597
27525
  filename?: string;
27526
+ holdJob?: boolean;
26598
27527
  jobmetadata?: KeyValueObjectQueryParam;
26599
27528
  notification?: string;
26600
27529
  notificationData?: KeyValueObjectQueryParam;
27530
+ originalFilename?: string;
26601
27531
  priority?: string;
26602
27532
  resourceId?: string;
26603
27533
  storageId?: string;
@@ -26620,6 +27550,7 @@ export declare const Shape: {
26620
27550
  * @param {object} options.pathParams - Path parameters
26621
27551
  * @param {string} options.pathParams.itemId
26622
27552
  * @param {object} [options.queryParams] - Query parameters
27553
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26623
27554
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
26624
27555
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26625
27556
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
@@ -26638,6 +27569,7 @@ export declare const Shape: {
26638
27569
  itemId: string;
26639
27570
  };
26640
27571
  queryParams?: {
27572
+ holdJob?: boolean;
26641
27573
  importTag?: string[];
26642
27574
  jobmetadata?: KeyValueObjectQueryParam;
26643
27575
  notification?: string;
@@ -26702,10 +27634,12 @@ export declare const Shape: {
26702
27634
  * @param {object} options.pathParams - Path parameters
26703
27635
  * @param {string} options.pathParams.itemId
26704
27636
  * @param {object} [options.queryParams] - Query parameters
26705
- * @param {string} [options.queryParams.filename] - The filename to be stored as original filename
27637
+ * @param {string} [options.queryParams.filename] - Deprecated since version 23.3: Use originalFilename instead. The filename that will be stored in the originalFilename metadata field. If both filename and originalFilename are provided, originalFilename will be used.
27638
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26706
27639
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26707
27640
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26708
27641
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
27642
+ * @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.
26709
27643
  * @param {string} [options.queryParams.priority] - The priority to assign to the job. Default is MEDIUM .
26710
27644
  * @param {string} [options.queryParams.storageId] - Identifier of storage where essence file is to be stored.
26711
27645
  * @param {string[]} [options.queryParams.tag] - The tags to assign to the new shape.
@@ -26721,9 +27655,11 @@ export declare const Shape: {
26721
27655
  };
26722
27656
  queryParams?: {
26723
27657
  filename?: string;
27658
+ holdJob?: boolean;
26724
27659
  jobmetadata?: KeyValueObjectQueryParam;
26725
27660
  notification?: string;
26726
27661
  notificationData?: KeyValueObjectQueryParam;
27662
+ originalFilename?: string;
26727
27663
  priority?: string;
26728
27664
  storageId?: string;
26729
27665
  tag?: string[];
@@ -26886,6 +27822,7 @@ export declare const Shape: {
26886
27822
  * @param {string} options.pathParams.shapeId
26887
27823
  * @param {object} [options.queryParams] - Query parameters
26888
27824
  * @param {string} [options.queryParams.callbackId] - The callback resource id to use for finding and running callback scripts.
27825
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26889
27826
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26890
27827
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26891
27828
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -26904,6 +27841,7 @@ export declare const Shape: {
26904
27841
  };
26905
27842
  queryParams?: {
26906
27843
  callbackId?: string;
27844
+ holdJob?: boolean;
26907
27845
  jobmetadata?: KeyValueObjectQueryParam;
26908
27846
  notification?: string;
26909
27847
  notificationData?: KeyValueObjectQueryParam;
@@ -26928,6 +27866,7 @@ export declare const Shape: {
26928
27866
  * @param {string} options.pathParams.itemId
26929
27867
  * @param {string} options.pathParams.shapeId
26930
27868
  * @param {object} [options.queryParams] - Query parameters
27869
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26931
27870
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26932
27871
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
26933
27872
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -26943,6 +27882,7 @@ export declare const Shape: {
26943
27882
  shapeId: string;
26944
27883
  };
26945
27884
  queryParams?: {
27885
+ holdJob?: boolean;
26946
27886
  jobmetadata?: KeyValueObjectQueryParam;
26947
27887
  notification?: string;
26948
27888
  notificationData?: KeyValueObjectQueryParam;
@@ -26989,6 +27929,7 @@ export declare const Shape: {
26989
27929
  * @param {object} [options.queryParams] - Query parameters
26990
27930
  * @param {boolean} [options.queryParams.allowMissing=true] - true (default) - Job will be started and the missing files will be ignored. false - Job won't be started if there are missing files.
26991
27931
  * @param {string} [options.queryParams.end] - Defines an end time code for the media.
27932
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
26992
27933
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
26993
27934
  * @param {string} [options.queryParams.locationName] - The name of an export location.
26994
27935
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -27013,6 +27954,7 @@ export declare const Shape: {
27013
27954
  queryParams?: {
27014
27955
  allowMissing?: boolean;
27015
27956
  end?: string;
27957
+ holdJob?: boolean;
27016
27958
  jobmetadata?: KeyValueObjectQueryParam;
27017
27959
  locationName?: string;
27018
27960
  metadata?: boolean;
@@ -27044,6 +27986,7 @@ export declare const Shape: {
27044
27986
  * @param {boolean} [options.queryParams.allowMissing=true] - true (default) - Job will be started and the missing files will be ignored. false - Job won't be started if there are missing files.
27045
27987
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.cplTrack] - Comma-separated list of item track ids to include in the CPL. Can include wildcards, e.g. A*. Can also contain component ids. Default is the same as the track parameter.
27046
27988
  * @param {string} [options.queryParams.end] - Defines an end time_code for the media.
27989
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
27047
27990
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
27048
27991
  * @param {string} [options.queryParams.locationName] - The name of an export location.
27049
27992
  * @param {boolean} [options.queryParams.metadata] - true - Metadata will also be exported to side-car XML file. false (default) - No metadata is exported.
@@ -27069,6 +28012,7 @@ export declare const Shape: {
27069
28012
  allowMissing?: boolean;
27070
28013
  cplTrack?: SingleOrArrayGenericQueryParam;
27071
28014
  end?: string;
28015
+ holdJob?: boolean;
27072
28016
  jobmetadata?: KeyValueObjectQueryParam;
27073
28017
  locationName?: string;
27074
28018
  metadata?: boolean;
@@ -27267,6 +28211,7 @@ export declare const Shape: {
27267
28211
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Creates thumbnails according to default transcoder rules. false - No thumbnails will be created.
27268
28212
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
27269
28213
  * @param {string} [options.queryParams.duration] - The desired duration of the highlight reel in seconds.
28214
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
27270
28215
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
27271
28216
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
27272
28217
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -27292,6 +28237,7 @@ export declare const Shape: {
27292
28237
  createThumbnails?: boolean;
27293
28238
  destinationItem?: string;
27294
28239
  duration?: string;
28240
+ holdJob?: boolean;
27295
28241
  jobmetadata?: KeyValueObjectQueryParam;
27296
28242
  notification?: string;
27297
28243
  notificationData?: KeyValueObjectQueryParam;
@@ -27689,6 +28635,31 @@ export declare const Shape: {
27689
28635
  headers?: VidiCoreRequestHeaderConfig;
27690
28636
  requestConfig?: AxiosRequestConfig;
27691
28637
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
28638
+ /**
28639
+ * Get Shape All Metadata Prefix
28640
+ *
28641
+ * 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.
28642
+ *
28643
+ * - accept: `text/plain`
28644
+ *
28645
+ * @param {object} options
28646
+ * @param {object} options.pathParams - Path parameters
28647
+ * @param {string} options.pathParams.itemId
28648
+ * @param {string} options.pathParams.shapeId
28649
+ * @param {string} options.pathParams.prefix
28650
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
28651
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
28652
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
28653
+ */
28654
+ getShapeAllMetadataPrefix: ({ pathParams: { itemId, shapeId, prefix }, headers, requestConfig, }: {
28655
+ pathParams: {
28656
+ itemId: string;
28657
+ shapeId: string;
28658
+ prefix: string;
28659
+ };
28660
+ headers?: VidiCoreRequestHeaderConfig;
28661
+ requestConfig?: AxiosRequestConfig;
28662
+ }) => Promise<AxiosResponse<string>>;
27692
28663
  /**
27693
28664
  * List Shape Mime Types
27694
28665
  *
@@ -27811,6 +28782,7 @@ export declare const Shape: {
27811
28782
  * @param {string} options.pathParams.itemId
27812
28783
  * @param {string} options.pathParams.shapeId
27813
28784
  * @param {object} [options.queryParams] - Query parameters
28785
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
27814
28786
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
27815
28787
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
27816
28788
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -27826,6 +28798,7 @@ export declare const Shape: {
27826
28798
  shapeId: string;
27827
28799
  };
27828
28800
  queryParams?: {
28801
+ holdJob?: boolean;
27829
28802
  jobmetadata?: KeyValueObjectQueryParam;
27830
28803
  notification?: string;
27831
28804
  notificationData?: KeyValueObjectQueryParam;
@@ -27877,6 +28850,7 @@ export declare const Shape: {
27877
28850
  * @param {object} [options.queryParams] - Query parameters
27878
28851
  * @param {string} [options.queryParams.aspect] - The aspect ratio to use, substituting "_" for ":" (e.g. 9_16). An analyze job for this aspect ratio must have been run prior to making this request.
27879
28852
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
28853
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
27880
28854
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
27881
28855
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
27882
28856
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -27897,6 +28871,7 @@ export declare const Shape: {
27897
28871
  queryParams?: {
27898
28872
  aspect?: string;
27899
28873
  destinationItem?: string;
28874
+ holdJob?: boolean;
27900
28875
  jobmetadata?: KeyValueObjectQueryParam;
27901
28876
  notification?: string;
27902
28877
  notificationData?: KeyValueObjectQueryParam;
@@ -27950,6 +28925,7 @@ export declare const Shape: {
27950
28925
  * @param {string} options.pathParams.shapeId
27951
28926
  * @param {string} options.pathParams.targetStorageId
27952
28927
  * @param {object} [options.queryParams] - Query parameters
28928
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
27953
28929
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
27954
28930
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
27955
28931
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -27971,6 +28947,7 @@ export declare const Shape: {
27971
28947
  targetStorageId: string;
27972
28948
  };
27973
28949
  queryParams?: {
28950
+ holdJob?: boolean;
27974
28951
  jobmetadata?: KeyValueObjectQueryParam;
27975
28952
  limitRate?: number;
27976
28953
  move?: boolean;
@@ -28075,6 +29052,7 @@ export declare const Shape: {
28075
29052
  * @param {object} [options.queryParams] - Query parameters
28076
29053
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
28077
29054
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.createThumbnails] - true - Creates thumbnails according to default transcoder rules. t1, ... - Thumbnails will be created on the specified, comma-separated, time codes. false (default) - No thumbnails will be created.
29055
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
28078
29056
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
28079
29057
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
28080
29058
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -28100,6 +29078,7 @@ export declare const Shape: {
28100
29078
  queryParams?: {
28101
29079
  createPosters?: string;
28102
29080
  createThumbnails?: SingleOrArrayGenericQueryParam;
29081
+ holdJob?: boolean;
28103
29082
  jobmetadata?: KeyValueObjectQueryParam;
28104
29083
  notification?: string;
28105
29084
  notificationData?: KeyValueObjectQueryParam;
@@ -28133,6 +29112,7 @@ export declare const Shape: {
28133
29112
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Creates thumbnails according to default transcoder rules. false - No thumbnails will be created.
28134
29113
  * @param {string} [options.queryParams.destinationItem] - An item id, to which the new new shape will be associated.
28135
29114
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
29115
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
28136
29116
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
28137
29117
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
28138
29118
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -28159,6 +29139,7 @@ export declare const Shape: {
28159
29139
  createThumbnails?: boolean;
28160
29140
  destinationItem?: string;
28161
29141
  fastStartLength?: string;
29142
+ holdJob?: boolean;
28162
29143
  jobmetadata?: KeyValueObjectQueryParam;
28163
29144
  notification?: string;
28164
29145
  notificationData?: KeyValueObjectQueryParam;
@@ -28189,6 +29170,7 @@ export declare const Shape: {
28189
29170
  * @param {object} [options.queryParams] - Query parameters
28190
29171
  * @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.
28191
29172
  * @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.
29173
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
28192
29174
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
28193
29175
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
28194
29176
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -28205,6 +29187,7 @@ export declare const Shape: {
28205
29187
  queryParams?: {
28206
29188
  ccFromVideo?: boolean;
28207
29189
  extractCc?: string;
29190
+ holdJob?: boolean;
28208
29191
  jobmetadata?: KeyValueObjectQueryParam;
28209
29192
  notification?: string;
28210
29193
  notificationData?: KeyValueObjectQueryParam;
@@ -28849,6 +29832,29 @@ export declare const ShapeTag: {
28849
29832
  headers?: VidiCoreRequestHeaderConfig;
28850
29833
  requestConfig?: AxiosRequestConfig;
28851
29834
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
29835
+ /**
29836
+ * Get Shape Tag All Metadata Prefix
29837
+ *
29838
+ * 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.
29839
+ *
29840
+ * - accept: `text/plain`
29841
+ *
29842
+ * @param {object} options
29843
+ * @param {object} options.pathParams - Path parameters
29844
+ * @param {string} options.pathParams.tagName
29845
+ * @param {string} options.pathParams.prefix
29846
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
29847
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
29848
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
29849
+ */
29850
+ getShapeTagAllMetadataPrefix: ({ pathParams: { tagName, prefix }, headers, requestConfig, }: {
29851
+ pathParams: {
29852
+ tagName: string;
29853
+ prefix: string;
29854
+ };
29855
+ headers?: VidiCoreRequestHeaderConfig;
29856
+ requestConfig?: AxiosRequestConfig;
29857
+ }) => Promise<AxiosResponse<string>>;
28852
29858
  /**
28853
29859
  * Unset Shape Tag Script
28854
29860
  *
@@ -29353,6 +30359,29 @@ export declare const Site: {
29353
30359
  headers?: VidiCoreRequestHeaderConfig;
29354
30360
  requestConfig?: AxiosRequestConfig;
29355
30361
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
30362
+ /**
30363
+ * Get Site All Metadata Prefix
30364
+ *
30365
+ * 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.
30366
+ *
30367
+ * - accept: `text/plain`
30368
+ *
30369
+ * @param {object} options
30370
+ * @param {object} options.pathParams - Path parameters
30371
+ * @param {string} options.pathParams.siteId
30372
+ * @param {string} options.pathParams.prefix
30373
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
30374
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
30375
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
30376
+ */
30377
+ getSiteAllMetadataPrefix: ({ pathParams: { siteId, prefix }, headers, requestConfig, }: {
30378
+ pathParams: {
30379
+ siteId: string;
30380
+ prefix: string;
30381
+ };
30382
+ headers?: VidiCoreRequestHeaderConfig;
30383
+ requestConfig?: AxiosRequestConfig;
30384
+ }) => Promise<AxiosResponse<string>>;
29356
30385
  };
29357
30386
 
29358
30387
  /**
@@ -29552,6 +30581,7 @@ declare const Storage_2: {
29552
30581
  * @param {object} [options.queryParams] - Query parameters
29553
30582
  * @param {boolean} [options.queryParams.createOnly=true] - true (default) - Fail if a file with that path already exists. false - Update the existing file if one exists, else create a new file entity.
29554
30583
  * @param {string} [options.queryParams.path] - The path of the file on the storage.
30584
+ * @param {string} [options.queryParams.range] - The sequence range, if the entity should represent a file sequence. The syntax is described in <sequence-uri>.
29555
30585
  * @param {string} [options.queryParams.state] - The state of the file. Default is OPEN.
29556
30586
  * @param {string} [options.queryParams.uri] - The absolute file URI (should be relative to the URI of a storage method).
29557
30587
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
@@ -29562,6 +30592,7 @@ declare const Storage_2: {
29562
30592
  queryParams?: {
29563
30593
  createOnly?: boolean;
29564
30594
  path?: string;
30595
+ range?: string;
29565
30596
  state?: string;
29566
30597
  uri?: string;
29567
30598
  };
@@ -29844,6 +30875,29 @@ declare const Storage_2: {
29844
30875
  headers?: VidiCoreRequestHeaderConfig;
29845
30876
  requestConfig?: AxiosRequestConfig;
29846
30877
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
30878
+ /**
30879
+ * Get Storage Deletion Lock File List All Metadata Prefix
30880
+ *
30881
+ * 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.
30882
+ *
30883
+ * - accept: `text/plain`
30884
+ *
30885
+ * @param {object} options
30886
+ * @param {object} options.pathParams - Path parameters
30887
+ * @param {string} options.pathParams.deletionLockId
30888
+ * @param {string} options.pathParams.prefix
30889
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
30890
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
30891
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
30892
+ */
30893
+ getStorageDeletionLockFileListAllMetadataPrefix: ({ pathParams: { deletionLockId, prefix }, headers, requestConfig, }: {
30894
+ pathParams: {
30895
+ deletionLockId: string;
30896
+ prefix: string;
30897
+ };
30898
+ headers?: VidiCoreRequestHeaderConfig;
30899
+ requestConfig?: AxiosRequestConfig;
30900
+ }) => Promise<AxiosResponse<string>>;
29847
30901
  /**
29848
30902
  * Post Storage Import
29849
30903
  *
@@ -29863,6 +30917,7 @@ declare const Storage_2: {
29863
30917
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
29864
30918
  * @param {string} [options.queryParams.filename] - The original filename of the file.
29865
30919
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
30920
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
29866
30921
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
29867
30922
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
29868
30923
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -29897,6 +30952,7 @@ declare const Storage_2: {
29897
30952
  fastStartLength?: string;
29898
30953
  filename?: string;
29899
30954
  frameRate?: string;
30955
+ holdJob?: boolean;
29900
30956
  id?: SingleOrArrayGenericQueryParam;
29901
30957
  importTag?: string[];
29902
30958
  jobmetadata?: KeyValueObjectQueryParam;
@@ -29936,6 +30992,7 @@ declare const Storage_2: {
29936
30992
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
29937
30993
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
29938
30994
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
30995
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
29939
30996
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
29940
30997
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
29941
30998
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -29964,6 +31021,7 @@ declare const Storage_2: {
29964
31021
  createPosters?: string;
29965
31022
  createThumbnails?: boolean;
29966
31023
  fastStartLength?: string;
31024
+ holdJob?: boolean;
29967
31025
  id?: SingleOrArrayGenericQueryParam;
29968
31026
  importTag?: string[];
29969
31027
  jobmetadata?: KeyValueObjectQueryParam;
@@ -30227,6 +31285,7 @@ declare const Storage_2: {
30227
31285
  * @param {object} options.pathParams - Path parameters
30228
31286
  * @param {string} options.pathParams.path
30229
31287
  * @param {object} [options.queryParams] - Query parameters
31288
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
30230
31289
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
30231
31290
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
30232
31291
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -30241,6 +31300,7 @@ declare const Storage_2: {
30241
31300
  path: string;
30242
31301
  };
30243
31302
  queryParams?: {
31303
+ holdJob?: boolean;
30244
31304
  jobmetadata?: KeyValueObjectQueryParam;
30245
31305
  notification?: string;
30246
31306
  notificationData?: KeyValueObjectQueryParam;
@@ -30322,6 +31382,7 @@ declare const Storage_2: {
30322
31382
  * @param {object} options.pathParams - Path parameters
30323
31383
  * @param {string} options.pathParams.path
30324
31384
  * @param {object} [options.queryParams] - Query parameters
31385
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
30325
31386
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
30326
31387
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
30327
31388
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -30336,6 +31397,7 @@ declare const Storage_2: {
30336
31397
  path: string;
30337
31398
  };
30338
31399
  queryParams?: {
31400
+ holdJob?: boolean;
30339
31401
  jobmetadata?: KeyValueObjectQueryParam;
30340
31402
  notification?: string;
30341
31403
  notificationData?: KeyValueObjectQueryParam;
@@ -30356,6 +31418,7 @@ declare const Storage_2: {
30356
31418
  * @param {object} options.pathParams - Path parameters
30357
31419
  * @param {string} options.pathParams.path
30358
31420
  * @param {object} [options.queryParams] - Query parameters
31421
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
30359
31422
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
30360
31423
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
30361
31424
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -30370,6 +31433,7 @@ declare const Storage_2: {
30370
31433
  path: string;
30371
31434
  };
30372
31435
  queryParams?: {
31436
+ holdJob?: boolean;
30373
31437
  jobmetadata?: KeyValueObjectQueryParam;
30374
31438
  notification?: string;
30375
31439
  notificationData?: KeyValueObjectQueryParam;
@@ -30703,6 +31767,31 @@ declare const Storage_2: {
30703
31767
  headers?: VidiCoreRequestHeaderConfig;
30704
31768
  requestConfig?: AxiosRequestConfig;
30705
31769
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
31770
+ /**
31771
+ * Get Storage Deletion Lock All Metadata By Path Prefix
31772
+ *
31773
+ * 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.
31774
+ *
31775
+ * - accept: `text/plain`
31776
+ *
31777
+ * @param {object} options
31778
+ * @param {object} options.pathParams - Path parameters
31779
+ * @param {string} options.pathParams.path
31780
+ * @param {string} options.pathParams.deletionLockId
31781
+ * @param {string} options.pathParams.prefix
31782
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
31783
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
31784
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
31785
+ */
31786
+ getStorageDeletionLockAllMetadataByPathPrefix: ({ pathParams: { path, deletionLockId, prefix }, headers, requestConfig, }: {
31787
+ pathParams: {
31788
+ path: string;
31789
+ deletionLockId: string;
31790
+ prefix: string;
31791
+ };
31792
+ headers?: VidiCoreRequestHeaderConfig;
31793
+ requestConfig?: AxiosRequestConfig;
31794
+ }) => Promise<AxiosResponse<string>>;
30706
31795
  /**
30707
31796
  * Delete Storage Entity By Path
30708
31797
  *
@@ -30770,6 +31859,7 @@ declare const Storage_2: {
30770
31859
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
30771
31860
  * @param {string} [options.queryParams.filename] - The original filename of the file.
30772
31861
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
31862
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
30773
31863
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
30774
31864
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
30775
31865
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -30803,6 +31893,7 @@ declare const Storage_2: {
30803
31893
  fastStartLength?: string;
30804
31894
  filename?: string;
30805
31895
  frameRate?: string;
31896
+ holdJob?: boolean;
30806
31897
  id?: SingleOrArrayGenericQueryParam;
30807
31898
  importTag?: string[];
30808
31899
  jobmetadata?: KeyValueObjectQueryParam;
@@ -30840,6 +31931,7 @@ declare const Storage_2: {
30840
31931
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
30841
31932
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
30842
31933
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
31934
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
30843
31935
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
30844
31936
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
30845
31937
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -30867,6 +31959,7 @@ declare const Storage_2: {
30867
31959
  createPosters?: string;
30868
31960
  createThumbnails?: boolean;
30869
31961
  fastStartLength?: string;
31962
+ holdJob?: boolean;
30870
31963
  id?: SingleOrArrayGenericQueryParam;
30871
31964
  importTag?: string[];
30872
31965
  jobmetadata?: KeyValueObjectQueryParam;
@@ -31018,6 +32111,29 @@ declare const Storage_2: {
31018
32111
  headers?: VidiCoreRequestHeaderConfig;
31019
32112
  requestConfig?: AxiosRequestConfig;
31020
32113
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
32114
+ /**
32115
+ * Get Storage All Metadata By Path Prefix
32116
+ *
32117
+ * 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.
32118
+ *
32119
+ * - accept: `text/plain`
32120
+ *
32121
+ * @param {object} options
32122
+ * @param {object} options.pathParams - Path parameters
32123
+ * @param {string} options.pathParams.path
32124
+ * @param {string} options.pathParams.prefix
32125
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
32126
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
32127
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
32128
+ */
32129
+ getStorageAllMetadataByPathPrefix: ({ pathParams: { path, prefix }, headers, requestConfig, }: {
32130
+ pathParams: {
32131
+ path: string;
32132
+ prefix: string;
32133
+ };
32134
+ headers?: VidiCoreRequestHeaderConfig;
32135
+ requestConfig?: AxiosRequestConfig;
32136
+ }) => Promise<AxiosResponse<string>>;
31021
32137
  /**
31022
32138
  * Reindex Storage By Path
31023
32139
  *
@@ -31105,6 +32221,7 @@ declare const Storage_2: {
31105
32221
  * @param {string} options.pathParams.targetStorageId
31106
32222
  * @param {object} [options.queryParams] - Query parameters
31107
32223
  * @param {string} [options.queryParams.filename] - The desired target filename.
32224
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31108
32225
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
31109
32226
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
31110
32227
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -31126,6 +32243,7 @@ declare const Storage_2: {
31126
32243
  };
31127
32244
  queryParams?: {
31128
32245
  filename?: string;
32246
+ holdJob?: boolean;
31129
32247
  jobmetadata?: KeyValueObjectQueryParam;
31130
32248
  limitRate?: number;
31131
32249
  move?: boolean;
@@ -31185,6 +32303,7 @@ declare const Storage_2: {
31185
32303
  * @param {object} options.pathParams - Path parameters
31186
32304
  * @param {string} options.pathParams.uri
31187
32305
  * @param {object} [options.queryParams] - Query parameters
32306
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31188
32307
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
31189
32308
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
31190
32309
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -31199,6 +32318,7 @@ declare const Storage_2: {
31199
32318
  uri: string;
31200
32319
  };
31201
32320
  queryParams?: {
32321
+ holdJob?: boolean;
31202
32322
  jobmetadata?: KeyValueObjectQueryParam;
31203
32323
  notification?: string;
31204
32324
  notificationData?: KeyValueObjectQueryParam;
@@ -31280,6 +32400,7 @@ declare const Storage_2: {
31280
32400
  * @param {object} options.pathParams - Path parameters
31281
32401
  * @param {string} options.pathParams.uri
31282
32402
  * @param {object} [options.queryParams] - Query parameters
32403
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31283
32404
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
31284
32405
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
31285
32406
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -31294,6 +32415,7 @@ declare const Storage_2: {
31294
32415
  uri: string;
31295
32416
  };
31296
32417
  queryParams?: {
32418
+ holdJob?: boolean;
31297
32419
  jobmetadata?: KeyValueObjectQueryParam;
31298
32420
  notification?: string;
31299
32421
  notificationData?: KeyValueObjectQueryParam;
@@ -31314,6 +32436,7 @@ declare const Storage_2: {
31314
32436
  * @param {object} options.pathParams - Path parameters
31315
32437
  * @param {string} options.pathParams.uri
31316
32438
  * @param {object} [options.queryParams] - Query parameters
32439
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31317
32440
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
31318
32441
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
31319
32442
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -31328,6 +32451,7 @@ declare const Storage_2: {
31328
32451
  uri: string;
31329
32452
  };
31330
32453
  queryParams?: {
32454
+ holdJob?: boolean;
31331
32455
  jobmetadata?: KeyValueObjectQueryParam;
31332
32456
  notification?: string;
31333
32457
  notificationData?: KeyValueObjectQueryParam;
@@ -31661,6 +32785,31 @@ declare const Storage_2: {
31661
32785
  headers?: VidiCoreRequestHeaderConfig;
31662
32786
  requestConfig?: AxiosRequestConfig;
31663
32787
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
32788
+ /**
32789
+ * Get Storage Deletion Lock All Metadata With Uri Prefix
32790
+ *
32791
+ * 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.
32792
+ *
32793
+ * - accept: `text/plain`
32794
+ *
32795
+ * @param {object} options
32796
+ * @param {object} options.pathParams - Path parameters
32797
+ * @param {string} options.pathParams.uri
32798
+ * @param {string} options.pathParams.deletionLockId
32799
+ * @param {string} options.pathParams.prefix
32800
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
32801
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
32802
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
32803
+ */
32804
+ getStorageDeletionLockAllMetadataWithUriPrefix: ({ pathParams: { uri, deletionLockId, prefix }, headers, requestConfig, }: {
32805
+ pathParams: {
32806
+ uri: string;
32807
+ deletionLockId: string;
32808
+ prefix: string;
32809
+ };
32810
+ headers?: VidiCoreRequestHeaderConfig;
32811
+ requestConfig?: AxiosRequestConfig;
32812
+ }) => Promise<AxiosResponse<string>>;
31664
32813
  /**
31665
32814
  * Delete Storage Entity With Uri
31666
32815
  *
@@ -31728,6 +32877,7 @@ declare const Storage_2: {
31728
32877
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
31729
32878
  * @param {string} [options.queryParams.filename] - The original filename of the file.
31730
32879
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
32880
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31731
32881
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
31732
32882
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
31733
32883
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -31761,6 +32911,7 @@ declare const Storage_2: {
31761
32911
  fastStartLength?: string;
31762
32912
  filename?: string;
31763
32913
  frameRate?: string;
32914
+ holdJob?: boolean;
31764
32915
  id?: SingleOrArrayGenericQueryParam;
31765
32916
  importTag?: string[];
31766
32917
  jobmetadata?: KeyValueObjectQueryParam;
@@ -31798,6 +32949,7 @@ declare const Storage_2: {
31798
32949
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
31799
32950
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
31800
32951
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
32952
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
31801
32953
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
31802
32954
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
31803
32955
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -31825,6 +32977,7 @@ declare const Storage_2: {
31825
32977
  createPosters?: string;
31826
32978
  createThumbnails?: boolean;
31827
32979
  fastStartLength?: string;
32980
+ holdJob?: boolean;
31828
32981
  id?: SingleOrArrayGenericQueryParam;
31829
32982
  importTag?: string[];
31830
32983
  jobmetadata?: KeyValueObjectQueryParam;
@@ -31976,6 +33129,29 @@ declare const Storage_2: {
31976
33129
  headers?: VidiCoreRequestHeaderConfig;
31977
33130
  requestConfig?: AxiosRequestConfig;
31978
33131
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
33132
+ /**
33133
+ * Get Storage All Metadata With Uri Prefix
33134
+ *
33135
+ * 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.
33136
+ *
33137
+ * - accept: `text/plain`
33138
+ *
33139
+ * @param {object} options
33140
+ * @param {object} options.pathParams - Path parameters
33141
+ * @param {string} options.pathParams.uri
33142
+ * @param {string} options.pathParams.prefix
33143
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
33144
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
33145
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
33146
+ */
33147
+ getStorageAllMetadataWithUriPrefix: ({ pathParams: { uri, prefix }, headers, requestConfig, }: {
33148
+ pathParams: {
33149
+ uri: string;
33150
+ prefix: string;
33151
+ };
33152
+ headers?: VidiCoreRequestHeaderConfig;
33153
+ requestConfig?: AxiosRequestConfig;
33154
+ }) => Promise<AxiosResponse<string>>;
31979
33155
  /**
31980
33156
  * Post Storage New Path With Uri
31981
33157
  *
@@ -32095,6 +33271,7 @@ declare const Storage_2: {
32095
33271
  * @param {string} options.pathParams.targetStorageId
32096
33272
  * @param {object} [options.queryParams] - Query parameters
32097
33273
  * @param {string} [options.queryParams.filename] - The desired target filename.
33274
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32098
33275
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
32099
33276
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
32100
33277
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -32116,6 +33293,7 @@ declare const Storage_2: {
32116
33293
  };
32117
33294
  queryParams?: {
32118
33295
  filename?: string;
33296
+ holdJob?: boolean;
32119
33297
  jobmetadata?: KeyValueObjectQueryParam;
32120
33298
  limitRate?: number;
32121
33299
  move?: boolean;
@@ -32173,6 +33351,7 @@ declare const Storage_2: {
32173
33351
  * @param {object} options.pathParams - Path parameters
32174
33352
  * @param {string} options.pathParams.fileId
32175
33353
  * @param {object} [options.queryParams] - Query parameters
33354
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32176
33355
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
32177
33356
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
32178
33357
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -32187,6 +33366,7 @@ declare const Storage_2: {
32187
33366
  fileId: string;
32188
33367
  };
32189
33368
  queryParams?: {
33369
+ holdJob?: boolean;
32190
33370
  jobmetadata?: KeyValueObjectQueryParam;
32191
33371
  notification?: string;
32192
33372
  notificationData?: KeyValueObjectQueryParam;
@@ -32262,6 +33442,7 @@ declare const Storage_2: {
32262
33442
  * @param {object} options.pathParams - Path parameters
32263
33443
  * @param {string} options.pathParams.fileId
32264
33444
  * @param {object} [options.queryParams] - Query parameters
33445
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32265
33446
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
32266
33447
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
32267
33448
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -32276,6 +33457,7 @@ declare const Storage_2: {
32276
33457
  fileId: string;
32277
33458
  };
32278
33459
  queryParams?: {
33460
+ holdJob?: boolean;
32279
33461
  jobmetadata?: KeyValueObjectQueryParam;
32280
33462
  notification?: string;
32281
33463
  notificationData?: KeyValueObjectQueryParam;
@@ -32294,6 +33476,7 @@ declare const Storage_2: {
32294
33476
  * @param {object} options.pathParams - Path parameters
32295
33477
  * @param {string} options.pathParams.fileId
32296
33478
  * @param {object} [options.queryParams] - Query parameters
33479
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32297
33480
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
32298
33481
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
32299
33482
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -32308,6 +33491,7 @@ declare const Storage_2: {
32308
33491
  fileId: string;
32309
33492
  };
32310
33493
  queryParams?: {
33494
+ holdJob?: boolean;
32311
33495
  jobmetadata?: KeyValueObjectQueryParam;
32312
33496
  notification?: string;
32313
33497
  notificationData?: KeyValueObjectQueryParam;
@@ -32615,6 +33799,29 @@ declare const Storage_2: {
32615
33799
  headers?: VidiCoreRequestHeaderConfig;
32616
33800
  requestConfig?: AxiosRequestConfig;
32617
33801
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
33802
+ /**
33803
+ * Get File Deletion Lock Storage All Metadata Prefix
33804
+ *
33805
+ * - accept: `text/plain`
33806
+ *
33807
+ * @param {object} options
33808
+ * @param {object} options.pathParams - Path parameters
33809
+ * @param {string} options.pathParams.fileId
33810
+ * @param {string} options.pathParams.deletionLockId
33811
+ * @param {string} options.pathParams.prefix
33812
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
33813
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
33814
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
33815
+ */
33816
+ getFileDeletionLockStorageAllMetadataPrefix: ({ pathParams: { fileId, deletionLockId, prefix }, headers, requestConfig, }: {
33817
+ pathParams: {
33818
+ fileId: string;
33819
+ deletionLockId: string;
33820
+ prefix: string;
33821
+ };
33822
+ headers?: VidiCoreRequestHeaderConfig;
33823
+ requestConfig?: AxiosRequestConfig;
33824
+ }) => Promise<AxiosResponse<string>>;
32618
33825
  /**
32619
33826
  * Delete File Storage Entity
32620
33827
  *
@@ -32676,6 +33883,7 @@ declare const Storage_2: {
32676
33883
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
32677
33884
  * @param {string} [options.queryParams.filename] - The original filename of the file.
32678
33885
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
33886
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32679
33887
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
32680
33888
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
32681
33889
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -32709,6 +33917,7 @@ declare const Storage_2: {
32709
33917
  fastStartLength?: string;
32710
33918
  filename?: string;
32711
33919
  frameRate?: string;
33920
+ holdJob?: boolean;
32712
33921
  id?: SingleOrArrayGenericQueryParam;
32713
33922
  importTag?: string[];
32714
33923
  jobmetadata?: KeyValueObjectQueryParam;
@@ -32744,6 +33953,7 @@ declare const Storage_2: {
32744
33953
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
32745
33954
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
32746
33955
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
33956
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
32747
33957
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
32748
33958
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
32749
33959
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -32771,6 +33981,7 @@ declare const Storage_2: {
32771
33981
  createPosters?: string;
32772
33982
  createThumbnails?: boolean;
32773
33983
  fastStartLength?: string;
33984
+ holdJob?: boolean;
32774
33985
  id?: SingleOrArrayGenericQueryParam;
32775
33986
  importTag?: string[];
32776
33987
  jobmetadata?: KeyValueObjectQueryParam;
@@ -32910,6 +34121,27 @@ declare const Storage_2: {
32910
34121
  headers?: VidiCoreRequestHeaderConfig;
32911
34122
  requestConfig?: AxiosRequestConfig;
32912
34123
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
34124
+ /**
34125
+ * Get File Storage All Metadata Prefix
34126
+ *
34127
+ * - accept: `text/plain`
34128
+ *
34129
+ * @param {object} options
34130
+ * @param {object} options.pathParams - Path parameters
34131
+ * @param {string} options.pathParams.fileId
34132
+ * @param {string} options.pathParams.prefix
34133
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
34134
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
34135
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
34136
+ */
34137
+ getFileStorageAllMetadataPrefix: ({ pathParams: { fileId, prefix }, headers, requestConfig, }: {
34138
+ pathParams: {
34139
+ fileId: string;
34140
+ prefix: string;
34141
+ };
34142
+ headers?: VidiCoreRequestHeaderConfig;
34143
+ requestConfig?: AxiosRequestConfig;
34144
+ }) => Promise<AxiosResponse<string>>;
32913
34145
  /**
32914
34146
  * Post File Storage New Path
32915
34147
  *
@@ -33019,6 +34251,7 @@ declare const Storage_2: {
33019
34251
  * @param {string} options.pathParams.targetStorageId
33020
34252
  * @param {object} [options.queryParams] - Query parameters
33021
34253
  * @param {string} [options.queryParams.filename] - The desired target filename.
34254
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
33022
34255
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
33023
34256
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
33024
34257
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -33040,6 +34273,7 @@ declare const Storage_2: {
33040
34273
  };
33041
34274
  queryParams?: {
33042
34275
  filename?: string;
34276
+ holdJob?: boolean;
33043
34277
  jobmetadata?: KeyValueObjectQueryParam;
33044
34278
  limitRate?: number;
33045
34279
  move?: boolean;
@@ -33606,6 +34840,29 @@ declare const Storage_2: {
33606
34840
  headers?: VidiCoreRequestHeaderConfig;
33607
34841
  requestConfig?: AxiosRequestConfig;
33608
34842
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
34843
+ /**
34844
+ * Get Storage Group All Metadata Prefix
34845
+ *
34846
+ * 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.
34847
+ *
34848
+ * - accept: `text/plain`
34849
+ *
34850
+ * @param {object} options
34851
+ * @param {object} options.pathParams - Path parameters
34852
+ * @param {string} options.pathParams.groupName
34853
+ * @param {string} options.pathParams.prefix
34854
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
34855
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
34856
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
34857
+ */
34858
+ getStorageGroupAllMetadataPrefix: ({ pathParams: { groupName, prefix }, headers, requestConfig, }: {
34859
+ pathParams: {
34860
+ groupName: string;
34861
+ prefix: string;
34862
+ };
34863
+ headers?: VidiCoreRequestHeaderConfig;
34864
+ requestConfig?: AxiosRequestConfig;
34865
+ }) => Promise<AxiosResponse<string>>;
33609
34866
  /**
33610
34867
  * Delete Storage Group Member
33611
34868
  *
@@ -34060,6 +35317,7 @@ declare const Storage_2: {
34060
35317
  * @param {object} [options.queryParams] - Query parameters
34061
35318
  * @param {boolean} [options.queryParams.createOnly=true] - true (default) - Fail if a file with that path already exists. false - Update the existing file if one exists, else create a new file entity.
34062
35319
  * @param {string} [options.queryParams.path] - The path of the file on the storage.
35320
+ * @param {string} [options.queryParams.range] - The sequence range, if the entity should represent a file sequence. The syntax is described in <sequence-uri>.
34063
35321
  * @param {string} [options.queryParams.state] - The state of the file. Default is OPEN.
34064
35322
  * @param {string} [options.queryParams.uri] - The absolute file URI (should be relative to the URI of a storage method).
34065
35323
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
@@ -34073,6 +35331,7 @@ declare const Storage_2: {
34073
35331
  queryParams?: {
34074
35332
  createOnly?: boolean;
34075
35333
  path?: string;
35334
+ range?: string;
34076
35335
  state?: string;
34077
35336
  uri?: string;
34078
35337
  };
@@ -34388,6 +35647,31 @@ declare const Storage_2: {
34388
35647
  headers?: VidiCoreRequestHeaderConfig;
34389
35648
  requestConfig?: AxiosRequestConfig;
34390
35649
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
35650
+ /**
35651
+ * Get Storage Deletion Lock By Id File List All Metadata Prefix
35652
+ *
35653
+ * 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.
35654
+ *
35655
+ * - accept: `text/plain`
35656
+ *
35657
+ * @param {object} options
35658
+ * @param {object} options.pathParams - Path parameters
35659
+ * @param {string} options.pathParams.storageId
35660
+ * @param {string} options.pathParams.deletionLockId
35661
+ * @param {string} options.pathParams.prefix
35662
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
35663
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
35664
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
35665
+ */
35666
+ getStorageDeletionLockByIdFileListAllMetadataPrefix: ({ pathParams: { storageId, deletionLockId, prefix }, headers, requestConfig, }: {
35667
+ pathParams: {
35668
+ storageId: string;
35669
+ deletionLockId: string;
35670
+ prefix: string;
35671
+ };
35672
+ headers?: VidiCoreRequestHeaderConfig;
35673
+ requestConfig?: AxiosRequestConfig;
35674
+ }) => Promise<AxiosResponse<string>>;
34391
35675
  /**
34392
35676
  * Post Storage By Id File Import
34393
35677
  *
@@ -34409,6 +35693,7 @@ declare const Storage_2: {
34409
35693
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
34410
35694
  * @param {string} [options.queryParams.filename] - The original filename of the file.
34411
35695
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
35696
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
34412
35697
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
34413
35698
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
34414
35699
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -34446,6 +35731,7 @@ declare const Storage_2: {
34446
35731
  fastStartLength?: string;
34447
35732
  filename?: string;
34448
35733
  frameRate?: string;
35734
+ holdJob?: boolean;
34449
35735
  id?: SingleOrArrayGenericQueryParam;
34450
35736
  importTag?: string[];
34451
35737
  jobmetadata?: KeyValueObjectQueryParam;
@@ -34487,6 +35773,7 @@ declare const Storage_2: {
34487
35773
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
34488
35774
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
34489
35775
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
35776
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
34490
35777
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
34491
35778
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
34492
35779
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -34518,6 +35805,7 @@ declare const Storage_2: {
34518
35805
  createPosters?: string;
34519
35806
  createThumbnails?: boolean;
34520
35807
  fastStartLength?: string;
35808
+ holdJob?: boolean;
34521
35809
  id?: SingleOrArrayGenericQueryParam;
34522
35810
  importTag?: string[];
34523
35811
  jobmetadata?: KeyValueObjectQueryParam;
@@ -34586,6 +35874,7 @@ declare const Storage_2: {
34586
35874
  * @param {string} options.pathParams.storageId
34587
35875
  * @param {string} options.pathParams.path
34588
35876
  * @param {object} [options.queryParams] - Query parameters
35877
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
34589
35878
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
34590
35879
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
34591
35880
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -34601,6 +35890,7 @@ declare const Storage_2: {
34601
35890
  path: string;
34602
35891
  };
34603
35892
  queryParams?: {
35893
+ holdJob?: boolean;
34604
35894
  jobmetadata?: KeyValueObjectQueryParam;
34605
35895
  notification?: string;
34606
35896
  notificationData?: KeyValueObjectQueryParam;
@@ -34687,6 +35977,7 @@ declare const Storage_2: {
34687
35977
  * @param {string} options.pathParams.storageId
34688
35978
  * @param {string} options.pathParams.path
34689
35979
  * @param {object} [options.queryParams] - Query parameters
35980
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
34690
35981
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
34691
35982
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
34692
35983
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -34702,6 +35993,7 @@ declare const Storage_2: {
34702
35993
  path: string;
34703
35994
  };
34704
35995
  queryParams?: {
35996
+ holdJob?: boolean;
34705
35997
  jobmetadata?: KeyValueObjectQueryParam;
34706
35998
  notification?: string;
34707
35999
  notificationData?: KeyValueObjectQueryParam;
@@ -34723,6 +36015,7 @@ declare const Storage_2: {
34723
36015
  * @param {string} options.pathParams.storageId
34724
36016
  * @param {string} options.pathParams.path
34725
36017
  * @param {object} [options.queryParams] - Query parameters
36018
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
34726
36019
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
34727
36020
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
34728
36021
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -34738,6 +36031,7 @@ declare const Storage_2: {
34738
36031
  path: string;
34739
36032
  };
34740
36033
  queryParams?: {
36034
+ holdJob?: boolean;
34741
36035
  jobmetadata?: KeyValueObjectQueryParam;
34742
36036
  notification?: string;
34743
36037
  notificationData?: KeyValueObjectQueryParam;
@@ -35097,6 +36391,33 @@ declare const Storage_2: {
35097
36391
  headers?: VidiCoreRequestHeaderConfig;
35098
36392
  requestConfig?: AxiosRequestConfig;
35099
36393
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
36394
+ /**
36395
+ * Get Storage Deletion Lock By Id File All Metadata By Path Prefix
36396
+ *
36397
+ * 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.
36398
+ *
36399
+ * - accept: `text/plain`
36400
+ *
36401
+ * @param {object} options
36402
+ * @param {object} options.pathParams - Path parameters
36403
+ * @param {string} options.pathParams.storageId
36404
+ * @param {string} options.pathParams.path
36405
+ * @param {string} options.pathParams.deletionLockId
36406
+ * @param {string} options.pathParams.prefix
36407
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
36408
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
36409
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
36410
+ */
36411
+ getStorageDeletionLockByIdFileAllMetadataByPathPrefix: ({ pathParams: { storageId, path, deletionLockId, prefix }, headers, requestConfig, }: {
36412
+ pathParams: {
36413
+ storageId: string;
36414
+ path: string;
36415
+ deletionLockId: string;
36416
+ prefix: string;
36417
+ };
36418
+ headers?: VidiCoreRequestHeaderConfig;
36419
+ requestConfig?: AxiosRequestConfig;
36420
+ }) => Promise<AxiosResponse<string>>;
35100
36421
  /**
35101
36422
  * Delete Storage By Id File Entity By Path
35102
36423
  *
@@ -35169,6 +36490,7 @@ declare const Storage_2: {
35169
36490
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
35170
36491
  * @param {string} [options.queryParams.filename] - The original filename of the file.
35171
36492
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
36493
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35172
36494
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
35173
36495
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
35174
36496
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -35203,6 +36525,7 @@ declare const Storage_2: {
35203
36525
  fastStartLength?: string;
35204
36526
  filename?: string;
35205
36527
  frameRate?: string;
36528
+ holdJob?: boolean;
35206
36529
  id?: SingleOrArrayGenericQueryParam;
35207
36530
  importTag?: string[];
35208
36531
  jobmetadata?: KeyValueObjectQueryParam;
@@ -35241,6 +36564,7 @@ declare const Storage_2: {
35241
36564
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
35242
36565
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
35243
36566
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
36567
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35244
36568
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
35245
36569
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
35246
36570
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -35269,6 +36593,7 @@ declare const Storage_2: {
35269
36593
  createPosters?: string;
35270
36594
  createThumbnails?: boolean;
35271
36595
  fastStartLength?: string;
36596
+ holdJob?: boolean;
35272
36597
  id?: SingleOrArrayGenericQueryParam;
35273
36598
  importTag?: string[];
35274
36599
  jobmetadata?: KeyValueObjectQueryParam;
@@ -35432,6 +36757,31 @@ declare const Storage_2: {
35432
36757
  headers?: VidiCoreRequestHeaderConfig;
35433
36758
  requestConfig?: AxiosRequestConfig;
35434
36759
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
36760
+ /**
36761
+ * Get Storage By Id File All Metadata By Path Prefix
36762
+ *
36763
+ * 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.
36764
+ *
36765
+ * - accept: `text/plain`
36766
+ *
36767
+ * @param {object} options
36768
+ * @param {object} options.pathParams - Path parameters
36769
+ * @param {string} options.pathParams.storageId
36770
+ * @param {string} options.pathParams.path
36771
+ * @param {string} options.pathParams.prefix
36772
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
36773
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
36774
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
36775
+ */
36776
+ getStorageByIdFileAllMetadataByPathPrefix: ({ pathParams: { storageId, path, prefix }, headers, requestConfig, }: {
36777
+ pathParams: {
36778
+ storageId: string;
36779
+ path: string;
36780
+ prefix: string;
36781
+ };
36782
+ headers?: VidiCoreRequestHeaderConfig;
36783
+ requestConfig?: AxiosRequestConfig;
36784
+ }) => Promise<AxiosResponse<string>>;
35435
36785
  /**
35436
36786
  * Reindex Storage By Id File By Path
35437
36787
  *
@@ -35526,6 +36876,7 @@ declare const Storage_2: {
35526
36876
  * @param {string} options.pathParams.targetStorageId
35527
36877
  * @param {object} [options.queryParams] - Query parameters
35528
36878
  * @param {string} [options.queryParams.filename] - The desired target filename.
36879
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35529
36880
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
35530
36881
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
35531
36882
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -35548,6 +36899,7 @@ declare const Storage_2: {
35548
36899
  };
35549
36900
  queryParams?: {
35550
36901
  filename?: string;
36902
+ holdJob?: boolean;
35551
36903
  jobmetadata?: KeyValueObjectQueryParam;
35552
36904
  limitRate?: number;
35553
36905
  move?: boolean;
@@ -35610,6 +36962,7 @@ declare const Storage_2: {
35610
36962
  * @param {string} options.pathParams.storageId
35611
36963
  * @param {string} options.pathParams.uri
35612
36964
  * @param {object} [options.queryParams] - Query parameters
36965
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35613
36966
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
35614
36967
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
35615
36968
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -35625,6 +36978,7 @@ declare const Storage_2: {
35625
36978
  uri: string;
35626
36979
  };
35627
36980
  queryParams?: {
36981
+ holdJob?: boolean;
35628
36982
  jobmetadata?: KeyValueObjectQueryParam;
35629
36983
  notification?: string;
35630
36984
  notificationData?: KeyValueObjectQueryParam;
@@ -35711,6 +37065,7 @@ declare const Storage_2: {
35711
37065
  * @param {string} options.pathParams.storageId
35712
37066
  * @param {string} options.pathParams.uri
35713
37067
  * @param {object} [options.queryParams] - Query parameters
37068
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35714
37069
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
35715
37070
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
35716
37071
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -35726,6 +37081,7 @@ declare const Storage_2: {
35726
37081
  uri: string;
35727
37082
  };
35728
37083
  queryParams?: {
37084
+ holdJob?: boolean;
35729
37085
  jobmetadata?: KeyValueObjectQueryParam;
35730
37086
  notification?: string;
35731
37087
  notificationData?: KeyValueObjectQueryParam;
@@ -35747,6 +37103,7 @@ declare const Storage_2: {
35747
37103
  * @param {string} options.pathParams.storageId
35748
37104
  * @param {string} options.pathParams.uri
35749
37105
  * @param {object} [options.queryParams] - Query parameters
37106
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
35750
37107
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
35751
37108
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
35752
37109
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -35762,6 +37119,7 @@ declare const Storage_2: {
35762
37119
  uri: string;
35763
37120
  };
35764
37121
  queryParams?: {
37122
+ holdJob?: boolean;
35765
37123
  jobmetadata?: KeyValueObjectQueryParam;
35766
37124
  notification?: string;
35767
37125
  notificationData?: KeyValueObjectQueryParam;
@@ -36121,6 +37479,33 @@ declare const Storage_2: {
36121
37479
  headers?: VidiCoreRequestHeaderConfig;
36122
37480
  requestConfig?: AxiosRequestConfig;
36123
37481
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
37482
+ /**
37483
+ * Get Storage Deletion Lock By Id File All Metadata With Uri Prefix
37484
+ *
37485
+ * 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.
37486
+ *
37487
+ * - accept: `text/plain`
37488
+ *
37489
+ * @param {object} options
37490
+ * @param {object} options.pathParams - Path parameters
37491
+ * @param {string} options.pathParams.storageId
37492
+ * @param {string} options.pathParams.uri
37493
+ * @param {string} options.pathParams.deletionLockId
37494
+ * @param {string} options.pathParams.prefix
37495
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
37496
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
37497
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
37498
+ */
37499
+ getStorageDeletionLockByIdFileAllMetadataWithUriPrefix: ({ pathParams: { storageId, uri, deletionLockId, prefix }, headers, requestConfig, }: {
37500
+ pathParams: {
37501
+ storageId: string;
37502
+ uri: string;
37503
+ deletionLockId: string;
37504
+ prefix: string;
37505
+ };
37506
+ headers?: VidiCoreRequestHeaderConfig;
37507
+ requestConfig?: AxiosRequestConfig;
37508
+ }) => Promise<AxiosResponse<string>>;
36124
37509
  /**
36125
37510
  * Delete Storage By Id File Entity With Uri
36126
37511
  *
@@ -36193,6 +37578,7 @@ declare const Storage_2: {
36193
37578
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
36194
37579
  * @param {string} [options.queryParams.filename] - The original filename of the file.
36195
37580
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
37581
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36196
37582
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
36197
37583
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
36198
37584
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -36227,6 +37613,7 @@ declare const Storage_2: {
36227
37613
  fastStartLength?: string;
36228
37614
  filename?: string;
36229
37615
  frameRate?: string;
37616
+ holdJob?: boolean;
36230
37617
  id?: SingleOrArrayGenericQueryParam;
36231
37618
  importTag?: string[];
36232
37619
  jobmetadata?: KeyValueObjectQueryParam;
@@ -36265,6 +37652,7 @@ declare const Storage_2: {
36265
37652
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
36266
37653
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
36267
37654
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
37655
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36268
37656
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
36269
37657
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
36270
37658
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -36293,6 +37681,7 @@ declare const Storage_2: {
36293
37681
  createPosters?: string;
36294
37682
  createThumbnails?: boolean;
36295
37683
  fastStartLength?: string;
37684
+ holdJob?: boolean;
36296
37685
  id?: SingleOrArrayGenericQueryParam;
36297
37686
  importTag?: string[];
36298
37687
  jobmetadata?: KeyValueObjectQueryParam;
@@ -36456,6 +37845,31 @@ declare const Storage_2: {
36456
37845
  headers?: VidiCoreRequestHeaderConfig;
36457
37846
  requestConfig?: AxiosRequestConfig;
36458
37847
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
37848
+ /**
37849
+ * Get Storage By Id File All Metadata With Uri Prefix
37850
+ *
37851
+ * 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.
37852
+ *
37853
+ * - accept: `text/plain`
37854
+ *
37855
+ * @param {object} options
37856
+ * @param {object} options.pathParams - Path parameters
37857
+ * @param {string} options.pathParams.storageId
37858
+ * @param {string} options.pathParams.uri
37859
+ * @param {string} options.pathParams.prefix
37860
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
37861
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
37862
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
37863
+ */
37864
+ getStorageByIdFileAllMetadataWithUriPrefix: ({ pathParams: { storageId, uri, prefix }, headers, requestConfig, }: {
37865
+ pathParams: {
37866
+ storageId: string;
37867
+ uri: string;
37868
+ prefix: string;
37869
+ };
37870
+ headers?: VidiCoreRequestHeaderConfig;
37871
+ requestConfig?: AxiosRequestConfig;
37872
+ }) => Promise<AxiosResponse<string>>;
36459
37873
  /**
36460
37874
  * Post Storage By Id File New Path With Uri
36461
37875
  *
@@ -36584,6 +37998,7 @@ declare const Storage_2: {
36584
37998
  * @param {string} options.pathParams.targetStorageId
36585
37999
  * @param {object} [options.queryParams] - Query parameters
36586
38000
  * @param {string} [options.queryParams.filename] - The desired target filename.
38001
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36587
38002
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
36588
38003
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
36589
38004
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -36606,6 +38021,7 @@ declare const Storage_2: {
36606
38021
  };
36607
38022
  queryParams?: {
36608
38023
  filename?: string;
38024
+ holdJob?: boolean;
36609
38025
  jobmetadata?: KeyValueObjectQueryParam;
36610
38026
  limitRate?: number;
36611
38027
  move?: boolean;
@@ -36666,6 +38082,7 @@ declare const Storage_2: {
36666
38082
  * @param {string} options.pathParams.storageId
36667
38083
  * @param {string} options.pathParams.fileId
36668
38084
  * @param {object} [options.queryParams] - Query parameters
38085
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36669
38086
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
36670
38087
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
36671
38088
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -36681,6 +38098,7 @@ declare const Storage_2: {
36681
38098
  fileId: string;
36682
38099
  };
36683
38100
  queryParams?: {
38101
+ holdJob?: boolean;
36684
38102
  jobmetadata?: KeyValueObjectQueryParam;
36685
38103
  notification?: string;
36686
38104
  notificationData?: KeyValueObjectQueryParam;
@@ -36761,6 +38179,7 @@ declare const Storage_2: {
36761
38179
  * @param {string} options.pathParams.storageId
36762
38180
  * @param {string} options.pathParams.fileId
36763
38181
  * @param {object} [options.queryParams] - Query parameters
38182
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36764
38183
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
36765
38184
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
36766
38185
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -36776,6 +38195,7 @@ declare const Storage_2: {
36776
38195
  fileId: string;
36777
38196
  };
36778
38197
  queryParams?: {
38198
+ holdJob?: boolean;
36779
38199
  jobmetadata?: KeyValueObjectQueryParam;
36780
38200
  notification?: string;
36781
38201
  notificationData?: KeyValueObjectQueryParam;
@@ -36795,6 +38215,7 @@ declare const Storage_2: {
36795
38215
  * @param {string} options.pathParams.storageId
36796
38216
  * @param {string} options.pathParams.fileId
36797
38217
  * @param {object} [options.queryParams] - Query parameters
38218
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
36798
38219
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
36799
38220
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
36800
38221
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -36810,6 +38231,7 @@ declare const Storage_2: {
36810
38231
  fileId: string;
36811
38232
  };
36812
38233
  queryParams?: {
38234
+ holdJob?: boolean;
36813
38235
  jobmetadata?: KeyValueObjectQueryParam;
36814
38236
  notification?: string;
36815
38237
  notificationData?: KeyValueObjectQueryParam;
@@ -37143,6 +38565,31 @@ declare const Storage_2: {
37143
38565
  headers?: VidiCoreRequestHeaderConfig;
37144
38566
  requestConfig?: AxiosRequestConfig;
37145
38567
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
38568
+ /**
38569
+ * Get Storage Deletion Lock By Id File All Metadata Prefix
38570
+ *
38571
+ * - accept: `text/plain`
38572
+ *
38573
+ * @param {object} options
38574
+ * @param {object} options.pathParams - Path parameters
38575
+ * @param {string} options.pathParams.storageId
38576
+ * @param {string} options.pathParams.fileId
38577
+ * @param {string} options.pathParams.deletionLockId
38578
+ * @param {string} options.pathParams.prefix
38579
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
38580
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
38581
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
38582
+ */
38583
+ getStorageDeletionLockByIdFileAllMetadataPrefix: ({ pathParams: { storageId, fileId, deletionLockId, prefix }, headers, requestConfig, }: {
38584
+ pathParams: {
38585
+ storageId: string;
38586
+ fileId: string;
38587
+ deletionLockId: string;
38588
+ prefix: string;
38589
+ };
38590
+ headers?: VidiCoreRequestHeaderConfig;
38591
+ requestConfig?: AxiosRequestConfig;
38592
+ }) => Promise<AxiosResponse<string>>;
37146
38593
  /**
37147
38594
  * Delete Storage By Id File Entity
37148
38595
  *
@@ -37209,6 +38656,7 @@ declare const Storage_2: {
37209
38656
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
37210
38657
  * @param {string} [options.queryParams.filename] - The original filename of the file.
37211
38658
  * @param {string} [options.queryParams.frameRate] - New in version 22.1. The frame rate of the image sequence.
38659
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
37212
38660
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
37213
38661
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
37214
38662
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -37243,6 +38691,7 @@ declare const Storage_2: {
37243
38691
  fastStartLength?: string;
37244
38692
  filename?: string;
37245
38693
  frameRate?: string;
38694
+ holdJob?: boolean;
37246
38695
  id?: SingleOrArrayGenericQueryParam;
37247
38696
  importTag?: string[];
37248
38697
  jobmetadata?: KeyValueObjectQueryParam;
@@ -37279,6 +38728,7 @@ declare const Storage_2: {
37279
38728
  * @param {string} [options.queryParams.createPosters] - A list of time codes to use for creating posters.
37280
38729
  * @param {boolean} [options.queryParams.createThumbnails] - true (default) - Generate thumbnails as per defined by shape tag. false - Disable thumbnail generation.
37281
38730
  * @param {string} [options.queryParams.fastStartLength] - Estimated duration of the clip in seconds.
38731
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
37282
38732
  * @param {SingleOrArrayGenericQueryParam} [options.queryParams.id] - Comma-delimited list of external ids to assign to the item.
37283
38733
  * @param {string[]} [options.queryParams.importTag] - A list of shape tags that the created shape will be associated with. Default is original.
37284
38734
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
@@ -37307,6 +38757,7 @@ declare const Storage_2: {
37307
38757
  createPosters?: string;
37308
38758
  createThumbnails?: boolean;
37309
38759
  fastStartLength?: string;
38760
+ holdJob?: boolean;
37310
38761
  id?: SingleOrArrayGenericQueryParam;
37311
38762
  importTag?: string[];
37312
38763
  jobmetadata?: KeyValueObjectQueryParam;
@@ -37458,6 +38909,29 @@ declare const Storage_2: {
37458
38909
  headers?: VidiCoreRequestHeaderConfig;
37459
38910
  requestConfig?: AxiosRequestConfig;
37460
38911
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
38912
+ /**
38913
+ * Get Storage By Id File All Metadata Prefix
38914
+ *
38915
+ * - accept: `text/plain`
38916
+ *
38917
+ * @param {object} options
38918
+ * @param {object} options.pathParams - Path parameters
38919
+ * @param {string} options.pathParams.storageId
38920
+ * @param {string} options.pathParams.fileId
38921
+ * @param {string} options.pathParams.prefix
38922
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
38923
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
38924
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
38925
+ */
38926
+ getStorageByIdFileAllMetadataPrefix: ({ pathParams: { storageId, fileId, prefix }, headers, requestConfig, }: {
38927
+ pathParams: {
38928
+ storageId: string;
38929
+ fileId: string;
38930
+ prefix: string;
38931
+ };
38932
+ headers?: VidiCoreRequestHeaderConfig;
38933
+ requestConfig?: AxiosRequestConfig;
38934
+ }) => Promise<AxiosResponse<string>>;
37461
38935
  /**
37462
38936
  * Post Storage By Id File By Id New Path
37463
38937
  *
@@ -37576,6 +39050,7 @@ declare const Storage_2: {
37576
39050
  * @param {string} options.pathParams.targetStorageId
37577
39051
  * @param {object} [options.queryParams] - Query parameters
37578
39052
  * @param {string} [options.queryParams.filename] - The desired target filename.
39053
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
37579
39054
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
37580
39055
  * @param {number} [options.queryParams.limitRate] - Throttle the rate at which the transfer takes place (bytes/second).
37581
39056
  * @param {boolean} [options.queryParams.move] - true - Delete the original file when the copy has finished. false - Just copy the file, and leave the original.
@@ -37598,6 +39073,7 @@ declare const Storage_2: {
37598
39073
  };
37599
39074
  queryParams?: {
37600
39075
  filename?: string;
39076
+ holdJob?: boolean;
37601
39077
  jobmetadata?: KeyValueObjectQueryParam;
37602
39078
  limitRate?: number;
37603
39079
  move?: boolean;
@@ -37877,6 +39353,29 @@ declare const Storage_2: {
37877
39353
  headers?: VidiCoreRequestHeaderConfig;
37878
39354
  requestConfig?: AxiosRequestConfig;
37879
39355
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
39356
+ /**
39357
+ * Get Storage All Metadata Prefix
39358
+ *
39359
+ * 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.
39360
+ *
39361
+ * - accept: `text/plain`
39362
+ *
39363
+ * @param {object} options
39364
+ * @param {object} options.pathParams - Path parameters
39365
+ * @param {string} options.pathParams.storageId
39366
+ * @param {string} options.pathParams.prefix
39367
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
39368
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
39369
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
39370
+ */
39371
+ getStorageAllMetadataPrefix: ({ pathParams: { storageId, prefix }, headers, requestConfig, }: {
39372
+ pathParams: {
39373
+ storageId: string;
39374
+ prefix: string;
39375
+ };
39376
+ headers?: VidiCoreRequestHeaderConfig;
39377
+ requestConfig?: AxiosRequestConfig;
39378
+ }) => Promise<AxiosResponse<string>>;
37880
39379
  /**
37881
39380
  * Delete Storage Method By Url
37882
39381
  *
@@ -38197,6 +39696,31 @@ declare const Storage_2: {
38197
39696
  headers?: VidiCoreRequestHeaderConfig;
38198
39697
  requestConfig?: AxiosRequestConfig;
38199
39698
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
39699
+ /**
39700
+ * Get Storage Method All Metadata Prefix
39701
+ *
39702
+ * 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.
39703
+ *
39704
+ * - accept: `text/plain`
39705
+ *
39706
+ * @param {object} options
39707
+ * @param {object} options.pathParams - Path parameters
39708
+ * @param {string} options.pathParams.storageId
39709
+ * @param {string} options.pathParams.methodId
39710
+ * @param {string} options.pathParams.prefix
39711
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
39712
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
39713
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
39714
+ */
39715
+ getStorageMethodAllMetadataPrefix: ({ pathParams: { storageId, methodId, prefix }, headers, requestConfig, }: {
39716
+ pathParams: {
39717
+ storageId: string;
39718
+ methodId: string;
39719
+ prefix: string;
39720
+ };
39721
+ headers?: VidiCoreRequestHeaderConfig;
39722
+ requestConfig?: AxiosRequestConfig;
39723
+ }) => Promise<AxiosResponse<string>>;
38200
39724
  /**
38201
39725
  * Delete Storage Notifications
38202
39726
  *
@@ -38915,6 +40439,31 @@ export declare const TaskDefinition: {
38915
40439
  headers?: VidiCoreRequestHeaderConfig;
38916
40440
  requestConfig?: AxiosRequestConfig;
38917
40441
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
40442
+ /**
40443
+ * Get Task Definition All Metadata Prefix By Step By Type
40444
+ *
40445
+ * 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.
40446
+ *
40447
+ * - accept: `text/plain`
40448
+ *
40449
+ * @param {object} options
40450
+ * @param {object} options.pathParams - Path parameters
40451
+ * @param {string} options.pathParams.type
40452
+ * @param {number} options.pathParams.step
40453
+ * @param {string} options.pathParams.prefix
40454
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
40455
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
40456
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
40457
+ */
40458
+ getTaskDefinitionAllMetadataPrefixByStepByType: ({ pathParams: { type, step, prefix }, headers, requestConfig, }: {
40459
+ pathParams: {
40460
+ type: string;
40461
+ step: number;
40462
+ prefix: string;
40463
+ };
40464
+ headers?: VidiCoreRequestHeaderConfig;
40465
+ requestConfig?: AxiosRequestConfig;
40466
+ }) => Promise<AxiosResponse<string>>;
38918
40467
  /**
38919
40468
  * Get Task Definition Script By Step By Type
38920
40469
  *
@@ -39181,6 +40730,29 @@ export declare const TaskDefinition: {
39181
40730
  headers?: VidiCoreRequestHeaderConfig;
39182
40731
  requestConfig?: AxiosRequestConfig;
39183
40732
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
40733
+ /**
40734
+ * Get Task Definition All Metadata Prefix
40735
+ *
40736
+ * 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.
40737
+ *
40738
+ * - accept: `text/plain`
40739
+ *
40740
+ * @param {object} options
40741
+ * @param {object} options.pathParams - Path parameters
40742
+ * @param {number} options.pathParams.taskDefinitionId
40743
+ * @param {string} options.pathParams.prefix
40744
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
40745
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
40746
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
40747
+ */
40748
+ getTaskDefinitionAllMetadataPrefix: ({ pathParams: { taskDefinitionId, prefix }, headers, requestConfig, }: {
40749
+ pathParams: {
40750
+ taskDefinitionId: number;
40751
+ prefix: string;
40752
+ };
40753
+ headers?: VidiCoreRequestHeaderConfig;
40754
+ requestConfig?: AxiosRequestConfig;
40755
+ }) => Promise<AxiosResponse<string>>;
39184
40756
  /**
39185
40757
  * Get Task Definition Script
39186
40758
  *
@@ -39489,6 +41061,29 @@ export declare const TaskGroup: {
39489
41061
  headers?: VidiCoreRequestHeaderConfig;
39490
41062
  requestConfig?: AxiosRequestConfig;
39491
41063
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
41064
+ /**
41065
+ * Get Task Group All Metadata Prefix
41066
+ *
41067
+ * 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.
41068
+ *
41069
+ * - accept: `text/plain`
41070
+ *
41071
+ * @param {object} options
41072
+ * @param {object} options.pathParams - Path parameters
41073
+ * @param {string} options.pathParams.name
41074
+ * @param {string} options.pathParams.prefix
41075
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
41076
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
41077
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
41078
+ */
41079
+ getTaskGroupAllMetadataPrefix: ({ pathParams: { name, prefix }, headers, requestConfig, }: {
41080
+ pathParams: {
41081
+ name: string;
41082
+ prefix: string;
41083
+ };
41084
+ headers?: VidiCoreRequestHeaderConfig;
41085
+ requestConfig?: AxiosRequestConfig;
41086
+ }) => Promise<AxiosResponse<string>>;
39492
41087
  /**
39493
41088
  * Remove Task Group Transcoder From Group
39494
41089
  *
@@ -39742,6 +41337,7 @@ export declare const Thumbnail: {
39742
41337
  * @param {string} options.pathParams.time
39743
41338
  * @param {object} [options.queryParams] - Query parameters
39744
41339
  * @param {string} [options.queryParams.format] - Image format of destination. E.g. tiff.
41340
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
39745
41341
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
39746
41342
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
39747
41343
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -39759,6 +41355,7 @@ export declare const Thumbnail: {
39759
41355
  };
39760
41356
  queryParams?: {
39761
41357
  format?: string;
41358
+ holdJob?: boolean;
39762
41359
  jobmetadata?: KeyValueObjectQueryParam;
39763
41360
  notification?: string;
39764
41361
  notificationData?: KeyValueObjectQueryParam;
@@ -39855,6 +41452,29 @@ export declare const Token: {
39855
41452
  headers?: VidiCoreRequestHeaderConfig;
39856
41453
  requestConfig?: AxiosRequestConfig;
39857
41454
  }) => Promise<AxiosResponse<AuthenticationTokenDocument>>;
41455
+ /**
41456
+ * Get Token
41457
+ *
41458
+ * 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.
41459
+ *
41460
+ * - accept: `text/plain`
41461
+ *
41462
+ * @param {object} options
41463
+ * @param {object} [options.queryParams] - Query parameters
41464
+ * @param {boolean} [options.queryParams.autoRefresh] - true - The expiration clock is reset with every API call. false (default) - The token always expires after seconds seconds after the token was created.
41465
+ * @param {number} [options.queryParams.seconds] - The duration of the token.
41466
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
41467
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
41468
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
41469
+ */
41470
+ getToken: ({ queryParams, headers, requestConfig, }: {
41471
+ queryParams?: {
41472
+ autoRefresh?: boolean;
41473
+ seconds?: number;
41474
+ };
41475
+ headers?: VidiCoreRequestHeaderConfig;
41476
+ requestConfig?: AxiosRequestConfig;
41477
+ }) => Promise<AxiosResponse<string>>;
39858
41478
  };
39859
41479
 
39860
41480
  /**
@@ -39869,6 +41489,7 @@ export declare const Transcode: {
39869
41489
  *
39870
41490
  * @param {object} options
39871
41491
  * @param {object} [options.queryParams] - Query parameters
41492
+ * @param {boolean} [options.queryParams.holdJob]
39872
41493
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
39873
41494
  * @param {string} [options.queryParams.notification]
39874
41495
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -39879,6 +41500,7 @@ export declare const Transcode: {
39879
41500
  */
39880
41501
  postTranscode: ({ queryParams, data, headers, requestConfig, }: {
39881
41502
  queryParams?: {
41503
+ holdJob?: boolean;
39882
41504
  jobmetadata?: KeyValueObjectQueryParam;
39883
41505
  notification?: string;
39884
41506
  notificationData?: KeyValueObjectQueryParam;
@@ -40005,6 +41627,7 @@ export declare const Transfertest: {
40005
41627
  * @param {object} options
40006
41628
  * @param {object} [options.queryParams] - Query parameters
40007
41629
  * @param {string} [options.queryParams.from]
41630
+ * @param {boolean} [options.queryParams.holdJob]
40008
41631
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata]
40009
41632
  * @param {string} [options.queryParams.notification]
40010
41633
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData]
@@ -40017,6 +41640,7 @@ export declare const Transfertest: {
40017
41640
  postTransfertestTransfer: ({ queryParams, headers, requestConfig, }: {
40018
41641
  queryParams?: {
40019
41642
  from?: string;
41643
+ holdJob?: boolean;
40020
41644
  jobmetadata?: KeyValueObjectQueryParam;
40021
41645
  notification?: string;
40022
41646
  notificationData?: KeyValueObjectQueryParam;
@@ -40270,6 +41894,7 @@ export declare const User: {
40270
41894
  * @param {string} options.pathParams.username
40271
41895
  * @param {object} [options.queryParams] - Query parameters
40272
41896
  * @param {boolean} [options.queryParams.hard] - If set to true, the user will be removed completely, including all access controls granted by the user. Else the user will be disabled. Default is false.
41897
+ * @param {boolean} [options.queryParams.holdJob] - If set to true, the job will be created in a HOLD state. Default is false.
40273
41898
  * @param {KeyValueObjectQueryParam} [options.queryParams.jobmetadata] - Additional information for the job task.
40274
41899
  * @param {string} [options.queryParams.notification] - The placeholder job notification to use for this job.
40275
41900
  * @param {KeyValueObjectQueryParam} [options.queryParams.notificationData] - Any additional data to include for notifications on this job.
@@ -40286,6 +41911,7 @@ export declare const User: {
40286
41911
  };
40287
41912
  queryParams?: {
40288
41913
  hard?: boolean;
41914
+ holdJob?: boolean;
40289
41915
  jobmetadata?: KeyValueObjectQueryParam;
40290
41916
  notification?: string;
40291
41917
  notificationData?: KeyValueObjectQueryParam;
@@ -40771,6 +42397,29 @@ export declare const User: {
40771
42397
  headers?: VidiCoreRequestHeaderConfig;
40772
42398
  requestConfig?: AxiosRequestConfig;
40773
42399
  }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
42400
+ /**
42401
+ * Get User All Metadata Prefix
42402
+ *
42403
+ * 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.
42404
+ *
42405
+ * - accept: `text/plain`
42406
+ *
42407
+ * @param {object} options
42408
+ * @param {object} options.pathParams - Path parameters
42409
+ * @param {string} options.pathParams.username
42410
+ * @param {string} options.pathParams.prefix
42411
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
42412
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
42413
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
42414
+ */
42415
+ getUserAllMetadataPrefix: ({ pathParams: { username, prefix }, headers, requestConfig, }: {
42416
+ pathParams: {
42417
+ username: string;
42418
+ prefix: string;
42419
+ };
42420
+ headers?: VidiCoreRequestHeaderConfig;
42421
+ requestConfig?: AxiosRequestConfig;
42422
+ }) => Promise<AxiosResponse<string>>;
40774
42423
  /**
40775
42424
  * Set User Password
40776
42425
  *
@@ -41502,11 +43151,16 @@ export declare const VidispineService: {
41502
43151
  * - accept: `text/plain`
41503
43152
  *
41504
43153
  * @param {object} options
43154
+ * @param {object} [options.queryParams] - Query parameters
43155
+ * @param {boolean} [options.queryParams.cluster=true] - If true, return stack traces from all instances in the cluster instead of only from the instance that handles the request. Default is true.
41505
43156
  * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
41506
43157
  * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
41507
43158
  * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
41508
43159
  */
41509
- getVidispineStackTrace: ({ headers, requestConfig, }: {
43160
+ getVidispineStackTrace: ({ queryParams, headers, requestConfig, }: {
43161
+ queryParams?: {
43162
+ cluster?: boolean;
43163
+ };
41510
43164
  headers?: VidiCoreRequestHeaderConfig;
41511
43165
  requestConfig?: AxiosRequestConfig;
41512
43166
  }) => Promise<AxiosResponse<string>>;
@@ -41660,6 +43314,27 @@ export declare const Vxa: {
41660
43314
  headers?: VidiCoreRequestHeaderConfig;
41661
43315
  requestConfig?: AxiosRequestConfig;
41662
43316
  }) => Promise<AxiosResponse<string>>;
43317
+ /**
43318
+ * Get Vxa Startup Configuration
43319
+ *
43320
+ * Returns the startup configuration for a VSA being executed as a stand-alone container.
43321
+ *
43322
+ * - accept: `text/plain`
43323
+ *
43324
+ * @param {object} options
43325
+ * @param {object} options.pathParams - Path parameters
43326
+ * @param {string} options.pathParams.uuid
43327
+ * @param {AxiosRequestConfig} [options.requestConfig] - Use to override axios request configurations.
43328
+ * @param {VidiCoreRequestHeaderConfig} [options.headers] - Add headers to request
43329
+ * @returns {Promise<AxiosResponse<string>>} Promise&lt;AxiosResponse&lt;string&gt;&gt;
43330
+ */
43331
+ getVxaStartupConfiguration: ({ pathParams: { uuid }, headers, requestConfig, }: {
43332
+ pathParams: {
43333
+ uuid: string;
43334
+ };
43335
+ headers?: VidiCoreRequestHeaderConfig;
43336
+ requestConfig?: AxiosRequestConfig;
43337
+ }) => Promise<AxiosResponse<string>>;
41663
43338
  };
41664
43339
 
41665
43340
  /**