Class: Simplify::Webhook

Inherits:
Hash
  • Object
show all
Defined in:
lib/simplify/webhook.rb

Overview

A Webhook object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#authentication ⇒ Object

Authentication object used to access the API (See Simplify::Authentication for details)



37
38
39
 
# File 'lib/simplify/webhook.rb', line 37

def authentication
  @authentication
end

Class Method Details

.create(parms, *auth) ⇒ Object

Creates an Webhook object

parms

a hash of parameters; valid keys are:

  • url Endpoint URL required

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 a Webhook object.



66
67
68
69
70
71
72
73
74
 
# File 'lib/simplify/webhook.rb', line 66

def self.create(parms, *auth)

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

.find(id, *auth) ⇒ Object

Retrieve a Webhook 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 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 a Webhook object.



108
109
110
111
112
113
114
115
116
 
# File 'lib/simplify/webhook.rb', line 108

def self.find(id, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("webhook", 'show', {"id" => id}, auth_obj)
    obj = Webhook.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

.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

Instance Method Details

#delete ⇒ Object

Delete this object



77
78
79
80
81
 
# File 'lib/simplify/webhook.rb', line 77

def delete()
    h = Simplify::PaymentsApi.execute("webhook", 'delete', self, self.authentication)
    self.merge!(h)
    self
end

#private_key ⇒ Object

Returns the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.



50
51
52
 
# File 'lib/simplify/webhook.rb', line 50

def private_key
    return self.authentication.private_key
end

#private_key=(k) ⇒ Object

Sets the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.



55
56
57
 
# File 'lib/simplify/webhook.rb', line 55

def private_key=(k)
    return self.authentication.private_key = k
end

#public_key ⇒ Object

Returns the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.



40
41
42
 
# File 'lib/simplify/webhook.rb', line 40

def public_key
    return self.authentication.public_key
end

#public_key=(k) ⇒ Object

Sets the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.



45
46
47
 
# File 'lib/simplify/webhook.rb', line 45

def public_key=(k)
    return self.authentication.public_key = k
end

#update ⇒ Object

Updates this object

The properties that can be updated:

  • url Endpoint URL (required)



122
123
124
125
126
 
# File 'lib/simplify/webhook.rb', line 122

def update()
      h = Simplify::PaymentsApi.execute("webhook", 'update', self, self.authentication)
      self.merge!(h)
      self
end