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 that contains the resource



28
29
30
31
32
33
34
 
# 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:

  • (defaults to: nil)

    The name to associate with the new address.

  • (defaults to: nil)

    The number and street address of the new address.

  • (defaults to: nil)

    The city of the new address.

  • (defaults to: nil)

    The state or region of the new address.

  • (defaults to: nil)

    The postal code of the new address.

  • (defaults to: nil)

    The ISO country code of the new address.

  • (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.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    The additional number and street address of the address.

Returns:

  • Created AddressInstance



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
80
81
82
83
84
85
86
 
# 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, 
    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

#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.



147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 147

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:

  • API-generated URL for the requested results page

Returns:

  • Page of AddressInstance



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

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:

  • (defaults to: :unset)

    The ‘customer_name` of the Address resources to read.

  • (defaults to: :unset)

    The string that identifies the Address resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    The ISO country code of the Address resources to read.

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



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

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

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

  • (defaults to: :unset)

    The ‘customer_name` of the Address resources to read.

  • (defaults to: :unset)

    The string that identifies the Address resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    The ISO country code of the Address resources to read.

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of AddressInstance



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 168

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:

  • (defaults to: :unset)

    The ‘customer_name` of the Address resources to read.

  • (defaults to: :unset)

    The string that identifies the Address resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    The ISO country code of the Address resources to read.

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 that will yield up to limit results



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

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



203
204
205
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 203

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