/** * 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 { CreateStateRequestBody, ListStatesFolderParameter, StateSchema, StatesSchema, UpdateStateRequestBody } from '../models/index'; export interface CreateStateRequest { createStateRequestBody: CreateStateRequestBody; } export interface DeleteStateRequest { stateId: string; } export interface ListStatesRequest { filterResourceType?: ListStatesFilterResourceTypeEnum; filterResourceIds?: string; folder?: ListStatesFolderParameter; pageSize?: number; pageAfter?: string; pageBefore?: string; } export interface ShowStateRequest { stateId: string; } export interface StateOptionsRequest { stateId: string; } export interface UpdateStateRequest { stateId: string; updateStateRequestBody: UpdateStateRequestBody; } /** * */ export declare class StatesApi extends runtime.BaseAPI { /** * Creates request options for createState without sending the request */ createStateRequestOpts(requestParameters: CreateStateRequest): Promise; /** * Idempotent upsert on `(user, resourceType, resourceId)`. Frontend posts the full desired state on every toggle. Sparse GSIs flip atomically. * Upsert State */ createStateRaw(requestParameters: CreateStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Idempotent upsert on `(user, resourceType, resourceId)`. Frontend posts the full desired state on every toggle. Sparse GSIs flip atomically. * Upsert State */ createState(requestParameters: CreateStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteState without sending the request */ deleteStateRequestOpts(requestParameters: DeleteStateRequest): Promise; /** * Hard-delete the state row. Equivalent to resetting the user\'s perception of the resource back to never-seen. * Delete State */ deleteStateRaw(requestParameters: DeleteStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Hard-delete the state row. Equivalent to resetting the user\'s perception of the resource back to never-seen. * Delete State */ deleteState(requestParameters: DeleteStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listStates without sending the request */ listStatesRequestOpts(requestParameters: ListStatesRequest): Promise; /** * Returns the authenticated user\'s per-resource states (seen/starred/flags). A state row exists only for resources the user has interacted with; there are no shadow rows auto-created on resource insert. That means `folder=all` without a resourceType/resourceIds filter lists only resources the user has actually touched. For the primary inbox feed, query `/v1/emails` first (filtered by direction/conversation/date) and batch-fetch states for the visible rows via `filterResourceIds=`. Scoping filters (orthogonal to `folder`): - `filterResourceType=emails` limits to one resource type. - `filterResourceIds=a,b,c` batch-fetches specific resources (requires `filterResourceType`). Folder filter (tagged union - exactly one value): - `folder=all` no filter (default) - `folder=unseen` unread rows, oldest-first (UnseenIndex) - `folder=starred` starred rows, most-recent-first (StarredIndex) - `folder=spam` user-marked spam (SpamIndex) - `folder=label:` rows whose flags.labels contains labelId * List States */ listStatesRaw(requestParameters: ListStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the authenticated user\'s per-resource states (seen/starred/flags). A state row exists only for resources the user has interacted with; there are no shadow rows auto-created on resource insert. That means `folder=all` without a resourceType/resourceIds filter lists only resources the user has actually touched. For the primary inbox feed, query `/v1/emails` first (filtered by direction/conversation/date) and batch-fetch states for the visible rows via `filterResourceIds=`. Scoping filters (orthogonal to `folder`): - `filterResourceType=emails` limits to one resource type. - `filterResourceIds=a,b,c` batch-fetches specific resources (requires `filterResourceType`). Folder filter (tagged union - exactly one value): - `folder=all` no filter (default) - `folder=unseen` unread rows, oldest-first (UnseenIndex) - `folder=starred` starred rows, most-recent-first (StarredIndex) - `folder=spam` user-marked spam (SpamIndex) - `folder=label:` rows whose flags.labels contains labelId * List States */ listStates(requestParameters?: ListStatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showState without sending the request */ showStateRequestOpts(requestParameters: ShowStateRequest): Promise; /** * Read one state row for the authenticated user. * Show State */ showStateRaw(requestParameters: ShowStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read one state row for the authenticated user. * Show State */ showState(requestParameters: ShowStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for stateOptions without sending the request */ stateOptionsRequestOpts(requestParameters: StateOptionsRequest): Promise; /** * Enable CORS by returning correct headers * State Options */ stateOptionsRaw(requestParameters: StateOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * State Options */ stateOptions(requestParameters: StateOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for statesOptions without sending the request */ statesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * States Options */ statesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * States Options */ statesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateState without sending the request */ updateStateRequestOpts(requestParameters: UpdateStateRequest): Promise; /** * Partial update of a state row. Omitted flags retain their current value. * Update State */ updateStateRaw(requestParameters: UpdateStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Partial update of a state row. Omitted flags retain their current value. * Update State */ updateState(requestParameters: UpdateStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListStatesFilterResourceTypeEnum: { readonly Emails: "emails"; readonly Chats: "chats"; readonly Calls: "calls"; readonly Comments: "comments"; readonly Candidates: "candidates"; readonly Conversations: "conversations"; readonly Jobs: "jobs"; readonly Talents: "talents"; readonly Personas: "personas"; readonly Reports: "reports"; readonly Tasks: "tasks"; }; export type ListStatesFilterResourceTypeEnum = typeof ListStatesFilterResourceTypeEnum[keyof typeof ListStatesFilterResourceTypeEnum]; //# sourceMappingURL=StatesApi.d.ts.map