@apideck/node/src/gen/models/UnifiedFile.ts

Apideck Node.js SDK

/* tslint:disable */
/* eslint-disable */
/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { exists } from '../runtime'
import { FileType, FileTypeFromJSON, FileTypeToJSON } from './FileType'
import { LinkedFolder, LinkedFolderFromJSON, LinkedFolderToJSON } from './LinkedFolder'
import { Owner, OwnerFromJSON, OwnerToJSON } from './Owner'
import {
  UnifiedFilePermissions,
  UnifiedFilePermissionsFromJSON,
  UnifiedFilePermissionsToJSON
} from './UnifiedFilePermissions'

/**
 *
 * @export
 * @interface UnifiedFile
 */
export interface UnifiedFile {
  /**
   * A unique identifier for an object.
   * @type {string}
   * @memberof UnifiedFile
   */
  readonly id: string
  /**
   * The name of the file
   * @type {string}
   * @memberof UnifiedFile
   */
  name: string | null
  /**
   *
   * @type {FileType}
   * @memberof UnifiedFile
   */
  type: FileType | null
  /**
   * The third-party API ID of original entity
   * @type {string}
   * @memberof UnifiedFile
   */
  readonly downstream_id?: string | null
  /**
   * Optional description of the file
   * @type {string}
   * @memberof UnifiedFile
   */
  description?: string | null
  /**
   * The full path of the file or folder (includes the file name)
   * @type {string}
   * @memberof UnifiedFile
   */
  path?: string | null
  /**
   * The MIME type of the file.
   * @type {string}
   * @memberof UnifiedFile
   */
  mime_type?: string | null
  /**
   * Whether the current user can download this file
   * @type {boolean}
   * @memberof UnifiedFile
   */
  downloadable?: boolean
  /**
   * The size of the file in bytes
   * @type {number}
   * @memberof UnifiedFile
   */
  size?: number | null
  /**
   *
   * @type {Owner}
   * @memberof UnifiedFile
   */
  owner?: Owner
  /**
   * The parent folders of the file, starting from the root
   * @type {Array<LinkedFolder>}
   * @memberof UnifiedFile
   */
  parent_folders?: Array<LinkedFolder>
  /**
   * Whether the list of parent folders is complete. Some connectors only return the direct parent of a file
   * @type {boolean}
   * @memberof UnifiedFile
   */
  parent_folders_complete?: boolean
  /**
   *
   * @type {UnifiedFilePermissions}
   * @memberof UnifiedFile
   */
  permissions?: UnifiedFilePermissions
  /**
   * Whether the current file is exportable to other file formats. This property is relevant for proprietary file formats such as Google Docs or Dropbox Paper.
   * @type {boolean}
   * @memberof UnifiedFile
   */
  exportable?: boolean
  /**
   * The available file formats when exporting this file.
   * @type {Array<string>}
   * @memberof UnifiedFile
   */
  export_formats?: Array<string> | null
  /**
   * When custom mappings are configured on the resource, the result is included here.
   * @type {object}
   * @memberof UnifiedFile
   */
  readonly custom_mappings?: object | null
  /**
   * The user who last updated the object.
   * @type {string}
   * @memberof UnifiedFile
   */
  readonly updated_by?: string | null
  /**
   * The user who created the object.
   * @type {string}
   * @memberof UnifiedFile
   */
  readonly created_by?: string | null
  /**
   * The date and time when the object was last updated.
   * @type {Date}
   * @memberof UnifiedFile
   */
  readonly updated_at?: Date | null
  /**
   * The date and time when the object was created.
   * @type {Date}
   * @memberof UnifiedFile
   */
  readonly created_at?: Date | null
}

export function UnifiedFileFromJSON(json: any): UnifiedFile {
  return UnifiedFileFromJSONTyped(json, false)
}

export function UnifiedFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnifiedFile {
  if (json === undefined || json === null) {
    return json
  }
  return {
    id: json['id'],
    name: json['name'],
    type: FileTypeFromJSON(json['type']),
    downstream_id: !exists(json, 'downstream_id') ? undefined : json['downstream_id'],
    description: !exists(json, 'description') ? undefined : json['description'],
    path: !exists(json, 'path') ? undefined : json['path'],
    mime_type: !exists(json, 'mime_type') ? undefined : json['mime_type'],
    downloadable: !exists(json, 'downloadable') ? undefined : json['downloadable'],
    size: !exists(json, 'size') ? undefined : json['size'],
    owner: !exists(json, 'owner') ? undefined : OwnerFromJSON(json['owner']),
    parent_folders: !exists(json, 'parent_folders')
      ? undefined
      : (json['parent_folders'] as Array<any>).map(LinkedFolderFromJSON),
    parent_folders_complete: !exists(json, 'parent_folders_complete')
      ? undefined
      : json['parent_folders_complete'],
    permissions: !exists(json, 'permissions')
      ? undefined
      : UnifiedFilePermissionsFromJSON(json['permissions']),
    exportable: !exists(json, 'exportable') ? undefined : json['exportable'],
    export_formats: !exists(json, 'export_formats') ? undefined : json['export_formats'],
    custom_mappings: !exists(json, 'custom_mappings') ? undefined : json['custom_mappings'],
    updated_by: !exists(json, 'updated_by') ? undefined : json['updated_by'],
    created_by: !exists(json, 'created_by') ? undefined : json['created_by'],
    updated_at: !exists(json, 'updated_at')
      ? undefined
      : json['updated_at'] === null
      ? null
      : new Date(json['updated_at']),
    created_at: !exists(json, 'created_at')
      ? undefined
      : json['created_at'] === null
      ? null
      : new Date(json['created_at'])
  }
}

export function UnifiedFileToJSON(value?: UnifiedFile | null): any {
  if (value === undefined) {
    return undefined
  }
  if (value === null) {
    return null
  }
  return {
    name: value.name,
    type: FileTypeToJSON(value.type),
    description: value.description,
    path: value.path,
    mime_type: value.mime_type,
    downloadable: value.downloadable,
    size: value.size,
    owner: OwnerToJSON(value.owner),
    parent_folders:
      value.parent_folders === undefined
        ? undefined
        : (value.parent_folders as Array<any>).map(LinkedFolderToJSON),
    parent_folders_complete: value.parent_folders_complete,
    permissions: UnifiedFilePermissionsToJSON(value.permissions),
    exportable: value.exportable,
    export_formats: value.export_formats
  }
}