module Simpal::Order
@see Simpal::API::Orders
Public Class Methods
Capture the payment for an order.
@see Simpal::API::Orders.capture
@param id [String] The ID of an existing order. @param params [Hash] The parameters for the capture request. @param headers [Hash] The custom headers to add to the request. @param client [Simpal::Client] The API
client to make the request with. @return [Hash] A Hash representing the order.
# File lib/simpal/order.rb, line 70 def self.capture(id, params = {}, headers: {}, client: nil) resource = API::Orders.capture(id, params, headers: headers, client: client) PayPalObject.new(resource) end
Create an order.
@see Simpal::API::Orders.create
@param params [Hash] The parameters for the create request. @param headers [Hash] The custom headers to add to the request. @param client [Simpal::Client] The API
client to make the request with. @return [Simpal::PayPalObject] An object representing the order.
# File lib/simpal/order.rb, line 15 def self.create(params = {}, headers: {}, client: nil) resource = API::Orders.create(params, headers: headers, client: client) PayPalObject.new(resource) end
Retrieve an order.
@see Simpal::API::Orders.retrieve
@param id [String] The ID of an existing order. @param headers [Hash] The custom headers to add to the request. @param client [Simpal::Client] The API
client to make the request with. @return [Hash] A Hash representing the order.
# File lib/simpal/order.rb, line 42 def self.retrieve(id, headers: {}, client: nil) resource = API::Orders.retrieve(id, headers: headers, client: client) PayPalObject.new(resource) end
Update an order.
@see Simpal::API::Orders.update
@param id [String] The ID of an existing order. @param params [Array<Hash>] The collection of patches to apply to the order. @param headers [Hash] The custom headers to add to the request. @param client [Simpal::Client] The API
client to make the request with. @return [Boolean] `true` if the order was updated, else an exception is raised.
# File lib/simpal/order.rb, line 29 def self.update(id, params = [], headers: {}, client: nil) API::Orders.update(id, params, headers: headers, client: client) true end