telnyx-mcp 6.53.0 → 6.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/local-docs-search.js +26 -26
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +26 -26
- package/local-docs-search.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.mjs +1 -1
- package/src/local-docs-search.ts +26 -26
- package/src/server.ts +1 -1
package/local-docs-search.js
CHANGED
|
@@ -31879,11 +31879,11 @@ const EMBEDDED_METHODS = [
|
|
|
31879
31879
|
qualified: 'client.publicInternetGateways.list',
|
|
31880
31880
|
params: ['filter?: { network_id?: string; };', 'page[number]?: number;', 'page[size]?: number;'],
|
|
31881
31881
|
response: "{ id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }",
|
|
31882
|
-
markdown: "## list\n\n`client.publicInternetGateways.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/public_internet_gateways`\n\nList all Public Internet Gateways.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `created_at?: string`\n - `name?: string`\n - `network_id?: string`\n - `public_ip?: string`\n - `record_type?: string`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const
|
|
31882
|
+
markdown: "## list\n\n`client.publicInternetGateways.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/public_internet_gateways`\n\nList all Public Internet Gateways.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `created_at?: string`\n - `name?: string`\n - `network_id?: string`\n - `public_ip?: string`\n - `record_type?: string`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const publicInternetGatewayRead of client.publicInternetGateways.list()) {\n console.log(publicInternetGatewayRead);\n}\n```",
|
|
31883
31883
|
perLanguage: {
|
|
31884
31884
|
typescript: {
|
|
31885
31885
|
method: 'client.publicInternetGateways.list',
|
|
31886
|
-
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\n// Automatically fetches more pages as needed.\nfor await (const
|
|
31886
|
+
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\n// Automatically fetches more pages as needed.\nfor await (const publicInternetGatewayRead of client.publicInternetGateways.list()) {\n console.log(publicInternetGatewayRead.id);\n}",
|
|
31887
31887
|
},
|
|
31888
31888
|
python: {
|
|
31889
31889
|
method: 'public_internet_gateways.list',
|
|
@@ -31923,8 +31923,8 @@ const EMBEDDED_METHODS = [
|
|
|
31923
31923
|
stainlessPath: '(resource) public_internet_gateways > (method) create',
|
|
31924
31924
|
qualified: 'client.publicInternetGateways.create',
|
|
31925
31925
|
params: ['name?: string;', 'network_id?: string;', 'region_code?: string;'],
|
|
31926
|
-
response:
|
|
31927
|
-
markdown: "## create\n\n`client.publicInternetGateways.create(name?: string, network_id?: string, region_code?: string): { data?:
|
|
31926
|
+
response: '{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
31927
|
+
markdown: "## create\n\n`client.publicInternetGateways.create(name?: string, network_id?: string, region_code?: string): { data?: public_internet_gateway_read; }`\n\n**post** `/public_internet_gateways`\n\nCreate a new Public Internet Gateway.\n\n### Parameters\n\n- `name?: string`\n A user specified name for the interface.\n\n- `network_id?: string`\n The id of the network associated with the interface.\n\n- `region_code?: string`\n The region interface is deployed to.\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst publicInternetGateway = await client.publicInternetGateways.create();\n\nconsole.log(publicInternetGateway);\n```",
|
|
31928
31928
|
perLanguage: {
|
|
31929
31929
|
typescript: {
|
|
31930
31930
|
method: 'client.publicInternetGateways.create',
|
|
@@ -31968,8 +31968,8 @@ const EMBEDDED_METHODS = [
|
|
|
31968
31968
|
stainlessPath: '(resource) public_internet_gateways > (method) delete',
|
|
31969
31969
|
qualified: 'client.publicInternetGateways.delete',
|
|
31970
31970
|
params: ['id: string;'],
|
|
31971
|
-
response:
|
|
31972
|
-
markdown: "## delete\n\n`client.publicInternetGateways.delete(id: string): { data?:
|
|
31971
|
+
response: '{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
31972
|
+
markdown: "## delete\n\n`client.publicInternetGateways.delete(id: string): { data?: public_internet_gateway_read; }`\n\n**delete** `/public_internet_gateways/{id}`\n\nDelete a Public Internet Gateway.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst publicInternetGateway = await client.publicInternetGateways.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(publicInternetGateway);\n```",
|
|
31973
31973
|
perLanguage: {
|
|
31974
31974
|
typescript: {
|
|
31975
31975
|
method: 'client.publicInternetGateways.delete',
|
|
@@ -32013,8 +32013,8 @@ const EMBEDDED_METHODS = [
|
|
|
32013
32013
|
stainlessPath: '(resource) public_internet_gateways > (method) retrieve',
|
|
32014
32014
|
qualified: 'client.publicInternetGateways.retrieve',
|
|
32015
32015
|
params: ['id: string;'],
|
|
32016
|
-
response:
|
|
32017
|
-
markdown: "## retrieve\n\n`client.publicInternetGateways.retrieve(id: string): { data?:
|
|
32016
|
+
response: '{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
32017
|
+
markdown: "## retrieve\n\n`client.publicInternetGateways.retrieve(id: string): { data?: public_internet_gateway_read; }`\n\n**get** `/public_internet_gateways/{id}`\n\nRetrieve a Public Internet Gateway.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; name?: string; network_id?: string; public_ip?: string; record_type?: string; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst publicInternetGateway = await client.publicInternetGateways.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(publicInternetGateway);\n```",
|
|
32018
32018
|
perLanguage: {
|
|
32019
32019
|
typescript: {
|
|
32020
32020
|
method: 'client.publicInternetGateways.retrieve',
|
|
@@ -41835,11 +41835,11 @@ const EMBEDDED_METHODS = [
|
|
|
41835
41835
|
qualified: 'client.virtualCrossConnects.list',
|
|
41836
41836
|
params: ['filter?: { network_id?: string; };', 'page[number]?: number;', 'page[size]?: number;'],
|
|
41837
41837
|
response: "{ id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }",
|
|
41838
|
-
markdown: "## list\n\n`client.virtualCrossConnects.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/virtual_cross_connects`\n\nList all Virtual Cross Connects.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `bandwidth_mbps?: number`\n - `bgp_asn?: number`\n - `cloud_provider?: 'aws' | 'azure' | 'gce'`\n - `cloud_provider_region?: string`\n - `created_at?: string`\n - `name?: string`\n - `network_id?: string`\n - `primary_bgp_key?: string`\n - `primary_cloud_account_id?: string`\n - `primary_cloud_ip?: string`\n - `primary_enabled?: boolean`\n - `primary_routing_announcement?: boolean`\n - `primary_telnyx_ip?: string`\n - `record_type?: string`\n - `region?: { code?: string; name?: string; record_type?: string; }`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const
|
|
41838
|
+
markdown: "## list\n\n`client.virtualCrossConnects.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/virtual_cross_connects`\n\nList all Virtual Cross Connects.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `bandwidth_mbps?: number`\n - `bgp_asn?: number`\n - `cloud_provider?: 'aws' | 'azure' | 'gce'`\n - `cloud_provider_region?: string`\n - `created_at?: string`\n - `name?: string`\n - `network_id?: string`\n - `primary_bgp_key?: string`\n - `primary_cloud_account_id?: string`\n - `primary_cloud_ip?: string`\n - `primary_enabled?: boolean`\n - `primary_routing_announcement?: boolean`\n - `primary_telnyx_ip?: string`\n - `record_type?: string`\n - `region?: { code?: string; name?: string; record_type?: string; }`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const virtualCrossConnectCombined of client.virtualCrossConnects.list()) {\n console.log(virtualCrossConnectCombined);\n}\n```",
|
|
41839
41839
|
perLanguage: {
|
|
41840
41840
|
typescript: {
|
|
41841
41841
|
method: 'client.virtualCrossConnects.list',
|
|
41842
|
-
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\n// Automatically fetches more pages as needed.\nfor await (const
|
|
41842
|
+
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\n// Automatically fetches more pages as needed.\nfor await (const virtualCrossConnectCombined of client.virtualCrossConnects.list()) {\n console.log(virtualCrossConnectCombined.id);\n}",
|
|
41843
41843
|
},
|
|
41844
41844
|
python: {
|
|
41845
41845
|
method: 'virtual_cross_connects.list',
|
|
@@ -41895,8 +41895,8 @@ const EMBEDDED_METHODS = [
|
|
|
41895
41895
|
'secondary_cloud_ip?: string;',
|
|
41896
41896
|
'secondary_telnyx_ip?: string;',
|
|
41897
41897
|
],
|
|
41898
|
-
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?:
|
|
41899
|
-
markdown: "## create\n\n`client.virtualCrossConnects.create(region_code: string, bandwidth_mbps?: number, bgp_asn?: number, cloud_provider?: 'aws' | 'azure' | 'gce', cloud_provider_region?: string, name?: string, network_id?: string, primary_bgp_key?: string, primary_cloud_account_id?: string, primary_cloud_ip?: string, primary_telnyx_ip?: string, secondary_bgp_key?: string, secondary_cloud_account_id?: string, secondary_cloud_ip?: string, secondary_telnyx_ip?: string): { data?:
|
|
41898
|
+
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }",
|
|
41899
|
+
markdown: "## create\n\n`client.virtualCrossConnects.create(region_code: string, bandwidth_mbps?: number, bgp_asn?: number, cloud_provider?: 'aws' | 'azure' | 'gce', cloud_provider_region?: string, name?: string, network_id?: string, primary_bgp_key?: string, primary_cloud_account_id?: string, primary_cloud_ip?: string, primary_telnyx_ip?: string, secondary_bgp_key?: string, secondary_cloud_account_id?: string, secondary_cloud_ip?: string, secondary_telnyx_ip?: string): { data?: virtual_cross_connect_combined; }`\n\n**post** `/virtual_cross_connects`\n\nCreate a new Virtual Cross Connect.<br /><br />For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option. Azure requires both the primary and secondary connections to be created at the same time and they can not be independantly disabled.\n\n### Parameters\n\n- `region_code: string`\n The region the interface should be deployed to.\n\n- `bandwidth_mbps?: number`\n The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint.\n\n- `bgp_asn?: number`\n The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.\n\n- `cloud_provider?: 'aws' | 'azure' | 'gce'`\n The Virtual Private Cloud with which you would like to establish a cross connect.\n\n- `cloud_provider_region?: string`\n The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint.\n\n- `name?: string`\n A user specified name for the interface.\n\n- `network_id?: string`\n The id of the network associated with the interface.\n\n- `primary_bgp_key?: string`\n The authentication key for BGP peer configuration.\n\n- `primary_cloud_account_id?: string`\n The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.\n\n- `primary_cloud_ip?: string`\n The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.\n\n- `primary_telnyx_ip?: string`\n The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.\n\n- `secondary_bgp_key?: string`\n The authentication key for BGP peer configuration.\n\n- `secondary_cloud_account_id?: string`\n The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE.\n\n- `secondary_cloud_ip?: string`\n The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.\n\n- `secondary_telnyx_ip?: string`\n The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.\n\n### Returns\n\n- `{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst virtualCrossConnect = await client.virtualCrossConnects.create({ region_code: 'ashburn-va' });\n\nconsole.log(virtualCrossConnect);\n```",
|
|
41900
41900
|
perLanguage: {
|
|
41901
41901
|
typescript: {
|
|
41902
41902
|
method: 'client.virtualCrossConnects.create',
|
|
@@ -41940,8 +41940,8 @@ const EMBEDDED_METHODS = [
|
|
|
41940
41940
|
stainlessPath: '(resource) virtual_cross_connects > (method) delete',
|
|
41941
41941
|
qualified: 'client.virtualCrossConnects.delete',
|
|
41942
41942
|
params: ['id: string;'],
|
|
41943
|
-
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?:
|
|
41944
|
-
markdown: "## delete\n\n`client.virtualCrossConnects.delete(id: string): { data?:
|
|
41943
|
+
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }",
|
|
41944
|
+
markdown: "## delete\n\n`client.virtualCrossConnects.delete(id: string): { data?: virtual_cross_connect_combined; }`\n\n**delete** `/virtual_cross_connects/{id}`\n\nDelete a Virtual Cross Connect.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst virtualCrossConnect = await client.virtualCrossConnects.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(virtualCrossConnect);\n```",
|
|
41945
41945
|
perLanguage: {
|
|
41946
41946
|
typescript: {
|
|
41947
41947
|
method: 'client.virtualCrossConnects.delete',
|
|
@@ -41985,8 +41985,8 @@ const EMBEDDED_METHODS = [
|
|
|
41985
41985
|
stainlessPath: '(resource) virtual_cross_connects > (method) retrieve',
|
|
41986
41986
|
qualified: 'client.virtualCrossConnects.retrieve',
|
|
41987
41987
|
params: ['id: string;'],
|
|
41988
|
-
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?:
|
|
41989
|
-
markdown: "## retrieve\n\n`client.virtualCrossConnects.retrieve(id: string): { data?:
|
|
41988
|
+
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }",
|
|
41989
|
+
markdown: "## retrieve\n\n`client.virtualCrossConnects.retrieve(id: string): { data?: virtual_cross_connect_combined; }`\n\n**get** `/virtual_cross_connects/{id}`\n\nRetrieve a Virtual Cross Connect.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst virtualCrossConnect = await client.virtualCrossConnects.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(virtualCrossConnect);\n```",
|
|
41990
41990
|
perLanguage: {
|
|
41991
41991
|
typescript: {
|
|
41992
41992
|
method: 'client.virtualCrossConnects.retrieve',
|
|
@@ -42038,8 +42038,8 @@ const EMBEDDED_METHODS = [
|
|
|
42038
42038
|
'secondary_enabled?: boolean;',
|
|
42039
42039
|
'secondary_routing_announcement?: boolean;',
|
|
42040
42040
|
],
|
|
42041
|
-
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?:
|
|
42042
|
-
markdown: "## update\n\n`client.virtualCrossConnects.update(id: string, primary_cloud_ip?: string, primary_enabled?: boolean, primary_routing_announcement?: boolean, secondary_cloud_ip?: string, secondary_enabled?: boolean, secondary_routing_announcement?: boolean): { data?:
|
|
42041
|
+
response: "{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }",
|
|
42042
|
+
markdown: "## update\n\n`client.virtualCrossConnects.update(id: string, primary_cloud_ip?: string, primary_enabled?: boolean, primary_routing_announcement?: boolean, secondary_cloud_ip?: string, secondary_enabled?: boolean, secondary_routing_announcement?: boolean): { data?: virtual_cross_connect_combined; }`\n\n**patch** `/virtual_cross_connects/{id}`\n\nUpdate the Virtual Cross Connect.<br /><br />Cloud IPs can only be patched during the `created` state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to `provisioning`, the IPs can no longer be patched.<br /><br />Once the Virtual Cross Connect has moved to `provisioned` and you are ready to enable routing, you can toggle the routing announcements to `true`.\n\n### Parameters\n\n- `id: string`\n\n- `primary_cloud_ip?: string`\n The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned.\n\n- `primary_enabled?: boolean`\n Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit.\n\n- `primary_routing_announcement?: boolean`\n Whether the primary BGP route is being announced.\n\n- `secondary_cloud_ip?: string`\n The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned.\n\n- `secondary_enabled?: boolean`\n Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit.\n\n- `secondary_routing_announcement?: boolean`\n Whether the secondary BGP route is being announced.\n\n### Returns\n\n- `{ data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; bandwidth_mbps?: number; bgp_asn?: number; cloud_provider?: 'aws' | 'azure' | 'gce'; cloud_provider_region?: string; created_at?: string; name?: string; network_id?: string; primary_bgp_key?: string; primary_cloud_account_id?: string; primary_cloud_ip?: string; primary_enabled?: boolean; primary_routing_announcement?: boolean; primary_telnyx_ip?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst virtualCrossConnect = await client.virtualCrossConnects.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(virtualCrossConnect);\n```",
|
|
42043
42043
|
perLanguage: {
|
|
42044
42044
|
typescript: {
|
|
42045
42045
|
method: 'client.virtualCrossConnects.update',
|
|
@@ -42228,11 +42228,11 @@ const EMBEDDED_METHODS = [
|
|
|
42228
42228
|
qualified: 'client.wireguardInterfaces.list',
|
|
42229
42229
|
params: ['filter?: { network_id?: string; };', 'page[number]?: number;', 'page[size]?: number;'],
|
|
42230
42230
|
response: "{ id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }",
|
|
42231
|
-
markdown: "## list\n\n`client.wireguardInterfaces.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/wireguard_interfaces`\n\nList all WireGuard Interfaces.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `created_at?: string`\n - `enable_sip_trunking?: boolean`\n - `endpoint?: string`\n - `name?: string`\n - `network_id?: string`\n - `public_key?: string`\n - `record_type?: string`\n - `region?: { code?: string; name?: string; record_type?: string; }`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const
|
|
42231
|
+
markdown: "## list\n\n`client.wireguardInterfaces.list(filter?: { network_id?: string; }, page[number]?: number, page[size]?: number): { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }`\n\n**get** `/wireguard_interfaces`\n\nList all WireGuard Interfaces.\n\n### Parameters\n\n- `filter?: { network_id?: string; }`\n Consolidated filter parameter (deepObject style). Originally: filter[network_id]\n - `network_id?: string`\n The associated network id to filter on.\n\n- `page[number]?: number`\n\n- `page[size]?: number`\n\n### Returns\n\n- `{ id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n - `id?: string`\n - `created_at?: string`\n - `enable_sip_trunking?: boolean`\n - `endpoint?: string`\n - `name?: string`\n - `network_id?: string`\n - `public_key?: string`\n - `record_type?: string`\n - `region?: { code?: string; name?: string; record_type?: string; }`\n - `region_code?: string`\n - `status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\n// Automatically fetches more pages as needed.\nfor await (const wireguardInterfaceRead of client.wireguardInterfaces.list()) {\n console.log(wireguardInterfaceRead);\n}\n```",
|
|
42232
42232
|
perLanguage: {
|
|
42233
42233
|
typescript: {
|
|
42234
42234
|
method: 'client.wireguardInterfaces.list',
|
|
42235
|
-
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\n// Automatically fetches more pages as needed.\nfor await (const
|
|
42235
|
+
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\n// Automatically fetches more pages as needed.\nfor await (const wireguardInterfaceRead of client.wireguardInterfaces.list()) {\n console.log(wireguardInterfaceRead.id);\n}",
|
|
42236
42236
|
},
|
|
42237
42237
|
python: {
|
|
42238
42238
|
method: 'wireguard_interfaces.list',
|
|
@@ -42277,8 +42277,8 @@ const EMBEDDED_METHODS = [
|
|
|
42277
42277
|
'name?: string;',
|
|
42278
42278
|
'network_id?: string;',
|
|
42279
42279
|
],
|
|
42280
|
-
response:
|
|
42281
|
-
markdown: "## create\n\n`client.wireguardInterfaces.create(region_code: string, enable_sip_trunking?: boolean, name?: string, network_id?: string): { data?:
|
|
42280
|
+
response: '{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
42281
|
+
markdown: "## create\n\n`client.wireguardInterfaces.create(region_code: string, enable_sip_trunking?: boolean, name?: string, network_id?: string): { data?: wireguard_interface_read; }`\n\n**post** `/wireguard_interfaces`\n\nCreate a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.\n\n### Parameters\n\n- `region_code: string`\n The region the interface should be deployed to.\n\n- `enable_sip_trunking?: boolean`\n Enable SIP traffic forwarding over VPN interface.\n\n- `name?: string`\n A user specified name for the interface.\n\n- `network_id?: string`\n The id of the network associated with the interface.\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst wireguardInterface = await client.wireguardInterfaces.create({ region_code: 'ashburn-va' });\n\nconsole.log(wireguardInterface);\n```",
|
|
42282
42282
|
perLanguage: {
|
|
42283
42283
|
typescript: {
|
|
42284
42284
|
method: 'client.wireguardInterfaces.create',
|
|
@@ -42322,8 +42322,8 @@ const EMBEDDED_METHODS = [
|
|
|
42322
42322
|
stainlessPath: '(resource) wireguard_interfaces > (method) delete',
|
|
42323
42323
|
qualified: 'client.wireguardInterfaces.delete',
|
|
42324
42324
|
params: ['id: string;'],
|
|
42325
|
-
response:
|
|
42326
|
-
markdown: "## delete\n\n`client.wireguardInterfaces.delete(id: string): { data?:
|
|
42325
|
+
response: '{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
42326
|
+
markdown: "## delete\n\n`client.wireguardInterfaces.delete(id: string): { data?: wireguard_interface_read; }`\n\n**delete** `/wireguard_interfaces/{id}`\n\nDelete a WireGuard Interface.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst wireguardInterface = await client.wireguardInterfaces.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(wireguardInterface);\n```",
|
|
42327
42327
|
perLanguage: {
|
|
42328
42328
|
typescript: {
|
|
42329
42329
|
method: 'client.wireguardInterfaces.delete',
|
|
@@ -42367,8 +42367,8 @@ const EMBEDDED_METHODS = [
|
|
|
42367
42367
|
stainlessPath: '(resource) wireguard_interfaces > (method) retrieve',
|
|
42368
42368
|
qualified: 'client.wireguardInterfaces.retrieve',
|
|
42369
42369
|
params: ['id: string;'],
|
|
42370
|
-
response:
|
|
42371
|
-
markdown: "## retrieve\n\n`client.wireguardInterfaces.retrieve(id: string): { data?:
|
|
42370
|
+
response: '{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }',
|
|
42371
|
+
markdown: "## retrieve\n\n`client.wireguardInterfaces.retrieve(id: string): { data?: wireguard_interface_read; }`\n\n**get** `/wireguard_interfaces/{id}`\n\nRetrieve a WireGuard Interfaces.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: object; region_code?: string; status?: interface_status; updated_at?: string; }; }`\n\n - `data?: { id?: string; created_at?: string; enable_sip_trunking?: boolean; endpoint?: string; name?: string; network_id?: string; public_key?: string; record_type?: string; region?: { code?: string; name?: string; record_type?: string; }; region_code?: string; status?: 'created' | 'provisioning' | 'provisioned' | 'deleting'; updated_at?: string; }`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst wireguardInterface = await client.wireguardInterfaces.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');\n\nconsole.log(wireguardInterface);\n```",
|
|
42372
42372
|
perLanguage: {
|
|
42373
42373
|
typescript: {
|
|
42374
42374
|
method: 'client.wireguardInterfaces.retrieve',
|