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



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.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 34

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.



91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 91

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.



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

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.



64
65
66
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 64

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.



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

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.



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

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



137
138
139
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 137

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