telnyx-numbers-compliance-go

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Numbers Compliance - 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. ## Retrieve Bundles Get all allowed bundles. `GET /bundle_pricing/billing_bundles` ```go page, err := client.BundlePricing.BillingBundles.List(context.TODO(), telnyx.BundlePricingBillingBundleListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Get Bundle By Id Get a single bundle by ID. `GET /bundle_pricing/billing_bundles/{bundle_id}` ```go billingBundle, err := client.BundlePricing.BillingBundles.Get( context.TODO(), "8661948c-a386-4385-837f-af00f40f111a", telnyx.BundlePricingBillingBundleGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", billingBundle.Data) ``` ## Get User Bundles Get a paginated list of user bundles. `GET /bundle_pricing/user_bundles` ```go page, err := client.BundlePricing.UserBundles.List(context.TODO(), telnyx.BundlePricingUserBundleListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Create User Bundles Creates multiple user bundles for the user. `POST /bundle_pricing/user_bundles/bulk` ```go userBundle, err := client.BundlePricing.UserBundles.New(context.TODO(), telnyx.BundlePricingUserBundleNewParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", userBundle.Data) ``` ## Get Unused User Bundles Returns all user bundles that aren't in use. `GET /bundle_pricing/user_bundles/unused` ```go response, err := client.BundlePricing.UserBundles.ListUnused(context.TODO(), telnyx.BundlePricingUserBundleListUnusedParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Get User Bundle by Id Retrieves a user bundle by its ID. `GET /bundle_pricing/user_bundles/{user_bundle_id}` ```go userBundle, err := client.BundlePricing.UserBundles.Get( context.TODO(), "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a", telnyx.BundlePricingUserBundleGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", userBundle.Data) ``` ## Deactivate User Bundle Deactivates a user bundle by its ID. `DELETE /bundle_pricing/user_bundles/{user_bundle_id}` ```go response, err := client.BundlePricing.UserBundles.Deactivate( context.TODO(), "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a", telnyx.BundlePricingUserBundleDeactivateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Get User Bundle Resources Retrieves the resources of a user bundle by its ID. `GET /bundle_pricing/user_bundles/{user_bundle_id}/resources` ```go response, err := client.BundlePricing.UserBundles.ListResources( context.TODO(), "ca1d2263-d1f1-43ac-ba53-248e7a4bb26a", telnyx.BundlePricingUserBundleListResourcesParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## List all document links List all documents links ordered by created_at descending. `GET /document_links` ```go page, err := client.DocumentLinks.List(context.TODO(), telnyx.DocumentLinkListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## List all documents List all documents ordered by created_at descending. `GET /documents` ```go page, err := client.Documents.List(context.TODO(), telnyx.DocumentListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Upload a document Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted. `POST /documents` ```go response, err := client.Documents.UploadJson(context.TODO(), telnyx.DocumentUploadJsonParams{ Document: telnyx.DocumentUploadJsonParamsDocument{}, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## Retrieve a document Retrieve a document. `GET /documents/{id}` ```go document, err := client.Documents.Get(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", document.Data) ``` ## Update a document Update a document. `PATCH /documents/{id}` ```go document, err := client.Documents.Update( context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58", telnyx.DocumentUpdateParams{ DocServiceDocument: telnyx.DocServiceDocumentParam{}, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", document.Data) ``` ## Delete a document Delete a document.<br /><br />A document can only be deleted if it's not linked to a service. `DELETE /documents/{id}` ```go document, err := client.Documents.Delete(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", document.Data) ``` ## Download a document Download a document. `GET /documents/{id}/download` ```go response, err := client.Documents.Download(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) ``` ## Generate a temporary download link for a document Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication. `GET /documents/{id}/download_link` ```go response, err := client.Documents.GenerateDownloadLink(context.TODO(), "550e8400-e29b-41d4-a716-446655440000") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Data) ``` ## List all requirements List all requirements with filtering, sorting, and pagination `GET /requirements` ```go page, err := client.Requirements.List(context.TODO(), telnyx.RequirementListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Retrieve a document requirement Retrieve a document requirement record `GET /requirements/{id}` ```go requirement, err := client.Requirements.Get(context.TODO(), "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirement.Data) ``` ## List all requirement types List all requirement types ordered by created_at descending `GET /requirement_types` ```go requirementTypes, err := client.RequirementTypes.List(context.TODO(), telnyx.RequirementTypeListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementTypes.Data) ``` ## Retrieve a requirement types Retrieve a requirement type by id `GET /requirement_types/{id}` ```go requirementType, err := client.RequirementTypes.Get(context.TODO(), "a38c217a-8019-48f8-bff6-0fdd9939075b") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementType.Data) ``` ## Retrieve regulatory requirements `GET /regulatory_requirements` ```go regulatoryRequirement, err := client.RegulatoryRequirements.Get(context.TODO(), telnyx.RegulatoryRequirementGetParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", regulatoryRequirement.Data) ``` ## List requirement groups `GET /requirement_groups` ```go requirementGroups, err := client.RequirementGroups.List(context.TODO(), telnyx.RequirementGroupListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroups) ``` ## Create a new requirement group `POST /requirement_groups` — Required: `country_code`, `phone_number_type`, `action` ```go requirementGroup, err := client.RequirementGroups.New(context.TODO(), telnyx.RequirementGroupNewParams{ Action: telnyx.RequirementGroupNewParamsActionOrdering, CountryCode: "US", PhoneNumberType: telnyx.RequirementGroupNewParamsPhoneNumberTypeLocal, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroup.ID) ``` ## Get a single requirement group by ID `GET /requirement_groups/{id}` ```go requirementGroup, err := client.RequirementGroups.Get(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroup.ID) ``` ## Update requirement values in requirement group `PATCH /requirement_groups/{id}` ```go requirementGroup, err := client.RequirementGroups.Update( context.TODO(), "id", telnyx.RequirementGroupUpdateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroup.ID) ``` ## Delete a requirement group by ID `DELETE /requirement_groups/{id}` ```go requirementGroup, err := client.RequirementGroups.Delete(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroup.ID) ``` ## Submit a Requirement Group for Approval `POST /requirement_groups/{id}/submit_for_approval` ```go requirementGroup, err := client.RequirementGroups.SubmitForApproval(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", requirementGroup.ID) ``` ## List all Verified Numbers Gets a paginated list of Verified Numbers. `GET /verified_numbers` ```go page, err := client.VerifiedNumbers.List(context.TODO(), telnyx.VerifiedNumberListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) ``` ## Request phone number verification Initiates phone number verification procedure. `POST /verified_numbers` — Required: `phone_number`, `verification_method` ```go