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



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 28

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, street_secondary: :unset) ⇒ AddressInstance

Create the AddressInstance

Parameters:

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

    The name to associate with the new address.

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

    The number and street address of the new address.

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

    The city of the new address.

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

    The state or region of the new address.

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

    The postal code of the new address.

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

    The ISO country code of the new address.

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

    A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.

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

    Whether to enable emergency calling on the new address. Can be: true or false.

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

    Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won’t alter the address you provide.

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

    The additional number and street address of the address.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 49

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, 
    street_secondary: :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,
        'StreetSecondary' => street_secondary,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    AddressInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
    )
end

#create_with_metadata(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, street_secondary: :unset) ⇒ AddressInstance

Create the AddressInstanceMetadata

Parameters:

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

    The name to associate with the new address.

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

    The number and street address of the new address.

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

    The city of the new address.

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

    The state or region of the new address.

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

    The postal code of the new address.

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

    The ISO country code of the new address.

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

    A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.

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

    Whether to enable emergency calling on the new address. Can be: true or false.

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

    Whether we should automatically correct the address. Can be: true or false and the default is true. If empty or true, we will correct the address you provide if necessary. If false, we won’t alter the address you provide.

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

    The additional number and street address of the address.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 102

def create_with_metadata(
  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, 
  street_secondary: :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,
        'StreetSecondary' => street_secondary,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    address_instance = AddressInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
    )
    AddressInstanceMetadata.new(
        @version,
        address_instance,
        response.headers,
        response.status_code
    )
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.



237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 237

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



282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 282

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, emergency_enabled: :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 of the Address resources to read.

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

    The string that identifies the Address resources to read.

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

    Whether the address can be associated to a number for emergency calling.

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

    The ISO country code of the Address resources to read.

  • 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



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

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

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

Returns Array of up to limit results.

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 216

def list_with_metadata(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'CustomerName' => customer_name,
        'FriendlyName' => friendly_name,
        'EmergencyEnabled' => emergency_enabled,
        'IsoCountry' => iso_country,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    AddressPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(customer_name: :unset, friendly_name: :unset, emergency_enabled: :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 of the Address resources to read.

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

    The string that identifies the Address resources to read.

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

    Whether the address can be associated to a number for emergency calling.

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

    The ISO country code of the Address resources to read.

  • 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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 258

def page(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'CustomerName' => customer_name,
        'FriendlyName' => friendly_name,
        'EmergencyEnabled' => emergency_enabled,
        'IsoCountry' => iso_country,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    AddressPage.new(@version, response, @solution)
end

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

Streams Instance 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 of the Address resources to read.

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

    The string that identifies the Address resources to read.

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

    Whether the address can be associated to a number for emergency calling.

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

    The ISO country code of the Address resources to read.

  • 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



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 190

def stream(customer_name: :unset, friendly_name: :unset, emergency_enabled: :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,
        emergency_enabled: emergency_enabled,
        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



293
294
295
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 293

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