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



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

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.

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



47
48
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 47

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,
    })

    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.



136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 136

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



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.

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.

  • 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



96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 96

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

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

    The string that identifies the Address resources to read.

  • 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



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 156

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: params)

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

#stream(customer_name: :unset, friendly_name: :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.

  • 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



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

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



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

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