/** * Synapse REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Summary of a requested file download. * @export * @interface FileDownloadSummary */ export interface FileDownloadSummary { /** * The file handle id of a requested file. * @type {string} * @memberof FileDownloadSummary */ fileHandleId?: string; /** * The ID of the object associated with the file * @type {string} * @memberof FileDownloadSummary */ associateObjectId?: string; /** * Enumeration of all possible objects types that can be associated with a file. * @type {string} * @memberof FileDownloadSummary */ associateObjectType?: FileDownloadSummaryAssociateObjectTypeEnum; /** * The zip entry name used for this file. This entry includes both the path and file name. The value will only be set if the status is set to 'SUCCESS' * @type {string} * @memberof FileDownloadSummary */ zipEntryName?: string; /** * The download status of this file. * @type {string} * @memberof FileDownloadSummary */ status?: FileDownloadSummaryStatusEnum; /** * If the download status of this file is set to 'FAILURE', then this will be the failure message. Null for 'SUCCESS'. * @type {string} * @memberof FileDownloadSummary */ failureMessage?: string; /** * If the download status of this file is set to 'FAILURE', then this will be the failure code. Null for 'SUCCESS'. * @type {string} * @memberof FileDownloadSummary */ failureCode?: FileDownloadSummaryFailureCodeEnum; } /** * @export */ export declare const FileDownloadSummaryAssociateObjectTypeEnum: { readonly FileEntity: "FileEntity"; readonly TableEntity: "TableEntity"; readonly WikiAttachment: "WikiAttachment"; readonly WikiMarkdown: "WikiMarkdown"; readonly UserProfileAttachment: "UserProfileAttachment"; readonly MessageAttachment: "MessageAttachment"; readonly TeamAttachment: "TeamAttachment"; readonly SubmissionAttachment: "SubmissionAttachment"; readonly VerificationSubmission: "VerificationSubmission"; readonly AccessRequirementAttachment: "AccessRequirementAttachment"; readonly DataAccessRequestAttachment: "DataAccessRequestAttachment"; readonly DataAccessSubmissionAttachment: "DataAccessSubmissionAttachment"; readonly FormData: "FormData"; }; export type FileDownloadSummaryAssociateObjectTypeEnum = typeof FileDownloadSummaryAssociateObjectTypeEnum[keyof typeof FileDownloadSummaryAssociateObjectTypeEnum]; /** * @export */ export declare const FileDownloadSummaryStatusEnum: { readonly SUCCESS: "SUCCESS"; readonly FAILURE: "FAILURE"; }; export type FileDownloadSummaryStatusEnum = typeof FileDownloadSummaryStatusEnum[keyof typeof FileDownloadSummaryStatusEnum]; /** * @export */ export declare const FileDownloadSummaryFailureCodeEnum: { readonly NOT_FOUND: "NOT_FOUND"; readonly UNAUTHORIZED: "UNAUTHORIZED"; readonly DUPLICATE: "DUPLICATE"; readonly EXCEEDS_SIZE_LIMIT: "EXCEEDS_SIZE_LIMIT"; readonly UNKNOWN_ERROR: "UNKNOWN_ERROR"; }; export type FileDownloadSummaryFailureCodeEnum = typeof FileDownloadSummaryFailureCodeEnum[keyof typeof FileDownloadSummaryFailureCodeEnum]; /** * Check if a given object implements the FileDownloadSummary interface. */ export declare function instanceOfFileDownloadSummary(value: object): value is FileDownloadSummary; export declare function FileDownloadSummaryFromJSON(json: any): FileDownloadSummary; export declare function FileDownloadSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileDownloadSummary; export declare function FileDownloadSummaryToJSON(json: any): FileDownloadSummary; export declare function FileDownloadSummaryToJSONTyped(value?: FileDownloadSummary | null, ignoreDiscriminator?: boolean): any;