openapi

package
v1.23.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2024 License: MIT Imports: 6 Imported by: 2

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://numbers.twilio.com

Class Method HTTP request Description
HostedNumberAuthorizationDocumentsApi CreateAuthorizationDocument Post /v2/HostedNumber/AuthorizationDocuments
HostedNumberAuthorizationDocumentsApi DeleteAuthorizationDocument Delete /v2/HostedNumber/AuthorizationDocuments/{Sid}
HostedNumberAuthorizationDocumentsApi FetchAuthorizationDocument Get /v2/HostedNumber/AuthorizationDocuments/{Sid}
HostedNumberAuthorizationDocumentsApi ListAuthorizationDocument Get /v2/HostedNumber/AuthorizationDocuments
HostedNumberAuthorizationDocumentsDependentHostedNumberOrdersApi ListDependentHostedNumberOrder Get /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders
HostedNumberOrdersApi CreateHostedNumberOrder Post /v2/HostedNumber/Orders
HostedNumberOrdersApi DeleteHostedNumberOrder Delete /v2/HostedNumber/Orders/{Sid}
HostedNumberOrdersApi FetchHostedNumberOrder Get /v2/HostedNumber/Orders/{Sid}
HostedNumberOrdersApi ListHostedNumberOrder Get /v2/HostedNumber/Orders
HostedNumberOrdersApi UpdateHostedNumberOrder Post /v2/HostedNumber/Orders/{Sid}
HostedNumberOrdersBulkApi CreateBulkHostedNumberOrder Post /v2/HostedNumber/Orders/Bulk
HostedNumberOrdersBulkApi FetchBulkHostedNumberOrder Get /v2/HostedNumber/Orders/Bulk/{BulkHostingSid}
RegulatoryComplianceBundlesApi CreateBundle Post /v2/RegulatoryCompliance/Bundles
RegulatoryComplianceBundlesApi DeleteBundle Delete /v2/RegulatoryCompliance/Bundles/{Sid}
RegulatoryComplianceBundlesApi FetchBundle Get /v2/RegulatoryCompliance/Bundles/{Sid}
RegulatoryComplianceBundlesApi ListBundle Get /v2/RegulatoryCompliance/Bundles
RegulatoryComplianceBundlesApi UpdateBundle Post /v2/RegulatoryCompliance/Bundles/{Sid}
RegulatoryComplianceBundlesClonesApi CreateBundleClone Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/Clones
RegulatoryComplianceBundlesCopiesApi CreateBundleCopy Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies
RegulatoryComplianceBundlesCopiesApi ListBundleCopy Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies
RegulatoryComplianceBundlesEvaluationsApi CreateEvaluation Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations
RegulatoryComplianceBundlesEvaluationsApi FetchEvaluation Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}
RegulatoryComplianceBundlesEvaluationsApi ListEvaluation Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations
RegulatoryComplianceBundlesItemAssignmentsApi CreateItemAssignment Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
RegulatoryComplianceBundlesItemAssignmentsApi DeleteItemAssignment Delete /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
RegulatoryComplianceBundlesItemAssignmentsApi FetchItemAssignment Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}
RegulatoryComplianceBundlesItemAssignmentsApi ListItemAssignment Get /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments
RegulatoryComplianceBundlesReplaceItemsApi CreateReplaceItems Post /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems
RegulatoryComplianceEndUserTypesApi FetchEndUserType Get /v2/RegulatoryCompliance/EndUserTypes/{Sid}
RegulatoryComplianceEndUserTypesApi ListEndUserType Get /v2/RegulatoryCompliance/EndUserTypes
RegulatoryComplianceEndUsersApi CreateEndUser Post /v2/RegulatoryCompliance/EndUsers
RegulatoryComplianceEndUsersApi DeleteEndUser Delete /v2/RegulatoryCompliance/EndUsers/{Sid}
RegulatoryComplianceEndUsersApi FetchEndUser Get /v2/RegulatoryCompliance/EndUsers/{Sid}
RegulatoryComplianceEndUsersApi ListEndUser Get /v2/RegulatoryCompliance/EndUsers
RegulatoryComplianceEndUsersApi UpdateEndUser Post /v2/RegulatoryCompliance/EndUsers/{Sid}
RegulatoryComplianceRegulationsApi FetchRegulation Get /v2/RegulatoryCompliance/Regulations/{Sid}
RegulatoryComplianceRegulationsApi ListRegulation Get /v2/RegulatoryCompliance/Regulations
RegulatoryComplianceSupportingDocumentTypesApi FetchSupportingDocumentType Get /v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}
RegulatoryComplianceSupportingDocumentTypesApi ListSupportingDocumentType Get /v2/RegulatoryCompliance/SupportingDocumentTypes
RegulatoryComplianceSupportingDocumentsApi CreateSupportingDocument Post /v2/RegulatoryCompliance/SupportingDocuments
RegulatoryComplianceSupportingDocumentsApi DeleteSupportingDocument Delete /v2/RegulatoryCompliance/SupportingDocuments/{Sid}
RegulatoryComplianceSupportingDocumentsApi FetchSupportingDocument Get /v2/RegulatoryCompliance/SupportingDocuments/{Sid}
RegulatoryComplianceSupportingDocumentsApi ListSupportingDocument Get /v2/RegulatoryCompliance/SupportingDocuments
RegulatoryComplianceSupportingDocumentsApi UpdateSupportingDocument Post /v2/RegulatoryCompliance/SupportingDocuments/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateAuthorizationDocument added in v1.9.0 

func (c *ApiService) CreateAuthorizationDocument(params *CreateAuthorizationDocumentParams) (*NumbersV2AuthorizationDocument, error)

Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.

func (*ApiService) CreateBulkHostedNumberOrder added in v1.20.0 

func (c *ApiService) CreateBulkHostedNumberOrder(params *CreateBulkHostedNumberOrderParams) (*NumbersV2BulkHostedNumberOrder, error)

Host multiple phone numbers on Twilio's platform.

func (*ApiService) CreateBundle added in v0.11.0 

func (c *ApiService) CreateBundle(params *CreateBundleParams) (*NumbersV2Bundle, error)

Create a new Bundle.

func (*ApiService) CreateBundleClone added in v1.22.4 

func (c *ApiService) CreateBundleClone(BundleSid string, params *CreateBundleCloneParams) (*NumbersV2BundleClone, error)

Creates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle

func (*ApiService) CreateBundleCopy added in v0.16.0 

func (c *ApiService) CreateBundleCopy(BundleSid string, params *CreateBundleCopyParams) (*NumbersV2BundleCopy, error)

Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle

func (*ApiService) CreateEndUser added in v0.11.0 

func (c *ApiService) CreateEndUser(params *CreateEndUserParams) (*NumbersV2EndUser, error)

Create a new End User.

func (*ApiService) CreateEvaluation added in v0.11.0 

func (c *ApiService) CreateEvaluation(BundleSid string) (*NumbersV2Evaluation, error)

Creates an evaluation for a bundle

func (*ApiService) CreateHostedNumberOrder added in v1.9.0 

func (c *ApiService) CreateHostedNumberOrder(params *CreateHostedNumberOrderParams) (*NumbersV2HostedNumberOrder, error)

Host a phone number's capability on Twilio's platform.

func (*ApiService) CreateItemAssignment added in v0.11.0 

func (c *ApiService) CreateItemAssignment(BundleSid string, params *CreateItemAssignmentParams) (*NumbersV2ItemAssignment, error)

Create a new Assigned Item.

func (*ApiService) CreateReplaceItems added in v0.16.0 

func (c *ApiService) CreateReplaceItems(BundleSid string, params *CreateReplaceItemsParams) (*NumbersV2ReplaceItems, error)

Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param)

func (*ApiService) CreateSupportingDocument added in v0.11.0 

func (c *ApiService) CreateSupportingDocument(params *CreateSupportingDocumentParams) (*NumbersV2SupportingDocument, error)

Create a new Supporting Document.

func (*ApiService) DeleteAuthorizationDocument added in v1.9.0 

func (c *ApiService) DeleteAuthorizationDocument(Sid string) error

Cancel the AuthorizationDocument request.

func (*ApiService) DeleteBundle added in v0.11.0 

func (c *ApiService) DeleteBundle(Sid string) error

Delete a specific Bundle.

func (*ApiService) DeleteEndUser added in v0.11.0 

func (c *ApiService) DeleteEndUser(Sid string) error

Delete a specific End User.

func (*ApiService) DeleteHostedNumberOrder added in v1.9.0 

func (c *ApiService) DeleteHostedNumberOrder(Sid string) error

Cancel the HostedNumberOrder (only available when the status is in `received`).

func (*ApiService) DeleteItemAssignment added in v0.11.0 

func (c *ApiService) DeleteItemAssignment(BundleSid string, Sid string) error

Remove an Assignment Item Instance.

func (*ApiService) DeleteSupportingDocument added in v0.11.0 

func (c *ApiService) DeleteSupportingDocument(Sid string) error

Delete a specific Supporting Document.

func (*ApiService) FetchAuthorizationDocument added in v1.9.0 

func (c *ApiService) FetchAuthorizationDocument(Sid string) (*NumbersV2AuthorizationDocument, error)

Fetch a specific AuthorizationDocument.

func (*ApiService) FetchBulkHostedNumberOrder added in v1.12.0 

func (c *ApiService) FetchBulkHostedNumberOrder(BulkHostingSid string, params *FetchBulkHostedNumberOrderParams) (*NumbersV2BulkHostedNumberOrder, error)

Fetch a specific BulkHostedNumberOrder.

func (*ApiService) FetchBundle added in v0.11.0 

func (c *ApiService) FetchBundle(Sid string) (*NumbersV2Bundle, error)

Fetch a specific Bundle instance.

func (*ApiService) FetchEndUser added in v0.11.0 

func (c *ApiService) FetchEndUser(Sid string) (*NumbersV2EndUser, error)

Fetch specific End User Instance.

func (*ApiService) FetchEndUserType added in v0.11.0 

func (c *ApiService) FetchEndUserType(Sid string) (*NumbersV2EndUserType, error)

Fetch a specific End-User Type Instance.

func (*ApiService) FetchEvaluation added in v0.11.0 

func (c *ApiService) FetchEvaluation(BundleSid string, Sid string) (*NumbersV2Evaluation, error)

Fetch specific Evaluation Instance.

func (*ApiService) FetchHostedNumberOrder added in v1.9.0 

func (c *ApiService) FetchHostedNumberOrder(Sid string) (*NumbersV2HostedNumberOrder, error)

Fetch a specific HostedNumberOrder.

func (*ApiService) FetchItemAssignment added in v0.11.0 

func (c *ApiService) FetchItemAssignment(BundleSid string, Sid string) (*NumbersV2ItemAssignment, error)

Fetch specific Assigned Item Instance.

func (*ApiService) FetchRegulation added in v0.11.0 

func (c *ApiService) FetchRegulation(Sid string, params *FetchRegulationParams) (*NumbersV2Regulation, error)

Fetch specific Regulation Instance.

func (*ApiService) FetchSupportingDocument added in v0.11.0 

func (c *ApiService) FetchSupportingDocument(Sid string) (*NumbersV2SupportingDocument, error)

Fetch specific Supporting Document Instance.

func (*ApiService) FetchSupportingDocumentType added in v0.11.0 

func (c *ApiService) FetchSupportingDocumentType(Sid string) (*NumbersV2SupportingDocumentType, error)

Fetch a specific Supporting Document Type Instance.

func (*ApiService) ListAuthorizationDocument added in v1.9.0 

func (c *ApiService) ListAuthorizationDocument(params *ListAuthorizationDocumentParams) ([]NumbersV2AuthorizationDocument, error)

Lists AuthorizationDocument records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListBundle added in v0.11.0 

func (c *ApiService) ListBundle(params *ListBundleParams) ([]NumbersV2Bundle, error)

Lists Bundle records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListBundleCopy added in v0.20.0 

func (c *ApiService) ListBundleCopy(BundleSid string, params *ListBundleCopyParams) ([]NumbersV2BundleCopy, error)

Lists BundleCopy records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListDependentHostedNumberOrder added in v1.9.0 

func (c *ApiService) ListDependentHostedNumberOrder(SigningDocumentSid string, params *ListDependentHostedNumberOrderParams) ([]NumbersV2DependentHostedNumberOrder, error)

Lists DependentHostedNumberOrder records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEndUser added in v0.11.0 

func (c *ApiService) ListEndUser(params *ListEndUserParams) ([]NumbersV2EndUser, error)

Lists EndUser records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEndUserType added in v0.11.0 

func (c *ApiService) ListEndUserType(params *ListEndUserTypeParams) ([]NumbersV2EndUserType, error)

Lists EndUserType records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEvaluation added in v0.11.0 

func (c *ApiService) ListEvaluation(BundleSid string, params *ListEvaluationParams) ([]NumbersV2Evaluation, error)

Lists Evaluation records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListHostedNumberOrder added in v1.9.0 

func (c *ApiService) ListHostedNumberOrder(params *ListHostedNumberOrderParams) ([]NumbersV2HostedNumberOrder, error)

Lists HostedNumberOrder records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListItemAssignment added in v0.11.0 

func (c *ApiService) ListItemAssignment(BundleSid string, params *ListItemAssignmentParams) ([]NumbersV2ItemAssignment, error)

Lists ItemAssignment records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListRegulation added in v0.11.0 

func (c *ApiService) ListRegulation(params *ListRegulationParams) ([]NumbersV2Regulation, error)

Lists Regulation records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSupportingDocument added in v0.11.0 

func (c *ApiService) ListSupportingDocument(params *ListSupportingDocumentParams) ([]NumbersV2SupportingDocument, error)

Lists SupportingDocument records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSupportingDocumentType added in v0.11.0 

func (c *ApiService) ListSupportingDocumentType(params *ListSupportingDocumentTypeParams) ([]NumbersV2SupportingDocumentType, error)

Lists SupportingDocumentType records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageAuthorizationDocument added in v1.9.0 

func (c *ApiService) PageAuthorizationDocument(params *ListAuthorizationDocumentParams, pageToken, pageNumber string) (*ListAuthorizationDocumentResponse, error)

Retrieve a single page of AuthorizationDocument records from the API. Request is executed immediately.

func (*ApiService) PageBundle added in v0.13.0 

func (c *ApiService) PageBundle(params *ListBundleParams, pageToken, pageNumber string) (*ListBundleResponse, error)

Retrieve a single page of Bundle records from the API. Request is executed immediately.

func (*ApiService) PageBundleCopy added in v0.20.0 

func (c *ApiService) PageBundleCopy(BundleSid string, params *ListBundleCopyParams, pageToken, pageNumber string) (*ListBundleCopyResponse, error)

Retrieve a single page of BundleCopy records from the API. Request is executed immediately.

func (*ApiService) PageDependentHostedNumberOrder added in v1.9.0 

func (c *ApiService) PageDependentHostedNumberOrder(SigningDocumentSid string, params *ListDependentHostedNumberOrderParams, pageToken, pageNumber string) (*ListDependentHostedNumberOrderResponse, error)

Retrieve a single page of DependentHostedNumberOrder records from the API. Request is executed immediately.

func (*ApiService) PageEndUser added in v0.13.0 

func (c *ApiService) PageEndUser(params *ListEndUserParams, pageToken, pageNumber string) (*ListEndUserResponse, error)

Retrieve a single page of EndUser records from the API. Request is executed immediately.

func (*ApiService) PageEndUserType added in v0.13.0 

func (c *ApiService) PageEndUserType(params *ListEndUserTypeParams, pageToken, pageNumber string) (*ListEndUserTypeResponse, error)

Retrieve a single page of EndUserType records from the API. Request is executed immediately.

func (*ApiService) PageEvaluation added in v0.13.0 

func (c *ApiService) PageEvaluation(BundleSid string, params *ListEvaluationParams, pageToken, pageNumber string) (*ListEvaluationResponse, error)

Retrieve a single page of Evaluation records from the API. Request is executed immediately.

func (*ApiService) PageHostedNumberOrder added in v1.9.0 

func (c *ApiService) PageHostedNumberOrder(params *ListHostedNumberOrderParams, pageToken, pageNumber string) (*ListHostedNumberOrderResponse, error)

Retrieve a single page of HostedNumberOrder records from the API. Request is executed immediately.

func (*ApiService) PageItemAssignment added in v0.13.0 

func (c *ApiService) PageItemAssignment(BundleSid string, params *ListItemAssignmentParams, pageToken, pageNumber string) (*ListItemAssignmentResponse, error)

Retrieve a single page of ItemAssignment records from the API. Request is executed immediately.

func (*ApiService) PageRegulation added in v0.13.0 

func (c *ApiService) PageRegulation(params *ListRegulationParams, pageToken, pageNumber string) (*ListRegulationResponse, error)

Retrieve a single page of Regulation records from the API. Request is executed immediately.

func (*ApiService) PageSupportingDocument added in v0.13.0 

func (c *ApiService) PageSupportingDocument(params *ListSupportingDocumentParams, pageToken, pageNumber string) (*ListSupportingDocumentResponse, error)

Retrieve a single page of SupportingDocument records from the API. Request is executed immediately.

func (*ApiService) PageSupportingDocumentType added in v0.13.0 

func (c *ApiService) PageSupportingDocumentType(params *ListSupportingDocumentTypeParams, pageToken, pageNumber string) (*ListSupportingDocumentTypeResponse, error)

Retrieve a single page of SupportingDocumentType records from the API. Request is executed immediately.

func (*ApiService) StreamAuthorizationDocument added in v1.9.0 

func (c *ApiService) StreamAuthorizationDocument(params *ListAuthorizationDocumentParams) (chan NumbersV2AuthorizationDocument, chan error)

Streams AuthorizationDocument records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamBundle added in v0.13.0 

func (c *ApiService) StreamBundle(params *ListBundleParams) (chan NumbersV2Bundle, chan error)

Streams Bundle records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamBundleCopy added in v0.20.0 

func (c *ApiService) StreamBundleCopy(BundleSid string, params *ListBundleCopyParams) (chan NumbersV2BundleCopy, chan error)

Streams BundleCopy records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamDependentHostedNumberOrder added in v1.9.0 

func (c *ApiService) StreamDependentHostedNumberOrder(SigningDocumentSid string, params *ListDependentHostedNumberOrderParams) (chan NumbersV2DependentHostedNumberOrder, chan error)

Streams DependentHostedNumberOrder records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEndUser added in v0.13.0 

func (c *ApiService) StreamEndUser(params *ListEndUserParams) (chan NumbersV2EndUser, chan error)

Streams EndUser records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEndUserType added in v0.13.0 

func (c *ApiService) StreamEndUserType(params *ListEndUserTypeParams) (chan NumbersV2EndUserType, chan error)

Streams EndUserType records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEvaluation added in v0.13.0 

func (c *ApiService) StreamEvaluation(BundleSid string, params *ListEvaluationParams) (chan NumbersV2Evaluation, chan error)

Streams Evaluation records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamHostedNumberOrder added in v1.9.0 

func (c *ApiService) StreamHostedNumberOrder(params *ListHostedNumberOrderParams) (chan NumbersV2HostedNumberOrder, chan error)

Streams HostedNumberOrder records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamItemAssignment added in v0.13.0 

func (c *ApiService) StreamItemAssignment(BundleSid string, params *ListItemAssignmentParams) (chan NumbersV2ItemAssignment, chan error)

Streams ItemAssignment records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamRegulation added in v0.13.0 

func (c *ApiService) StreamRegulation(params *ListRegulationParams) (chan NumbersV2Regulation, chan error)

Streams Regulation records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSupportingDocument added in v0.13.0 

func (c *ApiService) StreamSupportingDocument(params *ListSupportingDocumentParams) (chan NumbersV2SupportingDocument, chan error)

Streams SupportingDocument records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSupportingDocumentType added in v0.13.0 

func (c *ApiService) StreamSupportingDocumentType(params *ListSupportingDocumentTypeParams) (chan NumbersV2SupportingDocumentType, chan error)

Streams SupportingDocumentType records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateBundle added in v0.11.0 

func (c *ApiService) UpdateBundle(Sid string, params *UpdateBundleParams) (*NumbersV2Bundle, error)

Updates a Bundle in an account.

func (*ApiService) UpdateEndUser added in v0.11.0 

func (c *ApiService) UpdateEndUser(Sid string, params *UpdateEndUserParams) (*NumbersV2EndUser, error)

Update an existing End User.

func (*ApiService) UpdateHostedNumberOrder added in v1.23.7 

func (c *ApiService) UpdateHostedNumberOrder(Sid string, params *UpdateHostedNumberOrderParams) (*NumbersV2HostedNumberOrder, error)

Updates a specific HostedNumberOrder.

func (*ApiService) UpdateSupportingDocument added in v0.11.0 

func (c *ApiService) UpdateSupportingDocument(Sid string, params *UpdateSupportingDocumentParams) (*NumbersV2SupportingDocument, error)

Update an existing Supporting Document.

type CreateAuthorizationDocumentParams added in v1.9.0 

type CreateAuthorizationDocumentParams struct {
	// A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
	AddressSid *string `json:"AddressSid,omitempty"`
	// Email that this AuthorizationDocument will be sent to for signing.
	Email *string `json:"Email,omitempty"`
	// The contact phone number of the person authorized to sign the Authorization Document.
	ContactPhoneNumber *string `json:"ContactPhoneNumber,omitempty"`
	// A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
	HostedNumberOrderSids *[]string `json:"HostedNumberOrderSids,omitempty"`
	// The title of the person authorized to sign the Authorization Document for this phone number.
	ContactTitle *string `json:"ContactTitle,omitempty"`
	// Email recipients who will be informed when an Authorization Document has been sent and signed.
	CcEmails *[]string `json:"CcEmails,omitempty"`
}

Optional parameters for the method 'CreateAuthorizationDocument'

func (*CreateAuthorizationDocumentParams) SetAddressSid added in v1.9.0 

func (params *CreateAuthorizationDocumentParams) SetAddressSid(AddressSid string) *CreateAuthorizationDocumentParams

func (*CreateAuthorizationDocumentParams) SetCcEmails added in v1.9.0 

func (params *CreateAuthorizationDocumentParams) SetCcEmails(CcEmails []string) *CreateAuthorizationDocumentParams

func (*CreateAuthorizationDocumentParams) SetContactPhoneNumber added in v1.9.0 

func (params *CreateAuthorizationDocumentParams) SetContactPhoneNumber(ContactPhoneNumber string) *CreateAuthorizationDocumentParams

func (*CreateAuthorizationDocumentParams) SetContactTitle added in v1.9.0 

func (params *CreateAuthorizationDocumentParams) SetContactTitle(ContactTitle string) *CreateAuthorizationDocumentParams

func (*CreateAuthorizationDocumentParams) SetEmail added in v1.9.0 

func (params *CreateAuthorizationDocumentParams) SetEmail(Email string) *CreateAuthorizationDocumentParams

func (*CreateAuthorizationDocumentParams) SetHostedNumberOrderSids added in v1.10.0 

func (params *CreateAuthorizationDocumentParams) SetHostedNumberOrderSids(HostedNumberOrderSids []string) *CreateAuthorizationDocumentParams

type CreateBulkHostedNumberOrderParams added in v1.20.0 

type CreateBulkHostedNumberOrderParams struct {
	//
	Body *map[string]interface{} `json:"body,omitempty"`
}

Optional parameters for the method 'CreateBulkHostedNumberOrder'

func (*CreateBulkHostedNumberOrderParams) SetBody added in v1.20.0 

func (params *CreateBulkHostedNumberOrderParams) SetBody(Body map[string]interface{}) *CreateBulkHostedNumberOrderParams

type CreateBundleCloneParams added in v1.22.4 

type CreateBundleCloneParams struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned.
	TargetAccountSid *string `json:"TargetAccountSid,omitempty"`
	// If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved
	MoveToDraft *bool `json:"MoveToDraft,omitempty"`
	// The string that you assigned to describe the cloned bundle.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateBundleClone'

func (*CreateBundleCloneParams) SetFriendlyName added in v1.22.4 

func (params *CreateBundleCloneParams) SetFriendlyName(FriendlyName string) *CreateBundleCloneParams

func (*CreateBundleCloneParams) SetMoveToDraft added in v1.22.4 

func (params *CreateBundleCloneParams) SetMoveToDraft(MoveToDraft bool) *CreateBundleCloneParams

func (*CreateBundleCloneParams) SetTargetAccountSid added in v1.22.4 

func (params *CreateBundleCloneParams) SetTargetAccountSid(TargetAccountSid string) *CreateBundleCloneParams

type CreateBundleCopyParams added in v0.16.0 

type CreateBundleCopyParams struct {
	// The string that you assigned to describe the copied bundle.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateBundleCopy'

func (*CreateBundleCopyParams) SetFriendlyName added in v0.16.0 

func (params *CreateBundleCopyParams) SetFriendlyName(FriendlyName string) *CreateBundleCopyParams

type CreateBundleParams 

type CreateBundleParams struct {
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"Email,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"RegulationSid,omitempty"`
	// The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	//
	EndUserType *string `json:"EndUserType,omitempty"`
	// The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
	NumberType *string `json:"NumberType,omitempty"`
	// Indicates that Bundle is a Test Bundle and will be Auto-Rejected
	IsTest *bool `json:"IsTest,omitempty"`
}

Optional parameters for the method 'CreateBundle'

func (*CreateBundleParams) SetEmail 

func (params *CreateBundleParams) SetEmail(Email string) *CreateBundleParams

func (*CreateBundleParams) SetEndUserType 

func (params *CreateBundleParams) SetEndUserType(EndUserType string) *CreateBundleParams

func (*CreateBundleParams) SetFriendlyName 

func (params *CreateBundleParams) SetFriendlyName(FriendlyName string) *CreateBundleParams

func (*CreateBundleParams) SetIsTest added in v1.22.4 

func (params *CreateBundleParams) SetIsTest(IsTest bool) *CreateBundleParams

func (*CreateBundleParams) SetIsoCountry 

func (params *CreateBundleParams) SetIsoCountry(IsoCountry string) *CreateBundleParams

func (*CreateBundleParams) SetNumberType 

func (params *CreateBundleParams) SetNumberType(NumberType string) *CreateBundleParams

func (*CreateBundleParams) SetRegulationSid 

func (params *CreateBundleParams) SetRegulationSid(RegulationSid string) *CreateBundleParams

func (*CreateBundleParams) SetStatusCallback 

func (params *CreateBundleParams) SetStatusCallback(StatusCallback string) *CreateBundleParams

type CreateEndUserParams 

type CreateEndUserParams struct {
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	//
	Type *string `json:"Type,omitempty"`
	// The set of parameters that are the attributes of the End User resource which are derived End User Types.
	Attributes *interface{} `json:"Attributes,omitempty"`
}

Optional parameters for the method 'CreateEndUser'

func (*CreateEndUserParams) SetAttributes 

func (params *CreateEndUserParams) SetAttributes(Attributes interface{}) *CreateEndUserParams

func (*CreateEndUserParams) SetFriendlyName 

func (params *CreateEndUserParams) SetFriendlyName(FriendlyName string) *CreateEndUserParams

func (*CreateEndUserParams) SetType 

func (params *CreateEndUserParams) SetType(Type string) *CreateEndUserParams

type CreateHostedNumberOrderParams added in v1.9.0 

type CreateHostedNumberOrderParams struct {
	// The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
	PhoneNumber *string `json:"PhoneNumber,omitempty"`
	// The contact phone number of the person authorized to sign the Authorization Document.
	ContactPhoneNumber *string `json:"ContactPhoneNumber,omitempty"`
	// Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
	AddressSid *string `json:"AddressSid,omitempty"`
	// Optional. Email of the owner of this phone number that is being hosted.
	Email *string `json:"Email,omitempty"`
	// This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.
	AccountSid *string `json:"AccountSid,omitempty"`
	// A 128 character string that is a human readable text that describes this resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
	CcEmails *[]string `json:"CcEmails,omitempty"`
	// The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
	SmsUrl *string `json:"SmsUrl,omitempty"`
	// The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`.  This will be copied onto the IncomingPhoneNumber resource.
	SmsMethod *string `json:"SmsMethod,omitempty"`
	// A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
	SmsFallbackUrl *string `json:"SmsFallbackUrl,omitempty"`
	// Used to specify that the SMS capability will be hosted on Twilio's platform.
	SmsCapability *bool `json:"SmsCapability,omitempty"`
	// The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
	SmsFallbackMethod *string `json:"SmsFallbackMethod,omitempty"`
	// Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
	StatusCallbackUrl *string `json:"StatusCallbackUrl,omitempty"`
	// Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
	StatusCallbackMethod *string `json:"StatusCallbackMethod,omitempty"`
	// Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
	SmsApplicationSid *string `json:"SmsApplicationSid,omitempty"`
	// The title of the person authorized to sign the Authorization Document for this phone number.
	ContactTitle *string `json:"ContactTitle,omitempty"`
}

Optional parameters for the method 'CreateHostedNumberOrder'

func (*CreateHostedNumberOrderParams) SetAccountSid added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetAccountSid(AccountSid string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetAddressSid added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetAddressSid(AddressSid string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetCcEmails added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetCcEmails(CcEmails []string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetContactPhoneNumber added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetContactPhoneNumber(ContactPhoneNumber string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetContactTitle added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetContactTitle(ContactTitle string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetEmail added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetEmail(Email string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetFriendlyName added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetFriendlyName(FriendlyName string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetPhoneNumber added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetPhoneNumber(PhoneNumber string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsApplicationSid added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsApplicationSid(SmsApplicationSid string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsCapability added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsCapability(SmsCapability bool) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsFallbackMethod added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsFallbackMethod(SmsFallbackMethod string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsFallbackUrl added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsFallbackUrl(SmsFallbackUrl string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsMethod added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsMethod(SmsMethod string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetSmsUrl added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetSmsUrl(SmsUrl string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetStatusCallbackMethod added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetStatusCallbackMethod(StatusCallbackMethod string) *CreateHostedNumberOrderParams

func (*CreateHostedNumberOrderParams) SetStatusCallbackUrl added in v1.9.0 

func (params *CreateHostedNumberOrderParams) SetStatusCallbackUrl(StatusCallbackUrl string) *CreateHostedNumberOrderParams

type CreateItemAssignmentParams 

type CreateItemAssignmentParams struct {
	// The SID of an object bag that holds information of the different items.
	ObjectSid *string `json:"ObjectSid,omitempty"`
}

Optional parameters for the method 'CreateItemAssignment'

func (*CreateItemAssignmentParams) SetObjectSid 

func (params *CreateItemAssignmentParams) SetObjectSid(ObjectSid string) *CreateItemAssignmentParams

type CreateReplaceItemsParams added in v0.16.0 

type CreateReplaceItemsParams struct {
	// The source bundle sid to copy the item assignments from.
	FromBundleSid *string `json:"FromBundleSid,omitempty"`
}

Optional parameters for the method 'CreateReplaceItems'

func (*CreateReplaceItemsParams) SetFromBundleSid added in v0.16.0 

func (params *CreateReplaceItemsParams) SetFromBundleSid(FromBundleSid string) *CreateReplaceItemsParams

type CreateSupportingDocumentParams 

type CreateSupportingDocumentParams struct {
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The type of the Supporting Document.
	Type *string `json:"Type,omitempty"`
	// The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
	Attributes *interface{} `json:"Attributes,omitempty"`
}

Optional parameters for the method 'CreateSupportingDocument'

func (*CreateSupportingDocumentParams) SetAttributes 

func (params *CreateSupportingDocumentParams) SetAttributes(Attributes interface{}) *CreateSupportingDocumentParams

func (*CreateSupportingDocumentParams) SetFriendlyName 

func (params *CreateSupportingDocumentParams) SetFriendlyName(FriendlyName string) *CreateSupportingDocumentParams

func (*CreateSupportingDocumentParams) SetType 

func (params *CreateSupportingDocumentParams) SetType(Type string) *CreateSupportingDocumentParams

type FetchBulkHostedNumberOrderParams added in v1.12.0 

type FetchBulkHostedNumberOrderParams struct {
	// Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
	OrderStatus *string `json:"OrderStatus,omitempty"`
}

Optional parameters for the method 'FetchBulkHostedNumberOrder'

func (*FetchBulkHostedNumberOrderParams) SetOrderStatus added in v1.12.0 

func (params *FetchBulkHostedNumberOrderParams) SetOrderStatus(OrderStatus string) *FetchBulkHostedNumberOrderParams

type FetchRegulationParams added in v1.22.2 

type FetchRegulationParams struct {
	// A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
	IncludeConstraints *bool `json:"IncludeConstraints,omitempty"`
}

Optional parameters for the method 'FetchRegulation'

func (*FetchRegulationParams) SetIncludeConstraints added in v1.22.2 

func (params *FetchRegulationParams) SetIncludeConstraints(IncludeConstraints bool) *FetchRegulationParams

type ListAuthorizationDocumentParams added in v1.9.0 

type ListAuthorizationDocumentParams struct {
	// Email that this AuthorizationDocument will be sent to for signing.
	Email *string `json:"Email,omitempty"`
	// Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListAuthorizationDocument'

func (*ListAuthorizationDocumentParams) SetEmail added in v1.9.0 

func (params *ListAuthorizationDocumentParams) SetEmail(Email string) *ListAuthorizationDocumentParams

func (*ListAuthorizationDocumentParams) SetLimit added in v1.9.0 

func (params *ListAuthorizationDocumentParams) SetLimit(Limit int) *ListAuthorizationDocumentParams

func (*ListAuthorizationDocumentParams) SetPageSize added in v1.9.0 

func (params *ListAuthorizationDocumentParams) SetPageSize(PageSize int) *ListAuthorizationDocumentParams

func (*ListAuthorizationDocumentParams) SetStatus added in v1.9.0 

func (params *ListAuthorizationDocumentParams) SetStatus(Status string) *ListAuthorizationDocumentParams

type ListAuthorizationDocumentResponse added in v1.9.0 

type ListAuthorizationDocumentResponse struct {
	Items []NumbersV2AuthorizationDocument      `json:"items,omitempty"`
	Meta  ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListAuthorizationDocumentResponse struct for ListAuthorizationDocumentResponse

type ListAuthorizationDocumentResponseMeta added in v1.9.0 

type ListAuthorizationDocumentResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	Key             string  `json:"key,omitempty"`
	NextPageUrl     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page,omitempty"`
	PageSize        int     `json:"page_size,omitempty"`
	PreviousPageUrl *string `json:"previous_page_url,omitempty"`
	Url             string  `json:"url,omitempty"`
}

ListAuthorizationDocumentResponseMeta struct for ListAuthorizationDocumentResponseMeta

type ListBundleCopyParams added in v0.20.0 

type ListBundleCopyParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListBundleCopy'

func (*ListBundleCopyParams) SetLimit added in v0.20.0 

func (params *ListBundleCopyParams) SetLimit(Limit int) *ListBundleCopyParams

func (*ListBundleCopyParams) SetPageSize added in v0.20.0 

func (params *ListBundleCopyParams) SetPageSize(PageSize int) *ListBundleCopyParams

type ListBundleCopyResponse added in v0.20.0 

type ListBundleCopyResponse struct {
	Results []NumbersV2BundleCopy                 `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListBundleCopyResponse struct for ListBundleCopyResponse

type ListBundleParams 

type ListBundleParams struct {
	// The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
	Status *string `json:"Status,omitempty"`
	// The string that you assigned to describe the resource. The column can contain 255 variable characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
	RegulationSid *string `json:"RegulationSid,omitempty"`
	// The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
	NumberType *string `json:"NumberType,omitempty"`
	// Indicates that the Bundle is a valid Bundle until a specified expiration date.
	HasValidUntilDate *bool `json:"HasValidUntilDate,omitempty"`
	// Can be `valid-until` or `date-updated`. Defaults to `date-created`.
	SortBy *string `json:"SortBy,omitempty"`
	// Default is `DESC`. Can be `ASC` or `DESC`.
	SortDirection *string `json:"SortDirection,omitempty"`
	// Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
	ValidUntilDate *time.Time `json:"ValidUntilDate,omitempty"`
	// Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
	ValidUntilDateBefore *time.Time `json:"ValidUntilDate&lt;,omitempty"`
	// Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
	ValidUntilDateAfter *time.Time `json:"ValidUntilDate&gt;,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListBundle'

func (*ListBundleParams) SetFriendlyName 

func (params *ListBundleParams) SetFriendlyName(FriendlyName string) *ListBundleParams

func (*ListBundleParams) SetHasValidUntilDate added in v0.21.0 

func (params *ListBundleParams) SetHasValidUntilDate(HasValidUntilDate bool) *ListBundleParams

func (*ListBundleParams) SetIsoCountry 

func (params *ListBundleParams) SetIsoCountry(IsoCountry string) *ListBundleParams

func (*ListBundleParams) SetLimit added in v0.13.0 

func (params *ListBundleParams) SetLimit(Limit int) *ListBundleParams

func (*ListBundleParams) SetNumberType 

func (params *ListBundleParams) SetNumberType(NumberType string) *ListBundleParams

func (*ListBundleParams) SetPageSize 

func (params *ListBundleParams) SetPageSize(PageSize int) *ListBundleParams

func (*ListBundleParams) SetRegulationSid 

func (params *ListBundleParams) SetRegulationSid(RegulationSid string) *ListBundleParams

func (*ListBundleParams) SetSortBy added in v0.21.0 

func (params *ListBundleParams) SetSortBy(SortBy string) *ListBundleParams

func (*ListBundleParams) SetSortDirection added in v0.21.0 

func (params *ListBundleParams) SetSortDirection(SortDirection string) *ListBundleParams

func (*ListBundleParams) SetStatus 

func (params *ListBundleParams) SetStatus(Status string) *ListBundleParams

func (*ListBundleParams) SetValidUntilDate added in v0.21.0 

func (params *ListBundleParams) SetValidUntilDate(ValidUntilDate time.Time) *ListBundleParams

func (*ListBundleParams) SetValidUntilDateAfter added in v0.21.0 

func (params *ListBundleParams) SetValidUntilDateAfter(ValidUntilDateAfter time.Time) *ListBundleParams

func (*ListBundleParams) SetValidUntilDateBefore added in v0.21.0 

func (params *ListBundleParams) SetValidUntilDateBefore(ValidUntilDateBefore time.Time) *ListBundleParams

type ListBundleResponse 

type ListBundleResponse struct {
	Results []NumbersV2Bundle                     `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListBundleResponse struct for ListBundleResponse

type ListDependentHostedNumberOrderParams added in v1.9.0 

type ListDependentHostedNumberOrderParams struct {
	// Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
	Status *string `json:"Status,omitempty"`
	// An E164 formatted phone number hosted by this HostedNumberOrder.
	PhoneNumber *string `json:"PhoneNumber,omitempty"`
	// A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
	IncomingPhoneNumberSid *string `json:"IncomingPhoneNumberSid,omitempty"`
	// A human readable description of this resource, up to 128 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListDependentHostedNumberOrder'

func (*ListDependentHostedNumberOrderParams) SetFriendlyName added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetFriendlyName(FriendlyName string) *ListDependentHostedNumberOrderParams

func (*ListDependentHostedNumberOrderParams) SetIncomingPhoneNumberSid added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetIncomingPhoneNumberSid(IncomingPhoneNumberSid string) *ListDependentHostedNumberOrderParams

func (*ListDependentHostedNumberOrderParams) SetLimit added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetLimit(Limit int) *ListDependentHostedNumberOrderParams

func (*ListDependentHostedNumberOrderParams) SetPageSize added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetPageSize(PageSize int) *ListDependentHostedNumberOrderParams

func (*ListDependentHostedNumberOrderParams) SetPhoneNumber added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetPhoneNumber(PhoneNumber string) *ListDependentHostedNumberOrderParams

func (*ListDependentHostedNumberOrderParams) SetStatus added in v1.9.0 

func (params *ListDependentHostedNumberOrderParams) SetStatus(Status string) *ListDependentHostedNumberOrderParams

type ListDependentHostedNumberOrderResponse added in v1.9.0 

type ListDependentHostedNumberOrderResponse struct {
	Items []NumbersV2DependentHostedNumberOrder `json:"items,omitempty"`
	Meta  ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListDependentHostedNumberOrderResponse struct for ListDependentHostedNumberOrderResponse

type ListEndUserParams 

type ListEndUserParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEndUser'

func (*ListEndUserParams) SetLimit added in v0.13.0 

func (params *ListEndUserParams) SetLimit(Limit int) *ListEndUserParams

func (*ListEndUserParams) SetPageSize 

func (params *ListEndUserParams) SetPageSize(PageSize int) *ListEndUserParams

type ListEndUserResponse 

type ListEndUserResponse struct {
	Results []NumbersV2EndUser                    `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListEndUserResponse struct for ListEndUserResponse

type ListEndUserTypeParams 

type ListEndUserTypeParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEndUserType'

func (*ListEndUserTypeParams) SetLimit added in v0.13.0 

func (params *ListEndUserTypeParams) SetLimit(Limit int) *ListEndUserTypeParams

func (*ListEndUserTypeParams) SetPageSize 

func (params *ListEndUserTypeParams) SetPageSize(PageSize int) *ListEndUserTypeParams

type ListEndUserTypeResponse 

type ListEndUserTypeResponse struct {
	EndUserTypes []NumbersV2EndUserType                `json:"end_user_types,omitempty"`
	Meta         ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListEndUserTypeResponse struct for ListEndUserTypeResponse

type ListEvaluationParams 

type ListEvaluationParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEvaluation'

func (*ListEvaluationParams) SetLimit added in v0.13.0 

func (params *ListEvaluationParams) SetLimit(Limit int) *ListEvaluationParams

func (*ListEvaluationParams) SetPageSize 

func (params *ListEvaluationParams) SetPageSize(PageSize int) *ListEvaluationParams

type ListEvaluationResponse 

type ListEvaluationResponse struct {
	Results []NumbersV2Evaluation                 `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListEvaluationResponse struct for ListEvaluationResponse

type ListHostedNumberOrderParams added in v1.9.0 

type ListHostedNumberOrderParams struct {
	// The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
	Status *string `json:"Status,omitempty"`
	// Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.
	SmsCapability *bool `json:"SmsCapability,omitempty"`
	// An E164 formatted phone number hosted by this HostedNumberOrder.
	PhoneNumber *string `json:"PhoneNumber,omitempty"`
	// A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
	IncomingPhoneNumberSid *string `json:"IncomingPhoneNumberSid,omitempty"`
	// A human readable description of this resource, up to 128 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListHostedNumberOrder'

func (*ListHostedNumberOrderParams) SetFriendlyName added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetFriendlyName(FriendlyName string) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetIncomingPhoneNumberSid added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetIncomingPhoneNumberSid(IncomingPhoneNumberSid string) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetLimit added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetLimit(Limit int) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetPageSize added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetPageSize(PageSize int) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetPhoneNumber added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetPhoneNumber(PhoneNumber string) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetSmsCapability added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetSmsCapability(SmsCapability bool) *ListHostedNumberOrderParams

func (*ListHostedNumberOrderParams) SetStatus added in v1.9.0 

func (params *ListHostedNumberOrderParams) SetStatus(Status string) *ListHostedNumberOrderParams

type ListHostedNumberOrderResponse added in v1.9.0 

type ListHostedNumberOrderResponse struct {
	Items []NumbersV2HostedNumberOrder          `json:"items,omitempty"`
	Meta  ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListHostedNumberOrderResponse struct for ListHostedNumberOrderResponse

type ListItemAssignmentParams 

type ListItemAssignmentParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListItemAssignment'

func (*ListItemAssignmentParams) SetLimit added in v0.13.0 

func (params *ListItemAssignmentParams) SetLimit(Limit int) *ListItemAssignmentParams

func (*ListItemAssignmentParams) SetPageSize 

func (params *ListItemAssignmentParams) SetPageSize(PageSize int) *ListItemAssignmentParams

type ListItemAssignmentResponse 

type ListItemAssignmentResponse struct {
	Results []NumbersV2ItemAssignment             `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListItemAssignmentResponse struct for ListItemAssignmentResponse

type ListRegulationParams 

type ListRegulationParams struct {
	// The type of End User the regulation requires - can be `individual` or `business`.
	EndUserType *string `json:"EndUserType,omitempty"`
	// The ISO country code of the phone number's country.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The type of phone number that the regulatory requiremnt is restricting.
	NumberType *string `json:"NumberType,omitempty"`
	// A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
	IncludeConstraints *bool `json:"IncludeConstraints,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListRegulation'

func (*ListRegulationParams) SetEndUserType 

func (params *ListRegulationParams) SetEndUserType(EndUserType string) *ListRegulationParams

func (*ListRegulationParams) SetIncludeConstraints added in v1.22.2 

func (params *ListRegulationParams) SetIncludeConstraints(IncludeConstraints bool) *ListRegulationParams

func (*ListRegulationParams) SetIsoCountry 

func (params *ListRegulationParams) SetIsoCountry(IsoCountry string) *ListRegulationParams

func (*ListRegulationParams) SetLimit added in v0.13.0 

func (params *ListRegulationParams) SetLimit(Limit int) *ListRegulationParams

func (*ListRegulationParams) SetNumberType 

func (params *ListRegulationParams) SetNumberType(NumberType string) *ListRegulationParams

func (*ListRegulationParams) SetPageSize 

func (params *ListRegulationParams) SetPageSize(PageSize int) *ListRegulationParams

type ListRegulationResponse 

type ListRegulationResponse struct {
	Results []NumbersV2Regulation                 `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListRegulationResponse struct for ListRegulationResponse

type ListSupportingDocumentParams 

type ListSupportingDocumentParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSupportingDocument'

func (*ListSupportingDocumentParams) SetLimit added in v0.13.0 

func (params *ListSupportingDocumentParams) SetLimit(Limit int) *ListSupportingDocumentParams

func (*ListSupportingDocumentParams) SetPageSize 

func (params *ListSupportingDocumentParams) SetPageSize(PageSize int) *ListSupportingDocumentParams

type ListSupportingDocumentResponse 

type ListSupportingDocumentResponse struct {
	Results []NumbersV2SupportingDocument         `json:"results,omitempty"`
	Meta    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListSupportingDocumentResponse struct for ListSupportingDocumentResponse

type ListSupportingDocumentTypeParams 

type ListSupportingDocumentTypeParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSupportingDocumentType'

func (*ListSupportingDocumentTypeParams) SetLimit added in v0.13.0 

func (params *ListSupportingDocumentTypeParams) SetLimit(Limit int) *ListSupportingDocumentTypeParams

func (*ListSupportingDocumentTypeParams) SetPageSize 

func (params *ListSupportingDocumentTypeParams) SetPageSize(PageSize int) *ListSupportingDocumentTypeParams

type ListSupportingDocumentTypeResponse 

type ListSupportingDocumentTypeResponse struct {
	SupportingDocumentTypes []NumbersV2SupportingDocumentType     `json:"supporting_document_types,omitempty"`
	Meta                    ListAuthorizationDocumentResponseMeta `json:"meta,omitempty"`
}

ListSupportingDocumentTypeResponse struct for ListSupportingDocumentTypeResponse

type NumbersV2AuthorizationDocument added in v1.9.0 

type NumbersV2AuthorizationDocument struct {
	// A 34 character string that uniquely identifies this AuthorizationDocument.
	Sid *string `json:"sid,omitempty"`
	// A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
	AddressSid *string `json:"address_sid,omitempty"`
	Status     *string `json:"status,omitempty"`
	// Email that this AuthorizationDocument will be sent to for signing.
	Email *string `json:"email,omitempty"`
	// Email recipients who will be informed when an Authorization Document has been sent and signed.
	CcEmails *[]string `json:"cc_emails,omitempty"`
	// The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time              `json:"date_updated,omitempty"`
	Url         *string                 `json:"url,omitempty"`
	Links       *map[string]interface{} `json:"links,omitempty"`
}

NumbersV2AuthorizationDocument struct for NumbersV2AuthorizationDocument

type NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities added in v1.9.0 

type NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities struct {
	Mms   bool `json:"mms,omitempty"`
	Sms   bool `json:"sms,omitempty"`
	Voice bool `json:"voice,omitempty"`
	Fax   bool `json:"fax,omitempty"`
}

NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities A mapping of capabilities this hosted phone number will have enabled on Twilio's platform.

type NumbersV2BulkHostedNumberOrder added in v1.12.0 

type NumbersV2BulkHostedNumberOrder struct {
	// A 34 character string that uniquely identifies this BulkHostedNumberOrder.
	BulkHostingSid *string `json:"bulk_hosting_sid,omitempty"`
	RequestStatus  *string `json:"request_status,omitempty"`
	// A 128 character string that is a human-readable text that describes this resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// Email address used for send notifications about this Bulk hosted number request.
	NotificationEmail *string `json:"notification_email,omitempty"`
	// The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this resource was completed, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateCompleted *time.Time `json:"date_completed,omitempty"`
	// The URL of this BulkHostedNumberOrder resource.
	Url *string `json:"url,omitempty"`
	// The total count of phone numbers in this Bulk hosting request.
	TotalCount int `json:"total_count,omitempty"`
	// Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
	Results *[]interface{} `json:"results,omitempty"`
}

NumbersV2BulkHostedNumberOrder struct for NumbersV2BulkHostedNumberOrder

type NumbersV2Bundle added in v0.14.0 

type NumbersV2Bundle struct {
	// The unique string that we created to identify the Bundle resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
	ValidUntil *time.Time `json:"valid_until,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"email,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Bundle resource.
	Url *string `json:"url,omitempty"`
	// The URLs of the Assigned Items of the Bundle resource.
	Links *map[string]interface{} `json:"links,omitempty"`
}

NumbersV2Bundle struct for NumbersV2Bundle

type NumbersV2BundleClone added in v1.22.4 

type NumbersV2BundleClone struct {
	// The unique string that we created to identify the Bundle resource.
	BundleSid *string `json:"bundle_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
	ValidUntil *time.Time `json:"valid_until,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"email,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2BundleClone struct for NumbersV2BundleClone

type NumbersV2BundleCopy added in v0.16.0 

type NumbersV2BundleCopy struct {
	// The unique string that we created to identify the Bundle resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
	ValidUntil *time.Time `json:"valid_until,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"email,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

NumbersV2BundleCopy struct for NumbersV2BundleCopy

type NumbersV2DependentHostedNumberOrder added in v1.9.0 

type NumbersV2DependentHostedNumberOrder struct {
	// A 34 character string that uniquely identifies this Authorization Document
	Sid *string `json:"sid,omitempty"`
	// A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.
	BulkHostingRequestSid *string `json:"bulk_hosting_request_sid,omitempty"`
	// The next step you need to take to complete the hosted number order and request it successfully.
	NextStep *string `json:"next_step,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
	IncomingPhoneNumberSid *string `json:"incoming_phone_number_sid,omitempty"`
	// A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
	AddressSid *string `json:"address_sid,omitempty"`
	// A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.
	SigningDocumentSid *string `json:"signing_document_sid,omitempty"`
	// An E164 formatted phone number hosted by this HostedNumberOrder.
	PhoneNumber  *string                                                               `json:"phone_number,omitempty"`
	Capabilities *NumbersV2AuthorizationDocumentDependentHostedNumberOrderCapabilities `json:"capabilities,omitempty"`
	// A human readable description of this resource, up to 128 characters.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// A message that explains why a hosted_number_order went to status \"action-required\"
	FailureReason *string `json:"failure_reason,omitempty"`
	// The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Email of the owner of this phone number that is being hosted.
	Email *string `json:"email,omitempty"`
	// Email recipients who will be informed when an Authorization Document has been sent and signed
	CcEmails *[]string `json:"cc_emails,omitempty"`
	// The title of the person authorized to sign the Authorization Document for this phone number.
	ContactTitle *string `json:"contact_title,omitempty"`
	// The contact phone number of the person authorized to sign the Authorization Document.
	ContactPhoneNumber *string `json:"contact_phone_number,omitempty"`
}

NumbersV2DependentHostedNumberOrder struct for NumbersV2DependentHostedNumberOrder

type NumbersV2EndUser added in v0.14.0 

type NumbersV2EndUser struct {
	// The unique string created by Twilio to identify the End User resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the End User resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Type         *string `json:"type,omitempty"`
	// The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.
	Attributes *interface{} `json:"attributes,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the End User resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2EndUser struct for NumbersV2EndUser

type NumbersV2EndUserType added in v0.14.0 

type NumbersV2EndUserType struct {
	// The unique string that identifies the End-User Type resource.
	Sid *string `json:"sid,omitempty"`
	// A human-readable description that is assigned to describe the End-User Type resource. Examples can include first name, last name, email, business name, etc
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A machine-readable description of the End-User Type resource. Examples can include first_name, last_name, email, business_name, etc.
	MachineName *string `json:"machine_name,omitempty"`
	// The required information for creating an End-User. The required fields will change as regulatory needs change and will differ for businesses and individuals.
	Fields *[]interface{} `json:"fields,omitempty"`
	// The absolute URL of the End-User Type resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2EndUserType struct for NumbersV2EndUserType

type NumbersV2Evaluation added in v0.14.0 

type NumbersV2Evaluation struct {
	// The unique string that identifies the Evaluation resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The unique string that we created to identify the Bundle resource.
	BundleSid *string `json:"bundle_sid,omitempty"`
	Status    *string `json:"status,omitempty"`
	// The results of the Evaluation which includes the valid and invalid attributes.
	Results     *[]interface{} `json:"results,omitempty"`
	DateCreated *time.Time     `json:"date_created,omitempty"`
	Url         *string        `json:"url,omitempty"`
}

NumbersV2Evaluation struct for NumbersV2Evaluation

type NumbersV2HostedNumberOrder added in v1.9.0 

type NumbersV2HostedNumberOrder struct {
	// A 34 character string that uniquely identifies this HostedNumberOrder.
	Sid *string `json:"sid,omitempty"`
	// A 34 character string that uniquely identifies the account.
	AccountSid *string `json:"account_sid,omitempty"`
	// A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the phone number being hosted.
	IncomingPhoneNumberSid *string `json:"incoming_phone_number_sid,omitempty"`
	// A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
	AddressSid *string `json:"address_sid,omitempty"`
	// A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource) the user needs to sign.
	SigningDocumentSid *string `json:"signing_document_sid,omitempty"`
	// Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212
	PhoneNumber  *string                                 `json:"phone_number,omitempty"`
	Capabilities *NumbersV2HostedNumberOrderCapabilities `json:"capabilities,omitempty"`
	// A 128 character string that is a human-readable text that describes this resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// A message that explains why a hosted_number_order went to status \"action-required\"
	FailureReason *string `json:"failure_reason,omitempty"`
	// The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// Email of the owner of this phone number that is being hosted.
	Email *string `json:"email,omitempty"`
	// A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.
	CcEmails *[]string `json:"cc_emails,omitempty"`
	// The URL of this HostedNumberOrder.
	Url *string `json:"url,omitempty"`
	// The title of the person authorized to sign the Authorization Document for this phone number.
	ContactTitle *string `json:"contact_title,omitempty"`
	// The contact phone number of the person authorized to sign the Authorization Document.
	ContactPhoneNumber *string `json:"contact_phone_number,omitempty"`
	// A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.
	BulkHostingRequestSid *string `json:"bulk_hosting_request_sid,omitempty"`
	// The next step you need to take to complete the hosted number order and request it successfully.
	NextStep *string `json:"next_step,omitempty"`
	// The number of attempts made to verify ownership via a call for the hosted phone number.
	VerificationAttempts int `json:"verification_attempts,omitempty"`
	// The Call SIDs that identify the calls placed to verify ownership.
	VerificationCallSids *[]string `json:"verification_call_sids,omitempty"`
	// The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
	VerificationCallDelay int `json:"verification_call_delay,omitempty"`
	// The numerical extension to dial when making the ownership verification call.
	VerificationCallExtension *string `json:"verification_call_extension,omitempty"`
	// The digits the user must pass in the ownership verification call.
	VerificationCode *string `json:"verification_code,omitempty"`
	VerificationType *string `json:"verification_type,omitempty"`
}

NumbersV2HostedNumberOrder struct for NumbersV2HostedNumberOrder

type NumbersV2HostedNumberOrderCapabilities added in v1.9.0 

type NumbersV2HostedNumberOrderCapabilities struct {
	Mms   bool `json:"mms,omitempty"`
	Sms   bool `json:"sms,omitempty"`
	Voice bool `json:"voice,omitempty"`
	Fax   bool `json:"fax,omitempty"`
}

NumbersV2HostedNumberOrderCapabilities Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported.

type NumbersV2ItemAssignment added in v0.14.0 

type NumbersV2ItemAssignment struct {
	// The unique string that we created to identify the Item Assignment resource.
	Sid *string `json:"sid,omitempty"`
	// The unique string that we created to identify the Bundle resource.
	BundleSid *string `json:"bundle_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of an object bag that holds information of the different items.
	ObjectSid *string `json:"object_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The absolute URL of the Identity resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2ItemAssignment struct for NumbersV2ItemAssignment

type NumbersV2Regulation added in v0.14.0 

type NumbersV2Regulation struct {
	// The unique string that identifies the Regulation resource.
	Sid *string `json:"sid,omitempty"`
	// A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The ISO country code of the phone number's country.
	IsoCountry *string `json:"iso_country,omitempty"`
	// The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung.
	NumberType  *string `json:"number_type,omitempty"`
	EndUserType *string `json:"end_user_type,omitempty"`
	// The SID of an object that holds the regulatory information of the phone number country, phone number type, and end user type.
	Requirements *interface{} `json:"requirements,omitempty"`
	// The absolute URL of the Regulation resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2Regulation struct for NumbersV2Regulation

type NumbersV2ReplaceItems added in v0.16.0 

type NumbersV2ReplaceItems struct {
	// The unique string that we created to identify the Bundle resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string of a regulation that is associated to the Bundle resource.
	RegulationSid *string `json:"regulation_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	// The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
	ValidUntil *time.Time `json:"valid_until,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"email,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"status_callback,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

NumbersV2ReplaceItems struct for NumbersV2ReplaceItems

type NumbersV2SupportingDocument added in v0.14.0 

type NumbersV2SupportingDocument struct {
	// The unique string created by Twilio to identify the Supporting Document resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The image type uploaded in the Supporting Document container.
	MimeType *string `json:"mime_type,omitempty"`
	Status   *string `json:"status,omitempty"`
	// The failure reason of the Supporting Document Resource.
	FailureReason *string `json:"failure_reason,omitempty"`
	// A list of errors that occurred during the registering RC Bundle
	Errors *[]interface{} `json:"errors,omitempty"`
	// The type of the Supporting Document.
	Type *string `json:"type,omitempty"`
	// The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.
	Attributes *interface{} `json:"attributes,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Supporting Document resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2SupportingDocument struct for NumbersV2SupportingDocument

type NumbersV2SupportingDocumentType added in v0.14.0 

type NumbersV2SupportingDocumentType struct {
	// The unique string that identifies the Supporting Document Type resource.
	Sid *string `json:"sid,omitempty"`
	// A human-readable description of the Supporting Document Type resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The machine-readable description of the Supporting Document Type resource.
	MachineName *string `json:"machine_name,omitempty"`
	// The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals.
	Fields *[]interface{} `json:"fields,omitempty"`
	// The absolute URL of the Supporting Document Type resource.
	Url *string `json:"url,omitempty"`
}

NumbersV2SupportingDocumentType struct for NumbersV2SupportingDocumentType

type UpdateBundleParams 

type UpdateBundleParams struct {
	//
	Status *string `json:"Status,omitempty"`
	// The URL we call to inform your application of status changes.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The email address that will receive updates when the Bundle resource changes status.
	Email *string `json:"Email,omitempty"`
}

Optional parameters for the method 'UpdateBundle'

func (*UpdateBundleParams) SetEmail 

func (params *UpdateBundleParams) SetEmail(Email string) *UpdateBundleParams

func (*UpdateBundleParams) SetFriendlyName 

func (params *UpdateBundleParams) SetFriendlyName(FriendlyName string) *UpdateBundleParams

func (*UpdateBundleParams) SetStatus 

func (params *UpdateBundleParams) SetStatus(Status string) *UpdateBundleParams

func (*UpdateBundleParams) SetStatusCallback 

func (params *UpdateBundleParams) SetStatusCallback(StatusCallback string) *UpdateBundleParams

type UpdateEndUserParams 

type UpdateEndUserParams struct {
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The set of parameters that are the attributes of the End User resource which are derived End User Types.
	Attributes *interface{} `json:"Attributes,omitempty"`
}

Optional parameters for the method 'UpdateEndUser'

func (*UpdateEndUserParams) SetAttributes 

func (params *UpdateEndUserParams) SetAttributes(Attributes interface{}) *UpdateEndUserParams

func (*UpdateEndUserParams) SetFriendlyName 

func (params *UpdateEndUserParams) SetFriendlyName(FriendlyName string) *UpdateEndUserParams

type UpdateHostedNumberOrderParams added in v1.23.7 

type UpdateHostedNumberOrderParams struct {
	//
	Status *string `json:"Status,omitempty"`
	// The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
	VerificationCallDelay *int `json:"VerificationCallDelay,omitempty"`
	// The numerical extension to dial when making the ownership verification call.
	VerificationCallExtension *string `json:"VerificationCallExtension,omitempty"`
}

Optional parameters for the method 'UpdateHostedNumberOrder'

func (*UpdateHostedNumberOrderParams) SetStatus added in v1.23.7 

func (params *UpdateHostedNumberOrderParams) SetStatus(Status string) *UpdateHostedNumberOrderParams

func (*UpdateHostedNumberOrderParams) SetVerificationCallDelay added in v1.23.7 

func (params *UpdateHostedNumberOrderParams) SetVerificationCallDelay(VerificationCallDelay int) *UpdateHostedNumberOrderParams

func (*UpdateHostedNumberOrderParams) SetVerificationCallExtension added in v1.23.7 

func (params *UpdateHostedNumberOrderParams) SetVerificationCallExtension(VerificationCallExtension string) *UpdateHostedNumberOrderParams

type UpdateSupportingDocumentParams 

type UpdateSupportingDocumentParams struct {
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.
	Attributes *interface{} `json:"Attributes,omitempty"`
}

Optional parameters for the method 'UpdateSupportingDocument'

func (*UpdateSupportingDocumentParams) SetAttributes 

func (params *UpdateSupportingDocumentParams) SetAttributes(Attributes interface{}) *UpdateSupportingDocumentParams

func (*UpdateSupportingDocumentParams) SetFriendlyName 

func (params *UpdateSupportingDocumentParams) SetFriendlyName(FriendlyName string) *UpdateSupportingDocumentParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.