telnyx-mcp 6.73.1 → 6.74.0

package/local-docs-search.js

@@ -50480,37 +50480,37 @@ const EMBEDDED_METHODS = [
         description: 'Returns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only `uac_external_credential` is supported today.',
         stainlessPath: '(resource) sip_registration_status > (method) retrieve',
         qualified: 'client.sipRegistrationStatus.retrieve',
-        params: ['connection_id: string;', "credential_type: 'uac_external_credential';", 'user_id: string;'],
-        response: "{ b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }; internal_uac_settings?: { destination_uri?: string; }; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }",
-        markdown: "## retrieve\n\n`client.sipRegistrationStatus.retrieve(connection_id: string, credential_type: 'uac_external_credential', user_id: string): { b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: object; internal_uac_settings?: object; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }`\n\n**get** `/sip_registration_status`\n\nReturns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only `uac_external_credential` is supported today.\n\n### Parameters\n\n- `connection_id: string`\n  Identifier of the UAC connection to look up.\n\n- `credential_type: 'uac_external_credential'`\n  The kind of credential to look up. Only `uac_external_credential` is supported today.\n\n- `user_id: string`\n  Owner of the connection. Used to authorize the lookup.\n\n### Returns\n\n- `{ b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }; internal_uac_settings?: { destination_uri?: string; }; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }`\n\n  - `b2bua_external?: object`\n  - `b2bua_internal?: object`\n  - `connection_id?: string`\n  - `connection_name?: string`\n  - `credential_type?: 'uac_external_credential'`\n  - `external_state?: string`\n  - `external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }`\n  - `internal_uac_settings?: { destination_uri?: string; }`\n  - `last_registration_response?: string`\n  - `pair_state?: string`\n  - `registered?: boolean`\n  - `user_id?: string`\n  - `username?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({\n  connection_id: 'connection_id',\n  credential_type: 'uac_external_credential',\n  user_id: 'user_id',\n});\n\nconsole.log(sipRegistrationStatus);\n```",
+        params: ['connection_id: string;', "credential_type: 'uac_external_credential';"],
+        response: "{ connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; credential_username?: string; last_registration_response?: string; registered?: boolean; sip_registration_details?: { auth_retries?: number; expires?: number; failures?: number; next_action_at?: number; sipUriUserHost?: string; uptime?: number; }; sip_registration_status?: 'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown'; }",
+        markdown: "## retrieve\n\n`client.sipRegistrationStatus.retrieve(connection_id: string, credential_type: 'uac_external_credential'): { connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; credential_username?: string; last_registration_response?: string; registered?: boolean; sip_registration_details?: object; sip_registration_status?: 'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown'; }`\n\n**get** `/sip_registration_status`\n\nReturns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only `uac_external_credential` is supported today.\n\n### Parameters\n\n- `connection_id: string`\n  Identifier of the UAC connection to look up.\n\n- `credential_type: 'uac_external_credential'`\n  The kind of credential to look up. Only `uac_external_credential` is supported today.\n\n### Returns\n\n- `{ connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; credential_username?: string; last_registration_response?: string; registered?: boolean; sip_registration_details?: { auth_retries?: number; expires?: number; failures?: number; next_action_at?: number; sipUriUserHost?: string; uptime?: number; }; sip_registration_status?: 'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown'; }`\n\n  - `connection_id?: string`\n  - `connection_name?: string`\n  - `credential_type?: 'uac_external_credential'`\n  - `credential_username?: string`\n  - `last_registration_response?: string`\n  - `registered?: boolean`\n  - `sip_registration_details?: { auth_retries?: number; expires?: number; failures?: number; next_action_at?: number; sipUriUserHost?: string; uptime?: number; }`\n  - `sip_registration_status?: 'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown'`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({ connection_id: 'connection_id', credential_type: 'uac_external_credential' });\n\nconsole.log(sipRegistrationStatus);\n```",
         perLanguage: {
             typescript: {
                 method: 'client.sipRegistrationStatus.retrieve',
-                example: "import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({\n  connection_id: 'connection_id',\n  credential_type: 'uac_external_credential',\n  user_id: 'user_id',\n});\n\nconsole.log(sipRegistrationStatus.connection_id);",
+                example: "import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({\n  connection_id: 'connection_id',\n  credential_type: 'uac_external_credential',\n});\n\nconsole.log(sipRegistrationStatus.connection_id);",
             },
             python: {
                 method: 'sip_registration_status.retrieve',
-                example: 'import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted\n)\nsip_registration_status = client.sip_registration_status.retrieve(\n    connection_id="connection_id",\n    credential_type="uac_external_credential",\n    user_id="user_id",\n)\nprint(sip_registration_status.connection_id)',
+                example: 'import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted\n)\nsip_registration_status = client.sip_registration_status.retrieve(\n    connection_id="connection_id",\n    credential_type="uac_external_credential",\n)\nprint(sip_registration_status.connection_id)',
             },
             java: {
                 method: 'sipRegistrationStatus().retrieve',
-                example: 'package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveParams;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveResponse;\n\npublic final class Main {\n    private Main() {}\n\n    public static void main(String[] args) {\n        TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n        SipRegistrationStatusRetrieveParams params = SipRegistrationStatusRetrieveParams.builder()\n            .connectionId("connection_id")\n            .credentialType(SipRegistrationStatusRetrieveParams.CredentialType.UAC_EXTERNAL_CREDENTIAL)\n            .userId("user_id")\n            .build();\n        SipRegistrationStatusRetrieveResponse sipRegistrationStatus = client.sipRegistrationStatus().retrieve(params);\n    }\n}',
+                example: 'package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveParams;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveResponse;\n\npublic final class Main {\n    private Main() {}\n\n    public static void main(String[] args) {\n        TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n        SipRegistrationStatusRetrieveParams params = SipRegistrationStatusRetrieveParams.builder()\n            .connectionId("connection_id")\n            .credentialType(SipRegistrationStatusRetrieveParams.CredentialType.UAC_EXTERNAL_CREDENTIAL)\n            .build();\n        SipRegistrationStatusRetrieveResponse sipRegistrationStatus = client.sipRegistrationStatus().retrieve(params);\n    }\n}',
             },
             go: {
                 method: 'client.SipRegistrationStatus.Get',
-                example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/team-telnyx/telnyx-go"\n\t"github.com/team-telnyx/telnyx-go/option"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsipRegistrationStatus, err := client.SipRegistrationStatus.Get(context.TODO(), telnyx.SipRegistrationStatusGetParams{\n\t\tConnectionID:   "connection_id",\n\t\tCredentialType: telnyx.SipRegistrationStatusGetParamsCredentialTypeUacExternalCredential,\n\t\tUserID:         "user_id",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sipRegistrationStatus.ConnectionID)\n}\n',
+                example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/team-telnyx/telnyx-go"\n\t"github.com/team-telnyx/telnyx-go/option"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsipRegistrationStatus, err := client.SipRegistrationStatus.Get(context.TODO(), telnyx.SipRegistrationStatusGetParams{\n\t\tConnectionID:   "connection_id",\n\t\tCredentialType: telnyx.SipRegistrationStatusGetParamsCredentialTypeUacExternalCredential,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sipRegistrationStatus.ConnectionID)\n}\n',
             },
             ruby: {
                 method: 'sip_registration_status.retrieve',
-                example: 'require "telnyx"\n\ntelnyx = Telnyx::Client.new(api_key: "My API Key")\n\nsip_registration_status = telnyx.sip_registration_status.retrieve(\n  connection_id: "connection_id",\n  credential_type: :uac_external_credential,\n  user_id: "user_id"\n)\n\nputs(sip_registration_status)',
+                example: 'require "telnyx"\n\ntelnyx = Telnyx::Client.new(api_key: "My API Key")\n\nsip_registration_status = telnyx.sip_registration_status.retrieve(\n  connection_id: "connection_id",\n  credential_type: :uac_external_credential\n)\n\nputs(sip_registration_status)',
             },
             cli: {
                 method: 'sip_registration_status retrieve',
-                example: "telnyx sip-registration-status retrieve \\\n  --api-key 'My API Key' \\\n  --connection-id connection_id \\\n  --credential-type uac_external_credential \\\n  --user-id user_id",
+                example: "telnyx sip-registration-status retrieve \\\n  --api-key 'My API Key' \\\n  --connection-id connection_id \\\n  --credential-type uac_external_credential",
             },
             php: {
                 method: 'sipRegistrationStatus->retrieve',
-                example: "<?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\n$client = new Client(apiKey: 'My API Key');\n\n$sipRegistrationStatus = $client->sipRegistrationStatus->retrieve(\n  connectionID: 'connection_id',\n  credentialType: 'uac_external_credential',\n  userID: 'user_id',\n);\n\nvar_dump($sipRegistrationStatus);",
+                example: "<?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\n$client = new Client(apiKey: 'My API Key');\n\n$sipRegistrationStatus = $client->sipRegistrationStatus->retrieve(\n  connectionID: 'connection_id', credentialType: 'uac_external_credential'\n);\n\nvar_dump($sipRegistrationStatus);",
             },
             http: {
                 example: 'curl https://api.telnyx.com/v2/sip_registration_status \\\n    -H "Authorization: Bearer $TELNYX_API_KEY"',