telnyx-iot-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Iot - 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. ## Get all wireless regions Retrieve all wireless regions for the given product. `GET /wireless/regions` ```java import com.telnyx.sdk.models.wireless.WirelessRetrieveRegionsParams; import com.telnyx.sdk.models.wireless.WirelessRetrieveRegionsResponse; WirelessRetrieveRegionsParams params = WirelessRetrieveRegionsParams.builder() .product("public_ips") .build(); WirelessRetrieveRegionsResponse response = client.wireless().retrieveRegions(params); ``` ## Get all SIM cards Get all SIM cards belonging to the user that match the given filters. `GET /sim_cards` ```java import com.telnyx.sdk.models.simcards.SimCardListPage; import com.telnyx.sdk.models.simcards.SimCardListParams; SimCardListPage page = client.simCards().list(); ``` ## Get SIM card Returns the details regarding a specific SIM card. `GET /sim_cards/{id}` ```java import com.telnyx.sdk.models.simcards.SimCardRetrieveParams; import com.telnyx.sdk.models.simcards.SimCardRetrieveResponse; SimCardRetrieveResponse simCard = client.simCards().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Update a SIM card Updates SIM card data `PATCH /sim_cards/{id}` ```java import com.telnyx.sdk.models.simcards.SimCard; import com.telnyx.sdk.models.simcards.SimCardUpdateParams; import com.telnyx.sdk.models.simcards.SimCardUpdateResponse; SimCardUpdateParams params = SimCardUpdateParams.builder() .simCardId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .simCard(SimCard.builder().build()) .build(); SimCardUpdateResponse simCard = client.simCards().update(params); ``` ## Deletes a SIM card The SIM card will be decommissioned, removed from your account and you will stop being charged.<br />The SIM card won't be able to connect to the network after the deletion is completed, thus makin... `DELETE /sim_cards/{id}` ```java import com.telnyx.sdk.models.simcards.SimCardDeleteParams; import com.telnyx.sdk.models.simcards.SimCardDeleteResponse; SimCardDeleteResponse simCard = client.simCards().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get activation code for an eSIM It returns the activation code for an eSIM.<br/><br/> This API is only available for eSIMs. `GET /sim_cards/{id}/activation_code` ```java import com.telnyx.sdk.models.simcards.SimCardGetActivationCodeParams; import com.telnyx.sdk.models.simcards.SimCardGetActivationCodeResponse; SimCardGetActivationCodeResponse response = client.simCards().getActivationCode("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get SIM card device details It returns the device details where a SIM card is currently being used. `GET /sim_cards/{id}/device_details` ```java import com.telnyx.sdk.models.simcards.SimCardGetDeviceDetailsParams; import com.telnyx.sdk.models.simcards.SimCardGetDeviceDetailsResponse; SimCardGetDeviceDetailsResponse response = client.simCards().getDeviceDetails("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get SIM card public IP definition It returns the public IP requested for a SIM card. `GET /sim_cards/{id}/public_ip` ```java import com.telnyx.sdk.models.simcards.SimCardGetPublicIpParams; import com.telnyx.sdk.models.simcards.SimCardGetPublicIpResponse; SimCardGetPublicIpResponse response = client.simCards().getPublicIp("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List wireless connectivity logs This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes. `GET /sim_cards/{id}/wireless_connectivity_logs` ```java import com.telnyx.sdk.models.simcards.SimCardListWirelessConnectivityLogsPage; import com.telnyx.sdk.models.simcards.SimCardListWirelessConnectivityLogsParams; SimCardListWirelessConnectivityLogsPage page = client.simCards().listWirelessConnectivityLogs("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request a SIM card disable This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.<br/> The API will trigger an asynchronous operation called a SIM Card Action. `POST /sim_cards/{id}/actions/disable` ```java import com.telnyx.sdk.models.simcards.actions.ActionDisableParams; import com.telnyx.sdk.models.simcards.actions.ActionDisableResponse; ActionDisableResponse response = client.simCards().actions().disable("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request a SIM card enable This API enables a SIM card, connecting it to the network and making it possible to consume data.<br/> To enable a SIM card, it must be associated with a SIM card group.<br/> The API will trigger a... `POST /sim_cards/{id}/actions/enable` ```java import com.telnyx.sdk.models.simcards.actions.ActionEnableParams; import com.telnyx.sdk.models.simcards.actions.ActionEnableResponse; ActionEnableResponse response = client.simCards().actions().enable("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request removing a SIM card public IP This API removes an existing public IP from a SIM card. `POST /sim_cards/{id}/actions/remove_public_ip` ```java import com.telnyx.sdk.models.simcards.actions.ActionRemovePublicIpParams; import com.telnyx.sdk.models.simcards.actions.ActionRemovePublicIpResponse; ActionRemovePublicIpResponse response = client.simCards().actions().removePublicIp("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request setting a SIM card public IP This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. `POST /sim_cards/{id}/actions/set_public_ip` ```java import com.telnyx.sdk.models.simcards.actions.ActionSetPublicIpParams; import com.telnyx.sdk.models.simcards.actions.ActionSetPublicIpResponse; ActionSetPublicIpResponse response = client.simCards().actions().setPublicIp("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request setting a SIM card to standby The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.<br/> To set a SIM card to standby, it must be ... `POST /sim_cards/{id}/actions/set_standby` ```java import com.telnyx.sdk.models.simcards.actions.ActionSetStandbyParams; import com.telnyx.sdk.models.simcards.actions.ActionSetStandbyResponse; ActionSetStandbyResponse response = client.simCards().actions().setStandby("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request bulk setting SIM card public IPs. This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.<br/> For each SIM Card a SIM Card Action will be generated. `POST /sim_cards/actions/bulk_set_public_ips` — Required: `sim_card_ids` ```java import com.telnyx.sdk.models.simcards.actions.ActionBulkSetPublicIpsParams; import com.telnyx.sdk.models.simcards.actions.ActionBulkSetPublicIpsResponse; ActionBulkSetPublicIpsParams params = ActionBulkSetPublicIpsParams.builder() .addSimCardId("6b14e151-8493-4fa1-8664-1cc4e6d14158") .build(); ActionBulkSetPublicIpsResponse response = client.simCards().actions().bulkSetPublicIps(params); ``` ## Validate SIM cards registration codes It validates whether SIM card registration codes are valid or not. `POST /sim_cards/actions/validate_registration_codes` ```java import com.telnyx.sdk.models.simcards.actions.ActionValidateRegistrationCodesParams; import com.telnyx.sdk.models.simcards.actions.ActionValidateRegistrationCodesResponse; ActionValidateRegistrationCodesResponse response = client.simCards().actions().validateRegistrationCodes(); ``` ## List SIM card actions This API lists a paginated collection of SIM card actions. `GET /sim_card_actions` ```java import com.telnyx.sdk.models.simcards.actions.ActionListPage; import com.telnyx.sdk.models.simcards.actions.ActionListParams; ActionListPage page = client.simCards().actions().list(); ``` ## Get SIM card action details This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation. `GET /sim_card_actions/{id}` ```java import com.telnyx.sdk.models.simcards.actions.ActionRetrieveParams; import com.telnyx.sdk.models.simcards.actions.ActionRetrieveResponse; ActionRetrieveResponse action = client.simCards().actions().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## List bulk SIM card actions This API lists a paginated collection of bulk SIM card actions. `GET /bulk_sim_card_actions` ```java import com.telnyx.sdk.models.bulksimcardactions.BulkSimCardActionListPage; import com.telnyx.sdk.models.bulksimcardactions.BulkSimCardActionListParams; BulkSimCardActionListPage page = client.bulkSimCardActions().list(); ``` ## Get bulk SIM card action details This API fetches information about a bulk SIM card action. `GET /bulk_sim_card_actions/{id}` ```java import com.telnyx.sdk.models.bulksimcardactions.BulkSimCardActionRetrieveParams; import com.telnyx.sdk.models.bulksimcardactions.BulkSimCardActionRetrieveResponse; BulkSimCardActionRetrieveResponse bulkSimCardAction = client.bulkSimCardActions().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Get all SIM card groups Get all SIM card groups belonging to the user that match the given filters. `GET /sim_card_groups` ```java import com.telnyx.sdk.models.simcardgroups.SimCardGroupListPage; import com.telnyx.sdk.models.simcardgroups.SimCardGroupListParams; SimCardGroupListPage page = client.simCardGroups().list(); ``` ## Create a SIM card group Creates a new SIM card group object `POST /sim_card_groups` — Required: `name` ```java import com.telnyx.sdk.models.simcardgroups.SimCardGroupCreateParams; import com.telnyx.sdk.models.simcardgroups.SimCardGroupCreateResponse; SimCardGroupCreateParams params = SimCardGroupCreateParams.builder() .name("My Test Group") .build(); SimCardGroupCreateResponse simCardGroup = client.simCardGroups().create(params); ``` ## Get SIM card group Returns the details regarding a specific SIM card group `GET /sim_card_groups/{id}` ```java import com.telnyx.sdk.models.simcardgroups.SimCardGroupRetrieveParams; import com.telnyx.sdk.models.simcardgroups.SimCardGroupRetrieveResponse; SimCardGroupRetrieveResponse simCardGroup = client.simCardGroups().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Update a SIM card group Updates a SIM card group `PATCH /sim_card_groups/{id}` ```java import com.telnyx.sdk.models.simcardgroups.SimCardGroupUpdateParams; import com.telnyx.sdk.models.simcardgroups.SimCardGroupUpdateResponse; SimCardGroupUpdateResponse simCardGroup = client.simCardGroups().update("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Delete a SIM card group Permanently deletes a SIM card group `DELETE /sim_card_groups/{id}` ```java import com.telnyx.sdk.models.simcardgroups.SimCardGroupDeleteParams; import com.telnyx.sdk.models.simcardgroups.SimCardGroupDeleteResponse; SimCardGroupDeleteResponse simCardGroup = client.simCardGroups().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request Private Wireless Gateway removal from SIM card group This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. `POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway` ```java import com.telnyx.sdk.models.simcardgroups.actions.ActionRemovePrivateWirelessGatewayParams; import com.telnyx.sdk.models.simcardgroups.actions.ActionRemovePrivateWirelessGatewayResponse; ActionRemovePrivateWirelessGatewayResponse response = client.simCardGroups().actions().removePrivateWirelessGateway("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request Wireless Blocklist removal from SIM card group This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group. `POST /sim_card_groups/{id}/actions/remove_wireless_blocklist` ```java import com.telnyx.sdk.models.simcardgroups.actions.ActionRemoveWirelessBlocklistParams; import com.telnyx.sdk.models.simcardgroups.actions.ActionRemoveWirelessBlocklistResponse; ActionRemoveWirelessBlocklistResponse response = client.simCardGroups().actions().removeWirelessBlocklist("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); ``` ## Request Private Wireless Gateway assignment for SIM card group This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. `POST /sim_card_groups/{id}/actions/set_private_wireless_gateway` — Required: `private_wireless_gateway_id` ```java import com.telnyx.sdk.models.simcardgroups.actions.ActionSetPrivateWirelessGatewayParams; import com.telnyx.sdk.models.simcardgroups.actions.ActionSetPrivateWirelessGatewayResponse; ActionSetPrivateWirelessGatewayParams params = ActionSetPrivateWirelessGatewayParams.builder() .id("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .privateWirelessGatewayId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .build(); ActionSetPrivateWirelessGatewayResponse response = client.simCardGroups().actions().setPrivateWirelessGateway(params); ``` ## Request Wireless Blocklist assignment for SIM card group This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group. `POST /sim_card_groups/{id}/actions/set_wireless_blocklist` — Required: `wireless_blocklist_id` ```java import com.telnyx.sdk.models.simcardgroups.actions.ActionSetWirelessBlocklistParams; import com.telnyx.sdk.models.simcardgroups.actions.ActionSetWirelessBlocklistResponse; ActionSetWirelessBlocklistParams params = ActionSetWirelessBlocklistParams.builder() .id("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .wirelessBlocklistId("6a09cdc3-8948-47f0-aa62-74ac943d6c58") .build(); ActionSetWirelessBlocklistResponse response = client.simCardGroups().actions().setWirelessBlocklist(params); ``` ## List SIM card group actions This API allows listing a paginated collection a SIM card group actions. `GET /sim_card_group_actions` ```java import com.telnyx.sdk.models.simcardgroups.actions.ActionListPage; import com.telnyx.sdk.models.simcardgroups.actions.ActionListParams; ActionListPage page = client.simCardGroups().actions().list(); ``` ## Get SIM card group action details This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.