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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The account_sid



18
19
20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 18

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.

Parameters:

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

    The customer_name

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

    The street

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

    The city

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

    The region

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

    The postal_code

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

    The iso_country

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

    The friendly_name

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

    The emergency_enabled

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

    The auto_correct_address

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 41

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.



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 122

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AddressInstance



166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 166

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.

Parameters:

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

    The customer_name

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

    The friendly_name

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

    The iso_country

  • 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



81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 81

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.

Parameters:

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

    The customer_name

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

    The friendly_name

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

    The iso_country

  • 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 AddressInstance



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 144

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.

Parameters:

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

    The customer_name

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

    The friendly_name

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

    The iso_country

  • 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



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 105

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



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

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