domain

Documentation

Overview

Package domain contains auto-generated files. DO NOT MODIFY

Package domain contains auto-generated files. DO NOT MODIFY

Package domain contains auto-generated files. DO NOT MODIFY

Package domain contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchDomainResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchDomainResponse, error)
  • func (c Client) Update(input *UpdateDomainInput) (*UpdateDomainResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateDomainInput) (*UpdateDomainResponse, error)
• type ClientProperties
• type FetchDomainResponse
• type UpdateDomainInput
• type UpdateDomainResponse

Types

type Client

type Client struct {
	Auth *auth.Client
	// contains filtered or unexported fields
}

Client for managing a specific SIP domain resource

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the domain client

func (Client) Delete

func (c Client) Delete() error

Delete removes a SIP domain resource from the account See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#delete-a-sipdomain-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a SIP domain resource from the account See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#delete-a-sipdomain-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchDomainResponse, error)

Fetch retrieves a SIP domain resource See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#fetch-a-sipdomain-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchDomainResponse, error)

FetchWithContext retrieves a SIP domain resource See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#fetch-a-sipdomain-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateDomainInput) (*UpdateDomainResponse, error)

Update modifies a SIP domain resource See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#update-a-sipdomain-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateDomainInput) (*UpdateDomainResponse, error)

UpdateWithContext modifies a SIP domain resource See https://www.twilio.com/docs/voice/sip/api/sip-domain-resource#update-a-sipdomain-resource for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
	Sid        string
}

ClientProperties are the properties required to manage the domain resources

type FetchDomainResponse

type FetchDomainResponse struct {
	AccountSid                string             `json:"account_sid"`
	ApiVersion                string             `json:"api_version"`
	AuthType                  *string            `json:"auth_type,omitempty"`
	ByocTrunkSid              *string            `json:"byoc_trunk_sid,omitempty"`
	DateCreated               utils.RFC2822Time  `json:"date_created"`
	DateUpdated               *utils.RFC2822Time `json:"date_updated,omitempty"`
	DomainName                string             `json:"domain_name"`
	EmergencyCallerSid        *string            `json:"emergency_caller_sid,omitempty"`
	EmergencyCallingEnabled   bool               `json:"emergency_calling_enabled"`
	FriendlyName              *string            `json:"friendly_name,omitempty"`
	Secure                    bool               `json:"secure"`
	Sid                       string             `json:"sid"`
	SipRegistration           bool               `json:"sip_registration"`
	VoiceFallbackMethod       *string            `json:"voice_fallback_method,omitempty"`
	VoiceFallbackURL          *string            `json:"voice_fallback_url,omitempty"`
	VoiceMethod               *string            `json:"voice_method,omitempty"`
	VoiceStatusCallbackMethod *string            `json:"voice_status_callback_method,omitempty"`
	VoiceStatusCallbackURL    *string            `json:"voice_status_callback_url,omitempty"`
	VoiceURL                  *string            `json:"voice_url,omitempty"`
}

FetchDomainResponse defines the response fields for retrieving a SIP domain

type UpdateDomainInput

type UpdateDomainInput struct {
	ByocTrunkSid              *string `form:"ByocTrunkSid,omitempty"`
	DomainName                *string `form:"DomainName,omitempty"`
	EmergencyCallerSid        *string `form:"EmergencyCallerSid,omitempty"`
	EmergencyCallingEnabled   *bool   `form:"EmergencyCallingEnabled,omitempty"`
	FriendlyName              *string `form:"FriendlyName,omitempty"`
	Secure                    *bool   `form:"Secure,omitempty"`
	SipRegistration           *bool   `form:"SipRegistration,omitempty"`
	VoiceFallbackMethod       *string `form:"VoiceFallbackMethod,omitempty"`
	VoiceFallbackURL          *string `form:"VoiceFallbackUrl,omitempty"`
	VoiceMethod               *string `form:"VoiceMethod,omitempty"`
	VoiceStatusCallbackMethod *string `form:"VoiceStatusCallbackMethod,omitempty"`
	VoiceStatusCallbackURL    *string `form:"VoiceStatusCallbackUrl,omitempty"`
	VoiceURL                  *string `form:"VoiceUrl,omitempty"`
}

UpdateDomainInput defines input fields for updating a SIP domain

type UpdateDomainResponse

type UpdateDomainResponse struct {
	AccountSid                string             `json:"account_sid"`
	ApiVersion                string             `json:"api_version"`
	AuthType                  *string            `json:"auth_type,omitempty"`
	ByocTrunkSid              *string            `json:"byoc_trunk_sid,omitempty"`
	DateCreated               utils.RFC2822Time  `json:"date_created"`
	DateUpdated               *utils.RFC2822Time `json:"date_updated,omitempty"`
	DomainName                string             `json:"domain_name"`
	EmergencyCallerSid        *string            `json:"emergency_caller_sid,omitempty"`
	EmergencyCallingEnabled   bool               `json:"emergency_calling_enabled"`
	FriendlyName              *string            `json:"friendly_name,omitempty"`
	Secure                    bool               `json:"secure"`
	Sid                       string             `json:"sid"`
	SipRegistration           bool               `json:"sip_registration"`
	VoiceFallbackMethod       *string            `json:"voice_fallback_method,omitempty"`
	VoiceFallbackURL          *string            `json:"voice_fallback_url,omitempty"`
	VoiceMethod               *string            `json:"voice_method,omitempty"`
	VoiceStatusCallbackMethod *string            `json:"voice_status_callback_method,omitempty"`
	VoiceStatusCallbackURL    *string            `json:"voice_status_callback_url,omitempty"`
	VoiceURL                  *string            `json:"voice_url,omitempty"`
}

UpdateDomainResponse defines the response fields for the updated SIP domain