telnyx-numbers-go

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Numbers - 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 country coverage `GET /country_coverage` ```go countryCoverage, err := client.CountryCoverage.Get(context.TODO()) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", countryCoverage.Data) ``` ## Get coverage for a specific country `GET /country_coverage/countries/{country_code}` ```go response, err := client.CountryCoverage.GetCountry(context.TODO(), "US") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Create an inventory coverage request Creates an inventory coverage request. `GET /inventory_coverage` ```go inventoryCoverages, err := client.InventoryCoverage.List(context.TODO(), telnyx.InventoryCoverageListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", inventoryCoverages.Data) ``` ## List number reservations Gets a paginated list of phone number reservations. `GET /number_reservations` ```go page, err := client.NumberReservations.List(context.TODO(), telnyx.NumberReservationListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Create a number reservation Creates a Phone Number Reservation for multiple numbers. `POST /number_reservations` ```go numberReservation, err := client.NumberReservations.New(context.TODO(), telnyx.NumberReservationNewParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberReservation.Data) ``` ## Retrieve a number reservation Gets a single phone number reservation. `GET /number_reservations/{number_reservation_id}` ```go numberReservation, err := client.NumberReservations.Get(context.TODO(), "number_reservation_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberReservation.Data) ``` ## Extend a number reservation Extends reservation expiry time on all phone numbers. `POST /number_reservations/{number_reservation_id}/actions/extend` ```go response, err := client.NumberReservations.Actions.Extend(context.TODO(), "number_reservation_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## List number orders Get a paginated list of number orders. `GET /number_orders` ```go page, err := client.NumberOrders.List(context.TODO(), telnyx.NumberOrderListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Create a number order Creates a phone number order. `POST /number_orders` ```go numberOrder, err := client.NumberOrders.New(context.TODO(), telnyx.NumberOrderNewParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberOrder.Data) ``` ## Retrieve a number order Get an existing phone number order. `GET /number_orders/{number_order_id}` ```go numberOrder, err := client.NumberOrders.Get(context.TODO(), "number_order_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberOrder.Data) ``` ## Update a number order Updates a phone number order. `PATCH /number_orders/{number_order_id}` ```go numberOrder, err := client.NumberOrders.Update( context.TODO(), "number_order_id", telnyx.NumberOrderUpdateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberOrder.Data) ``` ## List number block orders Get a paginated list of number block orders. `GET /number_block_orders` ```go page, err := client.NumberBlockOrders.List(context.TODO(), telnyx.NumberBlockOrderListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Create a number block order Creates a phone number block order. `POST /number_block_orders` — Required: `starting_number`, `range` ```go numberBlockOrder, err := client.NumberBlockOrders.New(context.TODO(), telnyx.NumberBlockOrderNewParams{ Range: 10, StartingNumber: "+19705555000", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberBlockOrder.Data) ``` ## Retrieve a number block order Get an existing phone number block order. `GET /number_block_orders/{number_block_order_id}` ```go numberBlockOrder, err := client.NumberBlockOrders.Get(context.TODO(), "number_block_order_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberBlockOrder.Data) ``` ## Retrieve a list of phone numbers associated to orders Get a list of phone numbers associated to orders. `GET /number_order_phone_numbers` ```go numberOrderPhoneNumbers, err := client.NumberOrderPhoneNumbers.List(context.TODO(), telnyx.NumberOrderPhoneNumberListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberOrderPhoneNumbers.Data) ``` ## Update requirement group for a phone number order `POST /number_order_phone_numbers/{id}/requirement_group` — Required: `requirement_group_id` ```go response, err := client.NumberOrderPhoneNumbers.UpdateRequirementGroup( context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", telnyx.NumberOrderPhoneNumberUpdateRequirementGroupParams{ RequirementGroupID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Retrieve a single phone number within a number order. Get an existing phone number in number order. `GET /number_order_phone_numbers/{number_order_phone_number_id}` ```go numberOrderPhoneNumber, err := client.NumberOrderPhoneNumbers.Get(context.TODO(), "number_order_phone_number_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", numberOrderPhoneNumber.Data) ``` ## Update requirements for a single phone number within a number order. Updates requirements for a single phone number within a number order. `PATCH /number_order_phone_numbers/{number_order_phone_number_id}` ```go response, err := client.NumberOrderPhoneNumbers.UpdateRequirements( context.TODO(), "number_order_phone_number_id", telnyx.NumberOrderPhoneNumberUpdateRequirementsParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## List sub number orders Get a paginated list of sub number orders. `GET /sub_number_orders` ```go subNumberOrders, err := client.SubNumberOrders.List(context.TODO(), telnyx.SubNumberOrderListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", subNumberOrders.Data) ``` ## Update requirement group for a sub number order `POST /sub_number_orders/{id}/requirement_group` — Required: `requirement_group_id` ```go response, err := client.SubNumberOrders.UpdateRequirementGroup( context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", telnyx.SubNumberOrderUpdateRequirementGroupParams{ RequirementGroupID: "a4b201f9-8646-4e54-a7d2-b2e403eeaf8c", }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Retrieve a sub number order Get an existing sub number order. `GET /sub_number_orders/{sub_number_order_id}` ```go subNumberOrder, err := client.SubNumberOrders.Get( context.TODO(), "sub_number_order_id", telnyx.SubNumberOrderGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", subNumberOrder.Data) ``` ## Update a sub number order's requirements Updates a sub number order. `PATCH /sub_number_orders/{sub_number_order_id}` ```go subNumberOrder, err := client.SubNumberOrders.Update( context.TODO(), "sub_number_order_id", telnyx.SubNumberOrderUpdateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", subNumberOrder.Data) ``` ## Cancel a sub number order Allows you to cancel a sub number order in 'pending' status. `PATCH /sub_number_orders/{sub_number_order_id}/cancel` ```go response, err := client.SubNumberOrders.Cancel(context.TODO(), "sub_number_order_id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Create a sub number orders report Create a CSV report for sub number orders. `POST /sub_number_orders/report` ```go subNumberOrdersReport, err := client.SubNumberOrdersReport.New(context.TODO(), telnyx.SubNumberOrdersReportNewParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", subNumberOrdersReport.Data) ``` ## Retrieve a sub number orders report Get the status and details of a sub number orders report. `GET /sub_number_orders/report/{report_id}` ```go subNumberOrdersReport, err := client.SubNumberOrdersReport.Get(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", subNumberOrdersReport.Data) ``` ## Download a sub number orders report Download the CSV file for a completed sub number orders report. `GET /sub_number_orders/report/{report_id}/download` ```go response, err := client.SubNumberOrdersReport.Download(context.TODO(), "12ade33a-21c0-473b-b055-b3c836e1c293") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) ``` ## List Advanced Orders `GET /advanced_orders` ```go advancedOrders, err := client.AdvancedOrders.List(context.TODO()) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", advancedOrders.Data) ``` ## Create Advanced Order `POST /advanced_orders` ```go advancedOrder, err := client.AdvancedOrders.New(context.TODO(), telnyx.AdvancedOrderNewParams{ AdvancedOrder: telnyx.AdvancedOrderParam{}, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", advancedOrder.ID)