/** * 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 { CreateFinderRequestBody, FinderSchema, FindersSchema, UpdateFinderRequestBody } from '../models/index'; export interface CreateFinderRequest { createFinderRequestBody: CreateFinderRequestBody; } export interface DeleteFinderRequest { finderId: string; } export interface FinderOptionsRequest { finderId: string; } export interface ListFindersRequest { filterStatus?: ListFindersFilterStatusEnum; filterType?: ListFindersFilterTypeEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowFinderRequest { finderId: string; } export interface UpdateFinderRequest { finderId: string; updateFinderRequestBody: UpdateFinderRequestBody; } /** * */ export declare class FindersApi extends runtime.BaseAPI { /** * Creates request options for createFinder without sending the request */ createFinderRequestOpts(requestParameters: CreateFinderRequest): Promise; /** * Creates a new finder search in your account. Roles `recruiter`, `recops`, `owner` and `sysowner` only - search across the talent and candidate pool is limited to the roles that screen people. ### Finder\'s Attributes Here is a table that describes the attributes of the finder object: | Attribute | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the finder search (1-256 characters) | | `type` | string | Yes | The type of search: talents, candidates, jobs, emails, users, reports | | `query` | object | No | The search query parameters sent to OpenSearch (e.g. `{ \"type\": \"talents\", \"jobId\": \"...\" }`) | | `results` | object | No | The search results (auto-populated after OpenSearch query execution) | | `status` | string | No | The current status: active (default), pending, completed, failed, archived | | `languageCode` | string | No | Language code for the finder (default: `en`) | | `settings` | object | No | Additional configuration settings | | `source` | string | No | Source of the finder creation (nullable) | | `ttl` | string | No | Time-to-live expiration timestamp in ISO 8601 format (nullable) | | `timestamps.created` | string | No | The date and time when the finder was created (ISO 8601 format) | | `timestamps.modified` | string | No | The date and time when the finder was last modified (ISO 8601 format) | ### Relationships | Relationship | Type | Description | |-------------|------|-------------| | `jobs` | array | Associated job resources | | `users` | array | Associated user resources | | `talents` | array | Associated talent resources | | `candidates` | array | Associated candidate resources | ### Behavior When a `query` is provided, OpenSearch is queried immediately. The `results` field is populated with matching documents and `status` is set to `completed` or `failed`. * Create Finder */ createFinderRaw(requestParameters: CreateFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new finder search in your account. Roles `recruiter`, `recops`, `owner` and `sysowner` only - search across the talent and candidate pool is limited to the roles that screen people. ### Finder\'s Attributes Here is a table that describes the attributes of the finder object: | Attribute | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the finder search (1-256 characters) | | `type` | string | Yes | The type of search: talents, candidates, jobs, emails, users, reports | | `query` | object | No | The search query parameters sent to OpenSearch (e.g. `{ \"type\": \"talents\", \"jobId\": \"...\" }`) | | `results` | object | No | The search results (auto-populated after OpenSearch query execution) | | `status` | string | No | The current status: active (default), pending, completed, failed, archived | | `languageCode` | string | No | Language code for the finder (default: `en`) | | `settings` | object | No | Additional configuration settings | | `source` | string | No | Source of the finder creation (nullable) | | `ttl` | string | No | Time-to-live expiration timestamp in ISO 8601 format (nullable) | | `timestamps.created` | string | No | The date and time when the finder was created (ISO 8601 format) | | `timestamps.modified` | string | No | The date and time when the finder was last modified (ISO 8601 format) | ### Relationships | Relationship | Type | Description | |-------------|------|-------------| | `jobs` | array | Associated job resources | | `users` | array | Associated user resources | | `talents` | array | Associated talent resources | | `candidates` | array | Associated candidate resources | ### Behavior When a `query` is provided, OpenSearch is queried immediately. The `results` field is populated with matching documents and `status` is set to `completed` or `failed`. * Create Finder */ createFinder(requestParameters: CreateFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteFinder without sending the request */ deleteFinderRequestOpts(requestParameters: DeleteFinderRequest): Promise; /** * This endpoint allows you to delete a specific finder from your account. Once deleted, the finder\'s information will be permanently removed and cannot be recovered. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Delete Finder */ deleteFinderRaw(requestParameters: DeleteFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific finder from your account. Once deleted, the finder\'s information will be permanently removed and cannot be recovered. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Delete Finder */ deleteFinder(requestParameters: DeleteFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for finderOptions without sending the request */ finderOptionsRequestOpts(requestParameters: FinderOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Finder Options */ finderOptionsRaw(requestParameters: FinderOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Finder Options */ finderOptions(requestParameters: FinderOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for findersOptions without sending the request */ findersOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Finders Options */ findersOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Finders Options */ findersOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listFinders without sending the request */ listFindersRequestOpts(requestParameters: ListFindersRequest): Promise; /** * Returns a collection of your account finders. Roles `recruiter`, `recops`, `owner` and `sysowner` only - a finder row carries its hit list, so reading one is reading the search results. ## Overview Returns a collection of your account finders, sorted by the time they were inserted into the system in ascending order. ### Finders Endpoints Pagination The finders 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 Finders */ listFindersRaw(requestParameters: ListFindersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account finders. Roles `recruiter`, `recops`, `owner` and `sysowner` only - a finder row carries its hit list, so reading one is reading the search results. ## Overview Returns a collection of your account finders, sorted by the time they were inserted into the system in ascending order. ### Finders Endpoints Pagination The finders 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 Finders */ listFinders(requestParameters?: ListFindersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showFinder without sending the request */ showFinderRequestOpts(requestParameters: ShowFinderRequest): Promise; /** * This endpoint retrieves details of a specific finder from your account. You can view information such as name, type, query, results, status, settings, and other relevant attributes of the finder. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Show Finder */ showFinderRaw(requestParameters: ShowFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific finder from your account. You can view information such as name, type, query, results, status, settings, and other relevant attributes of the finder. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Show Finder */ showFinder(requestParameters: ShowFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateFinder without sending the request */ updateFinderRequestOpts(requestParameters: UpdateFinderRequest): Promise; /** * This endpoint allows you to update details of a specific finder in your account. You can modify information such as name, query, status, settings, and other relevant attributes of the finder. Only the fields provided in the request will be updated. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Update Finder */ updateFinderRaw(requestParameters: UpdateFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific finder in your account. You can modify information such as name, query, status, settings, and other relevant attributes of the finder. Only the fields provided in the request will be updated. Roles `recruiter`, `recops`, `owner` and `sysowner` only. * Update Finder */ updateFinder(requestParameters: UpdateFinderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListFindersFilterStatusEnum: { readonly Active: "active"; readonly Pending: "pending"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Archived: "archived"; }; export type ListFindersFilterStatusEnum = typeof ListFindersFilterStatusEnum[keyof typeof ListFindersFilterStatusEnum]; /** * @export */ export declare const ListFindersFilterTypeEnum: { readonly Talents: "talents"; readonly Candidates: "candidates"; readonly Jobs: "jobs"; readonly Emails: "emails"; readonly Users: "users"; readonly Reports: "reports"; readonly Briefs: "briefs"; }; export type ListFindersFilterTypeEnum = typeof ListFindersFilterTypeEnum[keyof typeof ListFindersFilterTypeEnum]; //# sourceMappingURL=FindersApi.d.ts.map