Class: Simplify::Plan

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

Overview

A Plan object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#private_key ⇒ Object

Private key used to access the API.



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

def private_key
  @private_key
end

#public_key ⇒ Object

Public key used to access the API.



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

def public_key
  @public_key
end

Class Method Details

.create(parms, public_key = nil, private_key = nil) ⇒ Object

Creates an Plan object

parms

a hash of parameters; valid keys are:

  • amount Amount of payment for the plan in minor units. Example: 1000 = 10.00 required

  • currency Currency code (ISO-4217) for the plan. Must match the currency associated with your account. required default:USD

  • frequency Frequency of payment for the plan. Example: Monthly required

  • name Name of the plan required

public_key

Public to use for the API call. If nil, the value of Simplify::public_key will be used.

private_key

Private key to use for the API call. If nil, the value of Simplify::private_key will be used.

Returns a Plan object.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/simplify/plan.rb', line 54

def self.create(parms, public_key = nil, private_key = nil)
    if public_key == nil then
        public_key = Simplify::public_key
    end
    if private_key == nil then
        private_key = Simplify::private_key
    end

    h = Simplify::PaymentsApi.execute("plan", 'create', parms, public_key, private_key)
    obj = Plan.new()
    obj.public_key = public_key
    obj.private_key = private_key
    obj = obj.merge(h)
    obj
end

.find(id, public_key = nil, private_key = nil) ⇒ Object

Retrieve a Plan object from the API

id

ID of object to retrieve

public_key

Public to use for the API call. If nil, the value of Simplify::public_key will be used.

private_key

Private key to use for the API call. If nil, the value of Simplify::private_key will be used.

Returns a Plan object.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/simplify/plan.rb', line 111

def self.find(id, public_key = nil, private_key = nil)
    if public_key == nil then
         public_key = Simplify::public_key
    end
    if private_key == nil then
        private_key = Simplify::private_key
    end

    h = Simplify::PaymentsApi.execute("plan", 'show', {"id" => id}, public_key, private_key)
    obj = Plan.new()
    obj.public_key = public_key
    obj.private_key = private_key
    obj = obj.merge(h)
    obj
end

.list(criteria = nil, public_key = nil, private_key = nil) ⇒ Object

Retrieve Plan 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. default:20

  • offset Used in paging of the list. This is the start offset of the page. 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 amount frequency name id.

public_key

Public to use for the API call. If nil, the value of Simplify::public_key will be used.

private_key

Private key to use for the API call. If nil, the value of Simplify::private_key will be used.

Returns an object where the list property contains the list of Plan objects and the total property contains the total number of Plan objects available for the given criteria.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/simplify/plan.rb', line 87

def self.list(criteria = nil, public_key = nil, private_key = nil)

    if public_key == nil then
        public_key = Simplify::public_key
    end
    if private_key == nil then
       private_key = Simplify::private_key
    end

    h = Simplify::PaymentsApi.execute("plan", 'list', criteria, public_key, private_key)
    obj = Plan.new()
    obj.public_key = public_key
    obj.private_key = private_key
    obj = obj.merge(h)
    obj

end

Instance Method Details

#delete ⇒ Object

Delete this object



71
72
73
74
75
 
# File 'lib/simplify/plan.rb', line 71

def delete()
    h = Simplify::PaymentsApi.execute("plan", 'delete', self, self.public_key, self.private_key)
    self.merge!(h)
    self
end

#update ⇒ Object

Updates this object

The properties that can be updated:

  • name Name of the plan. (required)



131
132
133
134
135
 
# File 'lib/simplify/plan.rb', line 131

def update()
      h = Simplify::PaymentsApi.execute("plan", 'update', self, self.public_key, self.private_key)
      self.merge!(h)
      self
end