Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: AssignedAddOnExtensionContext, AssignedAddOnExtensionInstance, AssignedAddOnExtensionList, AssignedAddOnExtensionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, resource_sid, sid) ⇒ AssignedAddOnContext

Initialize the AssignedAddOnContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the resource to fetch.

  • resource_sid (String) —

    The SID of the Phone Number to which the Add-on is assigned.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the resource to fetch.



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 160

def initialize(version, , resource_sid, sid)
    super(version)

    # Path Solution
    @solution = { account_sid: , resource_sid: resource_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:resource_sid]}/AssignedAddOns/#{@solution[:sid]}.json"

    # Dependents
    @extensions = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the AssignedAddOnInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



173
174
175
176
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 173

def delete

    @version.delete('DELETE', @uri)
end

#extensions(sid = :unset) ⇒ AssignedAddOnExtensionList, AssignedAddOnExtensionContext

Access the extensions

Returns:

Raises:

  • (ArgumentError) 


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 197

def extensions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return AssignedAddOnExtensionContext.new(@version, @solution[:account_sid], @solution[:resource_sid], @solution[:sid],sid )
    end

    unless @extensions
        @extensions = AssignedAddOnExtensionList.new(
            @version, account_sid: @solution[:account_sid], resource_sid: @solution[:resource_sid], assigned_add_on_sid: @solution[:sid], )
    end

 @extensions
end

#fetch ⇒ AssignedAddOnInstance

Fetch the AssignedAddOnInstance

Returns:



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 181

def fetch

    payload = @version.fetch('GET', @uri)
    AssignedAddOnInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        resource_sid: @solution[:resource_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



222
223
224
225
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 222

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.AssignedAddOnContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



215
216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 215

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.AssignedAddOnContext #{context}>"
end