telnyx-mcp 6.31.0 → 6.32.0

package/local-docs-search.js

@@ -6939,12 +6939,12 @@ const EMBEDDED_METHODS = [
         params: [
             'from: string;',
             'to: string;',
-            "whatsapp_message: { audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; biz_opaque_callback_data?: string; contacts?: { addresses?: object[]; birthday?: string; emails?: object[]; name?: string; org?: object; phones?: object[]; urls?: object[]; }[]; document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; interactive?: { action?: object; body?: object; footer?: object; header?: object; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }; location?: { address?: string; latitude?: string; longitude?: string; name?: string; }; reaction?: { emoji?: string; message_id?: string; }; sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; type?: string; video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; };",
+            "whatsapp_message: { audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; biz_opaque_callback_data?: string; contacts?: { addresses?: object[]; birthday?: string; emails?: object[]; name?: string; org?: object; phones?: object[]; urls?: object[]; }[]; document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; interactive?: { action?: object; body?: object; footer?: object; header?: object; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }; location?: { address?: string; latitude?: string; longitude?: string; name?: string; }; reaction?: { emoji?: string; message_id?: string; }; sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; template?: { components?: { index?: number; parameters?: object[]; sub_type?: 'quick_reply' | 'url'; type?: 'header' | 'body' | 'button'; }[]; language?: { code: string; policy?: string; }; name?: string; template_id?: string; }; text?: { body: string; preview_url?: boolean; }; type?: string; video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; };",
             "type?: 'WHATSAPP';",
             'webhook_url?: string;',
         ],
         response: "{ data?: { id?: string; body?: object; direction?: string; encoding?: string; from?: { carrier?: string; line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | ''; phone_number?: string; status?: 'received' | 'delivered'; }; messaging_profile_id?: string; organization_id?: string; received_at?: string; record_type?: string; to?: object[]; type?: string; wait_seconds?: number; }; }",
-        markdown: "## send_whatsapp\n\n`client.messages.sendWhatsapp(from: string, to: string, whatsapp_message: { audio?: whatsapp_media; biz_opaque_callback_data?: string; contacts?: whatsapp_contact[]; document?: whatsapp_media; image?: whatsapp_media; interactive?: whatsapp_interactive; location?: whatsapp_location; reaction?: whatsapp_reaction; sticker?: whatsapp_media; type?: string; video?: whatsapp_media; }, type?: 'WHATSAPP', webhook_url?: string): { data?: object; }`\n\n**post** `/messages/whatsapp`\n\nSend a Whatsapp message\n\n### Parameters\n\n- `from: string`\n  Phone number in +E.164 format associated with Whatsapp account\n\n- `to: string`\n  Phone number in +E.164 format\n\n- `whatsapp_message: { audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; biz_opaque_callback_data?: string; contacts?: { addresses?: object[]; birthday?: string; emails?: object[]; name?: string; org?: object; phones?: object[]; urls?: object[]; }[]; document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; interactive?: { action?: object; body?: object; footer?: object; header?: object; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }; location?: { address?: string; latitude?: string; longitude?: string; name?: string; }; reaction?: { emoji?: string; message_id?: string; }; sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; type?: string; video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; }`\n  - `audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `biz_opaque_callback_data?: string`\n    custom data to return with status update\n  - `contacts?: { addresses?: { city?: string; country?: string; country_code?: string; state?: string; street?: string; type?: string; zip?: string; }[]; birthday?: string; emails?: { email?: string; type?: string; }[]; name?: string; org?: { company?: string; department?: string; title?: string; }; phones?: { phone?: string; type?: string; wa_id?: string; }[]; urls?: { type?: string; url?: string; }[]; }[]`\n  - `document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `interactive?: { action?: { button?: string; buttons?: { reply?: object; type?: 'reply'; }[]; cards?: { action?: object; body?: object; card_index?: number; header?: object; type?: 'cta_url'; }[]; catalog_id?: string; mode?: string; name?: string; parameters?: { display_text?: string; url?: string; }; product_retailer_id?: string; sections?: { product_items?: object[]; rows?: object[]; title?: string; }[]; }; body?: { text?: string; }; footer?: { text?: string; }; header?: { document?: object; image?: object; sub_text?: string; text?: string; video?: object; }; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }`\n  - `location?: { address?: string; latitude?: string; longitude?: string; name?: string; }`\n  - `reaction?: { emoji?: string; message_id?: string; }`\n  - `sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `type?: string`\n  - `video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n\n- `type?: 'WHATSAPP'`\n  Message type - must be set to \"WHATSAPP\"\n\n- `webhook_url?: string`\n  The URL where webhooks related to this message will be sent.\n\n### Returns\n\n- `{ data?: { id?: string; body?: object; direction?: string; encoding?: string; from?: { carrier?: string; line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | ''; phone_number?: string; status?: 'received' | 'delivered'; }; messaging_profile_id?: string; organization_id?: string; received_at?: string; record_type?: string; to?: object[]; type?: string; wait_seconds?: number; }; }`\n\n  - `data?: { id?: string; body?: { audio?: object; biz_opaque_callback_data?: string; contacts?: object[]; document?: object; image?: object; interactive?: object; location?: object; reaction?: object; sticker?: object; type?: string; video?: object; }; direction?: string; encoding?: string; from?: { carrier?: string; line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | ''; phone_number?: string; status?: 'received' | 'delivered'; }; messaging_profile_id?: string; organization_id?: string; received_at?: string; record_type?: string; to?: { carrier?: string; line_type?: string; phone_number?: string; status?: string; }[]; type?: string; wait_seconds?: number; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst response = await client.messages.sendWhatsapp({\n  from: '+13125551234',\n  to: '+13125551234',\n  whatsapp_message: {},\n});\n\nconsole.log(response);\n```",
+        markdown: "## send_whatsapp\n\n`client.messages.sendWhatsapp(from: string, to: string, whatsapp_message: { audio?: whatsapp_media; biz_opaque_callback_data?: string; contacts?: whatsapp_contact[]; document?: whatsapp_media; image?: whatsapp_media; interactive?: whatsapp_interactive; location?: whatsapp_location; reaction?: whatsapp_reaction; sticker?: whatsapp_media; template?: object; text?: object; type?: string; video?: whatsapp_media; }, type?: 'WHATSAPP', webhook_url?: string): { data?: object; }`\n\n**post** `/messages/whatsapp`\n\nSend a Whatsapp message\n\n### Parameters\n\n- `from: string`\n  Phone number in +E.164 format associated with Whatsapp account\n\n- `to: string`\n  Phone number in +E.164 format\n\n- `whatsapp_message: { audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; biz_opaque_callback_data?: string; contacts?: { addresses?: object[]; birthday?: string; emails?: object[]; name?: string; org?: object; phones?: object[]; urls?: object[]; }[]; document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; interactive?: { action?: object; body?: object; footer?: object; header?: object; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }; location?: { address?: string; latitude?: string; longitude?: string; name?: string; }; reaction?: { emoji?: string; message_id?: string; }; sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; template?: { components?: { index?: number; parameters?: object[]; sub_type?: 'quick_reply' | 'url'; type?: 'header' | 'body' | 'button'; }[]; language?: { code: string; policy?: string; }; name?: string; template_id?: string; }; text?: { body: string; preview_url?: boolean; }; type?: string; video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }; }`\n  - `audio?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `biz_opaque_callback_data?: string`\n    custom data to return with status update\n  - `contacts?: { addresses?: { city?: string; country?: string; country_code?: string; state?: string; street?: string; type?: string; zip?: string; }[]; birthday?: string; emails?: { email?: string; type?: string; }[]; name?: string; org?: { company?: string; department?: string; title?: string; }; phones?: { phone?: string; type?: string; wa_id?: string; }[]; urls?: { type?: string; url?: string; }[]; }[]`\n  - `document?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `image?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `interactive?: { action?: { button?: string; buttons?: { reply?: object; type?: 'reply'; }[]; cards?: { action?: object; body?: object; card_index?: number; header?: object; type?: 'cta_url'; }[]; catalog_id?: string; mode?: string; name?: string; parameters?: { display_text?: string; url?: string; }; product_retailer_id?: string; sections?: { product_items?: object[]; rows?: object[]; title?: string; }[]; }; body?: { text?: string; }; footer?: { text?: string; }; header?: { document?: object; image?: object; sub_text?: string; text?: string; video?: object; }; type?: 'cta_url' | 'list' | 'carousel' | 'button' | 'location_request_message'; }`\n  - `location?: { address?: string; latitude?: string; longitude?: string; name?: string; }`\n  - `reaction?: { emoji?: string; message_id?: string; }`\n  - `sticker?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n  - `template?: { components?: { index?: number; parameters?: { text?: string; type?: 'text' | 'image' | 'video' | 'document' | 'currency' | 'date_time'; }[]; sub_type?: 'quick_reply' | 'url'; type?: 'header' | 'body' | 'button'; }[]; language?: { code: string; policy?: string; }; name?: string; template_id?: string; }`\n    Template message object. Provide either template_id or name + language to identify the template.\n  - `text?: { body: string; preview_url?: boolean; }`\n    Text message content. Can only be sent within a 24-hour customer service window.\n  - `type?: string`\n  - `video?: { caption?: string; filename?: string; link?: string; voice?: boolean; }`\n\n- `type?: 'WHATSAPP'`\n  Message type - must be set to \"WHATSAPP\"\n\n- `webhook_url?: string`\n  The URL where webhooks related to this message will be sent.\n\n### Returns\n\n- `{ data?: { id?: string; body?: object; direction?: string; encoding?: string; from?: { carrier?: string; line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | ''; phone_number?: string; status?: 'received' | 'delivered'; }; messaging_profile_id?: string; organization_id?: string; received_at?: string; record_type?: string; to?: object[]; type?: string; wait_seconds?: number; }; }`\n\n  - `data?: { id?: string; body?: { audio?: object; biz_opaque_callback_data?: string; contacts?: object[]; document?: object; image?: object; interactive?: object; location?: object; reaction?: object; sticker?: object; template?: { components?: object[]; language?: object; name?: string; template_id?: string; }; text?: { body: string; preview_url?: boolean; }; type?: string; video?: object; }; direction?: string; encoding?: string; from?: { carrier?: string; line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | ''; phone_number?: string; status?: 'received' | 'delivered'; }; messaging_profile_id?: string; organization_id?: string; received_at?: string; record_type?: string; to?: { carrier?: string; line_type?: string; phone_number?: string; status?: string; }[]; type?: string; wait_seconds?: number; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst response = await client.messages.sendWhatsapp({\n  from: '+13125551234',\n  to: '+13125551234',\n  whatsapp_message: {},\n});\n\nconsole.log(response);\n```",
     },
     {
         name: 'send_with_alphanumeric_sender',