@smartytalent/openai-tools 0.1.33-dev.4 → 0.1.33-dev.6

package/dist/tools.json

@@ -6509,6 +6509,22 @@
             "type": "string",
             "description": "Return only emails belonging to this conversation. Resolved via the ConversationIdIndex GSI (top-level denormalisation of relationships.conversations[0].data.id). Pass the full conversation id (e.g. `980434e7...-2`)."
           },
+          "filterDirection": {
+            "type": "string",
+            "description": "Return only emails with this direction. `inbound` = received from an external sender (Inbox), `outbound` = composed by the tenant (Sent). Resolved via the DirectionIndex GSI. Mutually exclusive with `filterStatus` and `filterConversationId` at the pagination layer.",
+            "enum": [
+              "inbound",
+              "outbound"
+            ]
+          },
+          "filterIds": {
+            "type": "string",
+            "description": "Batch-fetch emails by id. Pass a comma-separated list (e.g. `abc-1,def-2,ghi-3`). Resolves each id's shard from its suffix and issues a BatchGetItem. Used by the inbox UI to hydrate emails referenced by state rows (folder=unseen / starred / spam) without N showEmail calls. Cap: 500 ids per request; beyond that, page the state list and batch again. Bypasses pagination - the returned `data` is the full batch result with no `nextPage` cursor."
+          },
+          "filterIsSystemSpam": {
+            "type": "boolean",
+            "description": "Return only emails the system (broker / classifier) flagged as spam. Used by the Spam folder's `isSystemSpam=true` leg - the other leg comes from `/v1/states?folder=spam`. Backed by a filter-expression scan across shards for v1; promote to a sparse `SystemSpamIndex` if load warrants. Mutually exclusive with the other index-backed filters at the pagination layer."
+          },
           "filterCreatedFrom": {
             "type": "string",
             "description": "Filters results to include only those created from the specified date and time. The value must be in ISO 8601 format."
@@ -11736,17 +11752,9 @@
             "type": "string",
             "description": "Comma-separated list of resource ids to batch-fetch. Requires `filterResourceType`."
           },
-          "filterIsStarred": {
-            "type": "boolean",
-            "description": "Only return starred states."
-          },
-          "filterIsSeen": {
-            "type": "boolean",
-            "description": "Only return seen (true) or unseen (false) states."
-          },
-          "filterIsSpam": {
-            "type": "boolean",
-            "description": "Only return spam-marked states. Reads from the SpamIndex."
+          "folder": {
+            "type": "string",
+            "description": "Folder-style filter. Tagged-union: the fixed folders are an enum,\nand the label folder is a `label:<labelId>` template. Orthogonal\nto filterResourceType and filterResourceIds which scope within\nthe folder.\n\nFixed folders:\n  `all`     - default, no folder filter\n  `unseen`  - only unread rows (sparse UnseenIndex)\n  `starred` - only starred rows (sparse StarredIndex)\n  `spam`    - only user-spam-marked rows (sparse SpamIndex)\n\nLabel folder:\n  `label:<labelId>` - rows whose `flags.labels` contains labelId\n\nTypeScript callers should narrow this to\n`'all' | 'unseen' | 'starred' | 'spam' | \\`label:${string}\\``\nin their client wrapper; OpenAPI cannot express template-literal\nunions natively."
           },
           "pageSize": {
             "type": "integer",
@@ -15168,12 +15176,62 @@
                     "description": "The type of search to perform"
                   },
                   "query": {
-                    "type": "object",
-                    "description": "Search query parameters sent to OpenSearch. Supported keys for talent search: Semantic (full-text match) - \"search\" (multi-match across all text fields), \"name\", \"quickInsights\", \"skillsAndExpertise\", \"professionalExperience\", \"education\", \"experienceAndSeniority\", \"jobPositions\", \"keywords\", \"certifications\", \"industryExperience\", \"languagesSpoken\", \"locationPreferences\", \"personalityAndSoftSkills\", \"availability\", \"workPreferences\", \"workAuthorization\". Filters (exact match) - \"status\", \"source\", \"email\", \"gender\", \"shortCode\", \"isTalentPool\", \"relocationWillingness\", \"requiresSponsorship\", \"careerBreak\". IDs - \"jobId\", \"talentId\"."
+                    "description": "Search query parameters sent to OpenSearch. Shape varies by finder `type`. OpenAPI can't express the full type/query correlation as a strict discriminated union (the discriminator lives on the sibling `type` field, not on `query` itself), so this is encoded as `oneOf` over per-type query schemas. Clients should pick the shape matching the `type` they are posting.",
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/FinderQueryTalentsSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryCandidatesSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryJobsSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryEmailsSchema"
+                      }
+                    ]
                   },
                   "results": {
+                    "title": "FinderResultsSchema",
                     "type": "object",
-                    "description": "The search results returned from OpenSearch (auto-populated)"
+                    "description": "OpenSearch-shaped results attached to the finder record after the search runs. Hits array items carry whatever subset of the index schema was projected.",
+                    "properties": {
+                      "total": {
+                        "type": "integer",
+                        "description": "Count of matching documents before pagination."
+                      },
+                      "hits": {
+                        "type": "array",
+                        "items": {
+                          "title": "FinderResultHitSchema",
+                          "type": "object",
+                          "description": "Single hit from the OpenSearch query. The `id` equals the underlying resource id (emailId, talentId, candidateId, jobId, ...) so the frontend can navigate directly to that resource. Additional fields vary by finder `type`.",
+                          "properties": {
+                            "id": {
+                              "type": "string",
+                              "description": "The underlying resource id (emailId / talentId / candidateId / jobId)."
+                            },
+                            "tenantId": {
+                              "type": "string"
+                            },
+                            "status": {
+                              "type": "string"
+                            },
+                            "source": {
+                              "type": "string"
+                            },
+                            "created": {
+                              "type": "string"
+                            },
+                            "shortCode": {
+                              "type": "string"
+                            }
+                          },
+                          "additionalProperties": true
+                        }
+                      }
+                    }
                   },
                   "status": {
                     "type": "string",
@@ -15395,12 +15453,62 @@
                     "description": "The type of search to perform"
                   },
                   "query": {
-                    "type": "object",
-                    "description": "Search query parameters sent to OpenSearch. Supported keys for talent search: Semantic (full-text match) - \"search\" (multi-match across all text fields), \"name\", \"quickInsights\", \"skillsAndExpertise\", \"professionalExperience\", \"education\", \"experienceAndSeniority\", \"jobPositions\", \"keywords\", \"certifications\", \"industryExperience\", \"languagesSpoken\", \"locationPreferences\", \"personalityAndSoftSkills\", \"availability\", \"workPreferences\", \"workAuthorization\". Filters (exact match) - \"status\", \"source\", \"email\", \"gender\", \"shortCode\", \"isTalentPool\", \"relocationWillingness\", \"requiresSponsorship\", \"careerBreak\". IDs - \"jobId\", \"talentId\"."
+                    "description": "Search query parameters sent to OpenSearch. Shape varies by finder `type`. OpenAPI can't express the full type/query correlation as a strict discriminated union (the discriminator lives on the sibling `type` field, not on `query` itself), so this is encoded as `oneOf` over per-type query schemas. Clients should pick the shape matching the `type` they are posting.",
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/FinderQueryTalentsSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryCandidatesSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryJobsSchema"
+                      },
+                      {
+                        "$ref": "#/components/schemas/FinderQueryEmailsSchema"
+                      }
+                    ]
                   },
                   "results": {
+                    "title": "FinderResultsSchema",
                     "type": "object",
-                    "description": "The search results returned from OpenSearch (auto-populated)"
+                    "description": "OpenSearch-shaped results attached to the finder record after the search runs. Hits array items carry whatever subset of the index schema was projected.",
+                    "properties": {
+                      "total": {
+                        "type": "integer",
+                        "description": "Count of matching documents before pagination."
+                      },
+                      "hits": {
+                        "type": "array",
+                        "items": {
+                          "title": "FinderResultHitSchema",
+                          "type": "object",
+                          "description": "Single hit from the OpenSearch query. The `id` equals the underlying resource id (emailId, talentId, candidateId, jobId, ...) so the frontend can navigate directly to that resource. Additional fields vary by finder `type`.",
+                          "properties": {
+                            "id": {
+                              "type": "string",
+                              "description": "The underlying resource id (emailId / talentId / candidateId / jobId)."
+                            },
+                            "tenantId": {
+                              "type": "string"
+                            },
+                            "status": {
+                              "type": "string"
+                            },
+                            "source": {
+                              "type": "string"
+                            },
+                            "created": {
+                              "type": "string"
+                            },
+                            "shortCode": {
+                              "type": "string"
+                            }
+                          },
+                          "additionalProperties": true
+                        }
+                      }
+                    }
                   },
                   "status": {
                     "type": "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartytalent/openai-tools",
-  "version": "0.1.33-dev.4",
+  "version": "0.1.33-dev.6",
   "description": "OpenAI function/tool definitions for SmartyTalent API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",