/** * 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 { ApikeySchema, ApikeysSchema, CreateApikeyRequestBody, UpdateApikeyRequestBody } from '../models/index'; export interface ApikeyOptionsRequest { apikeyId: string; } export interface CreateApikeyRequest { createApikeyRequestBody: CreateApikeyRequestBody; } export interface DeleteApikeyRequest { apikeyId: string; } export interface ListApikeysRequest { filterStatus?: ListApikeysFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowApikeyRequest { apikeyId: string; } export interface UpdateApikeyRequest { apikeyId: string; updateApikeyRequestBody: UpdateApikeyRequestBody; } /** * */ export declare class ApikeysApi extends runtime.BaseAPI { /** * Creates request options for apikeyOptions without sending the request */ apikeyOptionsRequestOpts(requestParameters: ApikeyOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Apikey Options */ apikeyOptionsRaw(requestParameters: ApikeyOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Apikey Options */ apikeyOptions(requestParameters: ApikeyOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for apikeysOptions without sending the request */ apikeysOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Apikeys Options */ apikeysOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Apikeys Options */ apikeysOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createApikey without sending the request */ createApikeyRequestOpts(requestParameters: CreateApikeyRequest): Promise; /** * Creates a new apikey in your account. ### Apikey\'s Attributes Here is a table that describes the attributes of the apikey object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the apikey. | | `status` | string | The current status of the apikey (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the apikey was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the apikey was last modified (ISO 8601 format). | * Create Apikey */ createApikeyRaw(requestParameters: CreateApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new apikey in your account. ### Apikey\'s Attributes Here is a table that describes the attributes of the apikey object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the apikey. | | `status` | string | The current status of the apikey (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the apikey was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the apikey was last modified (ISO 8601 format). | * Create Apikey */ createApikey(requestParameters: CreateApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteApikey without sending the request */ deleteApikeyRequestOpts(requestParameters: DeleteApikeyRequest): Promise; /** * This endpoint allows you to delete a specific apikey from your account. Once deleted, the apikey\'s information will be permanently removed and cannot be recovered. * Delete Apikey */ deleteApikeyRaw(requestParameters: DeleteApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific apikey from your account. Once deleted, the apikey\'s information will be permanently removed and cannot be recovered. * Delete Apikey */ deleteApikey(requestParameters: DeleteApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listApikeys without sending the request */ listApikeysRequestOpts(requestParameters: ListApikeysRequest): Promise; /** * Returns a collection of your account apikeys ## Overview Returns a collection of your account apikeys, sorted by the time they were inserted into the system in ascending order. ### Apikeys Endpoints Pagination The apikeys 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 Apikeys */ listApikeysRaw(requestParameters: ListApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account apikeys ## Overview Returns a collection of your account apikeys, sorted by the time they were inserted into the system in ascending order. ### Apikeys Endpoints Pagination The apikeys 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 Apikeys */ listApikeys(requestParameters?: ListApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showApikey without sending the request */ showApikeyRequestOpts(requestParameters: ShowApikeyRequest): Promise; /** * This endpoint retrieves details of a specific apikey from your account. You can view information such as name, email, and other relevant attributes of the apikey. * Show Apikey */ showApikeyRaw(requestParameters: ShowApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific apikey from your account. You can view information such as name, email, and other relevant attributes of the apikey. * Show Apikey */ showApikey(requestParameters: ShowApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateApikey without sending the request */ updateApikeyRequestOpts(requestParameters: UpdateApikeyRequest): Promise; /** * This endpoint allows you to update details of a specific apikey in your account. You can modify information such as name, and other relevant attributes of the apikey. Only the fields provided in the request will be updated. * Update Apikey */ updateApikeyRaw(requestParameters: UpdateApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific apikey in your account. You can modify information such as name, and other relevant attributes of the apikey. Only the fields provided in the request will be updated. * Update Apikey */ updateApikey(requestParameters: UpdateApikeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListApikeysFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListApikeysFilterStatusEnum = typeof ListApikeysFilterStatusEnum[keyof typeof ListApikeysFilterStatusEnum]; //# sourceMappingURL=ApikeysApi.d.ts.map