/** * 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 { CreateNoteRequestBody, NoteSchema, NotesSchema, UpdateNoteRequestBody } from '../models/index'; export interface CreateNoteRequest { createNoteRequestBody: CreateNoteRequestBody; } export interface DeleteNoteRequest { noteId: string; } export interface ListNotesRequest { filterStatus?: ListNotesFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface NoteOptionsRequest { noteId: string; } export interface ShowNoteRequest { noteId: string; } export interface UpdateNoteRequest { noteId: string; updateNoteRequestBody: UpdateNoteRequestBody; } /** * */ export declare class NotesApi extends runtime.BaseAPI { /** * Creates request options for createNote without sending the request */ createNoteRequestOpts(requestParameters: CreateNoteRequest): Promise; /** * Creates a new note in your account. ### Note\'s Attributes Here is a table that describes the attributes of the note object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the note. | | `status` | string | The current status of the note (e.g., active, inactive, pending). | | `details` | object | Multilingual note details keyed by language code. | | `source` | string | Source of the note. | | `ttl` | string | Time-to-live expiration timestamp. | | `timestamps.created` | string | The date and time when the note was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the note was last modified (ISO 8601 format). | * Create Note */ createNoteRaw(requestParameters: CreateNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new note in your account. ### Note\'s Attributes Here is a table that describes the attributes of the note object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the note. | | `status` | string | The current status of the note (e.g., active, inactive, pending). | | `details` | object | Multilingual note details keyed by language code. | | `source` | string | Source of the note. | | `ttl` | string | Time-to-live expiration timestamp. | | `timestamps.created` | string | The date and time when the note was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the note was last modified (ISO 8601 format). | * Create Note */ createNote(requestParameters: CreateNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteNote without sending the request */ deleteNoteRequestOpts(requestParameters: DeleteNoteRequest): Promise; /** * This endpoint allows you to delete a specific note from your account. Once deleted, the note\'s information will be permanently removed and cannot be recovered. * Delete Note */ deleteNoteRaw(requestParameters: DeleteNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific note from your account. Once deleted, the note\'s information will be permanently removed and cannot be recovered. * Delete Note */ deleteNote(requestParameters: DeleteNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listNotes without sending the request */ listNotesRequestOpts(requestParameters: ListNotesRequest): Promise; /** * Returns a collection of your account notes ## Overview Returns a collection of your account notes, sorted by the time they were inserted into the system in ascending order. ### Notes Endpoints Pagination The notes 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 Notes */ listNotesRaw(requestParameters: ListNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account notes ## Overview Returns a collection of your account notes, sorted by the time they were inserted into the system in ascending order. ### Notes Endpoints Pagination The notes 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 Notes */ listNotes(requestParameters?: ListNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for noteOptions without sending the request */ noteOptionsRequestOpts(requestParameters: NoteOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Note Options */ noteOptionsRaw(requestParameters: NoteOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Note Options */ noteOptions(requestParameters: NoteOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for notesOptions without sending the request */ notesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Notes Options */ notesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Notes Options */ notesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showNote without sending the request */ showNoteRequestOpts(requestParameters: ShowNoteRequest): Promise; /** * This endpoint retrieves details of a specific note from your account. You can view information such as name, and other relevant attributes of the note. * Show Note */ showNoteRaw(requestParameters: ShowNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific note from your account. You can view information such as name, and other relevant attributes of the note. * Show Note */ showNote(requestParameters: ShowNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateNote without sending the request */ updateNoteRequestOpts(requestParameters: UpdateNoteRequest): Promise; /** * This endpoint allows you to update details of a specific note in your account. You can modify information such as name, and other relevant attributes of the note. Only the fields provided in the request will be updated. * Update Note */ updateNoteRaw(requestParameters: UpdateNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific note in your account. You can modify information such as name, and other relevant attributes of the note. Only the fields provided in the request will be updated. * Update Note */ updateNote(requestParameters: UpdateNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListNotesFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListNotesFilterStatusEnum = typeof ListNotesFilterStatusEnum[keyof typeof ListNotesFilterStatusEnum]; //# sourceMappingURL=NotesApi.d.ts.map