@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
64 lines • 3.9 kB
TypeScript
import type { Configuration } from '../generated';
import { FileUploadsAPIV4Api } from '../generated';
import type { V4FileUploadsControllerCreateFileUploadV4Request, V4FileUploadsControllerDeleteFileUploadV4Request, V4FileUploadsControllerGetFileUploadColumnsV4Request, V4FileUploadsControllerGetFileUploadV4Request, V4FileUploadsControllerGetFileUploadsInViewV4Request, V4FileUploadsControllerGetFileUploadsV4Request, V4FileUploadsControllerGetSignedUrlV4Request, V4FileUploadsControllerUpdateFileUploadV4Request, V4FileUploadsCreateFileUploadResponseDto, V4FileUploadsDeleteFileUploadResponseDto, V4FileUploadsGetFileUploadColumnsResponseDto, V4FileUploadsGetFileUploadResponseDto, V4FileUploadsGetFileUploadsInViewResponseDto, V4FileUploadsGetFileUploadsResponseDto, V4FileUploadsGetSignedUrlResponseDto, V4FileUploadsUpdateFileUploadBodyDto, V4FileUploadsUpdateFileUploadResponseDto } from '../generated';
export declare class FileUploads {
readonly list: FileUploadsList;
readonly create: FileUploadsCreate;
readonly update: FileUploadsUpdate;
readonly delete: FileUploadsDelete;
readonly file: FileUploadsFile;
constructor(config: Configuration);
}
export declare class FileUploadsList {
private api;
constructor(api: FileUploadsAPIV4Api);
/**
* one - get /v4/file-uploads/{fileUploadId}
*/
one(fileUploadId: V4FileUploadsControllerGetFileUploadV4Request['fileUploadId'], options?: Omit<V4FileUploadsControllerGetFileUploadV4Request, 'fileUploadId'>): Promise<V4FileUploadsGetFileUploadResponseDto>;
/**
* oneWithColumns - get /v4/file-uploads/{fileUploadId}/{columns}
*/
oneWithColumns(fileUploadId: V4FileUploadsControllerGetFileUploadColumnsV4Request['fileUploadId'], columns: V4FileUploadsControllerGetFileUploadColumnsV4Request['columns'], options?: Omit<V4FileUploadsControllerGetFileUploadColumnsV4Request, 'fileUploadId' | 'columns'>): Promise<V4FileUploadsGetFileUploadColumnsResponseDto>;
/**
* all - get /v4/file-uploads
*/
all(options?: V4FileUploadsControllerGetFileUploadsV4Request): Promise<V4FileUploadsGetFileUploadsResponseDto>;
/**
* withView - get /v4/file-uploads/viewId/{viewId}
*/
withView(viewId: V4FileUploadsControllerGetFileUploadsInViewV4Request['viewId'], options?: Omit<V4FileUploadsControllerGetFileUploadsInViewV4Request, 'viewId'>): Promise<V4FileUploadsGetFileUploadsInViewResponseDto>;
}
export declare class FileUploadsCreate {
private api;
constructor(api: FileUploadsAPIV4Api);
/**
* one - post /v4/file-uploads
*/
one(body: V4FileUploadsControllerCreateFileUploadV4Request): Promise<V4FileUploadsCreateFileUploadResponseDto>;
}
export declare class FileUploadsUpdate {
private api;
constructor(api: FileUploadsAPIV4Api);
/**
* one - patch /v4/file-uploads/{fileUploadId}
*/
one(fileUploadId: V4FileUploadsControllerUpdateFileUploadV4Request['fileUploadId'], body: V4FileUploadsUpdateFileUploadBodyDto['fileUpload']): Promise<V4FileUploadsUpdateFileUploadResponseDto>;
}
export declare class FileUploadsDelete {
private api;
constructor(api: FileUploadsAPIV4Api);
/**
* one - delete /v4/file-uploads/{fileUploadId}
*/
one(fileUploadId: V4FileUploadsControllerDeleteFileUploadV4Request['fileUploadId'], options?: Omit<V4FileUploadsControllerDeleteFileUploadV4Request, 'fileUploadId'>): Promise<V4FileUploadsDeleteFileUploadResponseDto>;
}
export declare class FileUploadsFile {
private api;
constructor(api: FileUploadsAPIV4Api);
/**
* getSignedUrl - get /v4/file-uploads/{fileUploadId}/file
*/
getSignedUrl(fileUploadId: V4FileUploadsControllerGetSignedUrlV4Request['fileUploadId'], options?: Omit<V4FileUploadsControllerGetSignedUrlV4Request, 'fileUploadId'>): Promise<V4FileUploadsGetSignedUrlResponseDto>;
}
//# sourceMappingURL=fileUploads.d.ts.map