@simplyhomes/sos-sdk/dist/generated/src/models/SoSFileUploadEntityBase.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * API v4
 * Swagger documentation for API v4
 *
 * The version of the OpenAPI document: 4.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { SoSFileUploadEntityType } from './SoSFileUploadEntityType';
/**
 *
 * @export
 * @interface SoSFileUploadEntityBase
 */
export interface SoSFileUploadEntityBase {
    /**
     * The unique identifier of the file upload
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    fuid: number;
    /**
     * Name of the uploaded file
     * @type {string}
     * @memberof SoSFileUploadEntityBase
     */
    name: string;
    /**
     * MIME type of the file
     * @type {string}
     * @memberof SoSFileUploadEntityBase
     */
    mimeType: string;
    /**
     * Size of the file in bytes
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    size: number;
    /**
     * Whether the file was successfully uploaded
     * @type {boolean}
     * @memberof SoSFileUploadEntityBase
     */
    uploadedSuccessfully?: boolean;
    /**
     * Timestamp when the file was uploaded
     * @type {Date}
     * @memberof SoSFileUploadEntityBase
     */
    uploadedAt: string;
    /**
     * ID of the user who uploaded the file
     * @type {string}
     * @memberof SoSFileUploadEntityBase
     */
    uploadedById: string;
    /**
     * The ID of the property this file belongs to
     * @type {string}
     * @memberof SoSFileUploadEntityBase
     */
    propertyId?: string;
    /**
     * The ID of the transaction this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    transactionId?: number;
    /**
     * The ID of the inspection this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    inspectionId?: number;
    /**
     * The ID of the renovation this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    renovationId?: number;
    /**
     * The ID of the rental listing this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    rentalListingId?: number;
    /**
     * The ID of the update this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    updateId?: number;
    /**
     * The ID of the work order this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    workOrderId?: number;
    /**
     * The ID of the leasing this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    leasingId?: number;
    /**
     * The ID of the message this file belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    messageId?: number;
    /**
     * The type/category of the file
     * @type {SoSFileUploadEntityType}
     * @memberof SoSFileUploadEntityBase
     */
    type?: SoSFileUploadEntityType;
    /**
     * The organization this file upload belongs to
     * @type {number}
     * @memberof SoSFileUploadEntityBase
     */
    organizationId: number;
}
/**
 * Check if a given object implements the SoSFileUploadEntityBase interface.
 */
export declare function instanceOfSoSFileUploadEntityBase(value: object): value is SoSFileUploadEntityBase;
export declare function SoSFileUploadEntityBaseFromJSON(json: any): SoSFileUploadEntityBase;
export declare function SoSFileUploadEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSFileUploadEntityBase;
export declare function SoSFileUploadEntityBaseToJSON(json: any): SoSFileUploadEntityBase;
export declare function SoSFileUploadEntityBaseToJSONTyped(value?: SoSFileUploadEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSFileUploadEntityBase.d.ts.map