telnyx-iot-go

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Iot - Go ## Installation ```bash go get github.com/team-telnyx/telnyx-go ``` ## Setup ```go import ( "context" "fmt" "os" "github.com/team-telnyx/telnyx-go" "github.com/team-telnyx/telnyx-go/option" ) client := telnyx.NewClient( option.WithAPIKey(os.Getenv("TELNYX_API_KEY")), ) ``` 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` ```go response, err := client.Wireless.GetRegions(context.TODO(), telnyx.WirelessGetRegionsParams{ Product: "public_ips", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Get all SIM cards Get all SIM cards belonging to the user that match the given filters. `GET /sim_cards` ```go page, err := client.SimCards.List(context.TODO(), telnyx.SimCardListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Get SIM card Returns the details regarding a specific SIM card. `GET /sim_cards/{id}` ```go simCard, err := client.SimCards.Get( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCard.Data) ``` ## Update a SIM card Updates SIM card data `PATCH /sim_cards/{id}` ```go simCard, err := client.SimCards.Update( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardUpdateParams{ SimCard: telnyx.SimCardParam{}, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCard.Data) ``` ## 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}` ```go simCard, err := client.SimCards.Delete( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardDeleteParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCard.Data) ``` ## 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` ```go response, err := client.SimCards.GetActivationCode(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Get SIM card device details It returns the device details where a SIM card is currently being used. `GET /sim_cards/{id}/device_details` ```go response, err := client.SimCards.GetDeviceDetails(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Get SIM card public IP definition It returns the public IP requested for a SIM card. `GET /sim_cards/{id}/public_ip` ```go response, err := client.SimCards.GetPublicIP(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go page, err := client.SimCards.ListWirelessConnectivityLogs( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardListWirelessConnectivityLogsParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## 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` ```go response, err := client.SimCards.Actions.Disable(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go response, err := client.SimCards.Actions.Enable(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go response, err := client.SimCards.Actions.RemovePublicIP(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go response, err := client.SimCards.Actions.SetPublicIP( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardActionSetPublicIPParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go response, err := client.SimCards.Actions.SetStandby(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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` ```go response, err := client.SimCards.Actions.BulkSetPublicIPs(context.TODO(), telnyx.SimCardActionBulkSetPublicIPsParams{ SimCardIDs: []string{"6b14e151-8493-4fa1-8664-1cc4e6d14158"}, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Validate SIM cards registration codes It validates whether SIM card registration codes are valid or not. `POST /sim_cards/actions/validate_registration_codes` ```go response, err := client.SimCards.Actions.ValidateRegistrationCodes(context.TODO(), telnyx.SimCardActionValidateRegistrationCodesParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## List SIM card actions This API lists a paginated collection of SIM card actions. `GET /sim_card_actions` ```go page, err := client.SimCards.Actions.List(context.TODO(), telnyx.SimCardActionListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## 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}` ```go action, err := client.SimCards.Actions.Get(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", action.Data) ``` ## List bulk SIM card actions This API lists a paginated collection of bulk SIM card actions. `GET /bulk_sim_card_actions` ```go page, err := client.BulkSimCardActions.List(context.TODO(), telnyx.BulkSimCardActionListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Get bulk SIM card action details This API fetches information about a bulk SIM card action. `GET /bulk_sim_card_actions/{id}` ```go bulkSimCardAction, err := client.BulkSimCardActions.Get(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", bulkSimCardAction.Data) ``` ## Get all SIM card groups Get all SIM card groups belonging to the user that match the given filters. `GET /sim_card_groups` ```go page, err := client.SimCardGroups.List(context.TODO(), telnyx.SimCardGroupListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Create a SIM card group Creates a new SIM card group object `POST /sim_card_groups` — Required: `name` ```go simCardGroup, err := client.SimCardGroups.New(context.TODO(), telnyx.SimCardGroupNewParams{ Name: "My Test Group", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCardGroup.Data) ``` ## Get SIM card group Returns the details regarding a specific SIM card group `GET /sim_card_groups/{id}` ```go simCardGroup, err := client.SimCardGroups.Get( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardGroupGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCardGroup.Data) ``` ## Update a SIM card group Updates a SIM card group `PATCH /sim_card_groups/{id}` ```go simCardGroup, err := client.SimCardGroups.Update( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.SimCardGroupUpdateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCardGroup.Data) ``` ## Delete a SIM card group Permanently deletes a SIM card group `DELETE /sim_card_groups/{id}` ```go simCardGroup, err := client.SimCardGroups.Delete(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", simCardGroup.Data) ``` ## 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` ```go response, err := client.SimCardGroups.Actions.RemovePrivateWirelessGateway(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## 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.