Class: Twilio::REST::Voice::V1::ByocTrunkList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ByocTrunkList

Initialize the ByocTrunkList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/ByocTrunks"
end

Instance Method Details

#create(friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset) ⇒ ByocTrunkInstance

Create the ByocTrunkInstance



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 56

def create(friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'VoiceUrl' => voice_url,
      'VoiceMethod' => voice_method,
      'VoiceFallbackUrl' => voice_fallback_url,
      'VoiceFallbackMethod' => voice_fallback_method,
      'StatusCallbackUrl' => status_callback_url,
      'StatusCallbackMethod' => status_callback_method,
      'CnamLookupEnabled' => cnam_lookup_enabled,
      'ConnectionPolicySid' => connection_policy_sid,
      'FromDomainSid' => from_domain_sid,
  })

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

  ByocTrunkInstance.new(@version, payload, )
end

#each ⇒ Object

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 113

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 ByocTrunkInstance records from the API. Request is executed immediately.



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 147

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

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

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



86
87
88
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 86

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 ByocTrunkInstance records from the API. Request is executed immediately.



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 130

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: params)

  ByocTrunkPage.new(@version, response, @solution)
end

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

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



101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 101

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



157
158
159
 
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 157

def to_s
  '#<Twilio.Voice.V1.ByocTrunkList>'
end