chargebee 1.7.5 → 2.0.0

data/lib/chargebee/models/card.rb

@@ -1,9 +1,9 @@
 module ChargeBee
   class Card < Model
 
-  attr_accessor :status, :gateway, :reference_id, :first_name, :last_name, :iin, :last4, :card_type,
+  attr_accessor :customer_id, :status, :gateway, :first_name, :last_name, :iin, :last4, :card_type,
   :expiry_month, :expiry_year, :billing_addr1, :billing_addr2, :billing_city, :billing_state_code,
-  :billing_state, :billing_country, :billing_zip, :ip_address, :customer_id, :masked_number
+  :billing_state, :billing_country, :billing_zip, :ip_address, :masked_number
 
   # OPERATIONS
   #-----------
@@ -16,10 +16,6 @@ module ChargeBee
     Request.send('post', uri_path("customers",id.to_s,"credit_card"), params, env, headers)
   end
 
-  def self.update_card_for_customer_using_payment_intent(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"credit_card_using_payment_intent"), params, env, headers)
-  end
-
   def self.switch_gateway_for_customer(id, params, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s,"switch_gateway"), params, env, headers)
   end

data/lib/chargebee/models/credit_note.rb

@@ -0,0 +1,44 @@
+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
+    end
+
+    class Discount < Model
+      attr_accessor :amount, :description, :entity_type, :entity_id
+    end
+
+    class Tax < Model
+      attr_accessor :amount, :description
+    end
+
+    class LinkedRefund < Model
+      attr_accessor :txn_id, :applied_amount, :applied_at, :txn_status, :txn_date, :txn_amount
+    end
+
+    class Allocation < Model
+      attr_accessor :invoice_id, :allocated_amount, :allocated_at, :invoice_date, :invoice_status
+    end
+
+  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
+
+  # OPERATIONS
+  #-----------
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("credit_notes",id.to_s), {}, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send('get', uri_path("credit_notes"), params, env, headers)
+  end
+
+  def self.credit_notes_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"credit_notes"), params, env, headers)
+  end
+
+  end # ~CreditNote
+end # ~ChargeBee

data/lib/chargebee/models/credit_note_estimate.rb

@@ -0,0 +1,23 @@
+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
+    end
+
+    class Discount < Model
+      attr_accessor :amount, :description, :entity_type, :entity_id
+    end
+
+    class Tax < Model
+      attr_accessor :amount, :description
+    end
+
+  attr_accessor :reference_invoice_id, :type, :price_type, :sub_total, :total, :amount_allocated,
+  :amount_available, :line_items, :discounts, :taxes
+
+  # OPERATIONS
+  #-----------
+
+  end # ~CreditNoteEstimate
+end # ~ChargeBee

data/lib/chargebee/models/customer.rb

@@ -15,7 +15,7 @@ module ChargeBee
 
   attr_accessor :id, :first_name, :last_name, :email, :phone, :company, :vat_number, :auto_collection,
   :allow_direct_debit, :created_at, :created_from_ip, :taxability, :card_status, :billing_address,
-  :contacts, :payment_method, :invoice_notes, :account_credits, :refundable_credits, :excess_payments,
+  :contacts, :payment_method, :invoice_notes, :promotional_credits, :refundable_credits, :excess_payments,
   :meta_data
 
   # OPERATIONS
@@ -57,16 +57,16 @@ module ChargeBee
     Request.send('post', uri_path("customers",id.to_s,"delete_contact"), params, env, headers)
   end
 
-  def self.add_account_credits(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"add_account_credits"), params, env, headers)
+  def self.add_promotional_credits(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"add_promotional_credits"), params, env, headers)
   end
 
-  def self.deduct_account_credits(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"deduct_account_credits"), params, env, headers)
+  def self.deduct_promotional_credits(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"deduct_promotional_credits"), params, env, headers)
   end
 
-  def self.set_account_credits(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"set_account_credits"), params, env, headers)
+  def self.set_promotional_credits(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"set_promotional_credits"), params, env, headers)
   end
 
   def self.delete(id, params={}, env=nil, headers={})

data/lib/chargebee/models/estimate.rb

@@ -1,21 +1,7 @@
 module ChargeBee
   class Estimate < Model
 
-    class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax, :tax_rate, :amount, :description, :type, :entity_type, :entity_id
-    end
-
-    class Discount < Model
-      attr_accessor :amount, :description, :type, :entity_id
-    end
-
-    class Tax < Model
-      attr_accessor :amount, :description
-    end
-
-  attr_accessor :created_at, :recurring, :subscription_id, :subscription_status, :term_ends_at,
-  :collect_now, :price_type, :amount, :credits_applied, :amount_due, :sub_total, :line_items,
-  :discounts, :taxes
+  attr_accessor :created_at, :subscription_estimate, :invoice_estimate, :credit_note_estimates
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/hosted_page.rb

@@ -34,14 +34,6 @@ module ChargeBee
     Request.send('post', uri_path("hosted_pages","update_payment_method"), params, env, headers)
   end
 
-  def self.checkout_onetime_charge(params, env=nil, headers={})
-    Request.send('post', uri_path("hosted_pages","checkout_onetime_charge"), params, env, headers)
-  end
-
-  def self.checkout_onetime_addons(params, env=nil, headers={})
-    Request.send('post', uri_path("hosted_pages","checkout_onetime_addons"), params, env, headers)
-  end
-
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("hosted_pages",id.to_s), {}, env, headers)
   end

data/lib/chargebee/models/invoice.rb

@@ -2,19 +2,31 @@ module ChargeBee
   class Invoice < Model
 
     class LineItem < Model
-      attr_accessor :date_from, :date_to, :unit_amount, :quantity, :is_taxed, :tax, :tax_rate, :amount, :description, :type, :entity_type, :entity_id
+      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
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :type, :entity_id
+      attr_accessor :amount, :description, :entity_type, :entity_id
     end
 
     class Tax < Model
       attr_accessor :amount, :description
     end
 
-    class LinkedTransaction < Model
-      attr_accessor :txn_id, :applied_amount, :applied_at, :txn_type, :txn_status, :txn_date, :txn_amount
+    class LinkedPayment < Model
+      attr_accessor :txn_id, :applied_amount, :applied_at, :txn_status, :txn_date, :txn_amount
+    end
+
+    class AppliedCredit < Model
+      attr_accessor :cn_id, :applied_amount, :applied_at, :cn_reason_code, :cn_date, :cn_status
+    end
+
+    class AdjustmentCreditNote < Model
+      attr_accessor :cn_id, :cn_reason_code, :cn_date, :cn_total, :cn_status
+    end
+
+    class IssuedCreditNote < Model
+      attr_accessor :cn_id, :cn_reason_code, :cn_date, :cn_total, :cn_status
     end
 
     class LinkedOrder < Model
@@ -34,10 +46,10 @@ module ChargeBee
     end
 
   attr_accessor :id, :po_number, :customer_id, :subscription_id, :recurring, :status, :vat_number,
-  :price_type, :start_date, :end_date, :amount, :amount_paid, :amount_adjusted, :credits_applied,
-  :amount_due, :paid_on, :dunning_status, :next_retry, :sub_total, :tax, :first_invoice, :currency_code,
-  :line_items, :discounts, :taxes, :linked_transactions, :linked_orders, :notes, :shipping_address,
-  :billing_address
+  :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,
+  :issued_credit_notes, :linked_orders, :notes, :shipping_address, :billing_address
 
   # OPERATIONS
   #-----------
@@ -86,14 +98,18 @@ module ChargeBee
     Request.send('post', uri_path("invoices",id.to_s,"add_addon_charge"), params, env, headers)
   end
 
-  def self.collect(id, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"collect"), {}, env, headers)
+  def self.close(id, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"close"), {}, env, headers)
   end
 
   def self.collect_payment(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("invoices",id.to_s,"collect_payment"), params, env, headers)
   end
 
+  def self.record_payment(id, params, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"record_payment"), params, env, headers)
+  end
+
   def self.refund(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("invoices",id.to_s,"refund"), params, env, headers)
   end

data/lib/chargebee/models/invoice_estimate.rb

@@ -0,0 +1,23 @@
+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
+    end
+
+    class Discount < Model
+      attr_accessor :amount, :description, :entity_type, :entity_id
+    end
+
+    class Tax < Model
+      attr_accessor :amount, :description
+    end
+
+  attr_accessor :recurring, :price_type, :sub_total, :total, :credits_applied, :amount_paid, :amount_due,
+  :line_items, :discounts, :taxes
+
+  # OPERATIONS
+  #-----------
+
+  end # ~InvoiceEstimate
+end # ~ChargeBee

data/lib/chargebee/models/model.rb

@@ -3,9 +3,10 @@ require 'uri'
 module ChargeBee
   class Model
     
-    def initialize(values, sub_types={})
+    def initialize(values, sub_types={}, dependant_types={})
       @values = values
       @sub_types = sub_types
+      @dependant_types = dependant_types
     end
     
     def to_s(*args) 
@@ -21,6 +22,8 @@ module ChargeBee
         values.each do |k, v|
           set_val = nil
           case v
+          when Hash && (@dependant_types[k] != nil)
+            next
           when Hash
             set_val = (@sub_types[k] != nil) ? @sub_types[k].construct(v) : v
           when Array
@@ -58,13 +61,41 @@ module ChargeBee
       return url
     end
     
-    def self.construct(values, sub_types = {})
+    def self.construct(values, sub_types = {}, dependant_types = {})
       if(values != nil)
-        obj = self.new(values, sub_types)
+        obj = self.new(values, sub_types, dependant_types)
         obj.load(values)
         obj
       end
     end
     
+    def init_dependant(obj, type, sub_types = {})
+      instance_eval do
+        if(obj[type] != nil)
+          case obj
+          when Hash
+            if(@dependant_types[type] != nil)
+              dependant_obj = @dependant_types[type].construct(obj[type], sub_types)
+              instance_variable_set("@#{type}", dependant_obj)
+            end
+          end
+        end
+      end
+    end
+    
+    def init_dependant_list(obj, type, sub_types = {})
+      instance_eval do
+        if(obj[type] != nil)
+          case obj[type]
+          when Array
+            if(@dependant_types[type] != nil)
+              set_val = obj[type].map {|dt| @dependant_types[type].construct(dt, sub_types)}
+              instance_variable_set("@#{type}", set_val)
+            end
+          end
+        end
+      end
+    end
+    
   end
 end

data/lib/chargebee/models/subscription_estimate.rb

@@ -0,0 +1,10 @@
+module ChargeBee
+  class SubscriptionEstimate < Model
+
+  attr_accessor :id, :status, :next_billing_at
+
+  # OPERATIONS
+  #-----------
+
+  end # ~SubscriptionEstimate
+end # ~ChargeBee

data/lib/chargebee/models/transaction.rb

@@ -2,7 +2,11 @@ module ChargeBee
   class Transaction < Model
 
     class LinkedInvoice < Model
-      attr_accessor :invoice_id, :applied_amount, :applied_at, :invoice_date, :invoice_amount
+      attr_accessor :invoice_id, :applied_amount, :applied_at, :invoice_date, :invoice_total, :invoice_status
+    end
+
+    class LinkedCreditNote < Model
+      attr_accessor :cn_id, :applied_amount, :applied_at, :cn_reason_code, :cn_date, :cn_total, :cn_status, :cn_reference_invoice_id
     end
 
     class LinkedRefund < Model
@@ -10,9 +14,9 @@ module ChargeBee
     end
 
   attr_accessor :id, :customer_id, :subscription_id, :payment_method, :reference_number, :gateway,
-  :description, :type, :date, :currency_code, :amount, :id_at_gateway, :status, :initiator_type,
-  :three_d_secure, :error_code, :error_text, :voided_at, :void_description, :amount_unused, :masked_card_number,
-  :reference_transaction_id, :refunded_txn_id, :reversal_transaction_id, :linked_invoices, :linked_refunds
+  :type, :date, :amount, :id_at_gateway, :status, :error_code, :error_text, :voided_at, :amount_unused,
+  :masked_card_number, :reference_transaction_id, :refunded_txn_id, :reversal_transaction_id,
+  :linked_invoices, :linked_credit_notes, :linked_refunds, :currency_code
 
   # OPERATIONS
   #-----------
@@ -29,17 +33,13 @@ module ChargeBee
     Request.send('get', uri_path("subscriptions",id.to_s,"transactions"), params, env, headers)
   end
 
-  def self.transactions_for_invoice(id, params={}, env=nil, headers={})
-    Request.send('get', uri_path("invoices",id.to_s,"transactions"), params, env, headers)
+  def self.payments_for_invoice(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("invoices",id.to_s,"payments"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("transactions",id.to_s), {}, env, headers)
   end
 
-  def self.record_payment(id, params, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"record_payment"), params, env, headers)
-  end
-
   end # ~Transaction
 end # ~ChargeBee

data/lib/chargebee/result.rb

@@ -6,90 +6,139 @@ module ChargeBee
     end
     
     def subscription() 
-        get(:subscription, Subscription, 
+        subscription = get(:subscription, Subscription,
         {:addons => Subscription::Addon, :coupons => Subscription::Coupon, :shipping_address => Subscription::ShippingAddress});
+        return subscription;
     end
 
     def customer() 
-        get(:customer, Customer, 
+        customer = get(:customer, Customer,
         {:billing_address => Customer::BillingAddress, :contacts => Customer::Contact, :payment_method => Customer::PaymentMethod});
+        return customer;
     end
 
     def card() 
-        get(:card, Card);
+        card = get(:card, Card);
+        return card;
     end
 
     def invoice() 
-        get(:invoice, Invoice, 
-        {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :taxes => Invoice::Tax, :linked_transactions => Invoice::LinkedTransaction, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :billing_address => Invoice::BillingAddress});
+        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});
+        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});
+        return credit_note;
     end
 
     def order() 
-        get(:order, Order);
+        order = get(:order, Order);
+        return order;
     end
 
     def transaction() 
-        get(:transaction, Transaction, 
-        {:linked_invoices => Transaction::LinkedInvoice, :linked_refunds => Transaction::LinkedRefund});
+        transaction = get(:transaction, Transaction,
+        {:linked_invoices => Transaction::LinkedInvoice, :linked_credit_notes => Transaction::LinkedCreditNote, :linked_refunds => Transaction::LinkedRefund});
+        return transaction;
     end
 
     def hosted_page() 
-        get(:hosted_page, HostedPage);
+        hosted_page = get(:hosted_page, HostedPage);
+        return hosted_page;
     end
 
     def estimate() 
-        get(:estimate, Estimate, 
-        {:line_items => Estimate::LineItem, :discounts => Estimate::Discount, :taxes => Estimate::Tax});
+        estimate = get(:estimate, Estimate, {},
+        {:subscription_estimate => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate});
+        estimate.init_dependant(@response[:estimate], :subscription_estimate,
+        {});
+        estimate.init_dependant(@response[:estimate], :invoice_estimate,
+        {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax});
+        estimate.init_dependant_list(@response[:estimate], :credit_note_estimates,
+        {:line_items => CreditNoteEstimate::LineItem, :discounts => CreditNoteEstimate::Discount, :taxes => CreditNoteEstimate::Tax});
+        return estimate;
     end
 
     def plan() 
-        get(:plan, Plan);
+        plan = get(:plan, Plan);
+        return plan;
     end
 
     def addon() 
-        get(:addon, Addon);
+        addon = get(:addon, Addon);
+        return addon;
     end
 
     def coupon() 
-        get(:coupon, Coupon);
+        coupon = get(:coupon, Coupon);
+        return coupon;
     end
 
     def coupon_code() 
-        get(:coupon_code, CouponCode);
+        coupon_code = get(:coupon_code, CouponCode);
+        return coupon_code;
     end
 
     def address() 
-        get(:address, Address);
+        address = get(:address, Address);
+        return address;
     end
 
     def event() 
-        get(:event, Event, 
+        event = get(:event, Event,
         {:webhooks => Event::Webhook});
+        return event;
     end
 
     def comment() 
-        get(:comment, Comment);
+        comment = get(:comment, Comment);
+        return comment;
     end
 
     def download() 
-        get(:download, Download);
+        download = get(:download, Download);
+        return download;
     end
 
     def portal_session() 
-        get(:portal_session, PortalSession, 
+        portal_session = get(:portal_session, PortalSession,
         {:linked_customers => PortalSession::LinkedCustomer});
+        return portal_session;
     end
 
-    def payment_intent() 
-        get(:payment_intent, PaymentIntent, 
-        {:payment_attempt => PaymentIntent::PaymentAttempt});
-    end
 
+    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});
+        return credit_notes;
+    end
+    
 
+    private
+    def get_list(type, klass, sub_types = {}, dependant_types = {}, dependant_sub_types = {})
+      if(@response[type] == nil)
+        return nil
+      end
+      set_val = Array.new
+      @response[type].each do |obj|
+        case obj
+        when Hash
+          model = klass.construct(obj, sub_types, dependant_types)
+          dependant_sub_types.each do |k,v|
+        		model.init_dependant(obj, k, v);
+          end
+          set_val.push(model)
+        end
+      end
+      return instance_variable_set("@#{type}", set_val)
+    end
 
     private
-    def get(type, klass, sub_types = {})
-      klass.construct(@response[type], sub_types)
+    def get(type, klass, sub_types = {}, dependant_types = {})
+      return klass.construct(@response[type], sub_types, dependant_types)
     end
 
     def to_s(*args)