@smartytalent/api-client 0.8.0 → 0.8.2

package/dist/apis/FindersApi.d.ts

@@ -48,12 +48,12 @@ export declare class FindersApi extends runtime.BaseAPI {
      */
     createFinderRequestOpts(requestParameters: CreateFinderRequest): Promise<runtime.RequestOpts>;
     /**
-     * Creates a new finder search in your account.  ### 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`.
+     * 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<runtime.ApiResponse<FinderSchema>>;
     /**
-     * Creates a new finder search in your account.  ### 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`.
+     * 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<FinderSchema>;
@@ -62,12 +62,12 @@ export declare class FindersApi extends runtime.BaseAPI {
      */
     deleteFinderRequestOpts(requestParameters: DeleteFinderRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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<runtime.ApiResponse<void>>;
     /**
-     * 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.
+     * 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<void>;
@@ -104,12 +104,12 @@ export declare class FindersApi extends runtime.BaseAPI {
      */
     listFindersRequestOpts(requestParameters: ListFindersRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns a collection of your account finders  ## 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).
+     * 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<runtime.ApiResponse<FindersSchema>>;
     /**
-     * Returns a collection of your account finders  ## 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).
+     * 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<FindersSchema>;
@@ -118,12 +118,12 @@ export declare class FindersApi extends runtime.BaseAPI {
      */
     showFinderRequestOpts(requestParameters: ShowFinderRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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<runtime.ApiResponse<FinderSchema>>;
     /**
-     * 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.
+     * 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<FinderSchema>;
@@ -132,12 +132,12 @@ export declare class FindersApi extends runtime.BaseAPI {
      */
     updateFinderRequestOpts(requestParameters: UpdateFinderRequest): Promise<runtime.RequestOpts>;
     /**
-     * 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.
+     * 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<runtime.ApiResponse<FinderSchema>>;
     /**
-     * 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.
+     * 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<FinderSchema>;

package/dist/apis/FindersApi.js

@@ -80,7 +80,7 @@ class FindersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Creates a new finder search in your account.  ### 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`.
+     * 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
      */
     async createFinderRaw(requestParameters, initOverrides) {
@@ -89,7 +89,7 @@ class FindersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FinderSchemaFromJSON)(jsonValue));
     }
     /**
-     * Creates a new finder search in your account.  ### 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`.
+     * 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
      */
     async createFinder(requestParameters, initOverrides) {
@@ -122,7 +122,7 @@ class FindersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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.
+     * 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
      */
     async deleteFinderRaw(requestParameters, initOverrides) {
@@ -131,7 +131,7 @@ class FindersApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
-     * 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.
+     * 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
      */
     async deleteFinder(requestParameters, initOverrides) {
@@ -253,7 +253,7 @@ class FindersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Returns a collection of your account finders  ## 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).
+     * 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
      */
     async listFindersRaw(requestParameters, initOverrides) {
@@ -262,7 +262,7 @@ class FindersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FindersSchemaFromJSON)(jsonValue));
     }
     /**
-     * Returns a collection of your account finders  ## 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).
+     * 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
      */
     async listFinders(requestParameters = {}, initOverrides) {
@@ -295,7 +295,7 @@ class FindersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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.
+     * 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
      */
     async showFinderRaw(requestParameters, initOverrides) {
@@ -304,7 +304,7 @@ class FindersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FinderSchemaFromJSON)(jsonValue));
     }
     /**
-     * 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.
+     * 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
      */
     async showFinder(requestParameters, initOverrides) {
@@ -342,7 +342,7 @@ class FindersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * 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.
+     * 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
      */
     async updateFinderRaw(requestParameters, initOverrides) {
@@ -351,7 +351,7 @@ class FindersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FinderSchemaFromJSON)(jsonValue));
     }
     /**
-     * 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.
+     * 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
      */
     async updateFinder(requestParameters, initOverrides) {

package/dist/apis/ResponsesApi.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 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 { GuestResponseSchema, ResponseSchema, ResponsesSchema, SubmitGuestResponseRequestBody } from '../models/index';
+export interface GuestResponseOptionsRequest {
+    responseId: string;
+}
+export interface ListResponsesRequest {
+    filterStatus?: ListResponsesFilterStatusEnum;
+    filterSurveyId?: string;
+    filterCandidateId?: string;
+    filterCreatedFrom?: Date;
+    filterCreatedTo?: Date;
+    filterModifiedFrom?: Date;
+    filterModifiedTo?: Date;
+    pageSize?: number;
+    pageNumber?: number;
+    pageAfter?: string;
+    pageBefore?: string;
+}
+export interface ResponseOptionsRequest {
+    responseId: string;
+}
+export interface ShowGuestResponseRequest {
+    responseId: string;
+    tenantId: string;
+    token: string;
+}
+export interface ShowResponseRequest {
+    responseId: string;
+}
+export interface SubmitGuestResponseRequest {
+    responseId: string;
+    submitGuestResponseRequestBody: SubmitGuestResponseRequestBody;
+}
+/**
+ *
+ */
+export declare class ResponsesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for guestResponseOptions without sending the request
+     */
+    guestResponseOptionsRequestOpts(requestParameters: GuestResponseOptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Enable CORS by returning correct headers
+     * Guest Response Options
+     */
+    guestResponseOptionsRaw(requestParameters: GuestResponseOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Enable CORS by returning correct headers
+     * Guest Response Options
+     */
+    guestResponseOptions(requestParameters: GuestResponseOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listResponses without sending the request
+     */
+    listResponsesRequestOpts(requestParameters: ListResponsesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a collection of survey responses for the caller\'s tenant. Recruiter surface - requires a session (CUSTOM authorizer); the recipient never reaches this path.  Use one filter at a time (one GSI per query):   - `filterStatus=completed`   - answered responses   - `filterSurveyId=<id>`      - responses of one survey   - `filterCandidateId=<id>`   - responses sent to one candidate  `answers` is keyed by questionId and absent until the recipient answers. `results` (e.g. the NPS category) are computed server-side on submit and are read-only. The NPS number itself is derived by the reader as `(promoters - detractors) / total * 100`.
+     * List Responses
+     */
+    listResponsesRaw(requestParameters: ListResponsesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponsesSchema>>;
+    /**
+     * Returns a collection of survey responses for the caller\'s tenant. Recruiter surface - requires a session (CUSTOM authorizer); the recipient never reaches this path.  Use one filter at a time (one GSI per query):   - `filterStatus=completed`   - answered responses   - `filterSurveyId=<id>`      - responses of one survey   - `filterCandidateId=<id>`   - responses sent to one candidate  `answers` is keyed by questionId and absent until the recipient answers. `results` (e.g. the NPS category) are computed server-side on submit and are read-only. The NPS number itself is derived by the reader as `(promoters - detractors) / total * 100`.
+     * List Responses
+     */
+    listResponses(requestParameters?: ListResponsesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponsesSchema>;
+    /**
+     * Creates request options for responseOptions without sending the request
+     */
+    responseOptionsRequestOpts(requestParameters: ResponseOptionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Enable CORS by returning correct headers
+     * Response Options
+     */
+    responseOptionsRaw(requestParameters: ResponseOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Enable CORS by returning correct headers
+     * Response Options
+     */
+    responseOptions(requestParameters: ResponseOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for responsesOptions without sending the request
+     */
+    responsesOptionsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Enable CORS by returning correct headers
+     * Responses Options
+     */
+    responsesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Enable CORS by returning correct headers
+     * Responses Options
+     */
+    responsesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for showGuestResponse without sending the request
+     */
+    showGuestResponseRequestOpts(requestParameters: ShowGuestResponseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Recipient opens the survey link from the email. There is no authorizer on this path: auth is `tenantId` + `token` (the per-response accessToken minted at create) read from the link query string, never a session.  The response is an explicit allowlist - status, languageCode, candidateName, jobTitle, companyName, title, questions, answers, expiresAt, respondedAt. `title` and `questions` are the SNAPSHOT of the published survey definition stamped at mint time. No `meta` (it holds the accessToken), no candidateId / jobId, no surveyId / surveyVersion, no results, no relationships.  A pending response past `expiresAt` reads back with status `expired`; an answered one reads back `completed` with the stored answers so the FE renders the thank-you state.  Every failure mode (unknown tenant, unknown response, wrong token) collapses to the same 404 - existence is never leaked.
+     * Show Guest Response
+     */
+    showGuestResponseRaw(requestParameters: ShowGuestResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestResponseSchema>>;
+    /**
+     * Recipient opens the survey link from the email. There is no authorizer on this path: auth is `tenantId` + `token` (the per-response accessToken minted at create) read from the link query string, never a session.  The response is an explicit allowlist - status, languageCode, candidateName, jobTitle, companyName, title, questions, answers, expiresAt, respondedAt. `title` and `questions` are the SNAPSHOT of the published survey definition stamped at mint time. No `meta` (it holds the accessToken), no candidateId / jobId, no surveyId / surveyVersion, no results, no relationships.  A pending response past `expiresAt` reads back with status `expired`; an answered one reads back `completed` with the stored answers so the FE renders the thank-you state.  Every failure mode (unknown tenant, unknown response, wrong token) collapses to the same 404 - existence is never leaked.
+     * Show Guest Response
+     */
+    showGuestResponse(requestParameters: ShowGuestResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestResponseSchema>;
+    /**
+     * Creates request options for showResponse without sending the request
+     */
+    showResponseRequestOpts(requestParameters: ShowResponseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a single survey response, including the question snapshot the recipient saw, their `answers` and the server-computed `results`. Recruiter surface - requires a session (CUSTOM authorizer).  Free-text answers are recipient-authored - treat them as untrusted content and never feed them to an LLM.
+     * Show Response
+     */
+    showResponseRaw(requestParameters: ShowResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseSchema>>;
+    /**
+     * Returns a single survey response, including the question snapshot the recipient saw, their `answers` and the server-computed `results`. Recruiter surface - requires a session (CUSTOM authorizer).  Free-text answers are recipient-authored - treat them as untrusted content and never feed them to an LLM.
+     * Show Response
+     */
+    showResponse(requestParameters: ShowResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseSchema>;
+    /**
+     * Creates request options for submitGuestResponse without sending the request
+     */
+    submitGuestResponseRequestOpts(requestParameters: SubmitGuestResponseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Recipient answers the survey. There is no authorizer on this path: auth is `meta.tenantId` + `meta.accessToken` from the emailed link, never a session.  `answers` is an object keyed by the snapshot\'s questionIds. Value shape per question type: scale -> integer within scaleMin..scaleMax; single-choice -> one option `value` slug; multiple-choice -> array of unique option `value` slugs; open-text -> string (maxLength). Every answer is validated against the row\'s snapshot - unknown questionIds, missing required answers, out-of-range scales, unknown option slugs and over-length text are all rejected in ONE 400 with per-question detail. `results` (e.g. the NPS category) are computed server-side and are read-only - a client-supplied value is ignored.  Single use: allowed only from status `pending` and only before `expiresAt`. A second submit is a 400-class error, never a silent overwrite. Token mismatch returns the same 404 as an unknown response. The response carries the same guest allowlist as showGuestResponse.
+     * Submit Guest Response
+     */
+    submitGuestResponseRaw(requestParameters: SubmitGuestResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestResponseSchema>>;
+    /**
+     * Recipient answers the survey. There is no authorizer on this path: auth is `meta.tenantId` + `meta.accessToken` from the emailed link, never a session.  `answers` is an object keyed by the snapshot\'s questionIds. Value shape per question type: scale -> integer within scaleMin..scaleMax; single-choice -> one option `value` slug; multiple-choice -> array of unique option `value` slugs; open-text -> string (maxLength). Every answer is validated against the row\'s snapshot - unknown questionIds, missing required answers, out-of-range scales, unknown option slugs and over-length text are all rejected in ONE 400 with per-question detail. `results` (e.g. the NPS category) are computed server-side and are read-only - a client-supplied value is ignored.  Single use: allowed only from status `pending` and only before `expiresAt`. A second submit is a 400-class error, never a silent overwrite. Token mismatch returns the same 404 as an unknown response. The response carries the same guest allowlist as showGuestResponse.
+     * Submit Guest Response
+     */
+    submitGuestResponse(requestParameters: SubmitGuestResponseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestResponseSchema>;
+}
+/**
+ * @export
+ */
+export declare const ListResponsesFilterStatusEnum: {
+    readonly Pending: "pending";
+    readonly Completed: "completed";
+    readonly Expired: "expired";
+};
+export type ListResponsesFilterStatusEnum = typeof ListResponsesFilterStatusEnum[keyof typeof ListResponsesFilterStatusEnum];
+//# sourceMappingURL=ResponsesApi.d.ts.map

package/dist/apis/ResponsesApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponsesApi.d.ts","sourceRoot":"","sources":["../../src/apis/ResponsesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAEV,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,8BAA8B,EAC/B,MAAM,iBAAiB,CAAC;AAczB,MAAM,WAAW,2BAA2B;IACxC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,YAAY,CAAC,EAAE,6BAA6B,CAAC;IAC7C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,CAAC;IAC1B,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAChC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B,EAAE,8BAA8B,CAAC;CAClE;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACG,+BAA+B,CAAC,iBAAiB,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAwBnH;;;OAGG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAO7K;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrJ;;OAEG;IACG,wBAAwB,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAqErG;;;OAGG;IACG,gBAAgB,CAAC,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAO1K;;;OAGG;IACG,aAAa,CAAC,iBAAiB,GAAE,oBAAyB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC;IAKvJ;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAwBzG;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOnK;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3I;;OAEG;IACG,2BAA2B,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAgBjE;;;OAGG;IACG,mBAAmB,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOzH;;;OAGG;IACG,gBAAgB,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjG;;OAEG;IACG,4BAA4B,CAAC,iBAAiB,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IA8C7G;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAOtL;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAK9J;;OAEG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAiCnG;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAOvK;;;OAGG;IACG,YAAY,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;IAK/I;;OAEG;IACG,8BAA8B,CAAC,iBAAiB,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAkCjH;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAO1L;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAKrK;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;CAIhC,CAAC;AACX,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC"}