Documentation ¶
Overview ¶
Package ip_addresses contains auto-generated files. DO NOT MODIFY
Package ip_addresses contains auto-generated files. DO NOT MODIFY
Package ip_addresses contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c Client) Create(input *CreateIpAddressInput) (*CreateIpAddressResponse, error)
- func (c Client) CreateWithContext(context context.Context, input *CreateIpAddressInput) (*CreateIpAddressResponse, error)
- func (c *Client) NewIpAddressesPaginator() *IpAddressesPaginator
- func (c *Client) NewIpAddressesPaginatorWithOptions(options *IpAddressesPageOptions) *IpAddressesPaginator
- func (c Client) Page(options *IpAddressesPageOptions) (*IpAddressesPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *IpAddressesPageOptions) (*IpAddressesPageResponse, error)
- type ClientProperties
- type CreateIpAddressInput
- type CreateIpAddressResponse
- type IpAddressesPage
- type IpAddressesPageOptions
- type IpAddressesPageResponse
- type IpAddressesPaginator
- type PageIpAddressResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for managing IP address resources
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the ip addresses client
func (Client) Create ¶
func (c Client) Create(input *CreateIpAddressInput) (*CreateIpAddressResponse, error)
Create creates a IP address resource See https://www.twilio.com/docs/voice/sip/api/sip-ipaddress-resource#create-a-sip-ipaddress-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) CreateWithContext ¶
func (c Client) CreateWithContext(context context.Context, input *CreateIpAddressInput) (*CreateIpAddressResponse, error)
CreateWithContext creates a IP address resource See https://www.twilio.com/docs/voice/sip/api/sip-ipaddress-resource#create-a-sip-ipaddress-resource for more details
func (*Client) NewIpAddressesPaginator ¶
func (c *Client) NewIpAddressesPaginator() *IpAddressesPaginator
NewIpAddressesPaginator creates a new instance of the paginator for Page.
func (*Client) NewIpAddressesPaginatorWithOptions ¶
func (c *Client) NewIpAddressesPaginatorWithOptions(options *IpAddressesPageOptions) *IpAddressesPaginator
NewIpAddressesPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *IpAddressesPageOptions) (*IpAddressesPageResponse, error)
Page retrieves a page of IP addresses See https://www.twilio.com/docs/voice/sip/api/sip-ipaddress-resource#read-multiple-sip-ipaddress-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (Client) PageWithContext ¶
func (c Client) PageWithContext(context context.Context, options *IpAddressesPageOptions) (*IpAddressesPageResponse, error)
PageWithContext retrieves a page of IP addresses See https://www.twilio.com/docs/voice/sip/api/sip-ipaddress-resource#read-multiple-sip-ipaddress-resources for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the ip addresses resources
type CreateIpAddressInput ¶
type CreateIpAddressInput struct { CidrPrefixLength *int `form:"CidrPrefixLength,omitempty"` FriendlyName string `validate:"required" form:"FriendlyName"` IpAddress string `validate:"required" form:"IpAddress"` }
CreateIpAddressInput defines input fields for creating a new IP address resource
type CreateIpAddressResponse ¶
type CreateIpAddressResponse struct { AccountSid string `json:"account_sid"` CidrPrefixLength int `json:"cidr_prefix_length"` DateCreated utils.RFC2822Time `json:"date_created"` DateUpdated *utils.RFC2822Time `json:"date_updated,omitempty"` FriendlyName string `json:"friendly_name"` IpAccessControlListSid string `json:"ip_access_control_list_sid"` IpAddress string `json:"ip_address"` Sid string `json:"sid"` }
CreateIpAddressResponse defines the response fields for creating a new IP address resource
type IpAddressesPage ¶
type IpAddressesPage struct { CurrentPage *IpAddressesPageResponse Error error // contains filtered or unexported fields }
IpAddressesPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageIpAddressResponse or error that is returned from the api call(s)
type IpAddressesPageOptions ¶
IpAddressesPageOptions defines the query options for the api operation
type IpAddressesPageResponse ¶
type IpAddressesPageResponse struct { End int `json:"end"` FirstPageURI string `json:"first_page_uri"` IpAddresses []PageIpAddressResponse `json:"ip_addresses"` NextPageURI *string `json:"next_page_uri,omitempty"` Page int `json:"page"` PageSize int `json:"page_size"` PreviousPageURI *string `json:"previous_page_uri,omitempty"` Start int `json:"start"` URI string `json:"uri"` }
IpAddressesPageResponse defines the response fields for the IP addresses page
type IpAddressesPaginator ¶
type IpAddressesPaginator struct { Page *IpAddressesPage IpAddresses []PageIpAddressResponse // contains filtered or unexported fields }
IpAddressesPaginator defines the fields for makings paginated api calls IpAddresses is an array of ipaddresses that have been returned from all of the page calls
func (*IpAddressesPaginator) CurrentPage ¶
func (p *IpAddressesPaginator) CurrentPage() *IpAddressesPageResponse
CurrentPage retrieves the results for the current page
func (*IpAddressesPaginator) Error ¶
func (p *IpAddressesPaginator) Error() error
Error retrieves the error returned from the page
func (*IpAddressesPaginator) Next ¶
func (p *IpAddressesPaginator) Next() bool
Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information
func (*IpAddressesPaginator) NextWithContext ¶
func (p *IpAddressesPaginator) NextWithContext(context context.Context) bool
NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate
type PageIpAddressResponse ¶
type PageIpAddressResponse struct { AccountSid string `json:"account_sid"` CidrPrefixLength int `json:"cidr_prefix_length"` DateCreated utils.RFC2822Time `json:"date_created"` DateUpdated *utils.RFC2822Time `json:"date_updated,omitempty"` FriendlyName string `json:"friendly_name"` IpAccessControlListSid string `json:"ip_access_control_list_sid"` IpAddress string `json:"ip_address"` Sid string `json:"sid"` }