Class: Twilio::REST::Api::V2010::AccountContext::AddressList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/address.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ AddressList

Initialize the AddressList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 22

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/Addresses.json"
end

Instance Method Details

#create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: :unset, emergency_enabled: :unset, auto_correct_address: :unset) ⇒ AddressInstance

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 48

def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
  data = Twilio::Values.of({
      'CustomerName' => customer_name,
      'Street' => street,
      'City' => city,
      'Region' => region,
      'PostalCode' => postal_code,
      'IsoCountry' => iso_country,
      'FriendlyName' => friendly_name,
      'EmergencyEnabled' => emergency_enabled,
      'AutoCorrectAddress' => auto_correct_address,
  })

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

  AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end

#each ⇒ Object

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



131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 131

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



176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 176

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

#list(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil) ⇒ Array

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



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 87

def list(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil)
  self.stream(
      customer_name: customer_name,
      friendly_name: friendly_name,
      iso_country: iso_country,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(customer_name: :unset, friendly_name: :unset, iso_country: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 154

def page(customer_name: :unset, friendly_name: :unset, iso_country: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'CustomerName' => customer_name,
      'FriendlyName' => friendly_name,
      'IsoCountry' => iso_country,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  AddressPage.new(@version, response, @solution)
end

#stream(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 114

def stream(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      customer_name: customer_name,
      friendly_name: friendly_name,
      iso_country: iso_country,
      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



186
187
188
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 186

def to_s
  '#<Twilio.Api.V2010.AddressList>'
end