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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The trunk_sid



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

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

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

Parameters:

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

    The weight

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

    The priority

  • enabled (Boolean) (defaults to: nil) —

    The enabled

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

    The friendly_name

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

    The sip_url

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 37

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.



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 102

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of OriginationUrlInstance



140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 140

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.

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



70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 70

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.

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 OriginationUrlInstance



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 121

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

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



88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 88

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



150
151
152
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb', line 150

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