late-sdk 0.0.871 → 0.0.873

data/spec/api/discord_api_spec.rb

@@ -34,7 +34,7 @@ describe 'DiscordApi' do
 
   # unit tests for add_discord_member_role
   # Assign a role to a guild member
-  # Assign one role to one member. Idempotent on Discord's side — re-running on a member who already has the role is a 204 no-op.  Path shape mirrors Discord's own API (`PUT /guilds/{guild}/members/{user}/roles/{role}`) for zero-translation mental mapping.  Bot needs MANAGE_ROLES permission in the guild AND its highest role must be above the target role (Discord hierarchy rule). The `@everyone` role (where roleId == guildId) cannot be assigned. 
+  # Assign one role to one member. Idempotent on Discord's side: re-running on a member who already has the role is a 204 no-op.  Path shape mirrors Discord's own API (`PUT /guilds/{guild}/members/{user}/roles/{role}`) for zero-translation mental mapping.  Bot needs MANAGE_ROLES permission in the guild AND its highest role must be above the target role (Discord hierarchy rule). The `@everyone` role (where roleId == guildId) cannot be assigned. 
   # @param guild_id 
   # @param user_id Discord user snowflake to assign the role to.
   # @param role_id 
@@ -63,7 +63,7 @@ describe 'DiscordApi' do
 
   # unit tests for create_discord_scheduled_event
   # Create a Discord scheduled event
-  # Create a guild scheduled event. Three event types, selected via the discriminator on `entity.type`:    - `external` — off-platform (Zoom, in-person, livestream). Requires     both `location` and `endsAt`. Most common type for scheduler     integrations.   - `voice` — hosted in a Discord voice channel. Requires `channelId`.   - `stage` — hosted in a Discord stage channel. Requires `channelId`.  Bot needs MANAGE_EVENTS in the guild. Existing installs (pre-events PR) need a re-invite OR a server admin manually granting the permission — see route header for details. 
+  # Create a guild scheduled event. Three event types, selected via the discriminator on `entity.type`:    - `external`: off-platform (Zoom, in-person, livestream). Requires     both `location` and `endsAt`. Most common type for scheduler     integrations.   - `voice`: hosted in a Discord voice channel. Requires `channelId`.   - `stage`: hosted in a Discord stage channel. Requires `channelId`.  Bot needs MANAGE_EVENTS in the guild. Existing installs (pre-events PR) need a re-invite OR a server admin manually granting the permission. See route header for details. 
   # @param guild_id 
   # @param create_discord_scheduled_event_request 
   # @param [Hash] opts the optional parameters
@@ -227,7 +227,7 @@ describe 'DiscordApi' do
 
   # unit tests for list_discord_guild_roles
   # List Discord guild roles
-  # Returns all roles in a Discord guild. Useful for building role-mention pickers, role-permission UIs, or finding the role ID before calling the role-assign endpoint.  Roles are returned unordered — sort client-side by `position` if you need Discord's UI ordering.  Caller must pass `accountId` of a Discord SocialAccount bound to this guild (route verifies team access + guild match). 
+  # Returns all roles in a Discord guild. Useful for building role-mention pickers, role-permission UIs, or finding the role ID before calling the role-assign endpoint.  Roles are returned unordered. Sort client-side by `position` if you need Discord's UI ordering.  Caller must pass `accountId` of a Discord SocialAccount bound to this guild (route verifies team access + guild match). 
   # @param guild_id Discord guild snowflake ID
   # @param account_id SocialAccount _id of the Discord account bound to this guild
   # @param [Hash] opts the optional parameters
@@ -253,7 +253,7 @@ describe 'DiscordApi' do
 
   # unit tests for list_discord_scheduled_events
   # List Discord scheduled events
-  # Return all scheduled events in the guild. Events are distinct from messages — they appear in the server's Events panel and Discord auto-notifies interested members ahead of start time.  Pass `withUserCount=true` to include `user_count` (number of members who RSVP'd) on each event. Useful for surfacing engagement. 
+  # Return all scheduled events in the guild. Events are distinct from messages: they appear in the server's Events panel and Discord auto-notifies interested members ahead of start time.  Pass `withUserCount=true` to include `user_count` (number of members who RSVP'd) on each event. Useful for surfacing engagement. 
   # @param guild_id 
   # @param account_id 
   # @param [Hash] opts the optional parameters
@@ -267,7 +267,7 @@ describe 'DiscordApi' do
 
   # unit tests for pin_discord_message
   # Pin a Discord message
-  # Pin a specific message in a channel. Path shape mirrors Discord's own API (`PUT /channels/{cid}/pins/{mid}`).  Idempotent — re-pinning an already-pinned message is a 204 no-op.  Constraints:   - Bot needs MANAGE_MESSAGES in the channel.   - 50-pin cap per channel — hitting it returns 400 (Discord-side).     Caller should unpin one first. 
+  # Pin a specific message in a channel. Path shape mirrors Discord's own API (`PUT /channels/{cid}/pins/{mid}`).  Idempotent: re-pinning an already-pinned message is a 204 no-op.  Constraints:   - Bot needs MANAGE_MESSAGES in the channel.   - 50-pin cap per channel: hitting it returns 400 (Discord-side).     Caller should unpin one first. 
   # @param channel_id 
   # @param message_id 
   # @param account_id 
@@ -281,7 +281,7 @@ describe 'DiscordApi' do
 
   # unit tests for remove_discord_member_role
   # Remove a role from a guild member
-  # Remove one role from one member. Idempotent — removing a role the member doesn't have returns 204 no-op.  Same permission + hierarchy constraints as the PUT counterpart. 
+  # Remove one role from one member. Idempotent: removing a role the member doesn't have returns 204 no-op.  Same permission + hierarchy constraints as the PUT counterpart. 
   # @param guild_id 
   # @param user_id 
   # @param role_id 
@@ -311,7 +311,7 @@ describe 'DiscordApi' do
 
   # unit tests for send_discord_direct_message
   # Send a Discord Direct Message
-  # Send a 1:1 Direct Message from the bot to a Discord user (by snowflake ID). Supports the same payload shape as channel posts — content, embeds, media attachments, and TTS.  Constraints (Discord platform limits):   - The bot can only DM users it shares at least one guild with.   - If the recipient has DMs disabled for non-friends, Discord returns 403     (surfaces as a 502 platform error).   - `content` capped at 2,000 chars.   - At least one of `content`, `embeds`, or `attachments` is required.   - The recipient must be identified by Discord snowflake ID (not username).  This is a dedicated endpoint rather than a `POST /v1/posts` variant because DMs are 1:1 operational messages (onboarding, billing reminders, support pings) with a different lifecycle than scheduled channel posts. DMs are not persisted to `Post` / `ExternalPost` and are always sent immediately. 
+  # Send a 1:1 Direct Message from the bot to a Discord user (by snowflake ID). Supports the same payload shape as channel posts: content, embeds, media attachments, and TTS.  Constraints (Discord platform limits):   - The bot can only DM users it shares at least one guild with.   - If the recipient has DMs disabled for non-friends, Discord returns 403     (surfaces as a 502 platform error).   - `content` capped at 2,000 chars.   - At least one of `content`, `embeds`, or `attachments` is required.   - The recipient must be identified by Discord snowflake ID (not username).  This is a dedicated endpoint rather than a `POST /v1/posts` variant because DMs are 1:1 operational messages (onboarding, billing reminders, support pings) with a different lifecycle than scheduled channel posts. DMs are not persisted to `Post` / `ExternalPost` and are always sent immediately. 
   # @param send_discord_direct_message_request 
   # @param [Hash] opts the optional parameters
   # @return [SendDiscordDirectMessage200Response]
@@ -323,7 +323,7 @@ describe 'DiscordApi' do
 
   # unit tests for unpin_discord_message
   # Unpin a Discord message
-  # Unpin a message. Same MANAGE_MESSAGES permission requirement as pin. Idempotent — unpinning a non-pinned message is a 204 no-op. 
+  # Unpin a message. Same MANAGE_MESSAGES permission requirement as pin. Idempotent: unpinning a non-pinned message is a 204 no-op. 
   # @param channel_id 
   # @param message_id 
   # @param account_id 
@@ -337,7 +337,7 @@ describe 'DiscordApi' do
 
   # unit tests for update_discord_scheduled_event
   # Update a Discord scheduled event
-  # Patch any subset of fields. Passing `status: 'cancelled'` is how you cancel an event — Discord doesn't have a dedicated cancel endpoint, it's a status transition.  Most status transitions Discord enforces (you can't go SCHEDULED → COMPLETED directly). The common consumer case is SCHEDULED → CANCELED. 
+  # Patch any subset of fields. Passing `status: 'cancelled'` is how you cancel an event. Discord doesn't have a dedicated cancel endpoint, it's a status transition.  Most status transitions Discord enforces (you can't go SCHEDULED → COMPLETED directly). The common consumer case is SCHEDULED → CANCELED. 
   # @param guild_id 
   # @param event_id 
   # @param update_discord_scheduled_event_request 

data/spec/api/gmb_attributes_api_spec.rb

@@ -37,7 +37,7 @@ describe 'GMBAttributesApi' do
   # Returns metadata about which Google Business Profile attributes are available for a location or business category. Use this endpoint to discover valid attribute names, value types, and allowed enum values before reading or writing via gmb-attributes.  Two mutually exclusive query modes:  **Location mode**: pass `locationId` (or rely on the account's stored `selectedLocationId`). Google returns attributes valid for that specific location.  **Category mode**: pass `categoryName` (must start with `categories/`) and `regionCode`. Google returns attributes valid for that category across the given region. `languageCode` is optional in category mode.  Both modes support `pageSize` and `pageToken` for pagination. 
   # @param account_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :location_id GBP location ID (e.g. \"6257659026299438786\"). If omitted, uses the account's stored selectedLocationId. Mutually exclusive with categoryName. 
+  # @option opts [String] :location_id Google Business Profile location ID (e.g. \"6257659026299438786\"). If omitted, uses the account's stored selectedLocationId. Mutually exclusive with categoryName. 
   # @option opts [String] :category_name Category resource name, must start with \"categories/\" (e.g. \"categories/gcid:plumber\"). Required together with regionCode. Mutually exclusive with locationId. 
   # @option opts [String] :region_code BCP-47 region code (e.g. \"US\", \"ES\"). Required when categoryName is provided. 
   # @option opts [String] :language_code BCP-47 language code for display names (e.g. \"en\", \"es\"). Optional when categoryName is provided. Omitted from the Google call when not supplied. 
@@ -52,7 +52,7 @@ describe 'GMBAttributesApi' do
 
   # unit tests for get_google_business_attributes
   # Get attributes
-  # Returns GBP location attributes (amenities, services, accessibility, payment types). Available attributes vary by business category.
+  # Returns Google Business Profile location attributes (amenities, services, accessibility, payment types). Available attributes vary by business category.
   # @param account_id 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :location_id Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.

data/spec/api/gmb_food_menus_api_spec.rb

@@ -34,7 +34,7 @@ describe 'GMBFoodMenusApi' do
 
   # unit tests for get_google_business_food_menus
   # Get food menus
-  # Returns food menus for a GBP location including sections, items, pricing, and dietary info. Only for locations with food menu support.
+  # Returns food menus for a Google Business Profile location including sections, items, pricing, and dietary info. Only for locations with food menu support.
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param [Hash] opts the optional parameters
   # @option opts [String] :location_id Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
@@ -47,7 +47,7 @@ describe 'GMBFoodMenusApi' do
 
   # unit tests for update_google_business_food_menus
   # Update food menus
-  # Updates food menus for a GBP location. Send the full menus array. Use updateMask for partial updates.
+  # Updates food menus for a Google Business Profile location. Send the full menus array. Use updateMask for partial updates.
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param update_google_business_food_menus_request 
   # @param [Hash] opts the optional parameters

data/spec/api/gmb_location_details_api_spec.rb

@@ -34,7 +34,7 @@ describe 'GMBLocationDetailsApi' do
 
   # unit tests for get_google_business_location_details
   # Get location details
-  # Returns detailed GBP location info (hours, description, phone, website, categories, services). Use readMask to request specific fields.
+  # Returns detailed Google Business Profile location info (hours, description, phone, website, categories, services). Use readMask to request specific fields.
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param [Hash] opts the optional parameters
   # @option opts [String] :location_id Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
@@ -48,7 +48,7 @@ describe 'GMBLocationDetailsApi' do
 
   # unit tests for update_google_business_location_details
   # Update location details
-  # Updates GBP location details. The updateMask field is required and specifies which fields to update. This endpoint proxies Google's Business Information API locations.patch, so any valid updateMask field is supported. Common fields: regularHours, specialHours, profile.description, websiteUri, phoneNumbers, categories, serviceItems. 
+  # Updates Google Business Profile location details. The updateMask field is required and specifies which fields to update. This endpoint proxies Google's Business Information API locations.patch, so any valid updateMask field is supported. Common fields: regularHours, specialHours, profile.description, websiteUri, phoneNumbers, categories, serviceItems. 
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param update_google_business_location_details_request 
   # @param [Hash] opts the optional parameters

data/spec/api/gmb_media_api_spec.rb

@@ -48,7 +48,7 @@ describe 'GMBMediaApi' do
 
   # unit tests for delete_google_business_media
   # Delete photo
-  # Deletes a photo or media item from a GBP location.
+  # Deletes a photo or media item from a Google Business Profile location.
   # @param account_id 
   # @param media_id The media item ID to delete
   # @param [Hash] opts the optional parameters

data/spec/api/gmb_place_actions_api_spec.rb

@@ -48,7 +48,7 @@ describe 'GMBPlaceActionsApi' do
 
   # unit tests for delete_google_business_place_action
   # Delete action link
-  # Deletes a place action link (e.g. booking or ordering URL) from a GBP location.
+  # Deletes a place action link (e.g. booking or ordering URL) from a Google Business Profile location.
   # @param account_id 
   # @param name The resource name of the place action link (e.g. locations/123/placeActionLinks/456)
   # @param [Hash] opts the optional parameters

data/spec/api/gmb_reviews_api_spec.rb

@@ -47,7 +47,7 @@ describe 'GMBReviewsApi' do
 
   # unit tests for delete_google_business_review_reply
   # Delete a review reply
-  # Removes the business owner reply from a Google Business review. The review itself remains.
+  # Removes the business owner reply from a Google Business Profile review. The review itself remains.
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param review_id The review ID portion (e.g. \"AIe9_BGx1234567890\"), not the full resource name
   # @param [Hash] opts the optional parameters
@@ -60,7 +60,7 @@ describe 'GMBReviewsApi' do
 
   # unit tests for get_google_business_review
   # Get a review
-  # Returns one Google Business review, in the same shape as the entries of GET /v1/accounts/{accountId}/gmb-reviews. The review is read from the account's selected location unless locationId overrides it, and Google returns 404 for a review id that belongs to another location. Read the review before replying if a human may have answered it already: replies are overwritten in place and Google keeps no history. 
+  # Returns one Google Business Profile review, in the same shape as the entries of GET /v1/accounts/{accountId}/gmb-reviews. The review is read from the account's selected location unless locationId overrides it, and Google returns 404 for a review id that belongs to another location. Read the review before replying if a human may have answered it already: replies are overwritten in place and Google keeps no history. 
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param review_id The review ID portion (e.g. \"AIe9_BGx1234567890\"), not the full resource name
   # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ describe 'GMBReviewsApi' do
 
   # unit tests for get_google_business_reviews
   # Get reviews
-  # Returns reviews for a GBP account including ratings, comments, and owner replies. Use nextPageToken for pagination.
+  # Returns reviews for a Google Business Profile account including ratings, comments, and owner replies. Use nextPageToken for pagination.
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param [Hash] opts the optional parameters
   # @option opts [String] :location_id Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
@@ -89,7 +89,7 @@ describe 'GMBReviewsApi' do
 
   # unit tests for reply_to_google_business_review
   # Reply to a review
-  # Posts (or updates) the business owner reply to a Google Business review. The reply is associated with the account's currently selected location (set via /v1/accounts/{accountId}/gmb-locations). Calling this endpoint a second time on the same review overwrites the previous reply (PUT semantics on Google's side). Google keeps no history, so an automated retry silently replaces a reply someone edited by hand in the Google Business Profile UI. Read the review before retrying if a human may have answered it. 
+  # Posts (or updates) the business owner reply to a Google Business Profile review. The reply is associated with the account's currently selected location (set via /v1/accounts/{accountId}/gmb-locations). Calling this endpoint a second time on the same review overwrites the previous reply (PUT semantics on Google's side). Google keeps no history, so an automated retry silently replaces a reply someone edited by hand in the Google Business Profile UI. Read the review before retrying if a human may have answered it. 
   # @param account_id The Zernio account ID (from /v1/accounts)
   # @param review_id The review ID portion (e.g. \"AIe9_BGx1234567890\"), not the full resource name
   # @param reply_to_google_business_review_request 

data/spec/api/inbox_analytics_api_spec.rb

@@ -34,7 +34,7 @@ describe 'InboxAnalyticsApi' do
 
   # unit tests for get_inbox_conversation_analytics
   # Get conversation analytics
-  # Per-conversation inbox analytics. The inbox analog of /v1/analytics/post-timeline — one conversation, daily totals, source mix.  The {conversationId} path param accepts EITHER the Mongo `_id` of the Conversation document OR its `platformConversationId` (the same identity used by metadata.conversationId at ingest time). Ownership is verified in MongoDB against the caller's team before the Tinybird query fires.  Max date range is 365 days. 
+  # Per-conversation inbox analytics. The inbox analog of /v1/analytics/post-timeline: one conversation, daily totals, source mix.  The {conversationId} path param accepts EITHER the Mongo `_id` of the Conversation document OR its `platformConversationId` (the same identity used by metadata.conversationId at ingest time). Ownership is verified in MongoDB against the caller's team before the Tinybird query fires.  Max date range is 365 days. 
   # @param conversation_id Mongo _id or platformConversationId.
   # @param from_date 
   # @param [Hash] opts the optional parameters
@@ -48,7 +48,7 @@ describe 'InboxAnalyticsApi' do
 
   # unit tests for get_inbox_heatmap
   # Get day × hour heatmap
-  # Day-of-week × hour-of-day breakdown of inbox messages. Buckets are sparse — only cells with at least one event are returned; clients zero-fill the rest to render the full 7×24 grid. The `dow` field follows ClickHouse's `toDayOfWeek` convention (1 = Monday … 7 = Sunday). Max date range is 365 days. 
+  # Day-of-week × hour-of-day breakdown of inbox messages. Buckets are sparse: only cells with at least one event are returned; clients zero-fill the rest to render the full 7×24 grid. The `dow` field follows ClickHouse's `toDayOfWeek` convention (1 = Monday … 7 = Sunday). Max date range is 365 days. 
   # @param from_date 
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :to_date 
@@ -66,7 +66,7 @@ describe 'InboxAnalyticsApi' do
 
   # unit tests for get_inbox_response_time
   # Get inbox response-time stats
-  # Time-to-first-response stats. Pairs each received message with the next sent message in the same conversation and reports the delta as both summary statistics and a fixed-bucket histogram suited for the analytics page's TTR chart.  `sampleSize` reflects only conversations that received AND got a reply in the window — received-but-never-answered conversations are excluded. Compare against /v1/analytics/inbox/volume's `summary.received` to compute reply rate.  Max date range is 365 days. 
+  # Time-to-first-response stats. Pairs each received message with the next sent message in the same conversation and reports the delta as both summary statistics and a fixed-bucket histogram suited for the analytics page's TTR chart.  `sampleSize` reflects only conversations that received AND got a reply in the window. Received-but-never-answered conversations are excluded. Compare against /v1/analytics/inbox/volume's `summary.received` to compute reply rate.  Max date range is 365 days. 
   # @param from_date 
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :to_date 
@@ -98,7 +98,7 @@ describe 'InboxAnalyticsApi' do
 
   # unit tests for get_inbox_top_accounts
   # Get top accounts by inbox volume
-  # Leaderboard of social accounts by inbox message volume. Decorates each row with display labels from the live SocialAccount record (so the UI shows username + displayName, not just an ID). Accounts that no longer map to a SocialAccount surface as \"(disconnected)\" so the row stays visible. Max date range is 365 days. 
+  # Leaderboard of accounts by inbox message volume. Decorates each row with display labels from the live SocialAccount record (so the UI shows username + displayName, not only an ID). Accounts that no longer map to a SocialAccount surface as \"(disconnected)\" so the row stays visible. Max date range is 365 days. 
   # @param from_date 
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :to_date 
@@ -132,7 +132,7 @@ describe 'InboxAnalyticsApi' do
 
   # unit tests for list_inbox_conversation_analytics
   # List conversation analytics
-  # Per-conversation listing with per-row totals + first/last message timestamps. The inbox analog of GET /v1/analytics (posts listing) — same filter shape, same pagination, same sort/order semantics. Use as the entry point for the per-conversation analytics drawer at /v1/analytics/inbox/conversations/{conversationId}.  Rows are enriched with the conversation's participant info (`participantName`, `participantUsername`, `participantPicture`) and last-message preview by joining the Conversation document scoped to the caller's team. Max date range is 365 days. 
+  # Per-conversation listing with per-row totals + first/last message timestamps. The inbox analog of GET /v1/analytics (posts listing): same filter shape, same pagination, same sort/order semantics. Use as the entry point for the per-conversation analytics drawer at /v1/analytics/inbox/conversations/{conversationId}.  Rows are enriched with the conversation's participant info (`participantName`, `participantUsername`, `participantPicture`) and last-message preview by joining the Conversation document scoped to the caller's team. Max date range is 365 days. 
   # @param from_date 
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :to_date 

data/spec/api/instagram_api_spec.rb

@@ -59,7 +59,7 @@ describe 'InstagramApi' do
 
   # unit tests for get_instagram_story_insights
   # Get Instagram story insights
-  # Returns metrics for a single story. The `source` field discriminates between three states:  - `live` — fetched from Meta in real time (story is still active) - `cached` — fetched from a persisted `story_insights` webhook payload   (story has expired but we received its final-state metrics from Meta) - `unavailable` — story has expired and we never received its webhook   payload (for example, the account connected after the story expired)  Meta can report an expired story as an empty successful result rather than an error, so an expired story resolves to `cached` or `unavailable` even though the upstream request itself succeeded.  Field semantics follow Meta's API. Counts below 5 may be returned as 0 due to Meta's privacy floor on small audiences. The `navigation` field is the sum of `tapsForward + tapsBack + exits + swipesForward`. 
+  # Returns metrics for a single story. The `source` field discriminates between three states:  - `live`: fetched from Meta in real time (story is still active) - `cached`: fetched from a persisted `story_insights` webhook payload   (story has expired but we received its final-state metrics from Meta) - `unavailable`: story has expired and we never received its webhook   payload (for example, the account connected after the story expired)  Meta can report an expired story as an empty successful result rather than an error, so an expired story resolves to `cached` or `unavailable` even though the upstream request itself succeeded.  Field semantics follow Meta's API. Counts below 5 may be returned as 0 due to Meta's privacy floor on small audiences. The `navigation` field is the sum of `tapsForward + tapsBack + exits + swipesForward`. 
   # @param account_id The Instagram account ID
   # @param story_id The Instagram media ID of the story.
   # @param [Hash] opts the optional parameters

data/spec/api/lead_gen_api_spec.rb

@@ -47,7 +47,7 @@ describe 'LeadGenApi' do
 
   # unit tests for create_lead_form
   # Create a lead form
-  # Creates a Lead Gen form. The form content goes inside `platformSpecificData` for both platforms (the shape is selected by the accountId's platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms); the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent — mixing both shapes is a 400. LinkedIn: created on the ad account's Company Page. NOT idempotent — a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on. 
+  # Creates a Lead Gen form. The form content goes inside `platformSpecificData` for both platforms (the shape is selected by the accountId's platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms); the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent; mixing both shapes is a 400. LinkedIn: created on the ad account's Company Page. NOT idempotent: a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on. 
   # @param create_lead_form_request 
   # @param [Hash] opts the optional parameters
   # @return [CreateLeadForm200Response]
@@ -100,7 +100,7 @@ describe 'LeadGenApi' do
 
   # unit tests for list_lead_forms
   # List lead forms
-  # Lists the Lead Gen forms owned by the account. Meta: forms on the connected Facebook Page. LinkedIn: forms owned by the ad account's Company Page — pass `adAccountId` (LinkedIn forms are org-owned). Requires the Ads add-on. 
+  # Lists the Lead Gen forms owned by the account. Meta: forms on the connected Facebook Page. LinkedIn: forms owned by the ad account's Company Page. Pass `adAccountId` (LinkedIn forms are org-owned). Requires the Ads add-on. 
   # @param account_id Connected facebook or linkedin ads account id.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :ad_account_id LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn.

data/spec/api/linked_in_mentions_api_spec.rb

@@ -34,7 +34,7 @@ describe 'LinkedInMentionsApi' do
 
   # unit tests for get_linked_in_mentions
   # Resolve LinkedIn mention
-  # Converts a LinkedIn profile or company URL to a URN for @mentions in posts.  How to use LinkedIn @mentions (2-step workflow):  1. Call this endpoint with the LinkedIn profile/company URL to get the mention URN and format. 2. Embed the returned mentionFormat (e.g. @[Vincent Jong](urn:li:person:xxx)) directly in your post's content field.  Example: - Resolve: GET /v1/accounts/{id}/linkedin-mentions?url=linkedin.com/in/vincentjong&displayName=Vincent Jong - Returns: mentionFormat: \"@[Vincent Jong](urn:li:person:xxx)\" - Use in post content: \"Great talk with @[Vincent Jong](urn:li:person:xxx) today!\"  Important: The mentions array field in POST /v1/posts is stored for reference only and does NOT trigger @mentions on LinkedIn. You must embed the mention format directly in the content text.  Requirements: - Person mentions require the LinkedIn account to be admin of at least one organization: both endpoints that resolve a profile URL to a member URN take an organization you administer. Organization mentions (e.g. @Microsoft) have no such requirement. - The two are not scoped alike. peopleTypeahead?q=organizationFollowers only returns that organization's followers; vanityUrl?q=vanityUrlAsOrganization does not, and its resolvable set is opaque. A 404 here does not mean the person is unknown to you or unknown to LinkedIn: a live public profile can 404 with no reason given. - For person mentions to be clickable, the displayName parameter must exactly match the name shown on their LinkedIn profile. - Person mentions DO work when published from personal profiles (the URN just needs to be valid). The limitation is only in the resolution step (URL to URN), not in publishing. 
+  # Converts a LinkedIn profile or company URL to a URN for @mentions in posts.  How to use LinkedIn @mentions (2-step workflow):  1. Call this endpoint with the LinkedIn profile/company URL to get the mention URN and format. 2. Embed the returned mentionFormat (e.g. @[Vincent Jong](urn:li:person:xxx)) directly in your post's content field.  Example: - Resolve: GET /v1/accounts/{id}/linkedin-mentions?url=linkedin.com/in/vincentjong&displayName=Vincent Jong - Returns: mentionFormat: \"@[Vincent Jong](urn:li:person:xxx)\" - Use in post content: \"Great talk with @[Vincent Jong](urn:li:person:xxx) today!\"  Important: The mentions array field in POST /v1/posts is stored for reference only and does NOT trigger @mentions on LinkedIn. You must embed the mention format directly in the content text.  Requirements: - Person mentions require the LinkedIn account to be admin of at least one organization: both endpoints that resolve a profile URL to a member URN take an organization you administer. Organization mentions (e.g. @Microsoft) have no such requirement. - The two are not scoped alike. peopleTypeahead?q=organizationFollowers only returns that organization's followers; vanityUrl?q=vanityUrlAsOrganization does not, and its resolvable set is opaque. A 404 here does not mean the person is unknown to you or unknown to LinkedIn: a live public profile can 404 with no reason given. - For person mentions to be clickable, the displayName parameter must exactly match the name shown on their LinkedIn profile. - Person mentions DO work when published from personal profiles (the URN only needs to be valid). The limitation is only in the resolution step (URL to URN), not in publishing. 
   # @param account_id The LinkedIn account ID
   # @param url LinkedIn profile URL, company URL, or vanity name.
   # @param [Hash] opts the optional parameters

data/spec/api/logs_api_spec.rb

@@ -46,7 +46,7 @@ describe 'LogsApi' do
   # @option opts [Integer] :skip Number of logs to skip (for pagination)
   # @option opts [String] :account_id Filter by connected account ID
   # @option opts [String] :event Filter webhook logs by event (e.g. post.published, message.received)
-  # @option opts [String] :request_id Correlation ID — returns every log spawned by a single API request
+  # @option opts [String] :request_id Correlation ID. Returns every log spawned by a single API request
   # @option opts [Time] :from Precise start instant (ISO 8601); narrows within the day range
   # @option opts [Time] :to Precise end instant (ISO 8601)
   # @option opts [Integer] :status_code Filter by exact HTTP status code (api_request logs)

data/spec/api/mentions_api_spec.rb

@@ -36,7 +36,7 @@ describe 'MentionsApi' do
   # List mentions
   # Returns mentions of your connected organization accounts, delivered via platform webhooks. Currently supports LinkedIn organization mentions.  Requires Inbox addon. 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :account_id Filter by social account ID
+  # @option opts [String] :account_id Filter by account ID
   # @option opts [String] :profile_id Filter by profile ID
   # @option opts [String] :sort_order Sort order by publishedAt
   # @option opts [Integer] :limit 
@@ -50,7 +50,7 @@ describe 'MentionsApi' do
 
   # unit tests for reply_to_mention
   # Reply to a mention
-  # Reply to a mention of the connected account. Supported on Instagram only.  Two shapes, selected by whether `commentId` is present:  - **Comment mention** (someone @mentioned the account inside a comment): pass both   `mediaId` and `commentId`. Instagram posts a reply under that comment. - **Caption mention** (someone @mentioned the account in their media caption, so no   comment exists): pass `mediaId` only. Instagram posts a comment on their media.  Story mentions are not supported by Instagram's API.  Note that `GET /v1/inbox/mentions` currently returns LinkedIn mentions only and does not surface Instagram mentions. Source `mediaId` and `commentId` from Instagram's `comments` webhook, which is where mention notifications are delivered for accounts connected through Instagram Login. 
+  # Reply to a mention of the connected account. Supported on Instagram only.  Two shapes, selected by whether `commentId` is present:  - **Comment mention** (someone @mentioned the account inside a comment): pass both   `mediaId` and `commentId`. Instagram posts a reply under that comment. - **Caption mention** (someone @mentioned the account in their media caption, so no   comment exists): pass `mediaId` only. Instagram posts a comment on their media.  Story mentions are not supported by Instagram's API.  `GET /v1/inbox/mentions` currently returns LinkedIn mentions only and does not surface Instagram mentions. Source `mediaId` and `commentId` from Instagram's `comments` webhook, which is where mention notifications are delivered for accounts connected through Instagram Login. 
   # @param reply_to_mention_request 
   # @param [Hash] opts the optional parameters
   # @return [ReplyToMention200Response]

data/spec/api/messages_api_spec.rb

@@ -48,7 +48,7 @@ describe 'MessagesApi' do
 
   # unit tests for create_inbox_conversation
   # Create conversation
-  # Initiate a new direct message conversation with a specified user. If a conversation already exists with the recipient, the message is added to the existing thread.  Supported platforms: X/Twitter, Bluesky, Reddit, WhatsApp, SMS, and Slack. Other platforms return PLATFORM_NOT_SUPPORTED.  Slack: pass a workspace member id as participantId (list them with GET /v1/accounts/{accountId}/slack-members). Zernio opens the DM channel with that member and sends the message; the thread then behaves like any other Slack conversation in the inbox. The member must belong to the connected workspace.  WhatsApp: this is the endpoint for sending an approved template message to a phone number. Provide templateName, templateLanguage, and templateParams (variable values for the text header, body and dynamic URL buttons, in that order), with the recipient phone in participantId. A template is required because WhatsApp does not permit freeform messages to open a conversation; a missing template returns TEMPLATE_REQUIRED. Templates with media headers (image, video, document) are handled automatically: Zernio reads the approved template definition and fills the header at send time with the template's approved sample asset. To send a DIFFERENT asset per message (e.g. a distinct invoice PDF for each recipient), pass the headerMedia field with a public link (or a Meta media id); it overrides the sample for that send. A template whose approved header format is LOCATION has no header asset to reconstruct at all: Meta only accepts the location at send time, so pass headerLocation (latitude and longitude required) whenever such a template is sent; headerMedia and headerLocation cannot both be supplied. A button that carries its own value at send time (a copy-code button holding a Pix payment code or a coupon, a flow token) is sent with templateButtonParams, addressed by the button's index; templateParams covers text variables and dynamic URL buttons only. Calling this for a number you already have a thread with simply sends the template into that thread, which also makes it the way to re-engage a contact after the 24-hour customer-service window has closed. Once the recipient replies (opening the 24h window), send freeform messages with the send-message endpoint (POST /v1/inbox/conversations/{conversationId}/messages). Template fields are accepted on the JSON body only, not on multipart requests. Alternatively, WhatsApp Business Accounts eligible for Meta Direct Send can open a conversation with a business-initiated utility text message and no template: pass category: 'utility' together with message (and no templateName). See the category field below.  DM eligibility (X/Twitter): Before sending, the endpoint checks if the recipient accepts DMs from your account (via the receives_your_dm field). If not, a 422 error with code DM_NOT_ALLOWED is returned. You can skip this check with skipDmCheck: true if you have already verified eligibility.  X API tier requirement: DM write endpoints require X API Pro tier ($5,000/month) or Enterprise access. This applies to BYOK (Bring Your Own Key) users who provide their own X API credentials.  Rate limits (X/Twitter only): X's DM API enforces 200 requests per 15 minutes, 1,000 per 24 hours per connected X account, and 15,000 per 24 hours per X developer app (shared across all DM endpoints). These limits do NOT apply to other platforms. WhatsApp sends are governed by Meta's per-number messaging tiers (unique business-initiated conversations per 24 hours) and per-number throughput instead. 
+  # Start a direct message conversation with a user. If a conversation with that recipient already exists, the message is added to the existing thread.  Supported platforms: X, Bluesky, Reddit, WhatsApp, SMS, and Slack. Other platforms return PLATFORM_NOT_SUPPORTED.  **Slack.** Pass a workspace member id as participantId (list them with GET /v1/accounts/{accountId}/slack-members). Zernio opens the DM channel with that member and sends the message; the thread then behaves like any other Slack conversation in the inbox. The member must belong to the connected workspace.  **WhatsApp.** This is the endpoint for sending an approved template message to a phone number. Provide templateName, templateLanguage, and templateParams (variable values for the text header, body and dynamic URL buttons, in that order), with the recipient phone in participantId. A template is required because WhatsApp does not permit freeform messages to open a conversation; a missing template returns TEMPLATE_REQUIRED.  - Templates with media headers (image, video, document) are handled automatically: Zernio reads the approved template definition and fills the header at send time with the template's approved sample asset. To send a DIFFERENT asset per message (e.g. a distinct invoice PDF for each recipient), pass the headerMedia field with a public link (or a Meta media id); it overrides the sample for that send. - A template whose approved header format is LOCATION has no header asset to reconstruct at all: Meta only accepts the location at send time, so pass headerLocation (latitude and longitude required) whenever such a template is sent; headerMedia and headerLocation cannot both be supplied. - A button that carries its own value at send time (a copy-code button holding a Pix payment code or a coupon, a flow token) is sent with templateButtonParams, addressed by the button's index; templateParams covers text variables and dynamic URL buttons only. - Template fields are accepted on the JSON body only, not on multipart requests.  For a number you already have a thread with, this sends the template into that thread, which also makes it the way to re-engage a contact after the 24-hour customer-service window has closed. Once the recipient replies (opening the 24h window), send freeform messages with the send-message endpoint (POST /v1/inbox/conversations/{conversationId}/messages).  Alternatively, WhatsApp Business Accounts eligible for Meta Direct Send can open a conversation with a business-initiated utility text message and no template: pass category: 'utility' together with message (and no templateName). See the category field below.  **DM eligibility (X).** Before sending, the endpoint checks if the recipient accepts DMs from your account (via the receives_your_dm field). If not, a 422 error with code DM_NOT_ALLOWED is returned. You can skip this check with skipDmCheck: true if you have already verified eligibility.  **X API tier requirement.** DM write endpoints require X API Pro tier ($5,000/month) or Enterprise access. This applies to BYOK (Bring Your Own Key) users who provide their own X API credentials.  **Rate limits (X only).** X's DM API enforces 200 requests per 15 minutes, 1,000 per 24 hours per connected X account, and 15,000 per 24 hours per X developer app (shared across all DM endpoints). These limits do NOT apply to other platforms. WhatsApp sends are governed by Meta's per-number messaging tiers (unique business-initiated conversations per 24 hours) and per-number throughput instead. 
   # @param create_inbox_conversation_request 
   # @param [Hash] opts the optional parameters
   # @return [CreateInboxConversation201Response]
@@ -60,10 +60,10 @@ describe 'MessagesApi' do
 
   # unit tests for delete_inbox_message
   # Delete message
-  # Delete a message from a conversation. Platform support varies: - Telegram: Full delete (bot's own messages anytime, others if admin) - X/Twitter: Full delete (own DM events only) - Bluesky: Delete for self only (recipient still sees it) - Reddit: Delete from sender's view only - Facebook, Instagram, WhatsApp: Not supported (returns 400) 
+  # Delete a message from a conversation. Platform support varies: - Telegram: Full delete (bot's own messages anytime, others if admin) - X: Full delete (own DM events only) - Bluesky: Delete for self only (recipient still sees it) - Reddit: Delete from sender's view only - Facebook, Instagram, WhatsApp: Not supported (returns 400) 
   # @param conversation_id The conversation ID
   # @param message_id The platform message ID to delete
-  # @param account_id Social account ID
+  # @param account_id Account ID
   # @param [Hash] opts the optional parameters
   # @return [UpdateYoutubeDefaultPlaylist200Response]
   describe 'delete_inbox_message test' do
@@ -90,7 +90,7 @@ describe 'MessagesApi' do
   # Get conversation
   # Retrieve details and metadata for a specific conversation. Requires accountId query parameter.
   # @param conversation_id Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
-  # @param account_id The social account ID
+  # @param account_id The account ID
   # @param [Hash] opts the optional parameters
   # @return [GetInboxConversation200Response]
   describe 'get_inbox_conversation test' do
@@ -101,13 +101,13 @@ describe 'MessagesApi' do
 
   # unit tests for get_inbox_conversation_messages
   # List messages
-  # Fetch messages for a specific conversation, with cursor-based pagination and ordering control.  Pagination: pass `pagination.nextCursor` from a prior response back as the `cursor` query param to fetch the next page. The cursor is opaque; do not parse or construct it client-side.  Sort order: defaults to `asc` (oldest first, chat style). For the \"show me the latest messages\" pattern, pass `?sortOrder=desc&limit=N`. Twitter, Instagram, Telegram, WhatsApp and Reddit honor the requested order from the local message store. For Facebook and Bluesky, the upstream APIs only return newest-first and have no order parameter — sort order is best-effort and only reverses items within a single page (pages still walk newest→oldest). The response field `sortOrderApplied` tells you what was actually applied.  Reddit threads are paginated client-side because Reddit's API has no per-thread cursor. Very long threads may be upstream-truncated by Reddit's inbox/sent windows (~100 most-recent items each); this is a Reddit platform limitation.  Instagram and Facebook conversations include history from before the account was connected, replayed from Meta. That replay covers the 500 most recent messages per conversation: a longer thread keeps its newest 500 and older messages are not retrievable. Messages that arrived after the account was connected are unaffected. Replayed messages are stored as already read and emit no webhooks.  Twitter/X limitation: X's encrypted \"X Chat\" messages are not accessible via the API. Conversations where the other participant uses encrypted X Chat may only show your outgoing messages. See the list conversations endpoint for more details.  This endpoint is read-only and does NOT mark messages as read or send read receipts. To mark a conversation read (and send WhatsApp blue ticks on eligible accounts), call `POST /v1/inbox/conversations/{conversationId}/read`. 
+  # Fetch messages for a specific conversation, with cursor-based pagination and ordering control.  Pagination: pass `pagination.nextCursor` from a prior response back as the `cursor` query param to fetch the next page. The cursor is opaque; do not parse or construct it client-side.  Sort order: defaults to `asc` (oldest first, chat style). For the \"show me the latest messages\" pattern, pass `?sortOrder=desc&limit=N`. X, Instagram, Telegram, WhatsApp and Reddit honor the requested order from the local message store. For Facebook and Bluesky, the upstream APIs only return newest-first and have no order parameter, so sort order is best-effort and only reverses items within a single page (pages still walk newest→oldest). The response field `sortOrderApplied` tells you what was actually applied.  Reddit threads are paginated client-side because Reddit's API has no per-thread cursor. Very long threads may be upstream-truncated by Reddit's inbox/sent windows (~100 most-recent items each); this is a Reddit platform limitation.  Instagram and Facebook conversations include history from before the account was connected, replayed from Meta. That replay covers the 500 most recent messages per conversation: a longer thread keeps its newest 500 and older messages are not retrievable. Messages that arrived after the account was connected are unaffected. Replayed messages are stored as already read and emit no webhooks.  X limitation: X's encrypted \"X Chat\" messages are not accessible via the API. Conversations where the other participant uses encrypted X Chat may only show your outgoing messages. See the list conversations endpoint for more details.  This endpoint is read-only and does NOT mark messages as read or send read receipts. To mark a conversation read (and send WhatsApp blue ticks on eligible accounts), call `POST /v1/inbox/conversations/{conversationId}/read`. 
   # @param conversation_id Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
-  # @param account_id Social account ID
+  # @param account_id Account ID
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit Number of messages to return per page. Default 100, max 100.
   # @option opts [String] :cursor Opaque pagination cursor. Pass `pagination.nextCursor` from a prior response verbatim: a cursor we cannot parse returns 400 rather than silently restarting from the first page.
-  # @option opts [String] :sort_order Order of returned messages. Default `asc` (oldest first, chat style). Twitter, Instagram, Telegram, WhatsApp and Reddit honor this order across cursor pages. For Facebook and Bluesky, only intra-page ordering is affected — pages always walk newest→oldest. See `sortOrderApplied` in the response. 
+  # @option opts [String] :sort_order Order of returned messages. Default `asc` (oldest first, chat style). X, Instagram, Telegram, WhatsApp and Reddit honor this order across cursor pages. For Facebook and Bluesky, only intra-page ordering is affected. Pages always walk newest→oldest. See `sortOrderApplied` in the response. 
   # @return [GetInboxConversationMessages200Response]
   describe 'get_inbox_conversation_messages test' do
     it 'should work' do
@@ -117,11 +117,11 @@ describe 'MessagesApi' do
 
   # unit tests for get_message_attachment
   # Resolve message attachment
-  # Resolve one attachment on a message to a media url that works right now.  Instagram and Facebook sign DM media urls per request and expire them, so the `url` on a message is a snapshot: it works when you read the message and stops working later. This endpoint checks the stored url and, when it has gone stale, re-mints the message's media from Meta and persists it before answering. The message id never expires, so this URL is the one to store. It is returned ready-made on each attachment as `refreshUrl` when you read a message over REST.  **Webhook payloads do not carry `refreshUrl`**, so a webhook-driven integration builds this URL itself. Every piece is in the event: `message.conversationId`, `message.platformMessageId`, the attachment's zero-based position, and `account.accountId`. Note that **`accountId` is a required query parameter**; omitting it returns `400` `missing_required_field`, which is the same requirement `GET /v1/whatsapp/media/{mediaId}` has.  By default it responds `302` to the live media url, so it can be used directly as an `<img src>` on a browser session. API-key integrators should pass `?format=json` and read `url` off the body, since a browser cannot attach an Authorization header to an image request.  Only Instagram and Facebook media can be re-minted. On other platforms the stored url is returned as-is when it still resolves, and `404` otherwise. 
+  # Resolve one attachment on a message to a media url that works right now.  Instagram and Facebook sign DM media urls per request and expire them, so the `url` on a message is a snapshot: it works when you read the message and stops working later. This endpoint checks the stored url and, when it has gone stale, re-mints the message's media from Meta and persists it before answering. The message id never expires, so this URL is the one to store. It is returned ready-made on each attachment as `refreshUrl` when you read a message over REST.  **Webhook payloads do not carry `refreshUrl`**, so a webhook-driven integration builds this URL itself. Every piece is in the event: `message.conversationId`, `message.platformMessageId`, the attachment's zero-based position, and `account.accountId`. **`accountId` is a required query parameter**; omitting it returns `400` `missing_required_field`, which is the same requirement `GET /v1/whatsapp/media/{mediaId}` has.  By default it responds `302` to the live media url, so it can be used directly as an `<img src>` on a browser session. API-key integrators should pass `?format=json` and read `url` off the body, since a browser cannot attach an Authorization header to an image request.  Only Instagram and Facebook media can be re-minted. On other platforms the stored url is returned as-is when it still resolves, and `404` otherwise. 
   # @param conversation_id The conversation ID (Zernio id or platform conversation id)
   # @param message_id The message id as returned by the list-messages endpoint (the platform message id)
   # @param index Zero-based position of the attachment in the message's attachments array
-  # @param account_id Social account ID. Required: without it the request returns 400 missing_required_field.
+  # @param account_id Account ID. Required: without it the request returns 400 missing_required_field.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :format `redirect` (default) answers 302 to the media; `json` returns the url in the body
   # @return [GetMessageAttachment200Response]
@@ -133,7 +133,7 @@ describe 'MessagesApi' do
 
   # unit tests for list_inbox_conversations
   # List conversations
-  # Fetch conversations (DMs) from all connected messaging accounts in a single API call. Supports filtering by profile and platform. Results are aggregated and deduplicated. Supported platforms: Facebook, Instagram, Twitter/X, Bluesky, Reddit, Telegram.  Twitter/X limitation: X has replaced traditional DMs with encrypted \"X Chat\" for many accounts. Messages sent or received through encrypted X Chat are not accessible via X's API (the /2/dm_events endpoint only returns legacy unencrypted DMs). This means some Twitter/X conversations may show only outgoing messages or appear empty. This is an X platform limitation that affects all third-party applications. See X's docs on encrypted messaging for more details.  Instagram and Facebook pre-connect history: when one of these accounts is connected, Zernio replays the DM history the account already holds on Meta, so conversations that began before the account was connected appear here. Up to 500 conversations per account are replayed. The replay runs in the background and can finish after a listing you have already taken, and replayed conversations keep their original lastMessageAt, so they sort into date order rather than appearing at the top. If you mirror this endpoint into your own store, re-run the sweep rather than relying on a single pass at connect time. Replayed history emits no webhooks and is stored as already read, so it never affects unread counts. Threads that Meta refuses to serve are skipped, and an account whose Instagram \"connected tools\" message access is turned off is not replayed at all. 
+  # Fetch conversations (DMs) from all connected messaging accounts in a single API call. Supports filtering by profile and platform. Results are aggregated and deduplicated.  Supported platforms: Facebook, Instagram, X, Bluesky, Reddit, Telegram.  **X limitation.** X has replaced traditional DMs with encrypted \"X Chat\" for many accounts. Messages sent or received through encrypted X Chat are not accessible via X's API (the /2/dm_events endpoint only returns legacy unencrypted DMs). This means some X conversations may show only outgoing messages or appear empty. This is an X platform limitation that affects all third-party applications. See X's docs on encrypted messaging for more details.  **Instagram and Facebook pre-connect history.** When one of these accounts is connected, Zernio replays the DM history the account already holds on Meta, so conversations that began before the account was connected appear here. Up to 500 conversations per account are replayed.  - The replay runs in the background and can finish after a listing you have already taken, and replayed conversations keep their original lastMessageAt, so they sort into date order rather than appearing at the top. If you mirror this endpoint into your own store, re-run the sweep rather than relying on a single pass at connect time. - Replayed history emits no webhooks and is stored as already read, so it never affects unread counts. - Threads that Meta refuses to serve are skipped, and an account whose Instagram \"connected tools\" message access is turned off is not replayed at all. 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :profile_id Filter by profile ID
   # @option opts [String] :platform Filter by platform
@@ -141,7 +141,7 @@ describe 'MessagesApi' do
   # @option opts [String] :sort_order Sort order by updated time
   # @option opts [Integer] :limit Maximum number of conversations to return
   # @option opts [String] :cursor Pagination cursor for next page
-  # @option opts [String] :account_id Filter by specific social account ID
+  # @option opts [String] :account_id Filter by specific account ID
   # @return [ListInboxConversations200Response]
   describe 'list_inbox_conversations test' do
     it 'should work' do
@@ -167,7 +167,7 @@ describe 'MessagesApi' do
   # Remove a reaction from a message. Platform support: - Telegram: Send empty reaction array to clear - WhatsApp: Send empty emoji to remove - Instagram and Facebook Messenger: Sends Meta's `unreact` action; the emoji does not need to be repeated - Slack: Removes the reaction we previously sent on that message - All others: Returns 400 (not supported) 
   # @param conversation_id The conversation ID
   # @param message_id The platform message ID (as returned by GET /messages) or the Zernio message ID (as returned by the reaction webhook)
-  # @param account_id Social account ID
+  # @param account_id Account ID
   # @param [Hash] opts the optional parameters
   # @return [RemoveMessageReaction200Response]
   describe 'remove_message_reaction test' do
@@ -178,13 +178,13 @@ describe 'MessagesApi' do
 
   # unit tests for search_inbox_conversations
   # Search conversations
-  # Search your conversations two ways at once, and get back the matching conversations, most-recent match first:  - Message text: matches words inside message bodies. Case-insensitive and accent-insensitive, exact tokens only (no substrings, no stemming). Each hit carries up to 3 most-recent matching messages. With direction=outgoing you can collect examples of how you write to customers, for example to teach an AI agent your tone of voice. - Contact identity: matches the participant's name, username, or phone number as a case-insensitive substring. These hits have matchCount 0 and an empty matches array.  A conversation that matches both ways is returned once, carrying its message matches.  Only platforms whose messages are stored by Zernio are searchable: WhatsApp, SMS, Telegram, Facebook, Instagram, Twitter/X and Reddit. Bluesky conversations are fetched live from the platform and cannot be searched; those accounts are listed in meta.accountsSkipped. 
+  # Search your conversations two ways at once, and get back the matching conversations, most-recent match first:  - Message text: matches words inside message bodies. Case-insensitive and accent-insensitive, exact tokens only (no substrings, no stemming). Each hit carries up to 3 most-recent matching messages. With direction=outgoing you can collect examples of how you write to customers, for example to teach an AI agent your tone of voice. - Contact identity: matches the participant's name, username, or phone number as a case-insensitive substring. These hits have matchCount 0 and an empty matches array.  A conversation that matches both ways is returned once, carrying its message matches.  Only platforms whose messages are stored by Zernio are searchable: WhatsApp, SMS, Telegram, Facebook, Instagram, X and Reddit. Bluesky conversations are fetched live from the platform and cannot be searched; those accounts are listed in meta.accountsSkipped. 
   # @param query Text to search for, in message content and in the contact's name, username, or phone number
   # @param [Hash] opts the optional parameters
   # @option opts [String] :direction Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.
   # @option opts [String] :profile_id Filter by profile ID
   # @option opts [String] :platform Filter by platform (searchable platforms only)
-  # @option opts [String] :account_id Filter by specific social account ID
+  # @option opts [String] :account_id Filter by specific account ID
   # @option opts [Integer] :limit Maximum number of conversations to return
   # @option opts [String] :cursor Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.
   # @return [SearchInboxConversations200Response]
@@ -221,6 +221,19 @@ describe 'MessagesApi' do
     end
   end
 
+  # unit tests for set_conversation_thread_control
+  # Hand a conversation to or from Meta Business Agent
+  # WhatsApp only, on numbers with Meta Business Agent enabled. Wraps Meta's thread control: - `release`: hand the conversation back to the agent so it resumes answering. You must currently hold control (sending any message takes it implicitly). - `take`: take control before sending anything, so the agent stops replying while an operator reads the thread. Meta accepts this only from the business configured as the number's escalation partner; other apps take control by sending a message. - `pass`: transfer control to the number's configured escalation partner, or to the agent with `target: ai_agent`.  The conversation's `threadControl` follows the result; a `conversation.control_changed` webhook fires when Meta later reports the change. 
+  # @param conversation_id The conversation ID
+  # @param set_conversation_thread_control_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SetConversationThreadControl200Response]
+  describe 'set_conversation_thread_control test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for update_inbox_conversation
   # Update conversation status
   # Archive or activate a conversation. Requires accountId in request body.
@@ -236,7 +249,7 @@ describe 'MessagesApi' do
 
   # unit tests for upload_media_direct
   # Upload media file
-  # Upload a media file using API key authentication and get back a publicly accessible URL. The URL can be used as attachmentUrl when sending inbox messages.  Files are stored in temporary storage and auto-delete after 7 days. Maximum file size is 25MB.  Unlike /v1/media/upload (which uses upload tokens for end-user flows), this endpoint uses standard Bearer token authentication for programmatic use. 
+  # Upload a media file using API key authentication and get back a publicly accessible URL. The URL can be used as attachmentUrl when sending inbox messages.  Files are stored in temporary storage and auto-delete after 7 days. Maximum file size is 25MB.  Unlike /v1/media/upload (which uses upload tokens for end-user flows), this endpoint takes your API key in the Authorization header, for programmatic use. 
   # @param file The file to upload (max 25MB)
   # @param [Hash] opts the optional parameters
   # @option opts [String] :content_type Override MIME type (e.g. \\\"image/jpeg\\\"). Auto-detected from file if not provided.

data/spec/api/messaging_ads_api_spec.rb

@@ -46,7 +46,7 @@ describe 'MessagingAdsApi' do
 
   # unit tests for create_ctwa_ad
   # Create Click-to-WhatsApp ad (deprecated)
-  # Deprecated: use POST /v1/ads/messaging with `destination: whatsapp`. This endpoint stays available for back-compat; no removal planned.  Creates one or more Click-to-WhatsApp (CTWA) ads on Meta under a single campaign and ad set. When tapped, each ad opens a WhatsApp conversation with the business attached to the supplied Facebook Page. The full hierarchy (campaign, ad set, creative(s), ad(s)) is created and activated in one call. The CTA is locked to WHATSAPP_MESSAGE and the destination is hard-coded to api.whatsapp.com/send; Meta resolves the actual WhatsApp number from the Page-to-WA pairing configured in Page settings or Business Manager.  Supports two mutually-exclusive shapes:  - **Single-creative**: supply top-level `headline`, `body`, and one of `imageUrl` / `video`. Creates 1 campaign + 1 ad set + 1 ad.  - **Multi-creative**: supply a `creatives[]` array with N entries (each carrying its own headline, body, and image/video). Creates 1 campaign + 1 ad set + N ads sharing budget and targeting so Meta A/Bs the creatives inside a single auction instead of fragmenting budget across N parallel campaigns. Recommended when launching multiple creative variants for the same campaign.  **Attach shape.** Send `adSetId` (with either creative shape) to add the ads to an EXISTING messaging ad set instead of building a campaign, so the ad set keeps its learning phase — the way to refresh a CTWA creative without resetting delivery. The ad set then owns budget, targeting and schedule, so `budgetAmount`, `budgetType`, `endDate`, `objective`, `countries`, `interests` and `audienceId` are rejected with a 400 alongside it rather than silently dropped. The target ad set's `destination_type` must match the ad's destination (a WhatsApp ad needs a `WHATSAPP` ad set), otherwise Meta would accept an ad that never delivers.  Prerequisites enforced by Meta (surfaced as platform_error on failure): the Facebook Page must be paired with a verified WhatsApp Business number, the WhatsApp Business Account must be business-verified, and the Meta access token must carry ads_management.
+  # Deprecated: use POST /v1/ads/messaging with `destination: whatsapp`. This endpoint stays available for back-compat; no removal planned.  Creates one or more Click-to-WhatsApp (CTWA) ads on Meta under a single campaign and ad set. When tapped, each ad opens a WhatsApp conversation with the business attached to the supplied Facebook Page. The full hierarchy (campaign, ad set, creative(s), ad(s)) is created and activated in one call. The CTA is locked to WHATSAPP_MESSAGE and the destination is hard-coded to api.whatsapp.com/send; Meta resolves the actual WhatsApp number from the Page-to-WA pairing configured in Page settings or Business Manager.  Supports two mutually-exclusive shapes:  - **Single-creative**: supply top-level `headline`, `body`, and one of `imageUrl` / `video`. Creates 1 campaign + 1 ad set + 1 ad.  - **Multi-creative**: supply a `creatives[]` array with N entries (each carrying its own headline, body, and image/video). Creates 1 campaign + 1 ad set + N ads sharing budget and targeting so Meta A/Bs the creatives inside a single auction instead of fragmenting budget across N parallel campaigns. Recommended when launching multiple creative variants for the same campaign.  **Attach shape.** Send `adSetId` (with either creative shape) to add the ads to an EXISTING messaging ad set instead of building a campaign, so the ad set keeps its learning phase, the way to refresh a CTWA creative without resetting delivery. The ad set then owns budget, targeting and schedule, so `budgetAmount`, `budgetType`, `endDate`, `objective`, `countries`, `interests` and `audienceId` are rejected with a 400 alongside it rather than silently dropped. The target ad set's `destination_type` must match the ad's destination (a WhatsApp ad needs a `WHATSAPP` ad set), otherwise Meta would accept an ad that never delivers.  Prerequisites enforced by Meta (surfaced as platform_error on failure): the Facebook Page must be paired with a verified WhatsApp Business number, the WhatsApp Business Account must be business-verified, and the Meta access token must carry ads_management.
   # @param ctwa_ad_request_body 
   # @param [Hash] opts the optional parameters
   # @return [CreateCtwaAd201Response]