simplify 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/simplify.rb +1 -1
- data/lib/simplify/accesstoken.rb +1 -1
- data/lib/simplify/apiexception.rb +1 -1
- data/lib/simplify/authentication.rb +1 -1
- data/lib/simplify/cardtoken.rb +14 -14
- data/lib/simplify/chargeback.rb +5 -5
- data/lib/simplify/constants.rb +2 -2
- data/lib/simplify/coupon.rb +14 -14
- data/lib/simplify/customer.rb +39 -36
- data/lib/simplify/deposit.rb +5 -5
- data/lib/simplify/event.rb +1 -1
- data/lib/simplify/invoice.rb +6 -6
- data/lib/simplify/invoiceitem.rb +11 -11
- data/lib/simplify/payment.rb +22 -22
- data/lib/simplify/paymentsapi.rb +1 -1
- data/lib/simplify/plan.rb +9 -9
- data/lib/simplify/refund.rb +8 -8
- data/lib/simplify/subscription.rb +21 -21
- data/lib/simplify/webhook.rb +5 -5
- metadata +58 -69
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a1c589251e08371d193bb548a973013d52c1b980
|
4
|
+
data.tar.gz: 8e07fc3b3e393bfc3c3947bc0d43581af463b249
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6b1f05b61d3afc92dc0b915629bc285d3e254cf91574612b081ba16af022333ba1623839cec3c6df145f7b39cfd5374c8879cd3590462dcebfc8fc0b7a2b371f
|
7
|
+
data.tar.gz: 1c94feb45597d15c9745f7201b2b88fe22ffe056ea4089d750767f1dbe1c5f04e9ba5942dd922138342d21ebf9dc2936531e40200f9bf563dcc6c3f234da57d6
|
data/lib/simplify.rb
CHANGED
data/lib/simplify/accesstoken.rb
CHANGED
data/lib/simplify/cardtoken.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,19 +60,19 @@ class CardToken < Hash
|
|
60
60
|
# Creates an CardToken object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>callback</code> The URL callback for the cardtoken
|
64
|
-
# * <code>card => addressCity</code> City of the cardholder.
|
65
|
-
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
|
66
|
-
# * <code>card => addressLine1</code> Address of the cardholder.
|
67
|
-
# * <code>card => addressLine2</code> Address of the cardholder if needed.
|
68
|
-
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder.
|
69
|
-
# * <code>card => addressZip</code> Postal code of the cardholder.
|
70
|
-
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
71
|
-
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 <b>required </b>
|
72
|
-
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 <b>required </b>
|
73
|
-
# * <code>card => name</code> Name as appears on the card.
|
74
|
-
# * <code>card => number</code> Card number as it appears on the card. <b>required </b>
|
75
|
-
# * <code>key</code> Key used to create the card token.
|
63
|
+
# * <code>callback</code> The URL callback for the cardtoken
|
64
|
+
# * <code>card => addressCity</code> City of the cardholder. [max length: 50, min length: 2]
|
65
|
+
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
|
66
|
+
# * <code>card => addressLine1</code> Address of the cardholder. [max length: 255]
|
67
|
+
# * <code>card => addressLine2</code> Address of the cardholder if needed. [max length: 255]
|
68
|
+
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
|
69
|
+
# * <code>card => addressZip</code> Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers. [max length: 9, min length: 3]
|
70
|
+
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
71
|
+
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
|
72
|
+
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 [max value: 99] <b>required </b>
|
73
|
+
# * <code>card => name</code> Name as appears on the card. [max length: 50, min length: 2]
|
74
|
+
# * <code>card => number</code> Card number as it appears on the card. [max length: 19, min length: 13] <b>required </b>
|
75
|
+
# * <code>key</code> Key used to create the card token.
|
76
76
|
# 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.
|
77
77
|
# Returns a CardToken object.
|
78
78
|
def self.create(parms, *auth)
|
data/lib/simplify/chargeback.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -59,10 +59,10 @@ class Chargeback < Hash
|
|
59
59
|
|
60
60
|
# Retrieve Chargeback objects.
|
61
61
|
# criteria:: a hash of parameters; valid keys are:
|
62
|
-
# * <code>filter</code> Filters to apply to the list.
|
63
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
64
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
65
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code>.
|
62
|
+
# * <code>filter</code> Filters to apply to the list.
|
63
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
64
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
65
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code>.
|
66
66
|
# 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.
|
67
67
|
# Returns an object where the <code>list</code> property contains the list of Chargeback objects and the <code>total</code>
|
68
68
|
# property contains the total number of Chargeback objects available for the given criteria.
|
data/lib/simplify/constants.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -30,7 +30,7 @@ module Simplify
|
|
30
30
|
# Constants.
|
31
31
|
class Constants
|
32
32
|
|
33
|
-
@@version = '1.1.
|
33
|
+
@@version = '1.1.1'
|
34
34
|
@@api_base_live_url = 'https://api.simplify.com/v1/api'
|
35
35
|
@@api_base_sandbox_url = 'https://sandbox.simplify.com/v1/api'
|
36
36
|
@@oauth_base_url = 'https://www.simplify.com/commerce/oauth';
|
data/lib/simplify/coupon.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,13 +60,13 @@ class Coupon < Hash
|
|
60
60
|
# Creates an Coupon object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amountOff</code> Amount off of the price of the product in minor units in the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 1000 = 10.00
|
64
|
-
# * <code>couponCode</code> Code that identifies the coupon to be used. <b>required </b>
|
65
|
-
# * <code>description</code> A brief section that describes the coupon.
|
66
|
-
# * <code>durationInMonths</code> Duration in months that the coupon will be applied after it has first been selected.
|
67
|
-
# * <code>endDate</code> Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.
|
68
|
-
# * <code>maxRedemptions</code> Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time.
|
69
|
-
# * <code>percentOff</code> Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number.
|
63
|
+
# * <code>amountOff</code> Amount off of the price of the product in minor units in the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 1000 = 10.00 [min value: 1, max value: 99999999]
|
64
|
+
# * <code>couponCode</code> Code that identifies the coupon to be used. [min length: 2] <b>required </b>
|
65
|
+
# * <code>description</code> A brief section that describes the coupon.
|
66
|
+
# * <code>durationInMonths</code> Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]
|
67
|
+
# * <code>endDate</code> Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.
|
68
|
+
# * <code>maxRedemptions</code> Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]
|
69
|
+
# * <code>percentOff</code> Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. [min value: 1, max value: 100]
|
70
70
|
# * <code>startDate</code> First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. <b>required </b>
|
71
71
|
# 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.
|
72
72
|
# Returns a Coupon object.
|
@@ -89,10 +89,10 @@ class Coupon < Hash
|
|
89
89
|
|
90
90
|
# Retrieve Coupon objects.
|
91
91
|
# criteria:: a hash of parameters; valid keys are:
|
92
|
-
# * <code>filter</code> Filters to apply to the list.
|
93
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
94
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
95
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> maxRedemptions</code><code> timesRedeemed</code><code> id</code><code> startDate</code><code> endDate</code><code> percentOff</code><code> couponCode</code><code> durationInMonths</code><code> amountOff</code>.
|
92
|
+
# * <code>filter</code> Filters to apply to the list.
|
93
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
94
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
95
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> maxRedemptions</code><code> timesRedeemed</code><code> id</code><code> startDate</code><code> endDate</code><code> percentOff</code><code> couponCode</code><code> durationInMonths</code><code> amountOff</code>.
|
96
96
|
# 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.
|
97
97
|
# Returns an object where the <code>list</code> property contains the list of Coupon objects and the <code>total</code>
|
98
98
|
# property contains the total number of Coupon objects available for the given criteria.
|
@@ -125,8 +125,8 @@ class Coupon < Hash
|
|
125
125
|
# Updates this object
|
126
126
|
#
|
127
127
|
# The properties that can be updated:
|
128
|
-
# * <code>endDate</code> The ending date in UTC millis for the coupon. This must be after the starting date of the coupon.
|
129
|
-
# * <code>maxRedemptions</code> Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time.
|
128
|
+
# * <code>endDate</code> The ending date in UTC millis for the coupon. This must be after the starting date of the coupon.
|
129
|
+
# * <code>maxRedemptions</code> Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]
|
130
130
|
def update()
|
131
131
|
h = Simplify::PaymentsApi.execute("coupon", 'update', self, self.authentication)
|
132
132
|
self.merge!(h)
|
data/lib/simplify/customer.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,29 +60,30 @@ class Customer < Hash
|
|
60
60
|
# Creates an Customer object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>card => addressCity</code> City of the cardholder.
|
64
|
-
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
|
65
|
-
# * <code>card => addressLine1</code> Address of the cardholder
|
66
|
-
# * <code>card => addressLine2</code> Address of the cardholder if needed.
|
67
|
-
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder.
|
68
|
-
# * <code>card => addressZip</code> Postal code of the cardholder.
|
69
|
-
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
63
|
+
# * <code>card => addressCity</code> City of the cardholder. <b>required </b>
|
64
|
+
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. <b>required </b>
|
65
|
+
# * <code>card => addressLine1</code> Address of the cardholder <b>required </b>
|
66
|
+
# * <code>card => addressLine2</code> Address of the cardholder if needed. <b>required </b>
|
67
|
+
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. <b>required </b>
|
68
|
+
# * <code>card => addressZip</code> Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers. <b>required </b>
|
69
|
+
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123 <b>required </b>
|
70
70
|
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 <b>required </b>
|
71
71
|
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 <b>required </b>
|
72
|
-
# * <code>card =>
|
73
|
-
# * <code>card =>
|
72
|
+
# * <code>card => id</code> ID of card. Unused during customer create.
|
73
|
+
# * <code>card => name</code> Name as appears on the card. <b>required </b>
|
74
|
+
# * <code>card => number</code> Card number as it appears on the card. [max length: 19, min length: 13]
|
74
75
|
# * <code>email</code> Email address of the customer <b>required </b>
|
75
|
-
# * <code>name</code> Customer name <b>required </b>
|
76
|
-
# * <code>reference</code> Reference field for external applications use.
|
77
|
-
# * <code>subscriptions => amount</code> Amount of payment in minor units. Example: 1000 = 10.00
|
78
|
-
# * <code>subscriptions => coupon</code> Coupon associated with the subscription for the customer.
|
79
|
-
# * <code>subscriptions => currency</code> Currency code (ISO-4217). Must match the currency associated with your account.
|
80
|
-
# * <code>subscriptions => customer</code> The customer ID to create the subscription for. Do not supply this when creating a customer.
|
81
|
-
# * <code>subscriptions => frequency</code> Frequency of payment for the plan. Example: Monthly
|
82
|
-
# * <code>subscriptions => name</code> Name describing subscription
|
83
|
-
# * <code>subscriptions => plan</code> The plan ID that the subscription should be created from.
|
84
|
-
# * <code>subscriptions => quantity</code> Quantity of the plan for the subscription.
|
85
|
-
# * <code>token</code> If specified, card associated with card token will be used
|
76
|
+
# * <code>name</code> Customer name [min length: 2] <b>required </b>
|
77
|
+
# * <code>reference</code> Reference field for external applications use.
|
78
|
+
# * <code>subscriptions => amount</code> Amount of payment in minor units. Example: 1000 = 10.00 [min value: 50, max value: 99999999]
|
79
|
+
# * <code>subscriptions => coupon</code> Coupon associated with the subscription for the customer.
|
80
|
+
# * <code>subscriptions => currency</code> Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
|
81
|
+
# * <code>subscriptions => customer</code> The customer ID to create the subscription for. Do not supply this when creating a customer.
|
82
|
+
# * <code>subscriptions => frequency</code> Frequency of payment for the plan. Example: Monthly
|
83
|
+
# * <code>subscriptions => name</code> Name describing subscription
|
84
|
+
# * <code>subscriptions => plan</code> The plan ID that the subscription should be created from.
|
85
|
+
# * <code>subscriptions => quantity</code> Quantity of the plan for the subscription. [min value: 1]
|
86
|
+
# * <code>token</code> If specified, card associated with card token will be used
|
86
87
|
# 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.
|
87
88
|
# Returns a Customer object.
|
88
89
|
def self.create(parms, *auth)
|
@@ -104,10 +105,10 @@ class Customer < Hash
|
|
104
105
|
|
105
106
|
# Retrieve Customer objects.
|
106
107
|
# criteria:: a hash of parameters; valid keys are:
|
107
|
-
# * <code>filter</code> Filters to apply to the list.
|
108
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
109
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
110
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> id</code><code> name</code><code> email</code><code> reference</code>.
|
108
|
+
# * <code>filter</code> Filters to apply to the list.
|
109
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
110
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
111
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> id</code><code> name</code><code> email</code><code> reference</code>.
|
111
112
|
# 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.
|
112
113
|
# Returns an object where the <code>list</code> property contains the list of Customer objects and the <code>total</code>
|
113
114
|
# property contains the total number of Customer objects available for the given criteria.
|
@@ -140,20 +141,22 @@ class Customer < Hash
|
|
140
141
|
# Updates this object
|
141
142
|
#
|
142
143
|
# The properties that can be updated:
|
143
|
-
# * <code>card => addressCity</code> City of the cardholder.
|
144
|
-
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
|
145
|
-
# * <code>card => addressLine1</code> Address of the cardholder.
|
146
|
-
# * <code>card => addressLine2</code> Address of the cardholder if needed.
|
147
|
-
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder.
|
148
|
-
# * <code>card => addressZip</code> Postal code of the cardholder.
|
149
|
-
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
144
|
+
# * <code>card => addressCity</code> City of the cardholder. <b>(required)</b>
|
145
|
+
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. <b>(required)</b>
|
146
|
+
# * <code>card => addressLine1</code> Address of the cardholder. <b>(required)</b>
|
147
|
+
# * <code>card => addressLine2</code> Address of the cardholder if needed. <b>(required)</b>
|
148
|
+
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. <b>(required)</b>
|
149
|
+
# * <code>card => addressZip</code> Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers. <b>(required)</b>
|
150
|
+
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123 <b>(required)</b>
|
150
151
|
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 <b>(required)</b>
|
151
152
|
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 <b>(required)</b>
|
152
|
-
# * <code>card =>
|
153
|
-
# * <code>card =>
|
153
|
+
# * <code>card => id</code> ID of card. If present, card details for the customer will not be updated. If not present, the customer will be updated with the supplied card details.
|
154
|
+
# * <code>card => name</code> Name as appears on the card. <b>(required)</b>
|
155
|
+
# * <code>card => number</code> Card number as it appears on the card. [max length: 19, min length: 13]
|
154
156
|
# * <code>email</code> Email address of the customer <b>(required)</b>
|
155
|
-
# * <code>name</code> Customer name <b>(required)</b>
|
156
|
-
# * <code>reference</code> Reference field for external applications use.
|
157
|
+
# * <code>name</code> Customer name [min length: 2] <b>(required)</b>
|
158
|
+
# * <code>reference</code> Reference field for external applications use.
|
159
|
+
# * <code>token</code> If specified, card associated with card token will be added to the customer
|
157
160
|
def update()
|
158
161
|
h = Simplify::PaymentsApi.execute("customer", 'update', self, self.authentication)
|
159
162
|
self.merge!(h)
|
data/lib/simplify/deposit.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -59,10 +59,10 @@ class Deposit < Hash
|
|
59
59
|
|
60
60
|
# Retrieve Deposit objects.
|
61
61
|
# criteria:: a hash of parameters; valid keys are:
|
62
|
-
# * <code>filter</code> Filters to apply to the list.
|
63
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
64
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
65
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> amount</code><code> dateCreated</code><code> depositDate</code>.
|
62
|
+
# * <code>filter</code> Filters to apply to the list.
|
63
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
64
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
65
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> amount</code><code> dateCreated</code><code> depositDate</code>.
|
66
66
|
# 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.
|
67
67
|
# Returns an object where the <code>list</code> property contains the list of Deposit objects and the <code>total</code>
|
68
68
|
# property contains the total number of Deposit objects available for the given criteria.
|
data/lib/simplify/event.rb
CHANGED
data/lib/simplify/invoice.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -59,10 +59,10 @@ class Invoice < Hash
|
|
59
59
|
|
60
60
|
# Retrieve Invoice objects.
|
61
61
|
# criteria:: a hash of parameters; valid keys are:
|
62
|
-
# * <code>filter</code> Filters to apply to the list.
|
63
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
64
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
65
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> invoiceDate</code><code> customer</code><code> amount</code><code> processedDate</code>.
|
62
|
+
# * <code>filter</code> Filters to apply to the list.
|
63
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
64
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
65
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> invoiceDate</code><code> customer</code><code> amount</code><code> processedDate</code>.
|
66
66
|
# 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.
|
67
67
|
# Returns an object where the <code>list</code> property contains the list of Invoice objects and the <code>total</code>
|
68
68
|
# property contains the total number of Invoice objects available for the given criteria.
|
@@ -95,7 +95,7 @@ class Invoice < Hash
|
|
95
95
|
# Updates this object
|
96
96
|
#
|
97
97
|
# The properties that can be updated:
|
98
|
-
# * <code>status</code>
|
98
|
+
# * <code>status</code> New status of the invoice. [valid values: PAID] <b>(required)</b>
|
99
99
|
def update()
|
100
100
|
h = Simplify::PaymentsApi.execute("invoice", 'update', self, self.authentication)
|
101
101
|
self.merge!(h)
|
data/lib/simplify/invoiceitem.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,9 +60,9 @@ class InvoiceItem < Hash
|
|
60
60
|
# Creates an InvoiceItem object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amount</code> Amount of the invoice item (minor units). Example: 1000 = 10.00 <b>required </b>
|
64
|
-
# * <code>currency</code> Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. <b>required </b
|
65
|
-
# * <code>description</code> Individual items of an invoice
|
63
|
+
# * <code>amount</code> Amount of the invoice item (minor units). Example: 1000 = 10.00 [min value: 1, max value: 99999999] <b>required </b>
|
64
|
+
# * <code>currency</code> Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. [default: USD] <b>required </b>
|
65
|
+
# * <code>description</code> Individual items of an invoice
|
66
66
|
# * <code>invoice</code> Description of the invoice item <b>required </b>
|
67
67
|
# 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.
|
68
68
|
# Returns a InvoiceItem object.
|
@@ -85,10 +85,10 @@ class InvoiceItem < Hash
|
|
85
85
|
|
86
86
|
# Retrieve InvoiceItem objects.
|
87
87
|
# criteria:: a hash of parameters; valid keys are:
|
88
|
-
# * <code>filter</code> Filters to apply to the list.
|
89
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
90
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
91
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> invoice</code>.
|
88
|
+
# * <code>filter</code> Filters to apply to the list.
|
89
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
90
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
91
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> invoice</code>.
|
92
92
|
# 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.
|
93
93
|
# Returns an object where the <code>list</code> property contains the list of InvoiceItem objects and the <code>total</code>
|
94
94
|
# property contains the total number of InvoiceItem objects available for the given criteria.
|
@@ -121,9 +121,9 @@ class InvoiceItem < Hash
|
|
121
121
|
# Updates this object
|
122
122
|
#
|
123
123
|
# The properties that can be updated:
|
124
|
-
# * <code>amount</code> Amount of the invoice item (minor units). Example: 1000 = 10.00
|
125
|
-
# * <code>currency</code> Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account.
|
126
|
-
# * <code>description</code> Individual items of an invoice
|
124
|
+
# * <code>amount</code> Amount of the invoice item (minor units). Example: 1000 = 10.00 [min value: 1, max value: 99999999]
|
125
|
+
# * <code>currency</code> Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. [default: USD]
|
126
|
+
# * <code>description</code> Individual items of an invoice
|
127
127
|
def update()
|
128
128
|
h = Simplify::PaymentsApi.execute("invoiceItem", 'update', self, self.authentication)
|
129
129
|
self.merge!(h)
|
data/lib/simplify/payment.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,23 +60,23 @@ class Payment < Hash
|
|
60
60
|
# Creates an Payment object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00 <b>required </b>
|
64
|
-
# * <code>card => addressCity</code> City of the cardholder.
|
65
|
-
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
|
66
|
-
# * <code>card => addressLine1</code> Address of the cardholder.
|
67
|
-
# * <code>card => addressLine2</code> Address of the cardholder if needed.
|
68
|
-
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder.
|
69
|
-
# * <code>card => addressZip</code> Postal code of the cardholder.
|
70
|
-
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
71
|
-
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 <b>required </b>
|
72
|
-
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 <b>required </b>
|
73
|
-
# * <code>card => name</code> Name as it appears on the card.
|
74
|
-
# * <code>card => number</code> Card number as it appears on the card. <b>required </b>
|
75
|
-
# * <code>currency</code> Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. <b>required </b
|
76
|
-
# * <code>customer</code> ID of customer. If specified, card on file of customer will be used.
|
77
|
-
# * <code>description</code> Custom naming of payment for external systems to use.
|
78
|
-
# * <code>reference</code> Custom reference field to be used with outside systems.
|
79
|
-
# * <code>token</code> If specified, card associated with card token will be used.
|
63
|
+
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00 [min value: 50, max value: 99999999] <b>required </b>
|
64
|
+
# * <code>card => addressCity</code> City of the cardholder. [max length: 50, min length: 2]
|
65
|
+
# * <code>card => addressCountry</code> Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
|
66
|
+
# * <code>card => addressLine1</code> Address of the cardholder. [max length: 255]
|
67
|
+
# * <code>card => addressLine2</code> Address of the cardholder if needed. [max length: 255]
|
68
|
+
# * <code>card => addressState</code> State code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
|
69
|
+
# * <code>card => addressZip</code> Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers. [max length: 9, min length: 3]
|
70
|
+
# * <code>card => cvc</code> CVC security code of the card. This is the code on the back of the card. Example: 123
|
71
|
+
# * <code>card => expMonth</code> Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <b>required </b>
|
72
|
+
# * <code>card => expYear</code> Expiration year of the card. Format is YY. Example: 2013 = 13 [max value: 99] <b>required </b>
|
73
|
+
# * <code>card => name</code> Name as it appears on the card. [max length: 50, min length: 2]
|
74
|
+
# * <code>card => number</code> Card number as it appears on the card. [max length: 19, min length: 13] <b>required </b>
|
75
|
+
# * <code>currency</code> Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] <b>required </b>
|
76
|
+
# * <code>customer</code> ID of customer. If specified, card on file of customer will be used.
|
77
|
+
# * <code>description</code> Custom naming of payment for external systems to use.
|
78
|
+
# * <code>reference</code> Custom reference field to be used with outside systems.
|
79
|
+
# * <code>token</code> If specified, card associated with card token will be used. [max length: 255]
|
80
80
|
# 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.
|
81
81
|
# Returns a Payment object.
|
82
82
|
def self.create(parms, *auth)
|
@@ -91,10 +91,10 @@ class Payment < Hash
|
|
91
91
|
|
92
92
|
# Retrieve Payment objects.
|
93
93
|
# criteria:: a hash of parameters; valid keys are:
|
94
|
-
# * <code>filter</code> Filters to apply to the list.
|
95
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
96
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
97
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> amount</code><code> id</code><code> description</code><code> paymentDate</code>.
|
94
|
+
# * <code>filter</code> Filters to apply to the list.
|
95
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
96
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
97
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> amount</code><code> id</code><code> description</code><code> paymentDate</code>.
|
98
98
|
# 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.
|
99
99
|
# Returns an object where the <code>list</code> property contains the list of Payment objects and the <code>total</code>
|
100
100
|
# property contains the total number of Payment objects available for the given criteria.
|
data/lib/simplify/paymentsapi.rb
CHANGED
data/lib/simplify/plan.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,10 +60,10 @@ class Plan < Hash
|
|
60
60
|
# Creates an Plan object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amount</code> Amount of payment for the plan in minor units. Example: 1000 = 10.00 <b>required </b>
|
64
|
-
# * <code>currency</code> Currency code (ISO-4217) for the plan. Must match the currency associated with your account. <b>required </b
|
63
|
+
# * <code>amount</code> Amount of payment for the plan in minor units. Example: 1000 = 10.00 [min value: 50, max value: 99999999] <b>required </b>
|
64
|
+
# * <code>currency</code> Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] <b>required </b>
|
65
65
|
# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly <b>required </b>
|
66
|
-
# * <code>name</code> Name of the plan <b>required </b>
|
66
|
+
# * <code>name</code> Name of the plan [max length: 50, min length: 2] <b>required </b>
|
67
67
|
# 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.
|
68
68
|
# Returns a Plan object.
|
69
69
|
def self.create(parms, *auth)
|
@@ -85,10 +85,10 @@ class Plan < Hash
|
|
85
85
|
|
86
86
|
# Retrieve Plan objects.
|
87
87
|
# criteria:: a hash of parameters; valid keys are:
|
88
|
-
# * <code>filter</code> Filters to apply to the list.
|
89
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
90
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
91
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> amount</code><code> frequency</code><code> name</code><code> id</code>.
|
88
|
+
# * <code>filter</code> Filters to apply to the list.
|
89
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
90
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
91
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code><code> amount</code><code> frequency</code><code> name</code><code> id</code>.
|
92
92
|
# 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.
|
93
93
|
# Returns an object where the <code>list</code> property contains the list of Plan objects and the <code>total</code>
|
94
94
|
# property contains the total number of Plan objects available for the given criteria.
|
@@ -121,7 +121,7 @@ class Plan < Hash
|
|
121
121
|
# Updates this object
|
122
122
|
#
|
123
123
|
# The properties that can be updated:
|
124
|
-
# * <code>name</code> Name of the plan. <b>(required)</b>
|
124
|
+
# * <code>name</code> Name of the plan. [min length: 2] <b>(required)</b>
|
125
125
|
def update()
|
126
126
|
h = Simplify::PaymentsApi.execute("plan", 'update', self, self.authentication)
|
127
127
|
self.merge!(h)
|
data/lib/simplify/refund.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,10 +60,10 @@ class Refund < Hash
|
|
60
60
|
# Creates an Refund object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amount</code> Amount of the refund in minor units. Example: 1000 = 10.00 <b>required </b>
|
63
|
+
# * <code>amount</code> Amount of the refund in minor units. Example: 1000 = 10.00 [min value: 1, max value: 99999999] <b>required </b>
|
64
64
|
# * <code>payment</code> ID of the payment for the refund <b>required </b>
|
65
|
-
# * <code>reason</code> Reason for the refund
|
66
|
-
# * <code>reference</code> Custom reference field to be used with outside systems.
|
65
|
+
# * <code>reason</code> Reason for the refund
|
66
|
+
# * <code>reference</code> Custom reference field to be used with outside systems.
|
67
67
|
# 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.
|
68
68
|
# Returns a Refund object.
|
69
69
|
def self.create(parms, *auth)
|
@@ -78,10 +78,10 @@ class Refund < Hash
|
|
78
78
|
|
79
79
|
# Retrieve Refund objects.
|
80
80
|
# criteria:: a hash of parameters; valid keys are:
|
81
|
-
# * <code>filter</code> Filters to apply to the list.
|
82
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
83
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
84
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code><code> paymentDate</code>.
|
81
|
+
# * <code>filter</code> Filters to apply to the list.
|
82
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
83
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
84
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code><code> paymentDate</code>.
|
85
85
|
# 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.
|
86
86
|
# Returns an object where the <code>list</code> property contains the list of Refund objects and the <code>total</code>
|
87
87
|
# property contains the total number of Refund objects available for the given criteria.
|
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -60,14 +60,14 @@ class Subscription < Hash
|
|
60
60
|
# Creates an Subscription object
|
61
61
|
#
|
62
62
|
# parms:: a hash of parameters; valid keys are:
|
63
|
-
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00
|
64
|
-
# * <code>coupon</code> Coupon ID associated with the subscription
|
65
|
-
# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account.
|
66
|
-
# * <code>customer</code> Customer that is enrolling in the subscription.
|
67
|
-
# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly
|
68
|
-
# * <code>name</code> Name describing subscription
|
69
|
-
# * <code>plan</code> The ID of the plan that should be used for the subscription.
|
70
|
-
# * <code>quantity</code> Quantity of the plan for the subscription.
|
63
|
+
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00 [min value: 50, max value: 99999999]
|
64
|
+
# * <code>coupon</code> Coupon ID associated with the subscription
|
65
|
+
# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
|
66
|
+
# * <code>customer</code> Customer that is enrolling in the subscription.
|
67
|
+
# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly
|
68
|
+
# * <code>name</code> Name describing subscription
|
69
|
+
# * <code>plan</code> The ID of the plan that should be used for the subscription.
|
70
|
+
# * <code>quantity</code> Quantity of the plan for the subscription. [min value: 1]
|
71
71
|
# 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.
|
72
72
|
# Returns a Subscription object.
|
73
73
|
def self.create(parms, *auth)
|
@@ -89,10 +89,10 @@ class Subscription < Hash
|
|
89
89
|
|
90
90
|
# Retrieve Subscription objects.
|
91
91
|
# criteria:: a hash of parameters; valid keys are:
|
92
|
-
# * <code>filter</code> Filters to apply to the list.
|
93
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
94
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
95
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> plan</code>.
|
92
|
+
# * <code>filter</code> Filters to apply to the list.
|
93
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
94
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
95
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> id</code><code> plan</code>.
|
96
96
|
# 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.
|
97
97
|
# Returns an object where the <code>list</code> property contains the list of Subscription objects and the <code>total</code>
|
98
98
|
# property contains the total number of Subscription objects available for the given criteria.
|
@@ -125,14 +125,14 @@ class Subscription < Hash
|
|
125
125
|
# Updates this object
|
126
126
|
#
|
127
127
|
# The properties that can be updated:
|
128
|
-
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00
|
129
|
-
# * <code>coupon</code> Coupon being assigned to this subscription
|
130
|
-
# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account.
|
131
|
-
# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly
|
132
|
-
# * <code>name</code> Name describing subscription
|
133
|
-
# * <code>plan</code> Plan that should be used for the subscription.
|
134
|
-
# * <code>prorate</code> Whether to prorate existing subscription. <b>(required)</b>
|
135
|
-
# * <code>quantity</code> Quantity of the plan for the subscription.
|
128
|
+
# * <code>amount</code> Amount of the payment (minor units). Example: 1000 = 10.00 [min value: 50, max value: 99999999]
|
129
|
+
# * <code>coupon</code> Coupon being assigned to this subscription
|
130
|
+
# * <code>currency</code> Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]
|
131
|
+
# * <code>frequency</code> Frequency of payment for the plan. Example: Monthly
|
132
|
+
# * <code>name</code> Name describing subscription
|
133
|
+
# * <code>plan</code> Plan that should be used for the subscription.
|
134
|
+
# * <code>prorate</code> Whether to prorate existing subscription. [default: true] <b>(required)</b>
|
135
|
+
# * <code>quantity</code> Quantity of the plan for the subscription. [min value: 1]
|
136
136
|
def update()
|
137
137
|
h = Simplify::PaymentsApi.execute("subscription", 'update', self, self.authentication)
|
138
138
|
self.merge!(h)
|
data/lib/simplify/webhook.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#
|
2
|
-
# Copyright (c) 2013, MasterCard International Incorporated
|
2
|
+
# Copyright (c) 2013, 2014 MasterCard International Incorporated
|
3
3
|
# All rights reserved.
|
4
4
|
#
|
5
5
|
# Redistribution and use in source and binary forms, with or without modification, are
|
@@ -82,10 +82,10 @@ class Webhook < Hash
|
|
82
82
|
|
83
83
|
# Retrieve Webhook objects.
|
84
84
|
# criteria:: a hash of parameters; valid keys are:
|
85
|
-
# * <code>filter</code> Filters to apply to the list.
|
86
|
-
# * <code>max</code> Allows up to a max of 50 list items to return.
|
87
|
-
# * <code>offset</code> Used in paging of the list. This is the start offset of the page.
|
88
|
-
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code>.
|
85
|
+
# * <code>filter</code> Filters to apply to the list.
|
86
|
+
# * <code>max</code> Allows up to a max of 50 list items to return. [max value: 50, default: 20]
|
87
|
+
# * <code>offset</code> Used in paging of the list. This is the start offset of the page. [default: 0]
|
88
|
+
# * <code>sorting</code> Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending). Sortable properties are: <code> dateCreated</code>.
|
89
89
|
# 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.
|
90
90
|
# Returns an object where the <code>list</code> property contains the list of Webhook objects and the <code>total</code>
|
91
91
|
# property contains the total number of Webhook objects available for the given criteria.
|
metadata
CHANGED
@@ -1,67 +1,63 @@
|
|
1
|
-
--- !ruby/object:Gem::Specification
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
2
|
name: simplify
|
3
|
-
version: !ruby/object:Gem::Version
|
4
|
-
|
5
|
-
segments:
|
6
|
-
- 1
|
7
|
-
- 1
|
8
|
-
- 0
|
9
|
-
version: 1.1.0
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.1.1
|
10
5
|
platform: ruby
|
11
|
-
authors:
|
6
|
+
authors:
|
12
7
|
- Simplify Commerce
|
13
8
|
autorequire:
|
14
9
|
bindir: bin
|
15
10
|
cert_chain: []
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
dependencies:
|
20
|
-
- !ruby/object:Gem::Dependency
|
11
|
+
date: 2014-01-28 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
21
14
|
name: rest-client
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
segments:
|
28
|
-
- 0
|
29
|
-
version: "0"
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '>='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
30
20
|
type: :runtime
|
31
|
-
version_requirements: *id001
|
32
|
-
- !ruby/object:Gem::Dependency
|
33
|
-
name: json
|
34
21
|
prerelease: false
|
35
|
-
|
36
|
-
requirements:
|
37
|
-
- -
|
38
|
-
- !ruby/object:Gem::Version
|
39
|
-
|
40
|
-
|
41
|
-
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: json
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
42
34
|
type: :runtime
|
43
|
-
version_requirements: *id002
|
44
|
-
- !ruby/object:Gem::Dependency
|
45
|
-
name: ruby-hmac
|
46
35
|
prerelease: false
|
47
|
-
|
48
|
-
requirements:
|
49
|
-
- -
|
50
|
-
- !ruby/object:Gem::Version
|
51
|
-
|
52
|
-
|
53
|
-
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: ruby-hmac
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
54
48
|
type: :runtime
|
55
|
-
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
56
55
|
description: Ruby access to the Simplify Commerce API
|
57
56
|
email: support@simplify.com
|
58
57
|
executables: []
|
59
|
-
|
60
58
|
extensions: []
|
61
|
-
|
62
59
|
extra_rdoc_files: []
|
63
|
-
|
64
|
-
files:
|
60
|
+
files:
|
65
61
|
- lib/simplify/accesstoken.rb
|
66
62
|
- lib/simplify/apiexception.rb
|
67
63
|
- lib/simplify/authentication.rb
|
@@ -81,35 +77,28 @@ files:
|
|
81
77
|
- lib/simplify/subscription.rb
|
82
78
|
- lib/simplify/webhook.rb
|
83
79
|
- lib/simplify.rb
|
84
|
-
has_rdoc: true
|
85
80
|
homepage: https://www.simplify.com/commerce
|
86
|
-
licenses:
|
81
|
+
licenses:
|
87
82
|
- BSD
|
83
|
+
metadata: {}
|
88
84
|
post_install_message:
|
89
85
|
rdoc_options: []
|
90
|
-
|
91
|
-
require_paths:
|
86
|
+
require_paths:
|
92
87
|
- lib
|
93
|
-
required_ruby_version: !ruby/object:Gem::Requirement
|
94
|
-
requirements:
|
95
|
-
- -
|
96
|
-
- !ruby/object:Gem::Version
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
- !ruby/object:Gem::Version
|
104
|
-
segments:
|
105
|
-
- 0
|
106
|
-
version: "0"
|
88
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
89
|
+
requirements:
|
90
|
+
- - '>='
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: '0'
|
93
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - '>='
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
107
98
|
requirements: []
|
108
|
-
|
109
99
|
rubyforge_project:
|
110
|
-
rubygems_version:
|
100
|
+
rubygems_version: 2.0.3
|
111
101
|
signing_key:
|
112
|
-
specification_version:
|
102
|
+
specification_version: 4
|
113
103
|
summary: Simplify Commerce Ruby SDK
|
114
104
|
test_files: []
|
115
|
-
|