/** * 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 { CreatePersonaRequestBody, PersonaSchema, PersonasSchema, UpdatePersonaRequestBody } from '../models/index'; export interface CreatePersonaRequest { createPersonaRequestBody: CreatePersonaRequestBody; } export interface DeletePersonaRequest { personaId: string; } export interface ListPersonasRequest { filterStatus?: ListPersonasFilterStatusEnum; filterScopeKey?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface PersonaOptionsRequest { personaId: string; } export interface ShowPersonaRequest { personaId: string; } export interface UpdatePersonaRequest { personaId: string; updatePersonaRequestBody: UpdatePersonaRequestBody; } /** * */ export declare class PersonasApi extends runtime.BaseAPI { /** * Creates request options for createPersona without sending the request */ createPersonaRequestOpts(requestParameters: CreatePersonaRequest): Promise; /** * Creates a new persona in your account. ### Persona\'s Attributes Here is a table that describes the attributes of the persona object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the persona. | | `status` | string | The current status of the persona (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the persona was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the persona was last modified (ISO 8601 format). | * Create Persona */ createPersonaRaw(requestParameters: CreatePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new persona in your account. ### Persona\'s Attributes Here is a table that describes the attributes of the persona object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the persona. | | `status` | string | The current status of the persona (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the persona was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the persona was last modified (ISO 8601 format). | * Create Persona */ createPersona(requestParameters: CreatePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deletePersona without sending the request */ deletePersonaRequestOpts(requestParameters: DeletePersonaRequest): Promise; /** * This endpoint allows you to delete a specific persona from your account. Once deleted, the persona\'s information will be permanently removed and cannot be recovered. * Delete Persona */ deletePersonaRaw(requestParameters: DeletePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific persona from your account. Once deleted, the persona\'s information will be permanently removed and cannot be recovered. * Delete Persona */ deletePersona(requestParameters: DeletePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listPersonas without sending the request */ listPersonasRequestOpts(requestParameters: ListPersonasRequest): Promise; /** * Returns a collection of your account personas ## Overview Returns a collection of your account personas, sorted by the time they were inserted into the system in ascending order. ### Personas Endpoints Pagination The personas 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 Personas */ listPersonasRaw(requestParameters: ListPersonasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account personas ## Overview Returns a collection of your account personas, sorted by the time they were inserted into the system in ascending order. ### Personas Endpoints Pagination The personas 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 Personas */ listPersonas(requestParameters?: ListPersonasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for personaOptions without sending the request */ personaOptionsRequestOpts(requestParameters: PersonaOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Persona Options */ personaOptionsRaw(requestParameters: PersonaOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Persona Options */ personaOptions(requestParameters: PersonaOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for personasOptions without sending the request */ personasOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Personas Options */ personasOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Personas Options */ personasOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showPersona without sending the request */ showPersonaRequestOpts(requestParameters: ShowPersonaRequest): Promise; /** * This endpoint retrieves details of a specific persona from your account. You can view information such as name, and other relevant attributes of the form. * Show Persona */ showPersonaRaw(requestParameters: ShowPersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific persona from your account. You can view information such as name, and other relevant attributes of the form. * Show Persona */ showPersona(requestParameters: ShowPersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updatePersona without sending the request */ updatePersonaRequestOpts(requestParameters: UpdatePersonaRequest): Promise; /** * This endpoint allows you to update details of a specific persona 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 Persona */ updatePersonaRaw(requestParameters: UpdatePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific persona 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 Persona */ updatePersona(requestParameters: UpdatePersonaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListPersonasFilterStatusEnum: { readonly Active: "active"; readonly Draft: "draft"; readonly Archived: "archived"; }; export type ListPersonasFilterStatusEnum = typeof ListPersonasFilterStatusEnum[keyof typeof ListPersonasFilterStatusEnum]; //# sourceMappingURL=PersonasApi.d.ts.map