/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.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 * as runtime from '../runtime'; import type { CreateFileRequestBody, FileSchema, FilesSchema, UpdateFileRequestBody } from '../models/index'; export interface CreateFileRequest { createFileRequestBody: CreateFileRequestBody; } export interface DeleteFileRequest { fileId: string; } export interface FileOptionsRequest { fileId: string; } export interface ListFilesRequest { filterStatus?: ListFilesFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowFileRequest { fileId: string; } export interface UpdateFileRequest { fileId: string; updateFileRequestBody: UpdateFileRequestBody; } /** * */ export declare class FilesApi extends runtime.BaseAPI { /** * Creates request options for createFile without sending the request */ createFileRequestOpts(requestParameters: CreateFileRequest): Promise; /** * Creates a new file in your account. ### File\'s Attributes Here is a table that describes the attributes of the file object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the file. | | `status` | string | The current status of the file (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the file was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the file was last modified (ISO 8601 format). | * Create File */ createFileRaw(requestParameters: CreateFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new file in your account. ### File\'s Attributes Here is a table that describes the attributes of the file object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the file. | | `status` | string | The current status of the file (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the file was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the file was last modified (ISO 8601 format). | * Create File */ createFile(requestParameters: CreateFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteFile without sending the request */ deleteFileRequestOpts(requestParameters: DeleteFileRequest): Promise; /** * This endpoint allows you to delete a specific file from your account. Once deleted, the file\'s information will be permanently removed and cannot be recovered. * Delete File */ deleteFileRaw(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific file from your account. Once deleted, the file\'s information will be permanently removed and cannot be recovered. * Delete File */ deleteFile(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for fileOptions without sending the request */ fileOptionsRequestOpts(requestParameters: FileOptionsRequest): Promise; /** * Enable CORS by returning correct headers * File Options */ fileOptionsRaw(requestParameters: FileOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * File Options */ fileOptions(requestParameters: FileOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for filesOptions without sending the request */ filesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Files Options */ filesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Files Options */ filesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listFiles without sending the request */ listFilesRequestOpts(requestParameters: ListFilesRequest): Promise; /** * Returns a collection of your account files ## Overview Returns a collection of your account files, sorted by the time they were inserted into the system in ascending order. ### Files Endpoints Pagination The files endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Files */ listFilesRaw(requestParameters: ListFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account files ## Overview Returns a collection of your account files, sorted by the time they were inserted into the system in ascending order. ### Files Endpoints Pagination The files endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Files */ listFiles(requestParameters?: ListFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showFile without sending the request */ showFileRequestOpts(requestParameters: ShowFileRequest): Promise; /** * This endpoint retrieves details of a specific file from your account. You can view information such as name, and other relevant attributes of the file. * Show File */ showFileRaw(requestParameters: ShowFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific file from your account. You can view information such as name, and other relevant attributes of the file. * Show File */ showFile(requestParameters: ShowFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateFile without sending the request */ updateFileRequestOpts(requestParameters: UpdateFileRequest): Promise; /** * This endpoint allows you to update details of a specific file in your account. You can modify information such as name, and other relevant attributes of the file. Only the fields provided in the request will be updated. * Update File */ updateFileRaw(requestParameters: UpdateFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific file in your account. You can modify information such as name, and other relevant attributes of the file. Only the fields provided in the request will be updated. * Update File */ updateFile(requestParameters: UpdateFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListFilesFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListFilesFilterStatusEnum = typeof ListFilesFilterStatusEnum[keyof typeof ListFilesFilterStatusEnum]; //# sourceMappingURL=FilesApi.d.ts.map