/** * 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 { CreateScheduleRequestBody, ScheduleSchema, SchedulesSchema, UpdateScheduleRequestBody } from '../models/index'; export interface CreateScheduleRequest { createScheduleRequestBody: CreateScheduleRequestBody; } export interface DeleteScheduleRequest { scheduleId: string; permanentDelete?: DeleteSchedulePermanentDeleteEnum; } export interface ListSchedulesRequest { filterStatus?: ListSchedulesFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ScheduleOptionsRequest { scheduleId: string; } export interface ShowScheduleRequest { scheduleId: string; } export interface UpdateScheduleRequest { scheduleId: string; updateScheduleRequestBody: UpdateScheduleRequestBody; } /** * */ export declare class SchedulesApi extends runtime.BaseAPI { /** * Creates request options for createSchedule without sending the request */ createScheduleRequestOpts(requestParameters: CreateScheduleRequest): Promise; /** * Schedule an action to fire at a future time. `fireAt` must be an absolute ISO 8601 timestamp. The `target` identifies which action Lambda to invoke (e.g. `email:send`, `call:initiate`) and the payload to pass it. Returns the persisted schedule; an EventBridge Schedule is created server-side. * Create Schedule */ createScheduleRaw(requestParameters: CreateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Schedule an action to fire at a future time. `fireAt` must be an absolute ISO 8601 timestamp. The `target` identifies which action Lambda to invoke (e.g. `email:send`, `call:initiate`) and the payload to pass it. Returns the persisted schedule; an EventBridge Schedule is created server-side. * Create Schedule */ createSchedule(requestParameters: CreateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteSchedule without sending the request */ deleteScheduleRequestOpts(requestParameters: DeleteScheduleRequest): Promise; /** * Cancel a pending schedule. The EventBridge Schedule is deleted so it does not fire. Soft delete (sets status=cancelled) by default; pass `?permanentDelete=true` to also remove the DynamoDB row. * Cancel Schedule */ deleteScheduleRaw(requestParameters: DeleteScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancel a pending schedule. The EventBridge Schedule is deleted so it does not fire. Soft delete (sets status=cancelled) by default; pass `?permanentDelete=true` to also remove the DynamoDB row. * Cancel Schedule */ deleteSchedule(requestParameters: DeleteScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listSchedules without sending the request */ listSchedulesRequestOpts(requestParameters: ListSchedulesRequest): Promise; /** * Return scheduled actions (pending, fired, cancelled, failed). * List Schedules */ listSchedulesRaw(requestParameters: ListSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return scheduled actions (pending, fired, cancelled, failed). * List Schedules */ listSchedules(requestParameters?: ListSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for scheduleOptions without sending the request */ scheduleOptionsRequestOpts(requestParameters: ScheduleOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Schedule Options */ scheduleOptionsRaw(requestParameters: ScheduleOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Schedule Options */ scheduleOptions(requestParameters: ScheduleOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for schedulesOptions without sending the request */ schedulesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Schedules Options */ schedulesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Schedules Options */ schedulesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showSchedule without sending the request */ showScheduleRequestOpts(requestParameters: ShowScheduleRequest): Promise; /** * Return a single schedule. * Show Schedule */ showScheduleRaw(requestParameters: ShowScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return a single schedule. * Show Schedule */ showSchedule(requestParameters: ShowScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateSchedule without sending the request */ updateScheduleRequestOpts(requestParameters: UpdateScheduleRequest): Promise; /** * Update a pending schedule\'s fireAt, name, target, or relationships. The EventBridge Schedule is updated to match. Schedules already in fired/cancelled/failed state cannot be updated. * Update Schedule */ updateScheduleRaw(requestParameters: UpdateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a pending schedule\'s fireAt, name, target, or relationships. The EventBridge Schedule is updated to match. Schedules already in fired/cancelled/failed state cannot be updated. * Update Schedule */ updateSchedule(requestParameters: UpdateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteSchedulePermanentDeleteEnum: { readonly True: "true"; readonly False: "false"; }; export type DeleteSchedulePermanentDeleteEnum = typeof DeleteSchedulePermanentDeleteEnum[keyof typeof DeleteSchedulePermanentDeleteEnum]; /** * @export */ export declare const ListSchedulesFilterStatusEnum: { readonly Pending: "pending"; readonly Fired: "fired"; readonly Cancelled: "cancelled"; readonly Failed: "failed"; }; export type ListSchedulesFilterStatusEnum = typeof ListSchedulesFilterStatusEnum[keyof typeof ListSchedulesFilterStatusEnum]; //# sourceMappingURL=SchedulesApi.d.ts.map