chargebee 1.7.4 → 2.6.7

data/lib/chargebee/models/hierarchy.rb

@@ -0,0 +1,10 @@
+module ChargeBee
+  class Hierarchy < Model
+
+  attr_accessor :parent_id, :payment_owner_id, :invoice_owner_id, :customer_id, :children_ids
+
+  # OPERATIONS
+  #-----------
+
+  end # ~Hierarchy
+end # ~ChargeBee

data/lib/chargebee/models/hosted_page.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class HostedPage < Model
 
   attr_accessor :id, :type, :url, :state, :failure_reason, :pass_thru_content, :embed, :created_at,
-  :expires_at
+  :expires_at, :updated_at, :resource_version, :checkout_info
 
   class Content < Result
   end
@@ -34,17 +34,45 @@ 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)
+  def self.manage_payment_sources(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","manage_payment_sources"), 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)
+  def self.collect_now(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","collect_now"), params, env, headers)
+  end
+
+  def self.accept_quote(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","accept_quote"), params, env, headers)
+  end
+
+  def self.extend_subscription(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","extend_subscription"), params, env, headers)
+  end
+
+  def self.checkout_gift(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","checkout_gift"), params, env, headers)
+  end
+
+  def self.claim_gift(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","claim_gift"), params, env, headers)
+  end
+
+  def self.retrieve_agreement_pdf(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","retrieve_agreement_pdf"), params, env, headers)
+  end
+
+  def self.acknowledge(id, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages",id.to_s,"acknowledge"), {}, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("hosted_pages",id.to_s), {}, env, headers)
   end
 
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("hosted_pages"), params, env, headers)
+  end
+
   end # ~HostedPage
 end # ~ChargeBee

data/lib/chargebee/models/invoice.rb

@@ -2,23 +2,51 @@ 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 :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :discount_amount, :item_level_discount_amount, :description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :type, :entity_id
+      attr_accessor :amount, :description, :entity_type, :entity_id
+    end
+
+    class LineItemDiscount < Model
+      attr_accessor :line_item_id, :discount_type, :coupon_id, :discount_amount
     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, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
+    end
+
+    class LineItemTier < Model
+      attr_accessor :line_item_id, :starting_unit, :ending_unit, :quantity_used, :unit_amount
+    end
+
+    class LinkedPayment < Model
+      attr_accessor :txn_id, :applied_amount, :applied_at, :txn_status, :txn_date, :txn_amount
     end
 
-    class LinkedTransaction < Model
-      attr_accessor :txn_id, :applied_amount, :applied_at, :txn_type, :txn_status, :txn_date, :txn_amount
+    class DunningAttempt < Model
+      attr_accessor :attempt, :transaction_id, :dunning_type, :created_at, :txn_status, :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
-      attr_accessor :id, :status, :reference_id, :fulfillment_status, :batch_id, :created_at
+      attr_accessor :id, :document_number, :status, :order_type, :reference_id, :fulfillment_status, :batch_id, :created_at
     end
 
     class Note < Model
@@ -26,18 +54,21 @@ module ChargeBee
     end
 
     class ShippingAddress < Model
-      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip, :validation_status
     end
 
     class BillingAddress < Model
-      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip, :validation_status
     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, :due_date, :net_term_days, :currency_code, :total, :amount_paid, :amount_adjusted,
+  :write_off_amount, :credits_applied, :amount_due, :paid_at, :dunning_status, :next_retry_at,
+  :voided_at, :resource_version, :updated_at, :sub_total, :tax, :first_invoice, :has_advance_charges,
+  :term_finalized, :is_gifted, :expected_payment_date, :amount_to_collect, :round_off_amount,
+  :line_items, :discounts, :line_item_discounts, :taxes, :line_item_taxes, :line_item_tiers, :linked_payments,
+  :dunning_attempts, :applied_credits, :adjustment_credit_notes, :issued_credit_notes, :linked_orders,
+  :notes, :shipping_address, :billing_address, :payment_owner, :deleted
 
   # OPERATIONS
   #-----------
@@ -54,12 +85,24 @@ module ChargeBee
     Request.send('post', uri_path("invoices","charge_addon"), params, env, headers)
   end
 
-  def self.stop_dunning(id, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"stop_dunning"), {}, env, headers)
+  def self.stop_dunning(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"stop_dunning"), params, env, headers)
+  end
+
+  def self.import_invoice(params, env=nil, headers={})
+    Request.send('post', uri_path("invoices","import_invoice"), params, env, headers)
+  end
+
+  def self.apply_payments(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"apply_payments"), params, env, headers)
+  end
+
+  def self.apply_credits(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"apply_credits"), params, env, headers)
   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={})
@@ -74,8 +117,8 @@ module ChargeBee
     Request.send('get', uri_path("invoices",id.to_s), {}, env, headers)
   end
 
-  def self.pdf(id, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"pdf"), {}, env, headers)
+  def self.pdf(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"pdf"), params, env, headers)
   end
 
   def self.add_charge(id, params, env=nil, headers={})
@@ -86,14 +129,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, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"close"), params, 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
@@ -102,13 +149,29 @@ module ChargeBee
     Request.send('post', uri_path("invoices",id.to_s,"record_refund"), params, env, headers)
   end
 
+  def self.remove_payment(id, params, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"remove_payment"), params, env, headers)
+  end
+
+  def self.remove_credit_note(id, params, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"remove_credit_note"), params, env, headers)
+  end
+
   def self.void_invoice(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("invoices",id.to_s,"void"), params, env, headers)
   end
 
+  def self.write_off(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"write_off"), params, env, headers)
+  end
+
   def self.delete(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("invoices",id.to_s,"delete"), params, env, headers)
   end
 
+  def self.update_details(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"update_details"), params, env, headers)
+  end
+
   end # ~Invoice
 end # ~ChargeBee

data/lib/chargebee/models/invoice_estimate.rb

@@ -0,0 +1,36 @@
+module ChargeBee
+  class InvoiceEstimate < Model
+
+    class LineItem < Model
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :discount_amount, :item_level_discount_amount, :description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+    end
+
+    class Discount < Model
+      attr_accessor :amount, :description, :entity_type, :entity_id
+    end
+
+    class Tax < Model
+      attr_accessor :name, :amount, :description
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
+    end
+
+    class LineItemTier < Model
+      attr_accessor :line_item_id, :starting_unit, :ending_unit, :quantity_used, :unit_amount
+    end
+
+    class LineItemDiscount < Model
+      attr_accessor :line_item_id, :discount_type, :coupon_id, :discount_amount
+    end
+
+  attr_accessor :recurring, :price_type, :currency_code, :sub_total, :total, :credits_applied,
+  :amount_paid, :amount_due, :line_items, :discounts, :taxes, :line_item_taxes, :line_item_tiers,
+  :line_item_discounts, :round_off_amount, :customer_id
+
+  # 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/order.rb

@@ -1,8 +1,38 @@
 module ChargeBee
   class Order < Model
 
-  attr_accessor :id, :invoice_id, :status, :reference_id, :fulfillment_status, :note, :tracking_id,
-  :batch_id, :created_by, :created_at, :status_update_at
+    class OrderLineItem < Model
+      attr_accessor :id, :invoice_id, :invoice_line_item_id, :unit_price, :description, :amount, :fulfillment_quantity, :fulfillment_amount, :tax_amount, :amount_paid, :amount_adjusted, :refundable_credits_issued, :refundable_credits, :is_shippable, :sku, :status, :entity_type, :item_level_discount_amount, :discount_amount, :entity_id
+    end
+
+    class ShippingAddress < Model
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip, :validation_status
+    end
+
+    class BillingAddress < Model
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip, :validation_status
+    end
+
+    class LineItemTax < Model
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code
+    end
+
+    class LineItemDiscount < Model
+      attr_accessor :line_item_id, :discount_type, :coupon_id, :discount_amount
+    end
+
+    class LinkedCreditNote < Model
+      attr_accessor :amount, :type, :id, :status, :amount_adjusted, :amount_refunded
+    end
+
+  attr_accessor :id, :document_number, :invoice_id, :subscription_id, :customer_id, :status, :cancellation_reason,
+  :payment_status, :order_type, :price_type, :reference_id, :fulfillment_status, :order_date,
+  :shipping_date, :note, :tracking_id, :batch_id, :created_by, :shipment_carrier, :invoice_round_off_amount,
+  :tax, :amount_paid, :amount_adjusted, :refundable_credits_issued, :refundable_credits, :rounding_adjustement,
+  :paid_on, :shipping_cut_off_date, :created_at, :status_update_at, :delivered_at, :shipped_at,
+  :resource_version, :updated_at, :cancelled_at, :order_line_items, :shipping_address, :billing_address,
+  :discount, :sub_total, :total, :line_item_taxes, :line_item_discounts, :linked_credit_notes,
+  :deleted, :currency_code, :is_gifted, :gift_note, :gift_id
 
   # OPERATIONS
   #-----------
@@ -15,12 +45,28 @@ module ChargeBee
     Request.send('post', uri_path("orders",id.to_s), params, env, headers)
   end
 
+  def self.assign_order_number(id, env=nil, headers={})
+    Request.send('post', uri_path("orders",id.to_s,"assign_order_number"), {}, env, headers)
+  end
+
+  def self.cancel(id, params, env=nil, headers={})
+    Request.send('post', uri_path("orders",id.to_s,"cancel"), params, env, headers)
+  end
+
+  def self.create_refundable_credit_note(id, params, env=nil, headers={})
+    Request.send('post', uri_path("orders",id.to_s,"create_refundable_credit_note"), params, env, headers)
+  end
+
+  def self.reopen(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("orders",id.to_s,"reopen"), params, env, headers)
+  end
+
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("orders",id.to_s), {}, env, headers)
   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/payment_source.rb

@@ -0,0 +1,84 @@
+module ChargeBee
+  class PaymentSource < Model
+
+    class Card < Model
+      attr_accessor :first_name, :last_name, :iin, :last4, :brand, :funding_type, :expiry_month, :expiry_year, :billing_addr1, :billing_addr2, :billing_city, :billing_state_code, :billing_state, :billing_country, :billing_zip, :masked_number
+    end
+
+    class BankAccount < Model
+      attr_accessor :last4, :name_on_account, :bank_name, :mandate_id, :account_type, :echeck_type, :account_holder_type
+    end
+
+    class AmazonPayment < Model
+      attr_accessor :email, :agreement_id
+    end
+
+    class Paypal < Model
+      attr_accessor :email, :agreement_id
+    end
+
+  attr_accessor :id, :resource_version, :updated_at, :created_at, :customer_id, :type, :reference_id,
+  :status, :gateway, :gateway_account_id, :ip_address, :issuing_country, :card, :bank_account,
+  :amazon_payment, :paypal, :deleted
+
+  # OPERATIONS
+  #-----------
+
+  def self.create_using_temp_token(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_using_temp_token"), params, env, headers)
+  end
+
+  def self.create_using_permanent_token(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_using_permanent_token"), params, env, headers)
+  end
+
+  def self.create_using_token(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_using_token"), params, env, headers)
+  end
+
+  def self.create_using_payment_intent(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_using_payment_intent"), params, env, headers)
+  end
+
+  def self.create_card(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_card"), params, env, headers)
+  end
+
+  def self.create_bank_account(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources","create_bank_account"), params, env, headers)
+  end
+
+  def self.update_card(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"update_card"), params, env, headers)
+  end
+
+  def self.verify_bank_account(id, params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"verify_bank_account"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("payment_sources",id.to_s), {}, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("payment_sources"), params, env, headers)
+  end
+
+  def self.switch_gateway_account(id, params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"switch_gateway_account"), params, env, headers)
+  end
+
+  def self.export_payment_source(id, params, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"export_payment_source"), params, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"delete"), {}, env, headers)
+  end
+
+  def self.delete_local(id, env=nil, headers={})
+    Request.send('post', uri_path("payment_sources",id.to_s,"delete_local"), {}, env, headers)
+  end
+
+  end # ~PaymentSource
+end # ~ChargeBee