Package simplify :: Class TransactionReview
[hide private]
[frames] | no frames]

Class TransactionReview

source code

domain.Domain --+
                |
               TransactionReview

A TransactionReview object.

Instance Methods [hide private]
 
delete(self, *auth_args)
Delete this object
source code
 
update(self, *auth_args)
Updates this object
source code

Inherited from domain.Domain: __getitem__, __init__, __setitem__, __str__, class_name, to_dict

Static Methods [hide private]
 
create(params, *auth_args)
Creates an TransactionReview object
source code
 
list(criteria=None, *auth_args)
Retrieve TransactionReview objects.
source code
 
find(object_id, *auth_args)
Retrieve a TransactionReview object from the API
source code
Method Details [hide private]

create(params, *auth_args)
Static Method

source code 

Creates an TransactionReview object

Parameters:
  • params - a dict of parameters; valid keys are:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
  • private_api_key - Private key to use for the API call. If None, the value of simplify.private_key will be used.
Returns:
a TransactionReview object

delete(self, *auth_args)

source code 

Delete this object

Parameters:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.

list(criteria=None, *auth_args)
Static Method

source code 

Retrieve TransactionReview objects.

Parameters:
  • criteria - a dict of parameters; valid keys are:
    • filter Allows for ascending or descending sorting of the list.
    • max Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]
    • offset Filters to apply to the list. [min value: 0, default: 0]
    • sorting Used in paging of the list. This is the start offset of the page. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated status.
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
an object which contains the list of TransactionReview objects in the <code>list</code> property and the total number of objects available for the given criteria in the <code>total</code> property.

find(object_id, *auth_args)
Static Method

source code 

Retrieve a TransactionReview object from the API

Parameters:
  • object_id - ID of object to retrieve
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a TransactionReview object

update(self, *auth_args)

source code 

Updates this object

The properties that can be updated:

  • status Status of the transaction review.
Parameters:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a TransactionReview object.