/** * 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 { TimelineSchema, TimelinesSchema } from '../models/index'; export interface CorsTimelineEntryRequest { timelineId: string; } export interface CorsTimelineRollbackRequest { timelineId: string; } export interface ListTimelinesRequest { filterEntityKey?: string; filterUserKey?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface RollbackTimelineRequest { timelineId: string; } export interface ShowTimelineRequest { timelineId: string; } /** * */ export declare class TimelinesApi extends runtime.BaseAPI { /** * Creates request options for corsTimelineEntry without sending the request */ corsTimelineEntryRequestOpts(requestParameters: CorsTimelineEntryRequest): Promise; /** * CORS support for Timeline Entry */ corsTimelineEntryRaw(requestParameters: CorsTimelineEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * CORS support for Timeline Entry */ corsTimelineEntry(requestParameters: CorsTimelineEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for corsTimelineRollback without sending the request */ corsTimelineRollbackRequestOpts(requestParameters: CorsTimelineRollbackRequest): Promise; /** * CORS support for Timeline Rollback */ corsTimelineRollbackRaw(requestParameters: CorsTimelineRollbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * CORS support for Timeline Rollback */ corsTimelineRollback(requestParameters: CorsTimelineRollbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for corsTimelines without sending the request */ corsTimelinesRequestOpts(): Promise; /** * CORS support for Timelines */ corsTimelinesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * CORS support for Timelines */ corsTimelines(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listTimelines without sending the request */ listTimelinesRequestOpts(requestParameters: ListTimelinesRequest): Promise; /** * Returns a collection of timeline entries. ## Overview Returns a collection of timeline entries (change history), sorted by the time they were created in descending order (most recent first). ### Timeline Endpoints Pagination The timeline 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. #### More information For more information, see the [pagination documentation](/docs/pagination). ### Filtering Use one filter at a time. Available filters: - `filterEntityKey` - Filter by entity key prefix (e.g., \"jobs#jobId\" to get all timeline entries for a specific job). Uses the EntityIndex. A job\'s feed mixes kind=change row edits with kind=event project-lifecycle entries (activation, form/ads/assessment/feedback builds); a candidate\'s feed carries its application history (stage moves live here, never on the job). - `filterUserKey` - Filter by user key prefix (e.g., \"userId\" to get all timeline entries by a specific user). Uses the UserIndex. - `filterCreatedFrom` / `filterCreatedTo` - Filter by creation date range. Uses the CreatedIndex. * List Timelines */ listTimelinesRaw(requestParameters: ListTimelinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of timeline entries. ## Overview Returns a collection of timeline entries (change history), sorted by the time they were created in descending order (most recent first). ### Timeline Endpoints Pagination The timeline 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. #### More information For more information, see the [pagination documentation](/docs/pagination). ### Filtering Use one filter at a time. Available filters: - `filterEntityKey` - Filter by entity key prefix (e.g., \"jobs#jobId\" to get all timeline entries for a specific job). Uses the EntityIndex. A job\'s feed mixes kind=change row edits with kind=event project-lifecycle entries (activation, form/ads/assessment/feedback builds); a candidate\'s feed carries its application history (stage moves live here, never on the job). - `filterUserKey` - Filter by user key prefix (e.g., \"userId\" to get all timeline entries by a specific user). Uses the UserIndex. - `filterCreatedFrom` / `filterCreatedTo` - Filter by creation date range. Uses the CreatedIndex. * List Timelines */ listTimelines(requestParameters?: ListTimelinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for rollbackTimeline without sending the request */ rollbackTimelineRequestOpts(requestParameters: RollbackTimelineRequest): Promise; /** * Rolls back the entity to the state captured in the specified timeline entry. * Rollback Timeline Entry */ rollbackTimelineRaw(requestParameters: RollbackTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Rolls back the entity to the state captured in the specified timeline entry. * Rollback Timeline Entry */ rollbackTimeline(requestParameters: RollbackTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showTimeline without sending the request */ showTimelineRequestOpts(requestParameters: ShowTimelineRequest): Promise; /** * Returns a single timeline entry by its ID. * Show Timeline Entry */ showTimelineRaw(requestParameters: ShowTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a single timeline entry by its ID. * Show Timeline Entry */ showTimeline(requestParameters: ShowTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } //# sourceMappingURL=TimelinesApi.d.ts.map