Class: Twilio::REST::Api::V2010::AccountContext::CallContext::PaymentContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Api::V2010::AccountContext::CallContext::PaymentContext

Defined in:

lib/twilio-ruby/rest/api/v2010/account/call/payment.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

Instance Method Summary

• #initialize(version, account_sid, call_sid, sid) ⇒ PaymentContext constructor

  Initialize the PaymentContext.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset) ⇒ PaymentInstance

  Update the PaymentInstance.

Constructor Details

#initialize(version, account_sid, call_sid, sid) ⇒ PaymentContext

Initialize the PaymentContext

Parameters:

• version (Version) —

  Version that contains the resource

• account_sid (String) —

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

• call_sid (String) —

  The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.

• sid (String) —

  The SID of Payments session that needs to be updated.

# File 'lib/twilio-ruby/rest/api/v2010/account/call/payment.rb', line 121

def initialize(version, account_sid, call_sid, sid)
    super(version)

    # Path Solution
    @solution = { account_sid: account_sid, call_sid: call_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Payments/#{@solution[:sid]}.json"

    
end

Instance Method Details

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/call/payment.rb', line 171

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

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/call/payment.rb', line 164

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

#update(idempotency_key: nil, status_callback: nil, capture: :unset, status: :unset) ⇒ PaymentInstance

Update the PaymentInstance

Parameters:

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

  A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.

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

  Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.

• capture (Capture) (defaults to: :unset)
• status (Status) (defaults to: :unset)

Returns:

• (PaymentInstance) —

  Updated PaymentInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/call/payment.rb', line 137

def update(
    idempotency_key: nil, 
    status_callback: nil, 
    capture: :unset, 
    status: :unset
)

    data = Twilio::Values.of({
        'IdempotencyKey' => idempotency_key,
        'StatusCallback' => status_callback,
        'Capture' => capture,
        'Status' => status,
    })

    payload = @version.update('POST', @uri, data: data)
    PaymentInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        call_sid: @solution[:call_sid],
        sid: @solution[:sid],
    )
end