/** * 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 { CreateFormRequestBody, FormSchema, FormsSchema, UpdateFormRequestBody } from '../models/index'; export interface CreateFormRequest { createFormRequestBody: CreateFormRequestBody; } export interface DeleteFormRequest { formId: string; } export interface FormOptionsRequest { formId: string; } export interface ListFormsRequest { filterStatus?: ListFormsFilterStatusEnum; filterKind?: ListFormsFilterKindEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowFormRequest { formId: string; } export interface UpdateFormRequest { formId: string; updateFormRequestBody: UpdateFormRequestBody; } /** * */ export declare class FormsApi extends runtime.BaseAPI { /** * Creates request options for createForm without sending the request */ createFormRequestOpts(requestParameters: CreateFormRequest): Promise; /** * Creates a new form in your account. ### Form\'s Attributes Here is a table that describes the attributes of the form object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the form. | | `status` | string | The current status of the form (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the form was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the form was last modified (ISO 8601 format). | * Create Form */ createFormRaw(requestParameters: CreateFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new form in your account. ### Form\'s Attributes Here is a table that describes the attributes of the form object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the form. | | `status` | string | The current status of the form (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the form was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the form was last modified (ISO 8601 format). | * Create Form */ createForm(requestParameters: CreateFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteForm without sending the request */ deleteFormRequestOpts(requestParameters: DeleteFormRequest): Promise; /** * This endpoint allows you to delete a specific form from your account. Once deleted, the form\'s information will be permanently removed and cannot be recovered. * Delete Form */ deleteFormRaw(requestParameters: DeleteFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific form from your account. Once deleted, the form\'s information will be permanently removed and cannot be recovered. * Delete Form */ deleteForm(requestParameters: DeleteFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for formOptions without sending the request */ formOptionsRequestOpts(requestParameters: FormOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Form Options */ formOptionsRaw(requestParameters: FormOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Form Options */ formOptions(requestParameters: FormOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for formsOptions without sending the request */ formsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Forms Options */ formsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Forms Options */ formsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listForms without sending the request */ listFormsRequestOpts(requestParameters: ListFormsRequest): Promise; /** * Returns a collection of your account forms ## Overview Returns a collection of your account forms, sorted by the time they were inserted into the system in ascending order. ### Forms Endpoints Pagination The forms 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 Forms */ listFormsRaw(requestParameters: ListFormsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account forms ## Overview Returns a collection of your account forms, sorted by the time they were inserted into the system in ascending order. ### Forms Endpoints Pagination The forms 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 Forms */ listForms(requestParameters?: ListFormsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showForm without sending the request */ showFormRequestOpts(requestParameters: ShowFormRequest): Promise; /** * This endpoint retrieves details of a specific form from your account. You can view information such as name, and other relevant attributes of the form. * Show Form */ showFormRaw(requestParameters: ShowFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific form from your account. You can view information such as name, and other relevant attributes of the form. * Show Form */ showForm(requestParameters: ShowFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateForm without sending the request */ updateFormRequestOpts(requestParameters: UpdateFormRequest): Promise; /** * This endpoint allows you to update details of a specific form 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 Form */ updateFormRaw(requestParameters: UpdateFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific form 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 Form */ updateForm(requestParameters: UpdateFormRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListFormsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListFormsFilterStatusEnum = typeof ListFormsFilterStatusEnum[keyof typeof ListFormsFilterStatusEnum]; /** * @export */ export declare const ListFormsFilterKindEnum: { readonly JobBrief: "jobBrief"; readonly CandidateSubmission: "candidateSubmission"; readonly TalentSubmission: "talentSubmission"; readonly General: "general"; }; export type ListFormsFilterKindEnum = typeof ListFormsFilterKindEnum[keyof typeof ListFormsFilterKindEnum]; //# sourceMappingURL=FormsApi.d.ts.map