Method: Simplify::Webhook.list

Defined in:
lib/simplify/webhook.rb

.list(criteria = nil, *auth) ⇒ Object

Retrieve Webhook objects.

criteria

a hash of parameters; valid keys are:

  • filter Filters to apply to the list.

  • 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 (either asc for ascending or desc for descending). Sortable properties are: dateCreated.

auth

Authentication information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::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 Webhook objects and the total property contains the total number of Webhook objects available for the given criteria.



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/simplify/webhook.rb', line 92

def self.list(criteria = nil, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("webhook", 'list', criteria, auth_obj)
    obj = Webhook.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj

end