chargebee 1.7.1 → 1.7.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +89 -81
  3. data/README.rdoc +9 -5
  4. data/chargebee.gemspec +2 -2
  5. data/lib/chargebee.rb +1 -1
  6. data/lib/chargebee/environment.rb +4 -4
  7. data/lib/chargebee/models/event.rb +7 -1
  8. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8d4e46e16695c6b232e7e47a317c4f3ccdb4dec0
4
- data.tar.gz: 5bc2f62fa3bb5a7c04919360255099ee61879859
3
+ metadata.gz: 15833e57d23c11402ded9150101a3687291e1808
4
+ data.tar.gz: 963b16c0d0c69367f741750483494c7812633316
5
5
  SHA512:
6
- metadata.gz: 8600c5a09a56fc5a847a56a025c4e350a9b99e0776a45d778538804e2e9c7df0f2367f883d8dce94b202a022596fc135d19a3f187a48a304b33d192865c8bd2f
7
- data.tar.gz: 507b31290f2812ce2fd6c269497e5ddc77f2470048de00f864bea50c16b1d3791aa0992dd33d8a576179d5107df6c4686eeed2425234202c78ced706ecb0ca35
6
+ metadata.gz: c1a519e18c0e22351f513ba810b4e473128342428959b4fae8f4e5115b030f40629131a47e96f3b8cb2df5f7f2c5432562f9f8bcd00e2edcb3d1b522387dff4d
7
+ data.tar.gz: 4a50e378af7981ffd3dacb81a32d8c20842cdeffde44b779ed0ddb2d3313978e5a047b9815e5e7e929adc9300c3e2eda0d0954589819810d2bb5d1e399c4e893
data/CHANGELOG.md CHANGED
@@ -1,29 +1,37 @@
1
+ ### v1.7.2 (2016-04-06)
2
+ * * *
3
+
4
+ *api_version* attribute is added to the Event resource.
5
+
6
+ Chargebee supports multiple [API versions](https://apidocs.chargebee.com/docs/api#versions) now. The *api_version* attribute indicates the API version based on which the event content is structured. More details here:
7
+ https://apidocs.chargebee.com/docs/api/v1/events
8
+
1
9
  ### v1.7.1 (2016-03-22)
2
10
  * * *
3
11
 
4
12
  ** APIs updated**:
5
13
 
6
14
  Support to specify additional information as "meta_data" in json format for Customer, Subscription, Plan, Addon & Coupon resources.
7
- Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
15
+ Now, create & update customer, subscription, create subscription for customer, create & update plan, addon and create coupon APIs accept the "meta_data"" parameter in json format. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
8
16
 
9
- New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
17
+ New attribute for "meta_data" is returned as part of Customer, Subscription, Plan, Addon and Coupon resources. See customer attributes here: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
10
18
 
11
19
 
12
20
  ** APIs added**:
13
21
 
14
- Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/cards#switch_gateway
22
+ Support to change card gateway for a customer. New api endpoint to switch gateway for a customer is added to Card resources. See: https://apidocs.chargebee.com/docs/api/v1/cards#switch_gateway
15
23
 
16
24
 
17
25
  ** Issue Fixed**:
18
26
 
19
- Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/invoices
27
+ Wrong keys in json response is now fixed for 'linked_transactions', 'linked_orders' & 'notes' in Invoice resource and for 'linked_invoices' & 'linked_refunds' in Transaction resource. See: invoice attributes here: https://apidocs.chargebee.com/docs/api/v1/invoices
20
28
 
21
29
  ### v1.7.0 (2016-03-10)
22
30
  * * *
23
31
 
24
32
  ** APIs updated**:
25
33
 
26
- Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
34
+ Support to keep the card in gateway while deleting customer. Delete a customer API accepts "delete_payment_method" parameter. See: https://apidocs.chargebee.com/docs/api/v1/customers#delete_a_customer
27
35
 
28
36
  Typo fix in chargebee.gemspec file.
29
37
 
@@ -36,16 +44,16 @@ RSpec development dependancy version has been upgraded to 3.0.0
36
44
 
37
45
  Support to delete a subscription. See: https://www.chargebee.com/docs/subscriptions.html#deleting-a-subscription
38
46
  New api endpoint to delete 'Subscription' is added to Subscription resources. See delete subscription API here:
39
- https://apidocs.chargebee.com/docs/api/subscriptions#delete_a_subscription
47
+ https://apidocs.chargebee.com/docs/api/v1/subscriptions#delete_a_subscription
40
48
 
41
49
  Support to delete a customer. See: https://www.chargebee.com/docs/customers.html#deleting-a-customer
42
50
  New api endpoint to delete 'Customer' is added to Customer resources. See delete customer API here:
43
- https://apidocs.chargebee.com/docs/api/customers#delete_a_customer
51
+ https://apidocs.chargebee.com/docs/api/v1/customers#delete_a_customer
44
52
 
45
53
 
46
54
  ** APIs updated**:
47
55
 
48
- Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
56
+ Now, events "subscription_deleted" & "customer_deleted" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types.
49
57
 
50
58
  ### v1.6.8 (2016-02-08)
51
59
  * * *
@@ -53,22 +61,22 @@ Now, events "subscription_deleted" & "customer_deleted" can be fetched via API.
53
61
  ** APIs added**:
54
62
 
55
63
  Support to add additional contact for a customer. See: https://www.chargebee.com/docs/customers.html#add-contact
56
- New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/customers#add_contacts_to_a_customer
64
+ New api endpoints to add, update and delete 'Contact' are added to Customer resource. See add contact API here: https://apidocs.chargebee.com/docs/api/v1/customers#add_contacts_to_a_customer
57
65
 
58
66
  ** APIs updated**:
59
67
 
60
- New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
68
+ New attribute 'contacts' with list of contacts is returned as part of Customer resource. See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
61
69
 
62
- Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice
70
+ Support for partial payment. Collect payment for an invoice API now accepts 'amount' paramater. See: https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice
63
71
 
64
72
  New attribute 'refundable_credits' is returned as part of Customer resource.
65
73
 
66
- New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
74
+ New attributes 'amount_paid', 'amount_adjusted' & 'credits_applied' are returned as part of Invoice resource. See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
67
75
 
68
- New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
76
+ New attributes 'credits_applied' & 'amount_due' are returned as part of Estimate resource. See: https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
69
77
 
70
78
  New entity type 'credit_note' is added as part of 'entity_type' attribute of Comment resource.
71
- See: https://apidocs.chargebee.com/docs/api/comments#comment_attributes
79
+ See: https://apidocs.chargebee.com/docs/api/v1/comments#comment_attributes
72
80
 
73
81
  ### v1.6.7 (2015-12-15)
74
82
  * * *
@@ -82,10 +90,10 @@ Wrong API invocation issue if empty/null value passed instead of resource id, is
82
90
 
83
91
  ** APIs updated**:
84
92
 
85
- Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
93
+ Support to specify accessbility in customer portal for a plan & addon. Create & update methods of Plan & Addon APIs accept "enabled_in_portal" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/v1/plans#create_a_plan
86
94
 
87
95
  New attribute "enabled_in_portal" is returned as part of Plan/Addon resource.
88
- See plan attributes here: https://apidocs.chargebee.com/docs/api/plans#plan_attributes
96
+ See plan attributes here: https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
89
97
 
90
98
  ### v1.6.5 (2015-11-09)
91
99
  * * *
@@ -95,57 +103,57 @@ See plan attributes here: https://apidocs.chargebee.com/docs/api/plans#plan_attr
95
103
  Support for excess payments. See : https://www.chargebee.com/docs/customers.html#excess-payments
96
104
 
97
105
  New attribute "excess_payments" is returned as part of Customer resource.
98
- See: https://apidocs.chargebee.com/docs/api/customers#customer_attributes
106
+ See: https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
99
107
 
100
108
  New attribute "applied_at" is returned as part of Linked Transaction subresource of Invoice resource.
101
- See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
109
+ See: https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
102
110
 
103
111
  New transaction type "PAYMENT_REVERSAL" is returned as part of Transaction resource.
104
- See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
112
+ See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
105
113
 
106
114
  New attributes "amount_unused", "reference_transaction_id", "reversal_transaction_id" & "linked_refunds" subresource are returned as part of Transaction resource.
107
115
 
108
116
  New attribute "applied_at" is returmed as part of Linked Invoice subresource of Transaction resource.
109
- See: https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
117
+ See: https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
110
118
 
111
119
  ### v1.6.4 (2015-10-26)
112
120
  * * *
113
121
 
114
122
  ** APIs updated**:
115
123
 
116
- Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
124
+ Support to specify if a customer can pay via direct debit. Now, create & update customer, create subscription APIs accept the "allow_direct_debit" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
117
125
 
118
126
  New attribute "allow_direct_debit" is returned as part of Customer resource.
119
- See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
127
+ See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
120
128
 
121
129
  New "price_type" attribute is returned as part of Estimate & Invoice Resource.
122
- See : https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
130
+ See : https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
123
131
 
124
132
  Support for address parameters in estimate APIs that is used to calculate tax. Now, create & update subscription estimate APIs accept billing state code, billing zip, shipping country, shipping state code & shipping zip.
125
- See : https://apidocs.chargebee.com/docs/api/estimates#create_subscription_estimate
133
+ See : https://apidocs.chargebee.com/docs/api/v1/estimates#create_subscription_estimate
126
134
 
127
135
  ### v1.6.3 (2015-09-18)
128
136
  * * *
129
137
 
130
138
  ** APIs updated**:
131
139
 
132
- Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/customers#create_a_customer
140
+ Support to specify customer's tax liability. Now, create & update customer, create & update subscription, create & update subscription estimate, checkout new hosted page APIs accept the "taxability" parameter for Customer resource. See create customer API here : https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
133
141
 
134
- Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/plans#create_a_plan
142
+ Support to specify taxability for a plan & addon. Create & update methods of Plan & Addon APIs accept "taxable" parameter. See create plan API here : https://apidocs.chargebee.com/docs/api/v1/plans#create_a_plan
135
143
 
136
144
  The attribute "taxablility" is returned as part of Customer resource.
137
- https://apidocs.chargebee.com/docs/api/customers#customer_attributes
145
+ https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
138
146
 
139
147
  The attribute "taxable" is returned as part of Plan resource.
140
- See : https://apidocs.chargebee.com/docs/api/plans#plan_attributes
148
+ See : https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
141
149
 
142
150
  The attribute "taxable" is returned as part of Addon resource.
143
- See : https://apidocs.chargebee.com/docs/api/addons#addon_attributes
151
+ See : https://apidocs.chargebee.com/docs/api/v1/addons#addon_attributes
144
152
 
145
153
 
146
154
  The attribute "is_taxed" returned as part of "line_items" subresource of Estimate & Invoice resorces.
147
155
  See attribute of line_items in Estimate here :
148
- https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
156
+ https://apidocs.chargebee.com/docs/api/v1/estimates#estimate_attributes
149
157
 
150
158
  ### v1.6.2 (2015-09-07)
151
159
  * * *
@@ -153,10 +161,10 @@ https://apidocs.chargebee.com/docs/api/estimates#estimate_attributes
153
161
  ** APIs updated**:
154
162
 
155
163
  The attribute for "user" is returned as part of Event resource.
156
- See : https://apidocs.chargebee.com/docs/api/events#event_attributes
164
+ See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
157
165
 
158
166
  Support for multiple webhooks. The attribute "webhooks" contains list of Webhook subresource is returned as part of Event API.
159
- See : https://apidocs.chargebee.com/docs/api/events#event_attributes
167
+ See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
160
168
 
161
169
  ** APIs deprecated**:
162
170
 
@@ -168,40 +176,40 @@ Attributes "webhook_status" & "webhook_failure_reason" of event resource has bee
168
176
  ** APIs updated**:
169
177
 
170
178
  The attribute for "first_invoice" & "currency_code" is returned as part of Invoice resource.
171
- See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
179
+ See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
172
180
 
173
181
  The attribute for "currency_code" is returned as part of Transaction resource.
174
- See : https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes
182
+ See : https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes
175
183
 
176
184
  A new source type "bulk_operation" is returned as part of "source" attribute of event resource.
177
- See : https://apidocs.chargebee.com/docs/api/events#event_attributes
185
+ See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
178
186
 
179
187
  ### v1.6.0 (2015-07-20)
180
188
  * * *
181
189
 
182
190
  ** APIs added**:
183
191
 
184
- New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/invoices#stop_dunning_for_invoice
192
+ New api endpoint to Stop Dunning for "Payment Due" invoices is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#stop_dunning_for_invoice
185
193
 
186
194
  ** APIs updated**:
187
195
 
188
196
  The attribute for "dunning_status" is returned as part of Invoice resource.
189
- See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
197
+ See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
190
198
 
191
199
  ### v1.5.9 (2015-07-09)
192
200
  * * *
193
201
 
194
202
  ** APIs added**:
195
203
 
196
- New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#record_refund_for_an_invoice
204
+ New api endpoint to Record Offline Refund for an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#record_refund_for_an_invoice
197
205
 
198
206
  ** APIs updated**:
199
207
 
200
- Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer
208
+ Support to update payment method stored in gateway vault. Now, update payment method for a customer, create customer, create & update subscription method APIs accept the "gateway" parameter for Payment Method resource along with reference_id. See "Card Payments" section here : https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer
201
209
 
202
- The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
210
+ The attribute for "gateway" name is returned as part of Payment Method sub-resource for a customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
203
211
 
204
- A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
212
+ A new source type "migration" is returned as part of "source" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
205
213
 
206
214
  A new discount type "account_credits" is added as part of "type" attribute of discounts sub-resource for estimate resource.
207
215
 
@@ -214,34 +222,34 @@ Attributes "description" & "void_description" of transaction resource has been d
214
222
 
215
223
  ** APIs added**:
216
224
 
217
- New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/invoices#void_an_invoice
225
+ New api endpoint to Void an invoice is added. See : https://apidocs.chargebee.com/docs/api/v1/invoices#void_an_invoice
218
226
 
219
227
  ** APIs updated**:
220
228
 
221
- A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
229
+ A new invoice status "voided" is returned as part of "status" attribute in invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
222
230
 
223
231
  ** APIs deprecated**:
224
232
 
225
- Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method
233
+ Update card for hosted page method API has been deprecated. Use "Update payment method" API to update card details. Read more about upadate payment method : https://apidocs.chargebee.com/docs/api/v1/hosted_pages#update_payment_method
226
234
 
227
235
  ### v1.5.7 (2015-06-12)
228
236
  * * *
229
237
 
230
238
  ** APIs added**:
231
239
 
232
- New api endpoints to Add, Deduct & Set the account credit for a customer is added. See the APIs below - https://apidocs.chargebee.com/docs/api/customers#add_account_credits_to_a_customer
233
- https://apidocs.chargebee.com/docs/api/customers#deduct_account_credits_for_a_customer
234
- https://apidocs.chargebee.com/docs/api/customers#set_account_credits_for_a_customer
240
+ New api endpoints to Add, Deduct & Set the account credit for a customer is added. See the APIs below - https://apidocs.chargebee.com/docs/api/v1/customers#add_account_credits_to_a_customer
241
+ https://apidocs.chargebee.com/docs/api/v1/customers#deduct_account_credits_for_a_customer
242
+ https://apidocs.chargebee.com/docs/api/v1/customers#set_account_credits_for_a_customer
235
243
 
236
244
  ** APIs updated**:
237
245
 
238
- Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/events#event_types.
246
+ Now, event "invoice_updated" can be fetched via API. See : https://apidocs.chargebee.com/docs/api/v1/events#event_types.
239
247
 
240
- A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
248
+ A new webkook status "skipped" is returned as part of "webhook_status" attribute of event resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
241
249
 
242
- The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/customers#customer_attributes
250
+ The resource attribute for "account_credits" is returned as part of Customer resource. See : https://apidocs.chargebee.com/docs/api/v1/customers#customer_attributes
243
251
 
244
- A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/events#event_attributes
252
+ A new discount type "account_credits" is returned as part of "discounts" sub-resource of Invoice resource. See : https://apidocs.chargebee.com/docs/api/v1/events#event_attributes
245
253
 
246
254
  ** APIs deprecated**:
247
255
 
@@ -256,9 +264,9 @@ The attribute "discount_quantity" deprecated for Create method of Coupon API.
256
264
 
257
265
  ** APIs added**:
258
266
 
259
- A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/customers#update_payment_method_for_a_customer.
267
+ A new api endpoint for "Update payment method for a customer" is added. This allows you to support PayPal Express Checkout via our API. See https://apidocs.chargebee.com/docs/api/v1/customers#update_payment_method_for_a_customer.
260
268
 
261
- A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/invoices#collect_payment_for_an_invoice.
269
+ A new api endpoint for "Collect payment for an invoice" is added. This allows you to manually collect the payment(if a payment method is present for the customer) for an invoice in "payment_due" or "not_paid" state. See https://apidocs.chargebee.com/docs/api/v1/invoices#collect_payment_for_an_invoice.
262
270
 
263
271
  ** APIs updated**:
264
272
 
@@ -277,15 +285,15 @@ The resource attribute for "po_number" is returned as part of Subscription and I
277
285
  Create and Update methods of plan, addon, coupon, customer and subscripiton APIs now accept "invoice_notes" that is added to the invoice raised for a customer. Read more about invoice notes : https://www.chargebee.com/docs/invoice_notes.html
278
286
 
279
287
  A new sub-resource "notes" is returned as part of the Invoice resource attributes.
280
- See https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
288
+ See https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes
281
289
 
282
290
  A new attribute "amount_due" is returned as part of Invoice resource.
283
291
 
284
292
  Checkout new, checkout existing, update payment method method APIs now accept "redirect_url" & "cancel_url" to which your customer should be redirected.
285
- See https://apidocs.chargebee.com/docs/api/hosted_pages#checkout_new_subscription
293
+ See https://apidocs.chargebee.com/docs/api/v1/hosted_pages#checkout_new_subscription
286
294
 
287
295
  Now, event "subscription_renewal_reminder" can be fetched via API.
288
- See https://apidocs.chargebee.com/docs/api/events#event_types.
296
+ See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
289
297
 
290
298
  ### v1.5.4 (2015-03-30)
291
299
  * * *
@@ -293,23 +301,23 @@ See https://apidocs.chargebee.com/docs/api/events#event_types.
293
301
  ** APIs added**:
294
302
 
295
303
  A new API "Delete an Invoice" added to delete un-paid invoices. This feature was supported through admin console earlier, now it is available via API too.
296
- See https://apidocs.chargebee.com/docs/api/invoices#delete_an_invoice.
304
+ See https://apidocs.chargebee.com/docs/api/v1/invoices#delete_an_invoice.
297
305
 
298
306
  ** APIs updated**:
299
307
 
300
308
  Create subscription/customer, update subscription/payment method APIs now accepts the IP Address of customer for card resource.
301
309
 
302
310
  Now, event "invoice_deleted" can be fetched via API.
303
- See https://apidocs.chargebee.com/docs/api/events#event_types.
311
+ See https://apidocs.chargebee.com/docs/api/v1/events#event_types.
304
312
 
305
313
  ### v1.5.3 (2015-02-27)
306
314
  * * *
307
315
 
308
316
  ** APIs added**:
309
317
 
310
- A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/invoices#create_an_invoice.
318
+ A new API "Create an Invoice" added to create one-off invoices with multiple 'Non Recurring' addon & ad-hoc charges for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#create_an_invoice.
311
319
 
312
- A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/portal_sessions.
320
+ A new API called Activate a portal session method(Portal session) added to support building your authentication for your website on top of ChargeBee. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions#activate_a_portal_session. Read about "Using ChargeBee authentication to allow access to your website" at https://apidocs.chargebee.com/docs/api/v1/portal_sessions.
313
321
 
314
322
  ** APIs updated**:
315
323
 
@@ -335,7 +343,7 @@ Create subscription/customer, update subscription/customer/payment method/billin
335
343
  Support for PayPal & Amazon payment added.
336
344
 
337
345
  ** APIs added**:
338
- A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/hosted_pages#update_payment_method for details.
346
+ A new API called Update payment method(HostedPage) added to support allowing customers to update their payment method with PayPal and Amazon payments. See https://apidocs.chargebee.com/docs/api/v1/hosted_pages#update_payment_method for details.
339
347
 
340
348
  ** APIs deprecated**:
341
349
  Update card(HostedPage) API is deprecated as an alternate API is added.
@@ -348,10 +356,10 @@ Create a customer API now accepts the end user IP.
348
356
 
349
357
  **APIs added**:
350
358
  A new resource called Order is introduced. This can be used for integrating ChargeBee with any shipping/order management application (like ShipStation). Orders are not automatically generated or updated by ChargeBee currently. They have to be created/updated either via api or merchant web console (a.k.a admin console). An order can be created against an invoice irrespective of the status of the invoice and an invoice can have multiple orders associated with it.
351
- See https://apidocs.chargebee.com/docs/api/orders?lang=ruby for details.
359
+ See https://apidocs.chargebee.com/docs/api/v1/orders?lang=ruby for details.
352
360
 
353
361
  **API Updates**:
354
- Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices.
362
+ Ability to filter Invoices with paid_on_after parameter. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#list_invoices.
355
363
 
356
364
  ### v1.4.9 (2014-11-24)
357
365
  * * *
@@ -369,7 +377,7 @@ Bug fixes.
369
377
  * * *
370
378
 
371
379
  **APIs Updated**:
372
- * Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/customers#update_a_customer.
380
+ * Set auto colection to on/off via "Update a customer" API. See https://apidocs.chargebee.com/docs/api/v1/customers#update_a_customer.
373
381
 
374
382
  ### v1.4.6 (2014-09-16)
375
383
  * * *
@@ -403,8 +411,8 @@ Added properties:
403
411
  * Property has_scheduled_changes added to the Subscription resource to indicate whether there are any pending change scheduled for this Subscription
404
412
 
405
413
  APIs added:
406
- * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/subscriptions#retrieve_with_scheduled_changes.
407
- * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/subscriptions#remove_scheduled_changes.
414
+ * Retrieve a subscription with scheduled changes applied. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#retrieve_with_scheduled_changes.
415
+ * Remove schedule changes for a subscription. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#remove_scheduled_changes.
408
416
 
409
417
  APIs updated:
410
418
  * Ability to pass description for Plans & Addons while Creating & Updating.
@@ -415,33 +423,33 @@ APIs Removed:
415
423
  ### v1.4.3 (2014-07-29)
416
424
  * * *
417
425
  APIs added:
418
- * Add a one time charged to the subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/subscriptions#add_charge_at_term_end.
419
- * Add a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/subscriptions#charge_addon_at_term_end.
420
- *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate
426
+ * Add a one time charged to the subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#add_charge_at_term_end.
427
+ * Add a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. See https://apidocs.chargebee.com/docs/api/v1/subscriptions#charge_addon_at_term_end.
428
+ *Return an estimate of the amount that will be charged when the subscription renews. See https://apidocs.chargebee.com/docs/api/v1/estimates#subscription_renewal_estimate
421
429
 
422
430
  APIs updated:
423
- * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/plans#plan_attributes
431
+ * Now plans supports charge model to specify how the subscription plan charges should be calculated. See https://apidocs.chargebee.com/docs/api/v1/plans#plan_attributes
424
432
  * Include delayed charges while calculating the Estimate.
425
433
 
426
434
  ### v1.4.2 (2014-06-19)
427
435
  * * *
428
436
  APIs added:
429
- * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#list_invoices_for_a_customer.
430
- * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/transactions?lang=ruby#list_transactions_for_a_customer.
437
+ * Retrieve invoices for a customer. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#list_invoices_for_a_customer.
438
+ * Retrieve transactions for a customer. See https://apidocs.chargebee.com/docs/api/v1/transactions?lang=ruby#list_transactions_for_a_customer.
431
439
 
432
440
  APIs updated:
433
- * Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#create_invoice_for_charge.
434
- * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/invoices?lang=ruby#create_invoice_for_addon.
441
+ * Now, a customer(without subscription) can be charged(Create invoice for Charge) for one time charges. See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#create_invoice_for_charge.
442
+ * Now, a customer(without subscription) can be charged for one time addons(Create invoice for Addon). See https://apidocs.chargebee.com/docs/api/v1/invoices?lang=ruby#create_invoice_for_addon.
435
443
 
436
444
  ### v1.4.1 (2014-05-28)
437
445
  * * *
438
- New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/portal_sessions?lang=ruby.
446
+ New API to support Single Sign-on (SSO) to access the customer portal, if you already have your own authentication for your website. See https://apidocs.chargebee.com/docs/api/v1/portal_sessions?lang=ruby.
439
447
 
440
448
  ### v1.4.0 (2014-05-23)
441
449
  * * *
442
- * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/customers#create_a_customer
450
+ * New API to create customer without subscription. See https://apidocs.chargebee.com/docs/api/v1/customers#create_a_customer
443
451
 
444
- * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/invoices#list_invoices_for_a_customer
452
+ * New API to fetch invoices for a customer. This helps you fetch the invoices created due to multiple subscriptions present for any customer. See https://apidocs.chargebee.com/docs/api/v1/invoices#list_invoices_for_a_customer
445
453
 
446
454
  * Customer id reference is added to the invoice attributes.
447
455
 
@@ -451,15 +459,15 @@ Support for returning shipping address as part of create/update subscription API
451
459
 
452
460
  ### v1.3.8 (2014-03-26)
453
461
  * * *
454
- * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices.
462
+ * Now the [Transaction attributes](https://apidocs.chargebee.com/docs/api/v1/transactions#transaction_attributes "Transaction attributes") contains the details about the linked invoices.
455
463
 
456
- * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions.
464
+ * Now the [Invoice attributes](https://apidocs.chargebee.com/docs/api/v1/invoices#invoice_attributes "Invoice attributes") contains the details about the linked transactions.
457
465
 
458
- * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/transactions#record_payment_for_an_invoice "Record Payment for an Invoice")
466
+ * Support for recording a payment received via offline mode. See our API documentation on [Record Payment for an Invoice](https://apidocs.chargebee.com/docs/api/v1/transactions#record_payment_for_an_invoice "Record Payment for an Invoice")
459
467
 
460
468
  ### v1.3.7 (2014-03-18)
461
469
  * * *
462
- Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/addons#delete_an_addon "Delete an addon").
470
+ Support for deleting the plans & addons. See our API documentation on [Delete a plan](https://apidocs.chargebee.com/docs/api/v1/plans#delete_a_plan "Delete a plan") & [Delete an addon](https://apidocs.chargebee.com/docs/api/v1/addons#delete_an_addon "Delete an addon").
463
471
 
464
472
  ### v1.3.6 (2014-03-10)
465
473
  * * *
data/README.rdoc CHANGED
@@ -1,16 +1,20 @@
1
- = ChargeBee Ruby Client Library
1
+ = Chargebee Ruby Client Library - API V1
2
2
 
3
- The ruby library for integrating with ChargeBee Recurring Billing and Subscription Management solution.
3
+ The ruby library for integrating with Chargebee Recurring Billing and Subscription Management solution.
4
+
5
+ Chargebee now supports two API versions - {V1}[https://apidocs.chargebee.com/docs/api/v1] and {V2}[https://apidocs.chargebee.com/docs/api]. This library is for our <b>older API version V1</b>. The library for V2 can be found in the {master branch}[https://github.com/chargebee/chargebee-ruby].
6
+
7
+ You'd want to upgrade to V2 to benefit from the new functionality. Click here for the {API V2 Upgradation Guide}[https://apidocs.chargebee.com/docs/api/v1#api-v2-upgradation-guide].
4
8
 
5
9
  == Installation
6
10
 
7
11
  Install the latest version of the gem with the following command...
8
-
9
- $ sudo gem install chargebee
12
+
13
+ $ sudo gem install chargebee -v '~>1'
10
14
 
11
15
  == Documentation
12
16
 
13
- For API reference see https://apidocs.chargebee.com/docs/api?lang=ruby
17
+ For API reference see {here}[https://apidocs.chargebee.com/docs/api/v1/?lang=ruby]
14
18
 
15
19
  == Usage
16
20
 
data/chargebee.gemspec CHANGED
@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
4
4
  s.rubygems_version = '1.3.5'
5
5
 
6
6
  s.name = 'chargebee'
7
- s.version = '1.7.1'
8
- s.date = '2016-03-22'
7
+ s.version = '1.7.2'
8
+ s.date = '2016-04-06'
9
9
 
10
10
  s.summary = "Ruby client for Chargebee API."
11
11
  s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
data/lib/chargebee.rb CHANGED
@@ -28,7 +28,7 @@ require File.dirname(__FILE__) + '/chargebee/models/download'
28
28
 
29
29
  module ChargeBee
30
30
 
31
- VERSION = '1.7.1'
31
+ VERSION = '1.7.2'
32
32
 
33
33
  @@default_env = nil
34
34
  @@verify_ca_certs = true
data/lib/chargebee/environment.rb CHANGED
@@ -1,17 +1,17 @@
1
1
  module ChargeBee
2
2
  class Environment
3
-
3
+ API_VERSION = "v1"
4
4
  attr_accessor :api_key, :site
5
- attr_reader :api_endpoint
5
+ attr_reader :api_endpoint
6
6
 
7
7
  def initialize(options)
8
8
  [:api_key, :site].each do |attr|
9
9
  instance_variable_set "@#{attr}", options[attr]
10
10
  end
11
11
  if($CHARGEBEE_DOMAIN == nil)
12
- @api_endpoint = "https://#{@site}.chargebee.com/api/v1"
12
+ @api_endpoint = "https://#{@site}.chargebee.com/api/#{API_VERSION}"
13
13
  else
14
- @api_endpoint = "#{$ENV_PROTOCOL == nil ? "http": "https"}://#{@site}.#{$CHARGEBEE_DOMAIN}/api/v1"
14
+ @api_endpoint = "#{$ENV_PROTOCOL == nil ? "http": "https"}://#{@site}.#{$CHARGEBEE_DOMAIN}/api/#{API_VERSION}"
15
15
  end
16
16
  end
17
17
 
data/lib/chargebee/models/event.rb CHANGED
@@ -6,7 +6,7 @@ module ChargeBee
6
6
  end
7
7
 
8
8
  attr_accessor :id, :occurred_at, :source, :user, :webhook_status, :webhook_failure_reason, :webhooks,
9
- :event_type
9
+ :event_type, :api_version
10
10
 
11
11
  class Content < Result
12
12
  end
@@ -21,6 +21,12 @@ module ChargeBee
21
21
  rescue JSON::ParserError => e
22
22
  raise Error.new("Invalid webhook object to deserialize. #{e}",e)
23
23
  end
24
+
25
+ api_version = webhook_data["api_version"]
26
+ if api_version != nil && api_version.casecmp(Environment::API_VERSION) != 0
27
+ raise Error.new("API version [#{api_version.upcase}] in response does not match with client library API version [#{Environment::API_VERSION.upcase}]")
28
+ end
29
+
24
30
  webhook_data = Util.symbolize_keys(webhook_data)
25
31
  Event.construct(webhook_data)
26
32
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chargebee
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.7.1
4
+ version: 1.7.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rajaraman S
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2016-03-22 00:00:00.000000000 Z
12
+ date: 2016-04-06 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: json_pure