Skip to content

Commit

Permalink
Update to latest API spec
Browse files Browse the repository at this point in the history
  • Loading branch information
ljwagerfield committed Mar 15, 2024
1 parent ee308ef commit 0353cdc
Showing 1 changed file with 97 additions and 21 deletions.
118 changes: 97 additions & 21 deletions src/public/shared/generated/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,24 @@ export interface CopyFileRequest {
* @memberof CopyFileRequest
*/
destination: string;
/**
*
* @type {CopyableFileDataFileMetadata}
* @memberof CopyFileRequest
*/
metadata?: CopyableFileDataFileMetadata;
/**
* Absolute path to a file. Begins with a `/`.
* @type {string}
* @memberof CopyFileRequest
*/
source: string;
/**
*
* @type {CopyableFileDataFileTagNameArray}
* @memberof CopyFileRequest
*/
tags?: CopyableFileDataFileTagNameArray;
}
/**
* Response body for CopyFile.
Expand All @@ -280,10 +292,10 @@ export interface CopyFileRequest {
export interface CopyFileResponse {
/**
*
* @type {FileCopyStatus}
* @type {FileCopyStatusCopied}
* @memberof CopyFileResponse
*/
status: FileCopyStatus;
status: FileCopyStatusCopied;
}
/**
* Request body for CopyFolderBatch.
Expand Down Expand Up @@ -343,6 +355,12 @@ export interface CopyFolderRequest {
* @memberof CopyFolderRequest
*/
destination: string;
/**
*
* @type {CopyableFileDataFileMetadata}
* @memberof CopyFolderRequest
*/
metadata?: CopyableFileDataFileMetadata;
/**
* If `true` then copies files and virtual folders that are descendants of the `source` folder.
*
Expand All @@ -359,6 +377,12 @@ export interface CopyFolderRequest {
* @memberof CopyFolderRequest
*/
source: string;
/**
*
* @type {CopyableFileDataFileTagNameArray}
* @memberof CopyFolderRequest
*/
tags?: CopyableFileDataFileTagNameArray;
}
/**
*
Expand All @@ -367,21 +391,15 @@ export interface CopyFolderRequest {
*/
export interface CopyableFileDataFileMetadata {
/**
* If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
* If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
*
* If `false` then uses `value` as-is, ignoring the settings from the original file.
*
* Default: false
* @type {boolean}
* @memberof CopyableFileDataFileMetadata
*/
merge?: boolean;
/**
* If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
*
* Default: true
* @type {boolean}
* @memberof CopyableFileDataFileMetadata
*/
setForAllArtifacts?: boolean;
/**
* The file metadata specified in the original upload request as a JSON object.
* @type {{ [key: string]: any; }}
Expand All @@ -396,29 +414,87 @@ export interface CopyableFileDataFileMetadata {
*/
export interface CopyableFileDataFileTagNameArray {
/**
* If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
* If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
*
* If `false` then uses `value` as-is, ignoring the settings from the original file.
*
* Default: false
* @type {boolean}
* @memberof CopyableFileDataFileTagNameArray
*/
merge?: boolean;
/**
* The value to set into the field.
*
* Default: empty object / empty array
* @type {Array<string>}
* @memberof CopyableFileDataFileTagNameArray
*/
value?: Array<string>;
}
/**
*
* @export
* @interface CopyableFileDataForArtifactsFileMetadata
*/
export interface CopyableFileDataForArtifactsFileMetadata {
/**
* If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
*
* If `false` then uses `value` as-is, ignoring the settings from the original file.
*
* Default: false
* @type {boolean}
* @memberof CopyableFileDataForArtifactsFileMetadata
*/
merge?: boolean;
/**
* The file metadata specified in the original upload request as a JSON object.
* @type {{ [key: string]: any; }}
* @memberof CopyableFileDataForArtifactsFileMetadata
*/
value?: { [key: string]: any };
/**
* If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
*
* Default: true
* @type {boolean}
* @memberof CopyableFileDataFileTagNameArray
* @memberof CopyableFileDataForArtifactsFileMetadata
*/
setForAllArtifacts?: boolean;
}
/**
*
* @export
* @interface CopyableFileDataForArtifactsFileTagNameArray
*/
export interface CopyableFileDataForArtifactsFileTagNameArray {
/**
* The value to set or merge into the field.
* If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
*
* If `false` then uses `value` as-is, ignoring the settings from the original file.
*
* Default: false
* @type {boolean}
* @memberof CopyableFileDataForArtifactsFileTagNameArray
*/
merge?: boolean;
/**
* The value to set into the field.
*
* Default: empty object / empty array
* @type {Array<string>}
* @memberof CopyableFileDataFileTagNameArray
* @memberof CopyableFileDataForArtifactsFileTagNameArray
*/
value?: Array<string>;
/**
* If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
*
* Default: true
* @type {boolean}
* @memberof CopyableFileDataForArtifactsFileTagNameArray
*/
setForAllArtifacts?: boolean;
}
/**
* Request body for DeleteFileBatch.
Expand Down Expand Up @@ -655,10 +731,10 @@ export interface ErrorResponseError {
code: string;
}
/**
* The result of the CopyFile operation.
*
* @export
*/
export type FileCopyStatus = "Copied" | "FileNotFound" | "SkippedDueToCondition";
export type FileCopyStatusCopied = "Copied";
/**
* Contains full information about a file, including its file metadata, file tags, original file name, and MIME type.
* @export
Expand Down Expand Up @@ -1501,16 +1577,16 @@ export interface ProcessFileAndSaveRequest {
extendedParams?: TransformationParams;
/**
*
* @type {CopyableFileDataFileMetadata}
* @type {CopyableFileDataForArtifactsFileMetadata}
* @memberof ProcessFileAndSaveRequest
*/
metadata?: CopyableFileDataFileMetadata;
metadata?: CopyableFileDataForArtifactsFileMetadata;
/**
*
* @type {CopyableFileDataFileTagNameArray}
* @type {CopyableFileDataForArtifactsFileTagNameArray}
* @memberof ProcessFileAndSaveRequest
*/
tags?: CopyableFileDataFileTagNameArray;
tags?: CopyableFileDataForArtifactsFileTagNameArray;
}
/**
* @type ProcessFileAndSaveResponse
Expand Down

0 comments on commit 0353cdc

Please sign in to comment.