chargebee 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b981e967df2845afe5a4012f7bd25a19735b64
-  data.tar.gz: ec73acf89d1558036cb5c7d3b4419898b409a10f
+  metadata.gz: c50f7763337a5cd1aaa98f7875b30d3c3f734fba
+  data.tar.gz: 178dbfe900f73a7bdcc647bf87a3541649c751ff
 SHA512:
-  metadata.gz: ca9a30a8fd1812b57af85f7c89343e5964d16deb9155a9721e8ef9a73250bab9f4ef929b51e055affb7e2f1e2c6f255e34346a665a9cb4c3a9436b764bb99523
-  data.tar.gz: 4915512947310028191ea516a37b8869767c533709ba550a10706eb9c7a71374d64d7c761b6166011645c826080eecc93b26d148372b6ea471a8d8a31a4ba698
+  metadata.gz: a756b7a44160fffedb9df52269caa8f180678d0b38a62693fcd4a310f03612f15091eed08c8cfeb544a9d405bcaab70541d2f52a0a82c3e2d9355bebfb586660
+  data.tar.gz: 316350759181c640abc1ca0a99f3793f21b93668800a08af3a3a5f4d52e34beb98f270781f2f0116fcab8bf1db3ec080b482af1c33339ae4182219c871aa56cd

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+### v2.0.3 (2016-05-20)
+* * *
+
+#### Filtering Resources using List API
+
+Chargebee supports bulk fetching of resources via 'List' API methods. (List invoices, List subscriptions etc..). In the List methods, filtering of resources can be performed using filter parameters. Also in the List methods, the sort_by parameter is provided for sorting the result in the desired order. 
+See : https://apidocs.chargebee.com/docs/api#pagination_and_filtering
+
+** APIs deprecated**:
+
+The Following API's are deprecated since these operations can be achieved through List API's
+* List Subscriptions for a Customer
+* List Invoices for a Customer
+* List Invoices for a Subscription
+* List Credit Note for a Customer
+* List Credit Note for a Subscription
+* List Transactions for a Customer
+* List Transations for a Subscription 
+
+** APIs added**:
+
+Support to copy card to gateway for a customer. New api endpoint to copy card for a customer is added to Card resources. 
+See: https://apidocs.chargebee.com/docs/api/cards#copy_card
+
+** APIs updated**:
+
+New attribute "id" is returned as part of Line Items subresource of Invoice and Credit Note resource.
+See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
+
+New attribute "name" is returned as part of Taxes subresource of Invoice and Credit Note resource.
+See: https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
+
+
+A new sub-resource "line_item_taxes" is returned as part of the Invoice and Credit Note resource attributes.
+See : https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes
+
+
 ### v2.0.2 (2016-05-02)
 * * *
 ** APIs added**:
@@ -38,7 +75,7 @@ The attribute "taxability" for customer has been deprecated in the Update Subscr
 #### Attributes and Operations Removed/Renamed in V2
 Chargebee [API V2](https://apidocs.chargebee.com/docs/api#versions) is now live! All our future developments will happen in V2. 
 
-V2 has been released to accommodate certain backwards-incompatible changes. Refer our [API V2 Upgradation guide](https://apidocs.chargebee.com/docs/api#api-v2-upgradation-guide) for the complete listing of the attributes and operations that have been removed/renamed in API V2.
+V2 has been released to accommodate certain backwards-incompatible changes. Refer our [API V2 Upgradation guide](https://apidocs.chargebee.com/docs/api/v1#api-v2-upgradation-guide) for the complete listing of the attributes and operations that have been removed/renamed in API V2.
 
 #### Incremental Changes in V2
 
@@ -61,6 +98,7 @@ V2 has been released to accommodate certain backwards-incompatible changes. Refe
   * *item_level_discount_amount* - only the item-level-discount amount component.
 * Further [discounts[].entity_type](https://apidocs.chargebee.com/docs/api/invoices#invoice_attributes) will have two types for coupon -  *item_level_coupon* and *document_level_coupon*. 
 * Input Param *use_existing_balances* is added to the operations - [Update Subscription Estimate](https://apidocs.chargebee.com/docs/api/estimates#update_subscription_estimate) and [Subscription Renewal Estimate](https://apidocs.chargebee.com/docs/api/estimates#subscription_renewal_estimate)
+* The API's *checkout_onetime_addons* and *checkout_onetime_charge* in Hosted Page resource are removed in V2.
 
 ### v1.7.2 (2016-04-06)
 * * *

data/chargebee.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'chargebee'
-  s.version           = '2.0.2'
-  s.date              = '2016-05-02'
+  s.version           = '2.0.3'
+  s.date              = '2016-05-20'
 
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
@@ -55,6 +55,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/model.rb
     lib/chargebee/models/order.rb
     lib/chargebee/models/plan.rb
+    lib/chargebee/models/plan.rb~
     lib/chargebee/models/portal_session.rb
     lib/chargebee/models/subscription.rb
     lib/chargebee/models/subscription_estimate.rb

data/lib/chargebee.rb

@@ -32,7 +32,7 @@ require File.dirname(__FILE__) + '/chargebee/models/download'
 
 module ChargeBee
 
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/lib/chargebee/models/addon.rb

@@ -17,7 +17,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("addons"), params, env, headers)
+    Request.send_list_request('get', uri_path("addons"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})

data/lib/chargebee/models/card.rb

@@ -20,6 +20,10 @@ module ChargeBee
     Request.send('post', uri_path("customers",id.to_s,"switch_gateway"), params, env, headers)
   end
 
+  def self.copy_card_for_customer(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"copy_card"), params, env, headers)
+  end
+
   def self.delete_card_for_customer(id, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s,"delete_card"), {}, env, headers)
   end

data/lib/chargebee/models/comment.rb

@@ -15,7 +15,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("comments"), params, env, headers)
+    Request.send_list_request('get', uri_path("comments"), params, env, headers)
   end
 
   def self.delete(id, env=nil, headers={})

data/lib/chargebee/models/coupon.rb

@@ -14,7 +14,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("coupons"), params, env, headers)
+    Request.send_list_request('get', uri_path("coupons"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})

data/lib/chargebee/models/credit_note.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class CreditNote < Model
 
     class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
+      attr_accessor :id, :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
     end
 
     class Discount < Model
@@ -10,7 +10,11 @@ module ChargeBee
     end
 
     class Tax < Model
-      attr_accessor :amount, :description
+      attr_accessor :name, :amount, :description
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
     end
 
     class LinkedRefund < Model
@@ -23,7 +27,8 @@ module ChargeBee
 
   attr_accessor :id, :customer_id, :subscription_id, :reference_invoice_id, :type, :reason_code,
   :status, :vat_number, :date, :price_type, :total, :amount_allocated, :amount_refunded, :amount_available,
-  :refunded_at, :sub_total, :line_items, :discounts, :taxes, :linked_refunds, :allocations
+  :refunded_at, :sub_total, :line_items, :discounts, :taxes, :line_item_taxes, :linked_refunds,
+  :allocations
 
   # OPERATIONS
   #-----------
@@ -33,7 +38,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("credit_notes"), params, env, headers)
+    Request.send_list_request('get', uri_path("credit_notes"), params, env, headers)
   end
 
   def self.credit_notes_for_customer(id, params={}, env=nil, headers={})

data/lib/chargebee/models/credit_note_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class CreditNoteEstimate < Model
 
     class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
+      attr_accessor :id, :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
     end
 
     class Discount < Model
@@ -10,11 +10,15 @@ module ChargeBee
     end
 
     class Tax < Model
-      attr_accessor :amount, :description
+      attr_accessor :name, :amount, :description
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
     end
 
   attr_accessor :reference_invoice_id, :type, :price_type, :sub_total, :total, :amount_allocated,
-  :amount_available, :line_items, :discounts, :taxes
+  :amount_available, :line_items, :discounts, :taxes, :line_item_taxes
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/customer.rb

@@ -26,7 +26,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("customers"), params, env, headers)
+    Request.send_list_request('get', uri_path("customers"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})

data/lib/chargebee/models/event.rb

@@ -35,7 +35,7 @@ module ChargeBee
   #-----------
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("events"), params, env, headers)
+    Request.send_list_request('get', uri_path("events"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})

data/lib/chargebee/models/invoice.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Invoice < Model
 
     class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
+      attr_accessor :id, :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
     end
 
     class Discount < Model
@@ -10,7 +10,11 @@ module ChargeBee
     end
 
     class Tax < Model
-      attr_accessor :amount, :description
+      attr_accessor :name, :amount, :description
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
     end
 
     class LinkedPayment < Model
@@ -48,7 +52,7 @@ module ChargeBee
   attr_accessor :id, :po_number, :customer_id, :subscription_id, :recurring, :status, :vat_number,
   :price_type, :date, :total, :amount_paid, :amount_adjusted, :write_off_amount, :credits_applied,
   :amount_due, :paid_at, :dunning_status, :next_retry_at, :sub_total, :tax, :first_invoice, :currency_code,
-  :line_items, :discounts, :taxes, :linked_payments, :applied_credits, :adjustment_credit_notes,
+  :line_items, :discounts, :taxes, :line_item_taxes, :linked_payments, :applied_credits, :adjustment_credit_notes,
   :issued_credit_notes, :linked_orders, :notes, :shipping_address, :billing_address
 
   # OPERATIONS
@@ -71,7 +75,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("invoices"), params, env, headers)
+    Request.send_list_request('get', uri_path("invoices"), params, env, headers)
   end
 
   def self.invoices_for_customer(id, params={}, env=nil, headers={})

data/lib/chargebee/models/invoice_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class InvoiceEstimate < Model
 
     class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
+      attr_accessor :id, :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax_amount, :tax_rate, :amount, :discount_amount, :item_level_discount_amount, :description, :entity_type, :entity_id
     end
 
     class Discount < Model
@@ -10,11 +10,15 @@ module ChargeBee
     end
 
     class Tax < Model
-      attr_accessor :amount, :description
+      attr_accessor :name, :amount, :description
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
     end
 
   attr_accessor :recurring, :price_type, :sub_total, :total, :credits_applied, :amount_paid, :amount_due,
-  :line_items, :discounts, :taxes
+  :line_items, :discounts, :taxes, :line_item_taxes
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/order.rb

@@ -20,7 +20,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("orders"), params, env, headers)
+    Request.send_list_request('get', uri_path("orders"), params, env, headers)
   end
 
   def self.orders_for_invoice(id, params={}, env=nil, headers={})

data/lib/chargebee/models/plan.rb

@@ -18,7 +18,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("plans"), params, env, headers)
+    Request.send_list_request('get', uri_path("plans"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})

data/lib/chargebee/models/plan.rb~

@@ -0,0 +1,33 @@
+module ChargeBee
+  class Plan < Model
+
+  attr_accessor :id, :name, :invoice_name, :description, :price, :period, :period_unit, :trial_period,
+  :trial_period_unit, :charge_model, :free_quantity, :setup_cost, :downgrade_penalty, :status,
+  :archived_at, :billing_cycles, :redirect_url, :enabled_in_hosted_pages, :enabled_in_portal,
+  :tax_code, :invoice_notes, :taxable, :meta_data
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("plans"), params, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("plans",id.to_s), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list('get', uri_path("plans"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("plans",id.to_s), {}, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("plans",id.to_s,"delete"), {}, env, headers)
+  end
+
+  end # ~Plan
+end # ~ChargeBee

data/lib/chargebee/models/subscription.rb

@@ -13,8 +13,8 @@ module ChargeBee
       attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip
     end
 
-  attr_accessor :id, :plan_id, :plan_quantity, :status, :start_date, :trial_start, :trial_end,
-  :current_term_start, :current_term_end, :remaining_billing_cycles, :po_number, :created_at,
+  attr_accessor :id, :customer_id, :plan_id, :plan_quantity, :status, :start_date, :trial_start,
+  :trial_end, :current_term_start, :current_term_end, :remaining_billing_cycles, :po_number, :created_at,
   :started_at, :activated_at, :cancelled_at, :cancel_reason, :affiliate_token, :created_from_ip,
   :has_scheduled_changes, :due_invoices_count, :due_since, :total_dues, :addons, :coupon, :coupons,
   :shipping_address, :invoice_notes, :meta_data
@@ -31,7 +31,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("subscriptions"), params, env, headers)
+    Request.send_list_request('get', uri_path("subscriptions"), params, env, headers)
   end
 
   def self.subscriptions_for_customer(id, params={}, env=nil, headers={})

data/lib/chargebee/models/transaction.rb

@@ -22,7 +22,7 @@ module ChargeBee
   #-----------
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("transactions"), params, env, headers)
+    Request.send_list_request('get', uri_path("transactions"), params, env, headers)
   end
 
   def self.transactions_for_customer(id, params={}, env=nil, headers={})

data/lib/chargebee/request.rb

@@ -1,6 +1,17 @@
 module ChargeBee
   class Request    
 
+    def self.send_list_request(method, url, params={}, env=nil, headers={})
+      serialized = {}
+      params.each do |k, v|
+        if(v.kind_of? Array)
+          v = v.to_json
+        end
+        serialized["#{k}"] = v
+      end 
+      self.send(method, url, serialized, env, headers) 
+    end
+
     def self.send(method, url, params={}, env=nil, headers={})
       env ||= ChargeBee.default_env
       ser_params = Util.serialize(params)

data/lib/chargebee/result.rb

@@ -24,13 +24,13 @@ module ChargeBee
 
     def invoice() 
         invoice = get(:invoice, Invoice,
-        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :taxes => Invoice::Tax, :linked_payments => Invoice::LinkedPayment, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :billing_address => Invoice::BillingAddress});
+        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :linked_payments => Invoice::LinkedPayment, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :billing_address => Invoice::BillingAddress});
         return invoice;
     end
 
     def credit_note() 
         credit_note = get(:credit_note, CreditNote,
-        {:line_items => CreditNote::LineItem, :discounts => CreditNote::Discount, :taxes => CreditNote::Tax, :linked_refunds => CreditNote::LinkedRefund, :allocations => CreditNote::Allocation});
+        {:line_items => CreditNote::LineItem, :discounts => CreditNote::Discount, :taxes => CreditNote::Tax, :line_item_taxes => CreditNote::LineItemTax, :linked_refunds => CreditNote::LinkedRefund, :allocations => CreditNote::Allocation});
         return credit_note;
     end
 
@@ -56,9 +56,9 @@ module ChargeBee
         estimate.init_dependant(@response[:estimate], :subscription_estimate,
         {});
         estimate.init_dependant(@response[:estimate], :invoice_estimate,
-        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax});
+        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax});
         estimate.init_dependant_list(@response[:estimate], :credit_note_estimates,
-        {:line_items => CreditNoteEstimate::LineItem, :discounts => CreditNoteEstimate::Discount, :taxes => CreditNoteEstimate::Tax});
+        {:line_items => CreditNoteEstimate::LineItem, :discounts => CreditNoteEstimate::Discount, :taxes => CreditNoteEstimate::Tax, :line_item_taxes => CreditNoteEstimate::LineItemTax});
         return estimate;
     end
 
@@ -112,7 +112,7 @@ module ChargeBee
 
     def credit_notes()
         credit_notes = get_list(:credit_notes, CreditNote,
-        {:line_items => CreditNote::LineItem, :discounts => CreditNote::Discount, :taxes => CreditNote::Tax, :linked_refunds => CreditNote::LinkedRefund, :allocations => CreditNote::Allocation});
+        {:line_items => CreditNote::LineItem, :discounts => CreditNote::Discount, :taxes => CreditNote::Tax, :line_item_taxes => CreditNote::LineItemTax, :linked_refunds => CreditNote::LinkedRefund, :allocations => CreditNote::Allocation});
         return credit_notes;
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -104,6 +104,7 @@ files:
 - lib/chargebee/models/model.rb
 - lib/chargebee/models/order.rb
 - lib/chargebee/models/plan.rb
+- lib/chargebee/models/plan.rb~
 - lib/chargebee/models/portal_session.rb
 - lib/chargebee/models/subscription.rb
 - lib/chargebee/models/subscription_estimate.rb