/** * 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 { CreateOperationRequestBody, OperationSchema, OperationsSchema, TeamtailorWebhookRequest, UpdateOperationRequestBody } from '../models/index'; export interface CreateOperationRequest { createOperationRequestBody: CreateOperationRequestBody; } export interface DeleteOperationRequest { operationId: string; } export interface ListOperationsRequest { filterStatus?: ListOperationsFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface OperationOptionsRequest { operationId: string; } export interface ShowOperationRequest { operationId: string; } export interface TeamtailorWebhookOperationRequest { tenantId: string; userId: string; teamtailorWebhookRequest: TeamtailorWebhookRequest; } export interface TeamtailorWebhookOptionsRequest { tenantId: string; userId: string; } export interface UpdateOperationRequest { operationId: string; updateOperationRequestBody: UpdateOperationRequestBody; } /** * */ export declare class OperationsApi extends runtime.BaseAPI { /** * Creates request options for createOperation without sending the request */ createOperationRequestOpts(requestParameters: CreateOperationRequest): Promise; /** * Creates a new operation in your account. ### Operation\'s Attributes Here is a table that describes the attributes of the operation object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the operation. | | `status` | string | The current status of the operation (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the operation was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the operation was last modified (ISO 8601 format). | * Create Operation */ createOperationRaw(requestParameters: CreateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new operation in your account. ### Operation\'s Attributes Here is a table that describes the attributes of the operation object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the operation. | | `status` | string | The current status of the operation (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the operation was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the operation was last modified (ISO 8601 format). | * Create Operation */ createOperation(requestParameters: CreateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteOperation without sending the request */ deleteOperationRequestOpts(requestParameters: DeleteOperationRequest): Promise; /** * This endpoint allows you to delete a specific operation from your account. Once deleted, the operation\'s information will be permanently removed and cannot be recovered. * Delete Operation */ deleteOperationRaw(requestParameters: DeleteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific operation from your account. Once deleted, the operation\'s information will be permanently removed and cannot be recovered. * Delete Operation */ deleteOperation(requestParameters: DeleteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listOperations without sending the request */ listOperationsRequestOpts(requestParameters: ListOperationsRequest): Promise; /** * Returns a collection of your account operations ## Overview Returns a collection of your account operations, sorted by the time they were inserted into the system in ascending order. ### Operations Endpoints Pagination The operations 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 Operations */ listOperationsRaw(requestParameters: ListOperationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account operations ## Overview Returns a collection of your account operations, sorted by the time they were inserted into the system in ascending order. ### Operations Endpoints Pagination The operations 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 Operations */ listOperations(requestParameters?: ListOperationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for operationOptions without sending the request */ operationOptionsRequestOpts(requestParameters: OperationOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Operation Options */ operationOptionsRaw(requestParameters: OperationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Operation Options */ operationOptions(requestParameters: OperationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for operationsOptions without sending the request */ operationsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Operations Options */ operationsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Operations Options */ operationsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showOperation without sending the request */ showOperationRequestOpts(requestParameters: ShowOperationRequest): Promise; /** * This endpoint retrieves details of a specific operation from your account. You can view information such as name, and other relevant attributes of the operation. * Show Operation */ showOperationRaw(requestParameters: ShowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific operation from your account. You can view information such as name, and other relevant attributes of the operation. * Show Operation */ showOperation(requestParameters: ShowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for teamtailorWebhook without sending the request */ teamtailorWebhookRequestOpts(requestParameters: TeamtailorWebhookOperationRequest): Promise; /** * Public endpoint Teamtailor POSTs Company Webhook events to. Authenticated via the TT-Signature HMAC header, not the platform apikey. Mints an operation ledger row (source=teamtailor) and emits service:operation:created. * Teamtailor Company Webhook */ teamtailorWebhookRaw(requestParameters: TeamtailorWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Public endpoint Teamtailor POSTs Company Webhook events to. Authenticated via the TT-Signature HMAC header, not the platform apikey. Mints an operation ledger row (source=teamtailor) and emits service:operation:created. * Teamtailor Company Webhook */ teamtailorWebhook(requestParameters: TeamtailorWebhookOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for teamtailorWebhookOptions without sending the request */ teamtailorWebhookOptionsRequestOpts(requestParameters: TeamtailorWebhookOptionsRequest): Promise; /** * CORS preflight. * Teamtailor webhook CORS preflight */ teamtailorWebhookOptionsRaw(requestParameters: TeamtailorWebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * CORS preflight. * Teamtailor webhook CORS preflight */ teamtailorWebhookOptions(requestParameters: TeamtailorWebhookOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateOperation without sending the request */ updateOperationRequestOpts(requestParameters: UpdateOperationRequest): Promise; /** * This endpoint allows you to update details of a specific operation in your account. You can modify information such as name, and other relevant attributes of the operation. Only the fields provided in the request will be updated. * Update Operation */ updateOperationRaw(requestParameters: UpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific operation in your account. You can modify information such as name, and other relevant attributes of the operation. Only the fields provided in the request will be updated. * Update Operation */ updateOperation(requestParameters: UpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListOperationsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListOperationsFilterStatusEnum = typeof ListOperationsFilterStatusEnum[keyof typeof ListOperationsFilterStatusEnum]; //# sourceMappingURL=OperationsApi.d.ts.map