Class: Twilio::REST::Trunking::V1::TrunkList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TrunkList

Initialize the TrunkList

Parameters:

  • version (Version) —

    Version that contains the resource



16
17
18
19
20
21
22
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 16

def initialize(version)
  super(version)

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

Instance Method Details

#create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset) ⇒ TrunkInstance

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

Parameters:

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

    A human-readable name for the Trunk.

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

    The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ‘-` and must always end with `pstn.twilio.com`. See [Termination Settings](www.twilio.com/docs/sip-trunking/getting-started#termination) for more information.

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

    The HTTP URL that Twilio will request if an error occurs while sending SIP traffic towards your configured Origination URL. Twilio will retrieve TwiML from this URL and execute those instructions like any other normal TwiML call. See [Disaster Recovery](www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information.

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

    The HTTP method Twilio will use when requesting the ‘DisasterRecoveryUrl`. Either `GET` or `POST`.

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

    The recording settings for this trunk. If turned on, all calls going through this trunk will be recorded and the recording can either start when the call is ringing or when the call is answered. See [Recording](www.twilio.com/docs/sip-trunking/getting-started#recording) for more information.

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

    The Secure Trunking settings for this trunk. If turned on, all calls going through this trunk will be secure using SRTP for media and TLS for signalling. If turned off, then RTP will be used for media. See [Secure Trunking](www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information.

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 50

def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'DomainName' => domain_name,
      'DisasterRecoveryUrl' => disaster_recovery_url,
      'DisasterRecoveryMethod' => disaster_recovery_method,
      'Recording' => recording,
      'Secure' => secure,
  })

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

  TrunkInstance.new(@version, payload, )
end

#each ⇒ Object

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



107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 107

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TrunkInstance



143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 143

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

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

Lists TrunkInstance 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



80
81
82
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 80

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 TrunkInstance 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 TrunkInstance



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 124

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
  )
  TrunkPage.new(@version, response, @solution)
end

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

Streams TrunkInstance 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



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

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



153
154
155
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 153

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