/** * 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 { BrowserSchema, BrowsersSchema, CreateBrowserRequestBody, UpdateBrowserRequestBody } from '../models/index'; export interface BrowserOptionsRequest { browserId: string; } export interface CreateBrowserRequest { createBrowserRequestBody: CreateBrowserRequestBody; } export interface DeleteBrowserRequest { browserId: string; } export interface ListBrowsersRequest { filterStatus?: ListBrowsersFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowBrowserRequest { browserId: string; } export interface UpdateBrowserRequest { browserId: string; updateBrowserRequestBody: UpdateBrowserRequestBody; } /** * */ export declare class BrowsersApi extends runtime.BaseAPI { /** * Creates request options for browserOptions without sending the request */ browserOptionsRequestOpts(requestParameters: BrowserOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Browser Options */ browserOptionsRaw(requestParameters: BrowserOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Browser Options */ browserOptions(requestParameters: BrowserOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for browsersOptions without sending the request */ browsersOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Browsers Options */ browsersOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Browsers Options */ browsersOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createBrowser without sending the request */ createBrowserRequestOpts(requestParameters: CreateBrowserRequest): Promise; /** * Creates a new browser in your account. ### Browser\'s Attributes Here is a table that describes the attributes of the browser object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the browser. | | `status` | string | The current status of the browser (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the browser was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the browser was last modified (ISO 8601 format). | * Create Browser */ createBrowserRaw(requestParameters: CreateBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new browser in your account. ### Browser\'s Attributes Here is a table that describes the attributes of the browser object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the browser. | | `status` | string | The current status of the browser (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the browser was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the browser was last modified (ISO 8601 format). | * Create Browser */ createBrowser(requestParameters: CreateBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteBrowser without sending the request */ deleteBrowserRequestOpts(requestParameters: DeleteBrowserRequest): Promise; /** * This endpoint allows you to delete a specific browser from your account. Once deleted, the browser\'s information will be permanently removed and cannot be recovered. * Delete Browser */ deleteBrowserRaw(requestParameters: DeleteBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific browser from your account. Once deleted, the browser\'s information will be permanently removed and cannot be recovered. * Delete Browser */ deleteBrowser(requestParameters: DeleteBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listBrowsers without sending the request */ listBrowsersRequestOpts(requestParameters: ListBrowsersRequest): Promise; /** * Returns a collection of your account browsers ## Overview Returns a collection of your account browsers, sorted by the time they were inserted into the system in ascending order. ### Browsers Endpoints Pagination The browsers 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 Browsers */ listBrowsersRaw(requestParameters: ListBrowsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account browsers ## Overview Returns a collection of your account browsers, sorted by the time they were inserted into the system in ascending order. ### Browsers Endpoints Pagination The browsers 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 Browsers */ listBrowsers(requestParameters?: ListBrowsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showBrowser without sending the request */ showBrowserRequestOpts(requestParameters: ShowBrowserRequest): Promise; /** * This endpoint retrieves details of a specific browser from your account. You can view information such as name, and other relevant attributes of the form. * Show Browser */ showBrowserRaw(requestParameters: ShowBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific browser from your account. You can view information such as name, and other relevant attributes of the form. * Show Browser */ showBrowser(requestParameters: ShowBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateBrowser without sending the request */ updateBrowserRequestOpts(requestParameters: UpdateBrowserRequest): Promise; /** * This endpoint allows you to update details of a specific browser in your account. You can modify information such as name, and other relevant attributes of the form. Only the fields provided in the request will be updated. * Update Browser */ updateBrowserRaw(requestParameters: UpdateBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific browser in your account. You can modify information such as name, and other relevant attributes of the form. Only the fields provided in the request will be updated. * Update Browser */ updateBrowser(requestParameters: UpdateBrowserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListBrowsersFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListBrowsersFilterStatusEnum = typeof ListBrowsersFilterStatusEnum[keyof typeof ListBrowsersFilterStatusEnum]; //# sourceMappingURL=BrowsersApi.d.ts.map