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



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

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, 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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 134

def create(domain_name: nil, friendly_name: :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,
      '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.



68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 68

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.



104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 104

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.



41
42
43
 
# 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.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 85

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.



56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 56

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



158
159
160
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 158

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