@smartytalent/openai-tools 0.1.33-dev.28 → 0.1.33-dev.29

package/dist/tools.json

@@ -332,7 +332,7 @@
           },
           "include": {
             "type": "string",
-            "description": "JSON:API compound document request — comma-separated list of relationship paths to include in the response (e.g. `feedbacks`, `feedbacks,boeUser`). Currently advisory: the service always returns all declared relationships with empty defaults."
+            "description": "JSON:API compound document request - comma-separated list of relationship paths to include in the response (e.g. `feedbacks`, `feedbacks,boeUser`). Currently advisory: the service always returns all declared relationships with empty defaults."
           }
         },
         "required": [
@@ -7627,7 +7627,7 @@
                   "outcomes": {
                     "title": "FeedbackOutcomesSchema",
                     "type": "object",
-                    "description": "Per-outcome feedback rules. Outcome keys map to candidate.recommendationStatusCode: 1=notFit, 2=maybe, 3=fit. Code 0 (not evaluated) never triggers feedback — the workflow pauses instead.",
+                    "description": "Per-outcome feedback rules. Outcome keys map to candidate.recommendationStatusCode: 1=notFit, 2=maybe, 3=fit. Code 0 (not evaluated) never triggers feedback - the workflow pauses instead.",
                     "properties": {
                       "notFit": {
                         "title": "FeedbackOutcomeRuleSchema",
@@ -8035,7 +8035,7 @@
                       "outcomes": {
                         "title": "FeedbackOutcomesSchema",
                         "type": "object",
-                        "description": "Per-outcome feedback rules. Outcome keys map to candidate.recommendationStatusCode: 1=notFit, 2=maybe, 3=fit. Code 0 (not evaluated) never triggers feedback — the workflow pauses instead.",
+                        "description": "Per-outcome feedback rules. Outcome keys map to candidate.recommendationStatusCode: 1=notFit, 2=maybe, 3=fit. Code 0 (not evaluated) never triggers feedback - the workflow pauses instead.",
                         "properties": {
                           "notFit": {
                             "title": "FeedbackOutcomeRuleSchema",
@@ -8513,7 +8513,7 @@
                       },
                       "actionName": {
                         "type": "string",
-                        "description": "Action identifier (e.g. `email:send`, `call:initiate`). Resolved by the same convention the workflow engine uses — `resource:verb` maps to `sm-${env}-tb-service-action-function-${resource}-${verb}`."
+                        "description": "Action identifier (e.g. `email:send`, `call:initiate`). Resolved by the same convention the workflow engine uses - `resource:verb` maps to `sm-${env}-tb-service-action-function-${resource}-${verb}`."
                       },
                       "input": {
                         "type": "object",
@@ -8770,7 +8770,7 @@
                           },
                           "actionName": {
                             "type": "string",
-                            "description": "Action identifier (e.g. `email:send`, `call:initiate`). Resolved by the same convention the workflow engine uses — `resource:verb` maps to `sm-${env}-tb-service-action-function-${resource}-${verb}`."
+                            "description": "Action identifier (e.g. `email:send`, `call:initiate`). Resolved by the same convention the workflow engine uses - `resource:verb` maps to `sm-${env}-tb-service-action-function-${resource}-${verb}`."
                           },
                           "input": {
                             "type": "object",
@@ -9021,7 +9021,7 @@
                       "candidate",
                       "talent"
                     ],
-                    "description": "Submission type — determines which workflow to trigger"
+                    "description": "Submission type - determines which workflow to trigger"
                   },
                   "status": {
                     "type": "string",
@@ -9329,7 +9329,7 @@
               "candidate",
               "talent"
             ],
-            "description": "Submission type — determines which workflow to trigger. Auto-derived from jobId if omitted."
+            "description": "Submission type - determines which workflow to trigger. Auto-derived from jobId if omitted."
           },
           "referral": {
             "type": "object",
@@ -9506,7 +9506,7 @@
                           "candidate",
                           "talent"
                         ],
-                        "description": "Submission type — determines which workflow to trigger"
+                        "description": "Submission type - determines which workflow to trigger"
                       },
                       "status": {
                         "type": "string",
@@ -10541,6 +10541,10 @@
             "type": "string",
             "description": "Filter by caller's protocol-native handle (E.164 phone for PSTN). Indexed via FromIdentifierIndex GSI."
           },
+          "filterToIdentifier": {
+            "type": "string",
+            "description": "Filter by callee's protocol-native handle (E.164 phone for PSTN). Indexed via ToIdentifierIndex GSI. Use for 'all calls to this number' views."
+          },
           "filterConversationId": {
             "type": "string",
             "description": "Filter all calls in a conversation thread. Indexed via ConversationIdIndex GSI."
@@ -10555,6 +10559,10 @@
               "other"
             ]
           },
+          "include": {
+            "type": "string",
+            "description": "JSON:API `?include=` sideloads. Comma-list of relationship\nslots; each resolved to a per-resource entry in the response\n`included[]` array. Eliminates N+1 lookups for avatars /\nnames. Allowed slots: conversation, candidate, talent, user,\nboeUser, job, brief, schedule. Each included resource carries\n`attributes.name` plus type-specific extras (`avatarUrl` +\n`isBoe` for users, `company` for candidate/talent, `title` +\n`shortCode` for job, `subject` + `type` for conversation,\n`fireAt` + `status` for schedule)."
+          },
           "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."
@@ -11120,7 +11128,12 @@
       "description": "Show Call",
       "parameters": {
         "type": "object",
-        "properties": {}
+        "properties": {
+          "include": {
+            "type": "string",
+            "description": "JSON:API `?include=` sideloads. Comma-list of relationship\nslots; each resolved entry is added to the response\n`included[]` array. Allowed slots: conversation, candidate,\ntalent, user, boeUser, job, brief, schedule."
+          }
+        }
       }
     }
   },
@@ -11492,6 +11505,245 @@
       }
     }
   },
+  {
+    "type": "function",
+    "function": {
+      "name": "list_comments",
+      "description": "List Comments",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "filterTargetType": {
+            "type": "string",
+            "description": "Limit to comments on this resource type. Pair with filterTargetId.",
+            "enum": [
+              "calls",
+              "chats",
+              "emails",
+              "candidates",
+              "jobs",
+              "talents",
+              "briefs",
+              "tasks"
+            ]
+          },
+          "filterTargetId": {
+            "type": "string",
+            "description": "Limit to comments on this specific target id. Requires filterTargetType."
+          },
+          "filterAuthorId": {
+            "type": "string",
+            "description": "Limit to comments authored by this user. Indexed via AuthorIndex."
+          },
+          "filterIsResolved": {
+            "type": "boolean",
+            "description": "Filter by `isResolved` flag (true/false). Post-filtered after pagination - acceptable while resolution is rare."
+          },
+          "include": {
+            "type": "string",
+            "description": "JSON:API sideload. Currently supports `author` (resolves to the user row with name + avatarUrl + isBoe)."
+          },
+          "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."
+          },
+          "filterCreatedTo": {
+            "type": "string",
+            "description": "Filters results to include only those created up to the specified date and time. The value must be in ISO 8601 format."
+          },
+          "filterModifiedFrom": {
+            "type": "string",
+            "description": "Filters results to include only those modified from the specified date and time. The value must be in ISO 8601 format."
+          },
+          "filterModifiedTo": {
+            "type": "string",
+            "description": "Filters results to include only those modified up to the specified date and time. The value must be in ISO 8601 format."
+          },
+          "pageSize": {
+            "type": "integer",
+            "description": "Specifies the number of items to retrieve per page. The maximum value is 100."
+          },
+          "pageNumber": {
+            "type": "integer",
+            "description": "Specifies the page number to retrieve. Used for traditional pagination."
+          },
+          "pageAfter": {
+            "type": "string",
+            "description": "Opaque base64-encoded cursor returned by a previous list response, used for forward cursor-based pagination. Pass the value verbatim; do not decode or mutate it."
+          },
+          "pageBefore": {
+            "type": "string",
+            "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
+          },
+          "sort": {
+            "type": "string",
+            "description": "Sort order. Default `-created` (newest first).",
+            "enum": [
+              "-created",
+              "created",
+              "-modified",
+              "modified"
+            ]
+          }
+        }
+      }
+    }
+  },
+  {
+    "type": "function",
+    "function": {
+      "name": "create_comment",
+      "description": "Create Comment",
+      "parameters": {
+        "title": "CreateCommentRequestSchema",
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object",
+            "required": [
+              "type",
+              "attributes"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "comments"
+                ]
+              },
+              "attributes": {
+                "type": "object",
+                "required": [
+                  "body",
+                  "targetType",
+                  "targetId"
+                ],
+                "properties": {
+                  "body": {
+                    "type": "string",
+                    "maxLength": 5000
+                  },
+                  "targetType": {
+                    "type": "string",
+                    "enum": [
+                      "calls",
+                      "chats",
+                      "emails",
+                      "candidates",
+                      "jobs",
+                      "talents",
+                      "briefs",
+                      "tasks"
+                    ]
+                  },
+                  "targetId": {
+                    "type": "string"
+                  },
+                  "parentCommentId": {
+                    "type": "string"
+                  },
+                  "mentionedUserIds": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "isResolved": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  {
+    "type": "function",
+    "function": {
+      "name": "show_comment",
+      "description": "Show Comment",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "include": {
+            "type": "string",
+            "description": "JSON:API sideload. `author` resolves the user row."
+          }
+        }
+      }
+    }
+  },
+  {
+    "type": "function",
+    "function": {
+      "name": "update_comment",
+      "description": "Update Comment",
+      "parameters": {
+        "title": "UpdateCommentRequestSchema",
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "comments"
+                ]
+              },
+              "id": {
+                "type": "string"
+              },
+              "attributes": {
+                "type": "object",
+                "description": "Patchable fields. Only `body`, `isResolved`, and `mentionedUserIds` are editable. Edit by author OR tenant admin/owner; others get 403.",
+                "properties": {
+                  "body": {
+                    "type": "string",
+                    "maxLength": 5000
+                  },
+                  "isResolved": {
+                    "type": "boolean"
+                  },
+                  "mentionedUserIds": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  {
+    "type": "function",
+    "function": {
+      "name": "delete_comment",
+      "description": "Delete Comment",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "permanentDelete": {
+            "type": "string",
+            "description": "Set to `true` for hard-delete. Default is soft-delete (status=archived).",
+            "enum": [
+              "true",
+              "false"
+            ]
+          }
+        }
+      }
+    }
+  },
   {
     "type": "function",
     "function": {
@@ -12685,6 +12937,7 @@
               "emails",
               "chats",
               "calls",
+              "comments",
               "candidates",
               "conversations",
               "jobs",
@@ -12992,11 +13245,12 @@
         "properties": {
           "filterResourceType": {
             "type": "string",
-            "description": "Only return aggregates for this resource type (e.g. emails, chats, calls).",
+            "description": "Only return aggregates for this resource type (e.g. emails, chats, calls, comments).",
             "enum": [
               "emails",
               "chats",
               "calls",
+              "comments",
               "candidates",
               "conversations",
               "jobs",
@@ -15700,7 +15954,7 @@
           },
           "filterCategory": {
             "type": "string",
-            "description": "Filter by category (sourcing, screening, assessment, onboarding, operational, general). Uses CategoryIndex GSI — efficient at scale.",
+            "description": "Filter by category (sourcing, screening, assessment, onboarding, operational, general). Uses CategoryIndex GSI - efficient at scale.",
             "enum": [
               "sourcing",
               "screening",

package/package.json

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