Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ DomainList

Initialize the DomainList

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this resource.



20
21
22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 20

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      account_sid: 
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains.json"
end

Instance Method Details

#create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset) ⇒ DomainInstance

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

Parameters:

  • domain_name (String) (defaults to: nil) —

    The unique address you reserve on Twilio to which you route your SIP traffic

  • friendly_name (String) (defaults to: :unset) —

    A user-specified, human-readable name for the trigger.

  • auth_type (String) (defaults to: :unset) —

    The types of authentication you have mapped to your domain

  • voice_url (String) (defaults to: :unset) —

    The URL Twilio will request when this domain receives a call

  • voice_method (String) (defaults to: :unset) —

    The HTTP method to use with the voice_url

  • voice_fallback_url (String) (defaults to: :unset) —

    The URL that Twilio will use if an error occurs retrieving or executing the TwiML requested by VoiceUrl

  • voice_fallback_method (String) (defaults to: :unset) —

    The HTTP method Twilio will use when requesting the VoiceFallbackUrl

  • voice_status_callback_url (String) (defaults to: :unset) —

    The URL that Twilio will request to pass status parameters

  • voice_status_callback_method (String) (defaults to: :unset) —

    The voice_status_callback_method

  • sip_registration (Boolean) (defaults to: :unset) —

    The sip_registration

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 140

def create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset)
  data = Twilio::Values.of({
      'DomainName' => domain_name,
      'FriendlyName' => friendly_name,
      'AuthType' => auth_type,
      'VoiceUrl' => voice_url,
      'VoiceMethod' => voice_method,
      'VoiceFallbackUrl' => voice_fallback_url,
      'VoiceFallbackMethod' => voice_fallback_method,
      'VoiceStatusCallbackUrl' => voice_status_callback_url,
      'VoiceStatusCallbackMethod' => voice_status_callback_method,
      'SipRegistration' => sip_registration,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  DomainInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
  )
end

#each ⇒ Object

When passed a block, yields DomainInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 73

def each
  limits = @version.read_limits

  page = self.page(
      page_size: limits[:page_size],
  )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DomainInstance



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 111

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  DomainPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists DomainInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 41

def list(limit: nil, page_size: nil)
  self.stream(
      limit: limit,
      page_size: page_size
  ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of DomainInstance



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 92

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  DomainPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams DomainInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



59
60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 59

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



169
170
171
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 169

def to_s
  '#<Twilio.Api.V2010.DomainList>'
end