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



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



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

    
    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.



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

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.



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

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.



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

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.



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

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.



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

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



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

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