class Simplify::TransactionReview
A TransactionReview
object.
Attributes
Authentication
object used to access the API (See Simplify::Authentication
for details)
Public Class Methods
Creates an TransactionReview
object
- parms
-
a hash of parameters; valid keys are:
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a TransactionReview
object.
# File lib/simplify/transactionreview.rb, line 65 def self.create(parms, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("transactionReview", 'create', parms, auth_obj) obj = TransactionReview.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Retrieve a TransactionReview
object from the API
- id
-
ID of object to retrieve
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns a TransactionReview
object.
# File lib/simplify/transactionreview.rb, line 107 def self.find(id, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("transactionReview", 'show', {"id" => id}, auth_obj) obj = TransactionReview.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Retrieve TransactionReview
objects.
- criteria
-
a hash of parameters; valid keys are:
-
filter
<table class=“filter_list”><tr><td>filter.id</td><td>Filter by the Id of the transaction review</td></tr><tr><td>filter.label</td><td>Filter by the status of the transaction review</td></tr></table> -
max
Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] -
offset
Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0] -
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (eitherasc
for ascending ordesc
for descending). Sortable properties are:dateCreated status
.
- auth
-
Authentication
information used for the API call. If no value is passed the global keysSimplify::public_key
andSimplify::private_key
are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.
Returns an object where the list
property contains the list of TransactionReview
objects and the total
property contains the total number of TransactionReview
objects available for the given criteria.
# File lib/simplify/transactionreview.rb, line 91 def self.list(criteria = nil, *auth) auth_obj = Simplify::PaymentsApi.create_auth_object(auth) h = Simplify::PaymentsApi.execute("transactionReview", 'list', criteria, auth_obj) obj = TransactionReview.new() obj.authentication = auth_obj obj = obj.merge!(h) obj end
Public Instance Methods
Delete this object
# File lib/simplify/transactionreview.rb, line 76 def delete() h = Simplify::PaymentsApi.execute("transactionReview", 'delete', self, self.authentication) self.merge!(h) self end
Returns the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/transactionreview.rb, line 50 def private_key return self.authentication.private_key end
Sets the private key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/transactionreview.rb, line 55 def private_key=(k) return self.authentication.private_key = k end
Returns the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/transactionreview.rb, line 40 def public_key return self.authentication.public_key end
Sets the public key used when accessing this object. Deprecated: please use 'authentication' instead.
# File lib/simplify/transactionreview.rb, line 45 def public_key=(k) return self.authentication.public_key = k end
Updates this object
The properties that can be updated:
-
status
Status of the transaction review.
# File lib/simplify/transactionreview.rb, line 121 def update() h = Simplify::PaymentsApi.execute("transactionReview", 'update', self, self.authentication) self.merge!(h) self end