@smartytalent/openai-tools 0.1.33-dev.0 → 0.1.33-dev.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/tools.json +1165 -233
  2. package/package.json +1 -1
package/dist/tools.json CHANGED
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "pageAfter": {
47
47
  "type": "string",
48
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
48
+ "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."
49
49
  },
50
50
  "pageBefore": {
51
51
  "type": "string",
@@ -773,7 +773,7 @@
773
773
  },
774
774
  "pageAfter": {
775
775
  "type": "string",
776
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
776
+ "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."
777
777
  },
778
778
  "pageBefore": {
779
779
  "type": "string",
@@ -1472,7 +1472,7 @@
1472
1472
  },
1473
1473
  "pageAfter": {
1474
1474
  "type": "string",
1475
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
1475
+ "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."
1476
1476
  },
1477
1477
  "pageBefore": {
1478
1478
  "type": "string",
@@ -1792,7 +1792,7 @@
1792
1792
  },
1793
1793
  "pageAfter": {
1794
1794
  "type": "string",
1795
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
1795
+ "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."
1796
1796
  },
1797
1797
  "pageBefore": {
1798
1798
  "type": "string",
@@ -2046,7 +2046,7 @@
2046
2046
  },
2047
2047
  "pageAfter": {
2048
2048
  "type": "string",
2049
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
2049
+ "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."
2050
2050
  },
2051
2051
  "pageBefore": {
2052
2052
  "type": "string",
@@ -3241,7 +3241,7 @@
3241
3241
  },
3242
3242
  "pageAfter": {
3243
3243
  "type": "string",
3244
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
3244
+ "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."
3245
3245
  },
3246
3246
  "pageBefore": {
3247
3247
  "type": "string",
@@ -4484,7 +4484,7 @@
4484
4484
  },
4485
4485
  "pageAfter": {
4486
4486
  "type": "string",
4487
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
4487
+ "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."
4488
4488
  },
4489
4489
  "pageBefore": {
4490
4490
  "type": "string",
@@ -5695,7 +5695,7 @@
5695
5695
  },
5696
5696
  "pageAfter": {
5697
5697
  "type": "string",
5698
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
5698
+ "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."
5699
5699
  },
5700
5700
  "pageBefore": {
5701
5701
  "type": "string",
@@ -5976,7 +5976,7 @@
5976
5976
  },
5977
5977
  "pageAfter": {
5978
5978
  "type": "string",
5979
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
5979
+ "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."
5980
5980
  },
5981
5981
  "pageBefore": {
5982
5982
  "type": "string",
@@ -6224,7 +6224,7 @@
6224
6224
  },
6225
6225
  "pageAfter": {
6226
6226
  "type": "string",
6227
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
6227
+ "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."
6228
6228
  },
6229
6229
  "pageBefore": {
6230
6230
  "type": "string",
@@ -6494,10 +6494,45 @@
6494
6494
  "properties": {
6495
6495
  "filterStatus": {
6496
6496
  "type": "string",
6497
- "description": "Returns emails with the current status (active, archived). If not provided, the default value will be set to 'active'.",
6497
+ "description": "Filter by the email's lifecycle status. Omit to return all statuses.",
6498
6498
  "enum": [
6499
- "active",
6500
- "archived"
6499
+ "draft",
6500
+ "scheduled",
6501
+ "sent",
6502
+ "suppressed",
6503
+ "archived",
6504
+ "failed",
6505
+ "pending"
6506
+ ]
6507
+ },
6508
+ "filterConversationId": {
6509
+ "type": "string",
6510
+ "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`)."
6511
+ },
6512
+ "filterDirection": {
6513
+ "type": "string",
6514
+ "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.",
6515
+ "enum": [
6516
+ "inbound",
6517
+ "outbound"
6518
+ ]
6519
+ },
6520
+ "filterIds": {
6521
+ "type": "string",
6522
+ "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."
6523
+ },
6524
+ "filterIsSystemSpam": {
6525
+ "type": "boolean",
6526
+ "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."
6527
+ },
6528
+ "sort": {
6529
+ "type": "string",
6530
+ "description": "Order results by a time field. Leading `-` means descending\n(newest-first). Accepted values:\n `-created` newest-first by creation time (CreatedIndex)\n `created` oldest-first by creation time\n `-modified` most-recently-modified first (ModifiedIndex)\n `modified` least-recently-modified first\nTakes effect only when no equality filter (filterStatus,\nfilterConversationId, filterDirection) dictates a different\nindex; equality filters win. Compatible with date-range filters\n(filterCreatedFrom/To, filterModifiedFrom/To) which already use\nthe same indexes; sort just picks the direction.",
6531
+ "enum": [
6532
+ "-created",
6533
+ "created",
6534
+ "-modified",
6535
+ "modified"
6501
6536
  ]
6502
6537
  },
6503
6538
  "filterCreatedFrom": {
@@ -6526,7 +6561,7 @@
6526
6561
  },
6527
6562
  "pageAfter": {
6528
6563
  "type": "string",
6529
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
6564
+ "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."
6530
6565
  },
6531
6566
  "pageBefore": {
6532
6567
  "type": "string",
@@ -6570,7 +6605,25 @@
6570
6605
  "type": "string"
6571
6606
  },
6572
6607
  "status": {
6573
- "type": "string"
6608
+ "type": "string",
6609
+ "enum": [
6610
+ "draft",
6611
+ "scheduled",
6612
+ "sent",
6613
+ "suppressed",
6614
+ "archived",
6615
+ "failed",
6616
+ "pending"
6617
+ ],
6618
+ "description": "Lifecycle status. draft = composing, scheduled = workflow owns the send, sent = delivered to SES, suppressed = SES bounce/complaint, archived = user soft-deleted, failed = internal error, pending = transitional."
6619
+ },
6620
+ "direction": {
6621
+ "type": "string",
6622
+ "enum": [
6623
+ "inbound",
6624
+ "outbound"
6625
+ ],
6626
+ "description": "Whether the email was received from an external sender (inbound, populated by the broker) or composed by the tenant/system and sent out (outbound). Populated at create time; never changes."
6574
6627
  },
6575
6628
  "emailFrom": {
6576
6629
  "type": "string"
@@ -6578,27 +6631,33 @@
6578
6631
  "emailTo": {
6579
6632
  "type": "string"
6580
6633
  },
6634
+ "emailCc": {
6635
+ "type": "array",
6636
+ "items": {
6637
+ "type": "string"
6638
+ },
6639
+ "description": "CC recipients. Each entry is an RFC 5322 address string."
6640
+ },
6641
+ "emailBcc": {
6642
+ "type": "array",
6643
+ "items": {
6644
+ "type": "string"
6645
+ },
6646
+ "description": "BCC recipients. Each entry is an RFC 5322 address string."
6647
+ },
6581
6648
  "subject": {
6582
- "oneOf": [
6583
- {
6584
- "type": "string"
6585
- },
6586
- {
6587
- "type": "object",
6588
- "additionalProperties": true
6589
- }
6590
- ]
6649
+ "type": "object",
6650
+ "additionalProperties": {
6651
+ "type": "string"
6652
+ },
6653
+ "description": "Multilingual subject keyed by IETF BCP 47 locale code (e.g. `en-US`, `pl-PL`). The DAL writes per-locale entries from the AI analyze + translate steps; the UI picks the right key based on `conversationLanguageCode`."
6591
6654
  },
6592
6655
  "body": {
6593
- "oneOf": [
6594
- {
6595
- "type": "string"
6596
- },
6597
- {
6598
- "type": "object",
6599
- "additionalProperties": true
6600
- }
6601
- ]
6656
+ "type": "object",
6657
+ "additionalProperties": {
6658
+ "type": "string"
6659
+ },
6660
+ "description": "Multilingual HTML body keyed by IETF BCP 47 locale code. Same shape as `subject`. Body values are HTML strings; plain-text fallback is derived on send."
6602
6661
  },
6603
6662
  "shortCode": {
6604
6663
  "type": "string"
@@ -6615,11 +6674,78 @@
6615
6674
  "isExternalSender": {
6616
6675
  "type": "boolean"
6617
6676
  },
6677
+ "attachments": {
6678
+ "type": "array",
6679
+ "items": {
6680
+ "type": "object",
6681
+ "properties": {
6682
+ "fileName": {
6683
+ "type": "string",
6684
+ "description": "Display name shown in the mail client and used as the attachment filename on send."
6685
+ },
6686
+ "url": {
6687
+ "type": "string",
6688
+ "description": "S3 URL of the stored file. For user-uploaded attachments this is the path returned by POST /v1/files; for system-generated attachments (job/persona/report PDFs) it is the resource's own S3 path."
6689
+ },
6690
+ "type": {
6691
+ "type": "string",
6692
+ "description": "Resource type this attachment belongs to. User-uploaded attachments use `files`; system-generated attachments use the owning resource type: `jobs`, `personas`, `talents`, `candidates`, `reports`, `ads`."
6693
+ },
6694
+ "fileId": {
6695
+ "type": "string",
6696
+ "description": "When `type == \"files\"`, the file resource ID so the frontend can resolve the latest file metadata (status, processing state) without parsing the URL."
6697
+ },
6698
+ "size": {
6699
+ "type": "integer",
6700
+ "description": "File size in bytes. Frontend displays it in the compose preview and mail list. Set by the upload flow from the Content-Length of the S3 object; absent on legacy rows."
6701
+ },
6702
+ "contentType": {
6703
+ "type": "string",
6704
+ "description": "MIME type (e.g. `application/pdf`, `image/png`). Drives icon selection in the UI and the Content-Type header in the outbound MIME part. Absent on legacy rows; frontend should fall back to extension inference."
6705
+ },
6706
+ "thumbnailUrl": {
6707
+ "type": "string",
6708
+ "description": "Optional S3 URL of a PNG preview (first-page render for PDFs/DOCX). Populated by the file service's conversion pipeline when a preview is available. Absent for non-previewable types."
6709
+ }
6710
+ }
6711
+ },
6712
+ "description": "Attachments on the email. For user-uploaded attachments: frontend creates a File via POST /v1/files (which returns a presigned PUT URL), uploads to S3, then references the File here with `type: \"files\"` and the returned `url`/`fileId`. For system-generated attachments (job/persona/report PDFs) the eventbus / outbound path populates these automatically."
6713
+ },
6714
+ "conversationLanguageCode": {
6715
+ "type": "string",
6716
+ "description": "Denormalised copy of the related conversation's languageCode (e.g. `pl-PL`, `en-US`). Avoids an N+1 fetch when the list/detail view needs to pick the right locale for the multilingual subject/body dicts. Source of truth is the conversation row; read-only from the email's perspective."
6717
+ },
6718
+ "parentEmailId": {
6719
+ "type": "string",
6720
+ "description": "Application-layer pointer to the email this one replies to. Used by the UI to render an 'in reply to' link in thread views. Set by the compose flow (frontend passes the parent on Reply) and by the broker when an inbound email matches an outbound via RFC 5322 In-Reply-To. Separate from meta.reference which carries the raw SMTP header chain."
6721
+ },
6722
+ "fromUserId": {
6723
+ "type": "string",
6724
+ "description": "Denormalised user id of the sender for outbound emails (the boe workflow user, or the human composer). Frontend joins this against its local user cache to render avatar + display name without a per-row API call. Null on inbound mail."
6725
+ },
6726
+ "fromCandidateId": {
6727
+ "type": "string",
6728
+ "description": "Denormalised candidate id of the sender for inbound replies from a candidate in an active conversation. Frontend joins this against its local candidate cache to render initials and the candidate name. Null on outbound mail and on anonymous inbound that didn't match a candidate."
6729
+ },
6730
+ "isSystemSpam": {
6731
+ "type": "boolean",
6732
+ "description": "System-level spam verdict on this email. Set by the broker (or a future classifier) at inbound time; never reflects a single user's opinion. Distinct from `status=suppressed`, which is SES reporting we cannot deliver on OUTBOUND. Frontend's Spam folder unions (my states where isSpam=true) with (emails where isSystemSpam=true)."
6733
+ },
6734
+ "scheduleId": {
6735
+ "type": "string",
6736
+ "description": "Foreign key to the Schedule resource driving this email's send. Populated by the wait:process workflow action right after it creates the Schedule. Null when no delayed send is pending (drafts, already-sent rows, inbound mail). To cancel the scheduled send, call DELETE /v1/schedules/{scheduleId} - the email eventbus handler listens for SCHEDULE_CANCELLED and reverts the row back to draft automatically."
6737
+ },
6738
+ "scheduledFireAt": {
6739
+ "type": "string",
6740
+ "description": "Denormalised copy of the owning Schedule's `fireAt` timestamp (ISO 8601). The scheduled-send banner reads this directly so the UI never has to round-trip to /v1/schedules just to render 'Send scheduled for X'. Source of truth is the Schedule; this field stays stable because Schedule.fireAt is immutable post-create."
6741
+ },
6618
6742
  "ttl": {
6619
6743
  "type": "string"
6620
6744
  },
6621
6745
  "sendScheduleDate": {
6622
- "type": "string"
6746
+ "type": "string",
6747
+ "deprecated": true,
6748
+ "description": "Legacy field from the retired CRUD-scheduler path. Kept as read-only metadata on old rows. New emails do not populate it; scheduling is owned by the workflow engine's wait:process action via the Schedule resource."
6623
6749
  },
6624
6750
  "meta": {
6625
6751
  "type": "object",
@@ -6740,6 +6866,25 @@
6740
6866
  }
6741
6867
  }
6742
6868
  }
6869
+ },
6870
+ "schedule": {
6871
+ "title": "EmailRelationshipsScheduleSchema",
6872
+ "type": "object",
6873
+ "description": "The Schedule arming this email's delayed send. Denormalised mirror of scheduleId so clients can `?include=schedule` in a single request. Populated by the email eventbus handler reacting to SCHEDULE_CREATED. Null while the email is draft / already-sent / inbound.",
6874
+ "properties": {
6875
+ "data": {
6876
+ "title": "EmailRelationshipsScheduleDataSchema",
6877
+ "type": "object",
6878
+ "properties": {
6879
+ "type": {
6880
+ "type": "string"
6881
+ },
6882
+ "id": {
6883
+ "type": "string"
6884
+ }
6885
+ }
6886
+ }
6887
+ }
6743
6888
  }
6744
6889
  }
6745
6890
  },
@@ -6813,7 +6958,25 @@
6813
6958
  "type": "string"
6814
6959
  },
6815
6960
  "status": {
6816
- "type": "string"
6961
+ "type": "string",
6962
+ "enum": [
6963
+ "draft",
6964
+ "scheduled",
6965
+ "sent",
6966
+ "suppressed",
6967
+ "archived",
6968
+ "failed",
6969
+ "pending"
6970
+ ],
6971
+ "description": "Lifecycle status. draft = composing, scheduled = workflow owns the send, sent = delivered to SES, suppressed = SES bounce/complaint, archived = user soft-deleted, failed = internal error, pending = transitional."
6972
+ },
6973
+ "direction": {
6974
+ "type": "string",
6975
+ "enum": [
6976
+ "inbound",
6977
+ "outbound"
6978
+ ],
6979
+ "description": "Whether the email was received from an external sender (inbound, populated by the broker) or composed by the tenant/system and sent out (outbound). Populated at create time; never changes."
6817
6980
  },
6818
6981
  "emailFrom": {
6819
6982
  "type": "string"
@@ -6821,27 +6984,33 @@
6821
6984
  "emailTo": {
6822
6985
  "type": "string"
6823
6986
  },
6987
+ "emailCc": {
6988
+ "type": "array",
6989
+ "items": {
6990
+ "type": "string"
6991
+ },
6992
+ "description": "CC recipients. Each entry is an RFC 5322 address string."
6993
+ },
6994
+ "emailBcc": {
6995
+ "type": "array",
6996
+ "items": {
6997
+ "type": "string"
6998
+ },
6999
+ "description": "BCC recipients. Each entry is an RFC 5322 address string."
7000
+ },
6824
7001
  "subject": {
6825
- "oneOf": [
6826
- {
6827
- "type": "string"
6828
- },
6829
- {
6830
- "type": "object",
6831
- "additionalProperties": true
6832
- }
6833
- ]
7002
+ "type": "object",
7003
+ "additionalProperties": {
7004
+ "type": "string"
7005
+ },
7006
+ "description": "Multilingual subject keyed by IETF BCP 47 locale code (e.g. `en-US`, `pl-PL`). The DAL writes per-locale entries from the AI analyze + translate steps; the UI picks the right key based on `conversationLanguageCode`."
6834
7007
  },
6835
7008
  "body": {
6836
- "oneOf": [
6837
- {
6838
- "type": "string"
6839
- },
6840
- {
6841
- "type": "object",
6842
- "additionalProperties": true
6843
- }
6844
- ]
7009
+ "type": "object",
7010
+ "additionalProperties": {
7011
+ "type": "string"
7012
+ },
7013
+ "description": "Multilingual HTML body keyed by IETF BCP 47 locale code. Same shape as `subject`. Body values are HTML strings; plain-text fallback is derived on send."
6845
7014
  },
6846
7015
  "shortCode": {
6847
7016
  "type": "string"
@@ -6858,11 +7027,78 @@
6858
7027
  "isExternalSender": {
6859
7028
  "type": "boolean"
6860
7029
  },
7030
+ "attachments": {
7031
+ "type": "array",
7032
+ "items": {
7033
+ "type": "object",
7034
+ "properties": {
7035
+ "fileName": {
7036
+ "type": "string",
7037
+ "description": "Display name shown in the mail client and used as the attachment filename on send."
7038
+ },
7039
+ "url": {
7040
+ "type": "string",
7041
+ "description": "S3 URL of the stored file. For user-uploaded attachments this is the path returned by POST /v1/files; for system-generated attachments (job/persona/report PDFs) it is the resource's own S3 path."
7042
+ },
7043
+ "type": {
7044
+ "type": "string",
7045
+ "description": "Resource type this attachment belongs to. User-uploaded attachments use `files`; system-generated attachments use the owning resource type: `jobs`, `personas`, `talents`, `candidates`, `reports`, `ads`."
7046
+ },
7047
+ "fileId": {
7048
+ "type": "string",
7049
+ "description": "When `type == \"files\"`, the file resource ID so the frontend can resolve the latest file metadata (status, processing state) without parsing the URL."
7050
+ },
7051
+ "size": {
7052
+ "type": "integer",
7053
+ "description": "File size in bytes. Frontend displays it in the compose preview and mail list. Set by the upload flow from the Content-Length of the S3 object; absent on legacy rows."
7054
+ },
7055
+ "contentType": {
7056
+ "type": "string",
7057
+ "description": "MIME type (e.g. `application/pdf`, `image/png`). Drives icon selection in the UI and the Content-Type header in the outbound MIME part. Absent on legacy rows; frontend should fall back to extension inference."
7058
+ },
7059
+ "thumbnailUrl": {
7060
+ "type": "string",
7061
+ "description": "Optional S3 URL of a PNG preview (first-page render for PDFs/DOCX). Populated by the file service's conversion pipeline when a preview is available. Absent for non-previewable types."
7062
+ }
7063
+ }
7064
+ },
7065
+ "description": "Attachments on the email. For user-uploaded attachments: frontend creates a File via POST /v1/files (which returns a presigned PUT URL), uploads to S3, then references the File here with `type: \"files\"` and the returned `url`/`fileId`. For system-generated attachments (job/persona/report PDFs) the eventbus / outbound path populates these automatically."
7066
+ },
7067
+ "conversationLanguageCode": {
7068
+ "type": "string",
7069
+ "description": "Denormalised copy of the related conversation's languageCode (e.g. `pl-PL`, `en-US`). Avoids an N+1 fetch when the list/detail view needs to pick the right locale for the multilingual subject/body dicts. Source of truth is the conversation row; read-only from the email's perspective."
7070
+ },
7071
+ "parentEmailId": {
7072
+ "type": "string",
7073
+ "description": "Application-layer pointer to the email this one replies to. Used by the UI to render an 'in reply to' link in thread views. Set by the compose flow (frontend passes the parent on Reply) and by the broker when an inbound email matches an outbound via RFC 5322 In-Reply-To. Separate from meta.reference which carries the raw SMTP header chain."
7074
+ },
7075
+ "fromUserId": {
7076
+ "type": "string",
7077
+ "description": "Denormalised user id of the sender for outbound emails (the boe workflow user, or the human composer). Frontend joins this against its local user cache to render avatar + display name without a per-row API call. Null on inbound mail."
7078
+ },
7079
+ "fromCandidateId": {
7080
+ "type": "string",
7081
+ "description": "Denormalised candidate id of the sender for inbound replies from a candidate in an active conversation. Frontend joins this against its local candidate cache to render initials and the candidate name. Null on outbound mail and on anonymous inbound that didn't match a candidate."
7082
+ },
7083
+ "isSystemSpam": {
7084
+ "type": "boolean",
7085
+ "description": "System-level spam verdict on this email. Set by the broker (or a future classifier) at inbound time; never reflects a single user's opinion. Distinct from `status=suppressed`, which is SES reporting we cannot deliver on OUTBOUND. Frontend's Spam folder unions (my states where isSpam=true) with (emails where isSystemSpam=true)."
7086
+ },
7087
+ "scheduleId": {
7088
+ "type": "string",
7089
+ "description": "Foreign key to the Schedule resource driving this email's send. Populated by the wait:process workflow action right after it creates the Schedule. Null when no delayed send is pending (drafts, already-sent rows, inbound mail). To cancel the scheduled send, call DELETE /v1/schedules/{scheduleId} - the email eventbus handler listens for SCHEDULE_CANCELLED and reverts the row back to draft automatically."
7090
+ },
7091
+ "scheduledFireAt": {
7092
+ "type": "string",
7093
+ "description": "Denormalised copy of the owning Schedule's `fireAt` timestamp (ISO 8601). The scheduled-send banner reads this directly so the UI never has to round-trip to /v1/schedules just to render 'Send scheduled for X'. Source of truth is the Schedule; this field stays stable because Schedule.fireAt is immutable post-create."
7094
+ },
6861
7095
  "ttl": {
6862
7096
  "type": "string"
6863
7097
  },
6864
7098
  "sendScheduleDate": {
6865
- "type": "string"
7099
+ "type": "string",
7100
+ "deprecated": true,
7101
+ "description": "Legacy field from the retired CRUD-scheduler path. Kept as read-only metadata on old rows. New emails do not populate it; scheduling is owned by the workflow engine's wait:process action via the Schedule resource."
6866
7102
  },
6867
7103
  "meta": {
6868
7104
  "type": "object",
@@ -6954,7 +7190,7 @@
6954
7190
  },
6955
7191
  "pageAfter": {
6956
7192
  "type": "string",
6957
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
7193
+ "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."
6958
7194
  },
6959
7195
  "pageBefore": {
6960
7196
  "type": "string",
@@ -7229,7 +7465,7 @@
7229
7465
  },
7230
7466
  "pageAfter": {
7231
7467
  "type": "string",
7232
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
7468
+ "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."
7233
7469
  },
7234
7470
  "pageBefore": {
7235
7471
  "type": "string",
@@ -8102,7 +8338,7 @@
8102
8338
  },
8103
8339
  "pageAfter": {
8104
8340
  "type": "string",
8105
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
8341
+ "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."
8106
8342
  },
8107
8343
  "pageBefore": {
8108
8344
  "type": "string",
@@ -8304,6 +8540,24 @@
8304
8540
  }
8305
8541
  }
8306
8542
  }
8543
+ },
8544
+ "email": {
8545
+ "title": "ScheduleRelationshipsEmailSchema",
8546
+ "type": "object",
8547
+ "description": "The email this schedule was armed for. Set by wait:process so the email service can denormalise scheduleId back onto the email row when SCHEDULE_CREATED fires.",
8548
+ "properties": {
8549
+ "data": {
8550
+ "type": "object",
8551
+ "properties": {
8552
+ "type": {
8553
+ "type": "string"
8554
+ },
8555
+ "id": {
8556
+ "type": "string"
8557
+ }
8558
+ }
8559
+ }
8560
+ }
8307
8561
  }
8308
8562
  }
8309
8563
  }
@@ -8545,20 +8799,38 @@
8545
8799
  }
8546
8800
  }
8547
8801
  }
8548
- }
8549
- }
8550
- }
8551
- }
8552
- }
8553
- }
8554
- }
8555
- },
8556
- "required": [
8557
- "scheduleId",
8558
- "requestBody"
8559
- ]
8560
- }
8561
- }
8802
+ },
8803
+ "email": {
8804
+ "title": "ScheduleRelationshipsEmailSchema",
8805
+ "type": "object",
8806
+ "description": "The email this schedule was armed for. Set by wait:process so the email service can denormalise scheduleId back onto the email row when SCHEDULE_CREATED fires.",
8807
+ "properties": {
8808
+ "data": {
8809
+ "type": "object",
8810
+ "properties": {
8811
+ "type": {
8812
+ "type": "string"
8813
+ },
8814
+ "id": {
8815
+ "type": "string"
8816
+ }
8817
+ }
8818
+ }
8819
+ }
8820
+ }
8821
+ }
8822
+ }
8823
+ }
8824
+ }
8825
+ }
8826
+ }
8827
+ },
8828
+ "required": [
8829
+ "scheduleId",
8830
+ "requestBody"
8831
+ ]
8832
+ }
8833
+ }
8562
8834
  },
8563
8835
  {
8564
8836
  "type": "function",
@@ -8889,7 +9161,7 @@
8889
9161
  },
8890
9162
  "pageAfter": {
8891
9163
  "type": "string",
8892
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
9164
+ "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."
8893
9165
  },
8894
9166
  "pageBefore": {
8895
9167
  "type": "string",
@@ -9600,7 +9872,7 @@
9600
9872
  },
9601
9873
  "pageAfter": {
9602
9874
  "type": "string",
9603
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
9875
+ "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."
9604
9876
  },
9605
9877
  "pageBefore": {
9606
9878
  "type": "string",
@@ -9911,7 +10183,7 @@
9911
10183
  },
9912
10184
  "pageAfter": {
9913
10185
  "type": "string",
9914
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
10186
+ "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."
9915
10187
  },
9916
10188
  "pageBefore": {
9917
10189
  "type": "string",
@@ -10162,7 +10434,7 @@
10162
10434
  },
10163
10435
  "pageAfter": {
10164
10436
  "type": "string",
10165
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
10437
+ "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."
10166
10438
  },
10167
10439
  "pageBefore": {
10168
10440
  "type": "string",
@@ -10593,7 +10865,7 @@
10593
10865
  },
10594
10866
  "pageAfter": {
10595
10867
  "type": "string",
10596
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
10868
+ "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."
10597
10869
  },
10598
10870
  "pageBefore": {
10599
10871
  "type": "string",
@@ -10912,7 +11184,7 @@
10912
11184
  },
10913
11185
  "pageAfter": {
10914
11186
  "type": "string",
10915
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
11187
+ "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."
10916
11188
  },
10917
11189
  "pageBefore": {
10918
11190
  "type": "string",
@@ -11225,12 +11497,627 @@
11225
11497
  "description": "Specifies the page number to retrieve. Used for traditional pagination."
11226
11498
  },
11227
11499
  "pageAfter": {
11500
+ "type": "string",
11501
+ "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."
11502
+ },
11503
+ "pageBefore": {
11228
11504
  "type": "string",
11229
11505
  "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
11506
+ }
11507
+ }
11508
+ }
11509
+ }
11510
+ },
11511
+ {
11512
+ "type": "function",
11513
+ "function": {
11514
+ "name": "create_note",
11515
+ "description": "Create Note",
11516
+ "parameters": {
11517
+ "title": "CreateNoteRequestBody",
11518
+ "type": "object",
11519
+ "required": [
11520
+ "data"
11521
+ ],
11522
+ "properties": {
11523
+ "data": {
11524
+ "title": "CreateNoteRequestBodyData",
11525
+ "type": "object",
11526
+ "required": [
11527
+ "type",
11528
+ "attributes"
11529
+ ],
11530
+ "properties": {
11531
+ "type": {
11532
+ "type": "string",
11533
+ "enum": [
11534
+ "notes"
11535
+ ]
11536
+ },
11537
+ "attributes": {
11538
+ "title": "NoteAttributesSchema",
11539
+ "type": "object",
11540
+ "properties": {
11541
+ "name": {
11542
+ "type": "string"
11543
+ },
11544
+ "status": {
11545
+ "type": "string"
11546
+ },
11547
+ "details": {
11548
+ "type": "object",
11549
+ "additionalProperties": {
11550
+ "type": "string"
11551
+ },
11552
+ "description": "Multilingual note details keyed by language code"
11553
+ },
11554
+ "source": {
11555
+ "type": "string",
11556
+ "description": "Source of the note"
11557
+ },
11558
+ "ttl": {
11559
+ "type": "string",
11560
+ "description": "Time-to-live expiration timestamp"
11561
+ },
11562
+ "meta": {
11563
+ "type": "object",
11564
+ "additionalProperties": true
11565
+ },
11566
+ "timestamps": {
11567
+ "title": "ResourceTimestampsSchema",
11568
+ "type": "object",
11569
+ "properties": {
11570
+ "created": {
11571
+ "type": "string",
11572
+ "format": "date-time"
11573
+ },
11574
+ "modified": {
11575
+ "type": "string",
11576
+ "format": "date-time"
11577
+ }
11578
+ }
11579
+ }
11580
+ }
11581
+ },
11582
+ "relationships": {
11583
+ "title": "NoteRelationshipsSchema",
11584
+ "type": "object",
11585
+ "properties": {
11586
+ "candidate": {
11587
+ "title": "NoteRelationshipsCandidateSchema",
11588
+ "type": "object",
11589
+ "properties": {
11590
+ "data": {
11591
+ "title": "NoteRelationshipsCandidateDataSchema",
11592
+ "type": "object",
11593
+ "properties": {
11594
+ "type": {
11595
+ "type": "string"
11596
+ },
11597
+ "id": {
11598
+ "type": "string"
11599
+ }
11600
+ }
11601
+ }
11602
+ }
11603
+ },
11604
+ "translations": {
11605
+ "title": "NoteRelationshipsTranslationsSchema",
11606
+ "type": "object",
11607
+ "properties": {
11608
+ "data": {
11609
+ "type": "array",
11610
+ "items": {
11611
+ "title": "NoteRelationshipsTranslationsDataSchema",
11612
+ "type": "object",
11613
+ "properties": {
11614
+ "type": {
11615
+ "type": "string"
11616
+ },
11617
+ "id": {
11618
+ "type": "string"
11619
+ }
11620
+ }
11621
+ }
11622
+ }
11623
+ }
11624
+ },
11625
+ "report": {
11626
+ "title": "NoteRelationshipsReportSchema",
11627
+ "type": "object",
11628
+ "properties": {
11629
+ "data": {
11630
+ "title": "NoteRelationshipsReportDataSchema",
11631
+ "type": "object",
11632
+ "properties": {
11633
+ "type": {
11634
+ "type": "string"
11635
+ },
11636
+ "id": {
11637
+ "type": "string"
11638
+ }
11639
+ }
11640
+ }
11641
+ }
11642
+ },
11643
+ "operation": {
11644
+ "title": "NoteRelationshipsOperationSchema",
11645
+ "type": "object",
11646
+ "properties": {
11647
+ "data": {
11648
+ "title": "NoteRelationshipsOperationDataSchema",
11649
+ "type": "object",
11650
+ "properties": {
11651
+ "type": {
11652
+ "type": "string"
11653
+ },
11654
+ "id": {
11655
+ "type": "string"
11656
+ }
11657
+ }
11658
+ }
11659
+ }
11660
+ }
11661
+ }
11662
+ }
11663
+ }
11664
+ }
11665
+ }
11666
+ }
11667
+ }
11668
+ },
11669
+ {
11670
+ "type": "function",
11671
+ "function": {
11672
+ "name": "notes_options",
11673
+ "description": "Notes Options",
11674
+ "parameters": {
11675
+ "type": "object",
11676
+ "properties": {}
11677
+ }
11678
+ }
11679
+ },
11680
+ {
11681
+ "type": "function",
11682
+ "function": {
11683
+ "name": "show_note",
11684
+ "description": "Show Note",
11685
+ "parameters": {
11686
+ "type": "object",
11687
+ "properties": {}
11688
+ }
11689
+ }
11690
+ },
11691
+ {
11692
+ "type": "function",
11693
+ "function": {
11694
+ "name": "update_note",
11695
+ "description": "Update Note",
11696
+ "parameters": {
11697
+ "title": "UpdateNoteRequestBody",
11698
+ "type": "object",
11699
+ "required": [
11700
+ "data"
11701
+ ],
11702
+ "properties": {
11703
+ "data": {
11704
+ "title": "UpdateNoteRequestBodyData",
11705
+ "type": "object",
11706
+ "required": [
11707
+ "type",
11708
+ "id",
11709
+ "attributes"
11710
+ ],
11711
+ "properties": {
11712
+ "type": {
11713
+ "type": "string",
11714
+ "enum": [
11715
+ "notes"
11716
+ ]
11717
+ },
11718
+ "id": {
11719
+ "type": "string"
11720
+ },
11721
+ "attributes": {
11722
+ "title": "NoteAttributesSchema",
11723
+ "type": "object",
11724
+ "properties": {
11725
+ "name": {
11726
+ "type": "string"
11727
+ },
11728
+ "status": {
11729
+ "type": "string"
11730
+ },
11731
+ "details": {
11732
+ "type": "object",
11733
+ "additionalProperties": {
11734
+ "type": "string"
11735
+ },
11736
+ "description": "Multilingual note details keyed by language code"
11737
+ },
11738
+ "source": {
11739
+ "type": "string",
11740
+ "description": "Source of the note"
11741
+ },
11742
+ "ttl": {
11743
+ "type": "string",
11744
+ "description": "Time-to-live expiration timestamp"
11745
+ },
11746
+ "meta": {
11747
+ "type": "object",
11748
+ "additionalProperties": true
11749
+ },
11750
+ "timestamps": {
11751
+ "title": "ResourceTimestampsSchema",
11752
+ "type": "object",
11753
+ "properties": {
11754
+ "created": {
11755
+ "type": "string",
11756
+ "format": "date-time"
11757
+ },
11758
+ "modified": {
11759
+ "type": "string",
11760
+ "format": "date-time"
11761
+ }
11762
+ }
11763
+ }
11764
+ }
11765
+ }
11766
+ }
11767
+ }
11768
+ }
11769
+ }
11770
+ }
11771
+ },
11772
+ {
11773
+ "type": "function",
11774
+ "function": {
11775
+ "name": "delete_note",
11776
+ "description": "Delete Note",
11777
+ "parameters": {
11778
+ "type": "object",
11779
+ "properties": {}
11780
+ }
11781
+ }
11782
+ },
11783
+ {
11784
+ "type": "function",
11785
+ "function": {
11786
+ "name": "note_options",
11787
+ "description": "Note Options",
11788
+ "parameters": {
11789
+ "type": "object",
11790
+ "properties": {}
11791
+ }
11792
+ }
11793
+ },
11794
+ {
11795
+ "type": "function",
11796
+ "function": {
11797
+ "name": "list_states",
11798
+ "description": "List States",
11799
+ "parameters": {
11800
+ "type": "object",
11801
+ "properties": {
11802
+ "filterResourceType": {
11803
+ "type": "string",
11804
+ "description": "Only return states for this resource type.",
11805
+ "enum": [
11806
+ "emails",
11807
+ "candidates",
11808
+ "conversations",
11809
+ "jobs",
11810
+ "talents",
11811
+ "personas",
11812
+ "reports",
11813
+ "tasks"
11814
+ ]
11815
+ },
11816
+ "filterResourceIds": {
11817
+ "type": "string",
11818
+ "description": "Comma-separated list of resource ids to batch-fetch. Requires `filterResourceType`."
11819
+ },
11820
+ "folder": {
11821
+ "type": "string",
11822
+ "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."
11823
+ },
11824
+ "pageSize": {
11825
+ "type": "integer",
11826
+ "description": "Specifies the number of items to retrieve per page. The maximum value is 100."
11827
+ },
11828
+ "pageAfter": {
11829
+ "type": "string",
11830
+ "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."
11831
+ },
11832
+ "pageBefore": {
11833
+ "type": "string",
11834
+ "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
11835
+ }
11836
+ }
11837
+ }
11838
+ }
11839
+ },
11840
+ {
11841
+ "type": "function",
11842
+ "function": {
11843
+ "name": "create_state",
11844
+ "description": "Upsert State",
11845
+ "parameters": {
11846
+ "title": "CreateStateRequestBody",
11847
+ "type": "object",
11848
+ "required": [
11849
+ "data"
11850
+ ],
11851
+ "properties": {
11852
+ "data": {
11853
+ "title": "CreateStateRequestBodyData",
11854
+ "type": "object",
11855
+ "required": [
11856
+ "type",
11857
+ "attributes"
11858
+ ],
11859
+ "properties": {
11860
+ "type": {
11861
+ "type": "string",
11862
+ "enum": [
11863
+ "states"
11864
+ ]
11865
+ },
11866
+ "attributes": {
11867
+ "title": "StateAttributesSchema",
11868
+ "type": "object",
11869
+ "properties": {
11870
+ "userId": {
11871
+ "type": "string",
11872
+ "description": "Owner of this state row. Always the authenticated user; never set by the client."
11873
+ },
11874
+ "resourceType": {
11875
+ "type": "string",
11876
+ "enum": [
11877
+ "emails",
11878
+ "candidates",
11879
+ "conversations",
11880
+ "jobs",
11881
+ "talents",
11882
+ "personas",
11883
+ "reports",
11884
+ "tasks"
11885
+ ],
11886
+ "description": "The kind of resource this state describes. Lives in the composite id as `{resourceType}:{resourceId}`."
11887
+ },
11888
+ "resourceId": {
11889
+ "type": "string",
11890
+ "description": "Id of the resource this state describes (e.g. an emailId, candidateId)."
11891
+ },
11892
+ "isSeen": {
11893
+ "type": "boolean",
11894
+ "description": "True if the user has opened the resource at least once. Derived from the presence of `seenAt`; clients can write either `isSeen` or `seenAt` on upsert."
11895
+ },
11896
+ "isStarred": {
11897
+ "type": "boolean",
11898
+ "description": "True if the user has starred/favourited the resource."
11899
+ },
11900
+ "isSpam": {
11901
+ "type": "boolean",
11902
+ "description": "True if the user marked this resource as spam. Distinct from the email service's `suppressed` status, which is SES-driven on outbound delivery; this is an inbound, per-user action."
11903
+ },
11904
+ "seenAt": {
11905
+ "type": "string",
11906
+ "description": "ISO 8601 timestamp of the user's most recent open. Absent means never seen."
11907
+ },
11908
+ "starredAt": {
11909
+ "type": "string",
11910
+ "description": "ISO 8601 timestamp of when the user starred the resource. Absent means not starred; used as the sort key for the `Starred` folder."
11911
+ },
11912
+ "spamAt": {
11913
+ "type": "string",
11914
+ "description": "ISO 8601 timestamp of when the user marked the resource as spam. Absent means not spam; used as the sort key for the `Spam` folder."
11915
+ },
11916
+ "resourceCreatedAt": {
11917
+ "type": "string",
11918
+ "description": "Denormalised copy of the underlying resource's own `created` timestamp. Used as the sparse unread-index sort key so the unread feed surfaces oldest resources first, not oldest state rows."
11919
+ },
11920
+ "flags": {
11921
+ "type": "object",
11922
+ "additionalProperties": true,
11923
+ "description": "Open-ended per-resource flags (e.g. `{muted: true}` on conversations, `{pinned: true}` on candidates). First-class state goes on the top-level attributes; ad-hoc state lives here."
11924
+ },
11925
+ "timestamps": {
11926
+ "title": "ResourceTimestampsSchema",
11927
+ "type": "object",
11928
+ "properties": {
11929
+ "created": {
11930
+ "type": "string",
11931
+ "format": "date-time"
11932
+ },
11933
+ "modified": {
11934
+ "type": "string",
11935
+ "format": "date-time"
11936
+ }
11937
+ }
11938
+ }
11939
+ }
11940
+ }
11941
+ }
11942
+ }
11943
+ }
11944
+ }
11945
+ }
11946
+ },
11947
+ {
11948
+ "type": "function",
11949
+ "function": {
11950
+ "name": "states_options",
11951
+ "description": "States Options",
11952
+ "parameters": {
11953
+ "type": "object",
11954
+ "properties": {}
11955
+ }
11956
+ }
11957
+ },
11958
+ {
11959
+ "type": "function",
11960
+ "function": {
11961
+ "name": "show_state",
11962
+ "description": "Show State",
11963
+ "parameters": {
11964
+ "type": "object",
11965
+ "properties": {}
11966
+ }
11967
+ }
11968
+ },
11969
+ {
11970
+ "type": "function",
11971
+ "function": {
11972
+ "name": "update_state",
11973
+ "description": "Update State",
11974
+ "parameters": {
11975
+ "title": "UpdateStateRequestBody",
11976
+ "type": "object",
11977
+ "required": [
11978
+ "data"
11979
+ ],
11980
+ "properties": {
11981
+ "data": {
11982
+ "title": "UpdateStateRequestBodyData",
11983
+ "type": "object",
11984
+ "required": [
11985
+ "type",
11986
+ "id",
11987
+ "attributes"
11988
+ ],
11989
+ "properties": {
11990
+ "type": {
11991
+ "type": "string",
11992
+ "enum": [
11993
+ "states"
11994
+ ]
11995
+ },
11996
+ "id": {
11997
+ "type": "string"
11998
+ },
11999
+ "attributes": {
12000
+ "title": "StateAttributesSchema",
12001
+ "type": "object",
12002
+ "properties": {
12003
+ "userId": {
12004
+ "type": "string",
12005
+ "description": "Owner of this state row. Always the authenticated user; never set by the client."
12006
+ },
12007
+ "resourceType": {
12008
+ "type": "string",
12009
+ "enum": [
12010
+ "emails",
12011
+ "candidates",
12012
+ "conversations",
12013
+ "jobs",
12014
+ "talents",
12015
+ "personas",
12016
+ "reports",
12017
+ "tasks"
12018
+ ],
12019
+ "description": "The kind of resource this state describes. Lives in the composite id as `{resourceType}:{resourceId}`."
12020
+ },
12021
+ "resourceId": {
12022
+ "type": "string",
12023
+ "description": "Id of the resource this state describes (e.g. an emailId, candidateId)."
12024
+ },
12025
+ "isSeen": {
12026
+ "type": "boolean",
12027
+ "description": "True if the user has opened the resource at least once. Derived from the presence of `seenAt`; clients can write either `isSeen` or `seenAt` on upsert."
12028
+ },
12029
+ "isStarred": {
12030
+ "type": "boolean",
12031
+ "description": "True if the user has starred/favourited the resource."
12032
+ },
12033
+ "isSpam": {
12034
+ "type": "boolean",
12035
+ "description": "True if the user marked this resource as spam. Distinct from the email service's `suppressed` status, which is SES-driven on outbound delivery; this is an inbound, per-user action."
12036
+ },
12037
+ "seenAt": {
12038
+ "type": "string",
12039
+ "description": "ISO 8601 timestamp of the user's most recent open. Absent means never seen."
12040
+ },
12041
+ "starredAt": {
12042
+ "type": "string",
12043
+ "description": "ISO 8601 timestamp of when the user starred the resource. Absent means not starred; used as the sort key for the `Starred` folder."
12044
+ },
12045
+ "spamAt": {
12046
+ "type": "string",
12047
+ "description": "ISO 8601 timestamp of when the user marked the resource as spam. Absent means not spam; used as the sort key for the `Spam` folder."
12048
+ },
12049
+ "resourceCreatedAt": {
12050
+ "type": "string",
12051
+ "description": "Denormalised copy of the underlying resource's own `created` timestamp. Used as the sparse unread-index sort key so the unread feed surfaces oldest resources first, not oldest state rows."
12052
+ },
12053
+ "flags": {
12054
+ "type": "object",
12055
+ "additionalProperties": true,
12056
+ "description": "Open-ended per-resource flags (e.g. `{muted: true}` on conversations, `{pinned: true}` on candidates). First-class state goes on the top-level attributes; ad-hoc state lives here."
12057
+ },
12058
+ "timestamps": {
12059
+ "title": "ResourceTimestampsSchema",
12060
+ "type": "object",
12061
+ "properties": {
12062
+ "created": {
12063
+ "type": "string",
12064
+ "format": "date-time"
12065
+ },
12066
+ "modified": {
12067
+ "type": "string",
12068
+ "format": "date-time"
12069
+ }
12070
+ }
12071
+ }
12072
+ }
12073
+ }
12074
+ }
12075
+ }
12076
+ }
12077
+ }
12078
+ }
12079
+ },
12080
+ {
12081
+ "type": "function",
12082
+ "function": {
12083
+ "name": "delete_state",
12084
+ "description": "Delete State",
12085
+ "parameters": {
12086
+ "type": "object",
12087
+ "properties": {}
12088
+ }
12089
+ }
12090
+ },
12091
+ {
12092
+ "type": "function",
12093
+ "function": {
12094
+ "name": "state_options",
12095
+ "description": "State Options",
12096
+ "parameters": {
12097
+ "type": "object",
12098
+ "properties": {}
12099
+ }
12100
+ }
12101
+ },
12102
+ {
12103
+ "type": "function",
12104
+ "function": {
12105
+ "name": "list_labels",
12106
+ "description": "List Labels",
12107
+ "parameters": {
12108
+ "type": "object",
12109
+ "properties": {
12110
+ "filterStatus": {
12111
+ "type": "string",
12112
+ "description": "filterStatus parameter",
12113
+ "enum": [
12114
+ "active",
12115
+ "archived"
12116
+ ]
11230
12117
  },
11231
- "pageBefore": {
11232
- "type": "string",
11233
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
12118
+ "pageSize": {
12119
+ "type": "integer",
12120
+ "description": "Specifies the number of items to retrieve per page. The maximum value is 100."
11234
12121
  }
11235
12122
  }
11236
12123
  }
@@ -11239,17 +12126,17 @@
11239
12126
  {
11240
12127
  "type": "function",
11241
12128
  "function": {
11242
- "name": "create_note",
11243
- "description": "Create Note",
12129
+ "name": "create_label",
12130
+ "description": "Create Label",
11244
12131
  "parameters": {
11245
- "title": "CreateNoteRequestBody",
12132
+ "title": "CreateLabelRequestBody",
11246
12133
  "type": "object",
11247
12134
  "required": [
11248
12135
  "data"
11249
12136
  ],
11250
12137
  "properties": {
11251
12138
  "data": {
11252
- "title": "CreateNoteRequestBodyData",
12139
+ "title": "CreateLabelRequestBodyData",
11253
12140
  "type": "object",
11254
12141
  "required": [
11255
12142
  "type",
@@ -11259,37 +12146,50 @@
11259
12146
  "type": {
11260
12147
  "type": "string",
11261
12148
  "enum": [
11262
- "notes"
12149
+ "labels"
11263
12150
  ]
11264
12151
  },
11265
12152
  "attributes": {
11266
- "title": "NoteAttributesSchema",
12153
+ "title": "LabelAttributesSchema",
11267
12154
  "type": "object",
11268
12155
  "properties": {
11269
12156
  "name": {
11270
- "type": "string"
12157
+ "type": "string",
12158
+ "description": "Display name. Unique within a scope by convention but not enforced."
11271
12159
  },
11272
- "status": {
11273
- "type": "string"
12160
+ "color": {
12161
+ "type": "string",
12162
+ "description": "Hex or CSS-named color the UI uses to render the label pill."
11274
12163
  },
11275
- "details": {
11276
- "type": "object",
11277
- "additionalProperties": {
11278
- "type": "string"
11279
- },
11280
- "description": "Multilingual note details keyed by language code"
12164
+ "description": {
12165
+ "type": "string"
11281
12166
  },
11282
- "source": {
12167
+ "scope": {
11283
12168
  "type": "string",
11284
- "description": "Source of the note"
12169
+ "enum": [
12170
+ "tenant",
12171
+ "user"
12172
+ ],
12173
+ "description": "tenant = visible to every user in the tenant; user = visible only to the owner."
11285
12174
  },
11286
- "ttl": {
12175
+ "ownerId": {
11287
12176
  "type": "string",
11288
- "description": "Time-to-live expiration timestamp"
12177
+ "description": "Set server-side from the caller. Tenant-scope: tenantId. User-scope: the authenticated user's full userId."
11289
12178
  },
11290
- "meta": {
11291
- "type": "object",
11292
- "additionalProperties": true
12179
+ "resourceTypes": {
12180
+ "type": "array",
12181
+ "items": {
12182
+ "type": "string"
12183
+ },
12184
+ "description": "Optional UI hint: if set, the frontend only exposes this label in the picker for these resource types (emails, candidates, ...). Not enforced server-side."
12185
+ },
12186
+ "status": {
12187
+ "type": "string",
12188
+ "enum": [
12189
+ "active",
12190
+ "archived"
12191
+ ],
12192
+ "description": "Archived labels stay readable (for historical assignments) but disappear from the default list."
11293
12193
  },
11294
12194
  "timestamps": {
11295
12195
  "title": "ResourceTimestampsSchema",
@@ -11306,87 +12206,6 @@
11306
12206
  }
11307
12207
  }
11308
12208
  }
11309
- },
11310
- "relationships": {
11311
- "title": "NoteRelationshipsSchema",
11312
- "type": "object",
11313
- "properties": {
11314
- "candidate": {
11315
- "title": "NoteRelationshipsCandidateSchema",
11316
- "type": "object",
11317
- "properties": {
11318
- "data": {
11319
- "title": "NoteRelationshipsCandidateDataSchema",
11320
- "type": "object",
11321
- "properties": {
11322
- "type": {
11323
- "type": "string"
11324
- },
11325
- "id": {
11326
- "type": "string"
11327
- }
11328
- }
11329
- }
11330
- }
11331
- },
11332
- "translations": {
11333
- "title": "NoteRelationshipsTranslationsSchema",
11334
- "type": "object",
11335
- "properties": {
11336
- "data": {
11337
- "type": "array",
11338
- "items": {
11339
- "title": "NoteRelationshipsTranslationsDataSchema",
11340
- "type": "object",
11341
- "properties": {
11342
- "type": {
11343
- "type": "string"
11344
- },
11345
- "id": {
11346
- "type": "string"
11347
- }
11348
- }
11349
- }
11350
- }
11351
- }
11352
- },
11353
- "report": {
11354
- "title": "NoteRelationshipsReportSchema",
11355
- "type": "object",
11356
- "properties": {
11357
- "data": {
11358
- "title": "NoteRelationshipsReportDataSchema",
11359
- "type": "object",
11360
- "properties": {
11361
- "type": {
11362
- "type": "string"
11363
- },
11364
- "id": {
11365
- "type": "string"
11366
- }
11367
- }
11368
- }
11369
- }
11370
- },
11371
- "operation": {
11372
- "title": "NoteRelationshipsOperationSchema",
11373
- "type": "object",
11374
- "properties": {
11375
- "data": {
11376
- "title": "NoteRelationshipsOperationDataSchema",
11377
- "type": "object",
11378
- "properties": {
11379
- "type": {
11380
- "type": "string"
11381
- },
11382
- "id": {
11383
- "type": "string"
11384
- }
11385
- }
11386
- }
11387
- }
11388
- }
11389
- }
11390
12209
  }
11391
12210
  }
11392
12211
  }
@@ -11397,8 +12216,8 @@
11397
12216
  {
11398
12217
  "type": "function",
11399
12218
  "function": {
11400
- "name": "notes_options",
11401
- "description": "Notes Options",
12219
+ "name": "labels_options",
12220
+ "description": "Labels Options",
11402
12221
  "parameters": {
11403
12222
  "type": "object",
11404
12223
  "properties": {}
@@ -11408,8 +12227,8 @@
11408
12227
  {
11409
12228
  "type": "function",
11410
12229
  "function": {
11411
- "name": "show_note",
11412
- "description": "Show Note",
12230
+ "name": "show_label",
12231
+ "description": "Show Label",
11413
12232
  "parameters": {
11414
12233
  "type": "object",
11415
12234
  "properties": {}
@@ -11419,17 +12238,17 @@
11419
12238
  {
11420
12239
  "type": "function",
11421
12240
  "function": {
11422
- "name": "update_note",
11423
- "description": "Update Note",
12241
+ "name": "update_label",
12242
+ "description": "Update Label",
11424
12243
  "parameters": {
11425
- "title": "UpdateNoteRequestBody",
12244
+ "title": "UpdateLabelRequestBody",
11426
12245
  "type": "object",
11427
12246
  "required": [
11428
12247
  "data"
11429
12248
  ],
11430
12249
  "properties": {
11431
12250
  "data": {
11432
- "title": "UpdateNoteRequestBodyData",
12251
+ "title": "UpdateLabelRequestBodyData",
11433
12252
  "type": "object",
11434
12253
  "required": [
11435
12254
  "type",
@@ -11440,40 +12259,53 @@
11440
12259
  "type": {
11441
12260
  "type": "string",
11442
12261
  "enum": [
11443
- "notes"
12262
+ "labels"
11444
12263
  ]
11445
12264
  },
11446
12265
  "id": {
11447
12266
  "type": "string"
11448
12267
  },
11449
12268
  "attributes": {
11450
- "title": "NoteAttributesSchema",
12269
+ "title": "LabelAttributesSchema",
11451
12270
  "type": "object",
11452
12271
  "properties": {
11453
12272
  "name": {
11454
- "type": "string"
12273
+ "type": "string",
12274
+ "description": "Display name. Unique within a scope by convention but not enforced."
11455
12275
  },
11456
- "status": {
11457
- "type": "string"
12276
+ "color": {
12277
+ "type": "string",
12278
+ "description": "Hex or CSS-named color the UI uses to render the label pill."
11458
12279
  },
11459
- "details": {
11460
- "type": "object",
11461
- "additionalProperties": {
11462
- "type": "string"
11463
- },
11464
- "description": "Multilingual note details keyed by language code"
12280
+ "description": {
12281
+ "type": "string"
11465
12282
  },
11466
- "source": {
12283
+ "scope": {
11467
12284
  "type": "string",
11468
- "description": "Source of the note"
12285
+ "enum": [
12286
+ "tenant",
12287
+ "user"
12288
+ ],
12289
+ "description": "tenant = visible to every user in the tenant; user = visible only to the owner."
11469
12290
  },
11470
- "ttl": {
12291
+ "ownerId": {
11471
12292
  "type": "string",
11472
- "description": "Time-to-live expiration timestamp"
12293
+ "description": "Set server-side from the caller. Tenant-scope: tenantId. User-scope: the authenticated user's full userId."
11473
12294
  },
11474
- "meta": {
11475
- "type": "object",
11476
- "additionalProperties": true
12295
+ "resourceTypes": {
12296
+ "type": "array",
12297
+ "items": {
12298
+ "type": "string"
12299
+ },
12300
+ "description": "Optional UI hint: if set, the frontend only exposes this label in the picker for these resource types (emails, candidates, ...). Not enforced server-side."
12301
+ },
12302
+ "status": {
12303
+ "type": "string",
12304
+ "enum": [
12305
+ "active",
12306
+ "archived"
12307
+ ],
12308
+ "description": "Archived labels stay readable (for historical assignments) but disappear from the default list."
11477
12309
  },
11478
12310
  "timestamps": {
11479
12311
  "title": "ResourceTimestampsSchema",
@@ -11500,8 +12332,8 @@
11500
12332
  {
11501
12333
  "type": "function",
11502
12334
  "function": {
11503
- "name": "delete_note",
11504
- "description": "Delete Note",
12335
+ "name": "delete_label",
12336
+ "description": "Delete Label",
11505
12337
  "parameters": {
11506
12338
  "type": "object",
11507
12339
  "properties": {}
@@ -11511,8 +12343,8 @@
11511
12343
  {
11512
12344
  "type": "function",
11513
12345
  "function": {
11514
- "name": "note_options",
11515
- "description": "Note Options",
12346
+ "name": "label_options",
12347
+ "description": "Label Options",
11516
12348
  "parameters": {
11517
12349
  "type": "object",
11518
12350
  "properties": {}
@@ -11563,7 +12395,7 @@
11563
12395
  },
11564
12396
  "pageAfter": {
11565
12397
  "type": "string",
11566
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
12398
+ "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."
11567
12399
  },
11568
12400
  "pageBefore": {
11569
12401
  "type": "string",
@@ -12110,7 +12942,7 @@
12110
12942
  },
12111
12943
  "pageAfter": {
12112
12944
  "type": "string",
12113
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
12945
+ "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."
12114
12946
  },
12115
12947
  "pageBefore": {
12116
12948
  "type": "string",
@@ -12444,7 +13276,7 @@
12444
13276
  },
12445
13277
  "pageAfter": {
12446
13278
  "type": "string",
12447
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
13279
+ "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."
12448
13280
  },
12449
13281
  "pageBefore": {
12450
13282
  "type": "string",
@@ -12788,7 +13620,7 @@
12788
13620
  },
12789
13621
  "pageAfter": {
12790
13622
  "type": "string",
12791
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
13623
+ "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."
12792
13624
  },
12793
13625
  "pageBefore": {
12794
13626
  "type": "string",
@@ -13078,7 +13910,7 @@
13078
13910
  },
13079
13911
  "pageAfter": {
13080
13912
  "type": "string",
13081
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
13913
+ "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."
13082
13914
  },
13083
13915
  "pageBefore": {
13084
13916
  "type": "string",
@@ -13316,7 +14148,7 @@
13316
14148
  },
13317
14149
  "pageAfter": {
13318
14150
  "type": "string",
13319
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14151
+ "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."
13320
14152
  },
13321
14153
  "pageBefore": {
13322
14154
  "type": "string",
@@ -13622,7 +14454,7 @@
13622
14454
  },
13623
14455
  "pageAfter": {
13624
14456
  "type": "string",
13625
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14457
+ "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."
13626
14458
  },
13627
14459
  "pageBefore": {
13628
14460
  "type": "string",
@@ -13728,7 +14560,7 @@
13728
14560
  },
13729
14561
  "pageAfter": {
13730
14562
  "type": "string",
13731
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14563
+ "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."
13732
14564
  },
13733
14565
  "pageBefore": {
13734
14566
  "type": "string",
@@ -13816,7 +14648,7 @@
13816
14648
  },
13817
14649
  "pageAfter": {
13818
14650
  "type": "string",
13819
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14651
+ "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."
13820
14652
  },
13821
14653
  "pageBefore": {
13822
14654
  "type": "string",
@@ -13908,7 +14740,7 @@
13908
14740
  },
13909
14741
  "pageAfter": {
13910
14742
  "type": "string",
13911
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14743
+ "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."
13912
14744
  },
13913
14745
  "pageBefore": {
13914
14746
  "type": "string",
@@ -14105,7 +14937,7 @@
14105
14937
  },
14106
14938
  "pageAfter": {
14107
14939
  "type": "string",
14108
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
14940
+ "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."
14109
14941
  },
14110
14942
  "pageBefore": {
14111
14943
  "type": "string",
@@ -14348,7 +15180,7 @@
14348
15180
  },
14349
15181
  "pageAfter": {
14350
15182
  "type": "string",
14351
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
15183
+ "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."
14352
15184
  },
14353
15185
  "pageBefore": {
14354
15186
  "type": "string",
@@ -14409,12 +15241,62 @@
14409
15241
  "description": "The type of search to perform"
14410
15242
  },
14411
15243
  "query": {
14412
- "type": "object",
14413
- "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\"."
15244
+ "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.",
15245
+ "oneOf": [
15246
+ {
15247
+ "$ref": "#/components/schemas/FinderQueryTalentsSchema"
15248
+ },
15249
+ {
15250
+ "$ref": "#/components/schemas/FinderQueryCandidatesSchema"
15251
+ },
15252
+ {
15253
+ "$ref": "#/components/schemas/FinderQueryJobsSchema"
15254
+ },
15255
+ {
15256
+ "$ref": "#/components/schemas/FinderQueryEmailsSchema"
15257
+ }
15258
+ ]
14414
15259
  },
14415
15260
  "results": {
15261
+ "title": "FinderResultsSchema",
14416
15262
  "type": "object",
14417
- "description": "The search results returned from OpenSearch (auto-populated)"
15263
+ "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.",
15264
+ "properties": {
15265
+ "total": {
15266
+ "type": "integer",
15267
+ "description": "Count of matching documents before pagination."
15268
+ },
15269
+ "hits": {
15270
+ "type": "array",
15271
+ "items": {
15272
+ "title": "FinderResultHitSchema",
15273
+ "type": "object",
15274
+ "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`.",
15275
+ "properties": {
15276
+ "id": {
15277
+ "type": "string",
15278
+ "description": "The underlying resource id (emailId / talentId / candidateId / jobId)."
15279
+ },
15280
+ "tenantId": {
15281
+ "type": "string"
15282
+ },
15283
+ "status": {
15284
+ "type": "string"
15285
+ },
15286
+ "source": {
15287
+ "type": "string"
15288
+ },
15289
+ "created": {
15290
+ "type": "string"
15291
+ },
15292
+ "shortCode": {
15293
+ "type": "string"
15294
+ }
15295
+ },
15296
+ "additionalProperties": true
15297
+ }
15298
+ }
15299
+ }
14418
15300
  },
14419
15301
  "status": {
14420
15302
  "type": "string",
@@ -14636,12 +15518,62 @@
14636
15518
  "description": "The type of search to perform"
14637
15519
  },
14638
15520
  "query": {
14639
- "type": "object",
14640
- "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\"."
15521
+ "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.",
15522
+ "oneOf": [
15523
+ {
15524
+ "$ref": "#/components/schemas/FinderQueryTalentsSchema"
15525
+ },
15526
+ {
15527
+ "$ref": "#/components/schemas/FinderQueryCandidatesSchema"
15528
+ },
15529
+ {
15530
+ "$ref": "#/components/schemas/FinderQueryJobsSchema"
15531
+ },
15532
+ {
15533
+ "$ref": "#/components/schemas/FinderQueryEmailsSchema"
15534
+ }
15535
+ ]
14641
15536
  },
14642
15537
  "results": {
15538
+ "title": "FinderResultsSchema",
14643
15539
  "type": "object",
14644
- "description": "The search results returned from OpenSearch (auto-populated)"
15540
+ "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.",
15541
+ "properties": {
15542
+ "total": {
15543
+ "type": "integer",
15544
+ "description": "Count of matching documents before pagination."
15545
+ },
15546
+ "hits": {
15547
+ "type": "array",
15548
+ "items": {
15549
+ "title": "FinderResultHitSchema",
15550
+ "type": "object",
15551
+ "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`.",
15552
+ "properties": {
15553
+ "id": {
15554
+ "type": "string",
15555
+ "description": "The underlying resource id (emailId / talentId / candidateId / jobId)."
15556
+ },
15557
+ "tenantId": {
15558
+ "type": "string"
15559
+ },
15560
+ "status": {
15561
+ "type": "string"
15562
+ },
15563
+ "source": {
15564
+ "type": "string"
15565
+ },
15566
+ "created": {
15567
+ "type": "string"
15568
+ },
15569
+ "shortCode": {
15570
+ "type": "string"
15571
+ }
15572
+ },
15573
+ "additionalProperties": true
15574
+ }
15575
+ }
15576
+ }
14645
15577
  },
14646
15578
  "status": {
14647
15579
  "type": "string",
@@ -14760,7 +15692,7 @@
14760
15692
  },
14761
15693
  "pageAfter": {
14762
15694
  "type": "string",
14763
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
15695
+ "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."
14764
15696
  },
14765
15697
  "pageBefore": {
14766
15698
  "type": "string",
@@ -15019,7 +15951,7 @@
15019
15951
  },
15020
15952
  "pageAfter": {
15021
15953
  "type": "string",
15022
- "description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
15954
+ "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."
15023
15955
  },
15024
15956
  "pageBefore": {
15025
15957
  "type": "string",