Class: Twilio::REST::Trunking::V1::TrunkContext::OriginationUrlList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, trunk_sid: nil) ⇒ OriginationUrlList

Initialize the OriginationUrlList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 20

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

  # Path Solution
  @solution = {trunk_sid: trunk_sid}
  @uri = "/Trunks/#{@solution[:trunk_sid]}/OriginationUrls"
end

Instance Method Details

#create(weight: nil, priority: nil, enabled: nil, friendly_name: nil, sip_url: nil) ⇒ OriginationUrlInstance

Create the OriginationUrlInstance



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 43

def create(weight: nil, priority: nil, enabled: nil, friendly_name: nil, sip_url: nil)
  data = Twilio::Values.of({
      'Weight' => weight,
      'Priority' => priority,
      'Enabled' => enabled,
      'FriendlyName' => friendly_name,
      'SipUrl' => sip_url,
  })

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

  OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
end

#each ⇒ Object

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



95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 95

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



129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 129

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

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

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



68
69
70
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 68

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



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 112

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)

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

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

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



83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 83

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



139
140
141
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 139

def to_s
  '#<Twilio.Trunking.V1.OriginationUrlList>'
end