telnyx-networking-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Networking - Java ## Installation ```text // See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup ``` ## Setup ```java import com.telnyx.sdk.client.TelnyxClient; import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient; TelnyxClient client = TelnyxOkHttpClient.fromEnv(); ``` All examples below assume `client` is already initialized as shown above. ## List all Regions List all regions and the interfaces that region supports `GET /regions` ```java import com.telnyx.sdk.models.regions.RegionListParams; import com.telnyx.sdk.models.regions.RegionListResponse; RegionListResponse regions = client.regions().list(); ``` ## List all Networks List all Networks. `GET /networks` ```java import com.telnyx.sdk.models.networks.NetworkListPage; import com.telnyx.sdk.models.networks.NetworkListParams; NetworkListPage page = client.networks().list(); ``` ## Create a Network Create a new Network. `POST /networks` ```java import com.telnyx.sdk.models.networks.NetworkCreate; import com.telnyx.sdk.models.networks.NetworkCreateParams; import com.telnyx.sdk.models.networks.NetworkCreateResponse; NetworkCreate params = NetworkCreate.builder() .name("test network") .build(); NetworkCreateResponse network = client.networks().create(params); ``` ## Retrieve a Network Retrieve a Network. `GET /networks/{id}` ```java import com.telnyx.sdk.models.networks.NetworkRetrieveParams; import com.telnyx.sdk.models.networks.NetworkRetrieveResponse; NetworkRetrieveResponse network = client.networks().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Update a Network Update a Network. `PATCH /networks/{id}` ```java import com.telnyx.sdk.models.networks.NetworkCreate; import com.telnyx.sdk.models.networks.NetworkUpdateParams; import com.telnyx.sdk.models.networks.NetworkUpdateResponse; NetworkUpdateParams params = NetworkUpdateParams.builder() .networkId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .networkCreate(NetworkCreate.builder() .name("test network") .build()) .build(); NetworkUpdateResponse network = client.networks().update(params); ``` ## Delete a Network Delete a Network. `DELETE /networks/{id}` ```java import com.telnyx.sdk.models.networks.NetworkDeleteParams; import com.telnyx.sdk.models.networks.NetworkDeleteResponse; NetworkDeleteResponse network = client.networks().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get Default Gateway status. `GET /networks/{id}/default_gateway` ```java import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayRetrieveParams; import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayRetrieveResponse; DefaultGatewayRetrieveResponse defaultGateway = client.networks().defaultGateway().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Create Default Gateway. `POST /networks/{id}/default_gateway` ```java import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayCreateParams; import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayCreateResponse; DefaultGatewayCreateResponse defaultGateway = client.networks().defaultGateway().create("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete Default Gateway. `DELETE /networks/{id}/default_gateway` ```java import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayDeleteParams; import com.telnyx.sdk.models.networks.defaultgateway.DefaultGatewayDeleteResponse; DefaultGatewayDeleteResponse defaultGateway = client.networks().defaultGateway().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List all Interfaces for a Network. `GET /networks/{id}/network_interfaces` ```java import com.telnyx.sdk.models.networks.NetworkListInterfacesPage; import com.telnyx.sdk.models.networks.NetworkListInterfacesParams; NetworkListInterfacesPage page = client.networks().listInterfaces("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List all WireGuard Interfaces List all WireGuard Interfaces. `GET /wireguard_interfaces` ```java import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceListPage; import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceListParams; WireguardInterfaceListPage page = client.wireguardInterfaces().list(); ``` ## Create a WireGuard Interface Create a new WireGuard Interface. `POST /wireguard_interfaces` ```java import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceCreateParams; import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceCreateResponse; WireguardInterfaceCreateResponse wireguardInterface = client.wireguardInterfaces().create(); ``` ## Retrieve a WireGuard Interfaces Retrieve a WireGuard Interfaces. `GET /wireguard_interfaces/{id}` ```java import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceRetrieveParams; import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceRetrieveResponse; WireguardInterfaceRetrieveResponse wireguardInterface = client.wireguardInterfaces().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a WireGuard Interface Delete a WireGuard Interface. `DELETE /wireguard_interfaces/{id}` ```java import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceDeleteParams; import com.telnyx.sdk.models.wireguardinterfaces.WireguardInterfaceDeleteResponse; WireguardInterfaceDeleteResponse wireguardInterface = client.wireguardInterfaces().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List all WireGuard Peers List all WireGuard peers. `GET /wireguard_peers` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerListPage; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerListParams; WireguardPeerListPage page = client.wireguardPeers().list(); ``` ## Create a WireGuard Peer Create a new WireGuard Peer. `POST /wireguard_peers` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerCreateParams; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerCreateResponse; WireguardPeerCreateParams params = WireguardPeerCreateParams.builder() .wireguardInterfaceId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .build(); WireguardPeerCreateResponse wireguardPeer = client.wireguardPeers().create(params); ``` ## Retrieve the WireGuard Peer Retrieve the WireGuard peer. `GET /wireguard_peers/{id}` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveParams; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveResponse; WireguardPeerRetrieveResponse wireguardPeer = client.wireguardPeers().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Update the WireGuard Peer Update the WireGuard peer. `PATCH /wireguard_peers/{id}` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerPatch; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerUpdateParams; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerUpdateResponse; WireguardPeerUpdateParams params = WireguardPeerUpdateParams.builder() .id("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .wireguardPeerPatch(WireguardPeerPatch.builder().build()) .build(); WireguardPeerUpdateResponse wireguardPeer = client.wireguardPeers().update(params); ``` ## Delete the WireGuard Peer Delete the WireGuard peer. `DELETE /wireguard_peers/{id}` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerDeleteParams; import com.telnyx.sdk.models.wireguardpeers.WireguardPeerDeleteResponse; WireguardPeerDeleteResponse wireguardPeer = client.wireguardPeers().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Retrieve Wireguard config template for Peer `GET /wireguard_peers/{id}/config` ```java import com.telnyx.sdk.models.wireguardpeers.WireguardPeerRetrieveConfigParams; String response = client.wireguardPeers().retrieveConfig("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get all Private Wireless Gateways Get all Private Wireless Gateways belonging to the user. `GET /private_wireless_gateways` ```java import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListPage; import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayListParams; PrivateWirelessGatewayListPage page = client.privateWirelessGateways().list(); ``` ## Create a Private Wireless Gateway Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. `POST /private_wireless_gateways` — Required: `network_id`, `name` ```java import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayCreateParams; import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayCreateResponse; PrivateWirelessGatewayCreateParams params = PrivateWirelessGatewayCreateParams.builder() .name("My private wireless gateway") .networkId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .build(); PrivateWirelessGatewayCreateResponse privateWirelessGateway = client.privateWirelessGateways().create(params); ``` ## Get a Private Wireless Gateway Retrieve information about a Private Wireless Gateway. `GET /private_wireless_gateways/{id}` ```java import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayRetrieveParams; import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayRetrieveResponse; PrivateWirelessGatewayRetrieveResponse privateWirelessGateway = client.privateWirelessGateways().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a Private Wireless Gateway Deletes the Private Wireless Gateway. `DELETE /private_wireless_gateways/{id}` ```java import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayDeleteParams; import com.telnyx.sdk.models.privatewirelessgateways.PrivateWirelessGatewayDeleteResponse; PrivateWirelessGatewayDeleteResponse privateWirelessGateway = client.privateWirelessGateways().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List all Public Internet Gateways List all Public Internet Gateways. `GET /public_internet_gateways` ```java import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayListPage; import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayListParams; PublicInternetGatewayListPage page = client.publicInternetGateways().list(); ``` ## Create a Public Internet Gateway Create a new Public Internet Gateway. `POST /public_internet_gateways` ```java import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayCreateParams; import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayCreateResponse; PublicInternetGatewayCreateResponse publicInternetGateway = client.publicInternetGateways().create(); ``` ## Retrieve a Public Internet Gateway Retrieve a Public Internet Gateway. `GET /public_internet_gateways/{id}` ```java import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayRetrieveParams; import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayRetrieveResponse; PublicInternetGatewayRetrieveResponse publicInternetGateway = client.publicInternetGateways().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a Public Internet Gateway Delete a Public Internet Gateway. `DELETE /public_internet_gateways/{id}` ```java import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayDeleteParams; import com.telnyx.sdk.models.publicinternetgateways.PublicInternetGatewayDeleteResponse; PublicInternetGatewayDeleteResponse publicInternetGateway = client.publicInternetGateways().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List all Virtual Cross Connects List all Virtual Cross Connects. `GET /virtual_cross_connects` ```java import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectListPage; import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectListParams; VirtualCrossConnectListPage page = client.virtualCrossConnects().list(); ``` ## Create a Virtual Cross Connect Create 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. `POST /virtual_cross_connects` ```java import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectCreateParams; import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectCreateResponse; VirtualCrossConnectCreateResponse virtualCrossConnect = client.virtualCrossConnects().create(); ``` ## Retrieve a Virtual Cross Connect Retrieve a Virtual Cross Connect. `GET /virtual_cross_connects/{id}` ```java import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectRetrieveParams; import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectRetrieveResponse; VirtualCrossConnectRetrieveResponse virtualCrossConnect = client.virtualCrossConnects().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Update the Virtual Cross Connect Update 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 bee... `PATCH /virtual_cross_connects/{id}` ```java import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectUpdateParams; import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectUpdateResponse; VirtualCrossConnectUpdateResponse virtualCrossConnect = client.virtualCrossConnects().update("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a Virtual Cross Connect Delete a Virtual Cross Connect. `DELETE /virtual_cross_connects/{id}` ```java import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectDeleteParams; import com.telnyx.sdk.models.virtualcrossconnects.VirtualCrossConnectDeleteResponse; VirtualCrossConnectDeleteResponse virtualCrossConnect = client.virtualCrossConnects().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List Virtual Cross Connect Cloud Coverage List Virtual Cross Connects Cloud Coverage.<br /><br />This endpoint shows which cloud regions are available for the `location_code` your Virtual Cross Connect will be provisioned in. `GET /virtual_cross_connects/coverage` ```java import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListPage; import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListParams;