chargebee 1.7.5 → 2.6.8

data/lib/chargebee/models/credit_note.rb

@@ -0,0 +1,79 @@
+module ChargeBee
+  class CreditNote < 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 LineItemDiscount < Model
+      attr_accessor :line_item_id, :discount_type, :coupon_id, :discount_amount
+    end
+
+    class LineItemTier < Model
+      attr_accessor :line_item_id, :starting_unit, :ending_unit, :quantity_used, :unit_amount
+    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, :tax_amount_in_local_currency, :local_currency_code
+    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, :currency_code, :total, :amount_allocated, :amount_refunded,
+  :amount_available, :refunded_at, :voided_at, :resource_version, :updated_at, :sub_total, :sub_total_in_local_currency,
+  :total_in_local_currency, :local_currency_code, :round_off_amount, :fractional_correction, :line_items,
+  :discounts, :line_item_discounts, :line_item_tiers, :taxes, :line_item_taxes, :linked_refunds,
+  :allocations, :deleted
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("credit_notes",id.to_s), {}, env, headers)
+  end
+
+  def self.pdf(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes",id.to_s,"pdf"), params, env, headers)
+  end
+
+  def self.record_refund(id, params, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes",id.to_s,"record_refund"), params, env, headers)
+  end
+
+  def self.void_credit_note(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes",id.to_s,"void"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, 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={})
+    Request.send('get', uri_path("customers",id.to_s,"credit_notes"), params, env, headers)
+  end
+
+  def self.delete(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes",id.to_s,"delete"), params, env, headers)
+  end
+
+  end # ~CreditNote
+end # ~ChargeBee

data/lib/chargebee/models/credit_note_estimate.rb

@@ -0,0 +1,36 @@
+module ChargeBee
+  class CreditNoteEstimate < 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, :tax_amount_in_local_currency, :local_currency_code
+    end
+
+    class LineItemDiscount < Model
+      attr_accessor :line_item_id, :discount_type, :coupon_id, :discount_amount
+    end
+
+    class LineItemTier < Model
+      attr_accessor :line_item_id, :starting_unit, :ending_unit, :quantity_used, :unit_amount
+    end
+
+  attr_accessor :reference_invoice_id, :type, :price_type, :currency_code, :sub_total, :total,
+  :amount_allocated, :amount_available, :line_items, :discounts, :taxes, :line_item_taxes, :line_item_discounts,
+  :line_item_tiers, :round_off_amount, :customer_id
+
+  # OPERATIONS
+  #-----------
+
+  end # ~CreditNoteEstimate
+end # ~ChargeBee

data/lib/chargebee/models/customer.rb

@@ -2,7 +2,11 @@ module ChargeBee
   class Customer < Model
 
     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
+
+    class ReferralUrl < Model
+      attr_accessor :external_customer_id, :referral_sharing_url, :created_at, :updated_at, :referral_campaign_id, :referral_account_id, :referral_external_campaign_id, :referral_system
     end
 
     class Contact < Model
@@ -10,13 +14,26 @@ module ChargeBee
     end
 
     class PaymentMethod < Model
-      attr_accessor :type, :gateway, :status, :reference_id
+      attr_accessor :type, :gateway, :gateway_account_id, :status, :reference_id
+    end
+
+    class Balance < Model
+      attr_accessor :promotional_credits, :excess_payments, :refundable_credits, :unbilled_charges, :currency_code, :balance_currency_code
+    end
+
+    class Relationship < Model
+      attr_accessor :parent_id, :payment_owner_id, :invoice_owner_id
     end
 
   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,
-  :meta_data
+  :net_term_days, :vat_number_validated_time, :vat_number_status, :allow_direct_debit, :is_location_valid,
+  :created_at, :created_from_ip, :exemption_details, :taxability, :entity_code, :exempt_number,
+  :resource_version, :updated_at, :locale, :consolidated_invoicing, :billing_date, :billing_date_mode,
+  :billing_day_of_week, :billing_day_of_week_mode, :pii_cleared, :card_status, :fraud_flag, :primary_payment_source_id,
+  :backup_payment_source_id, :billing_address, :referral_urls, :contacts, :payment_method, :invoice_notes,
+  :preferred_currency_code, :promotional_credits, :unbilled_charges, :refundable_credits, :excess_payments,
+  :balances, :meta_data, :deleted, :registered_for_gst, :business_customer_without_vat_number,
+  :customer_type, :relationship
 
   # OPERATIONS
   #-----------
@@ -26,7 +43,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={})
@@ -45,6 +62,14 @@ module ChargeBee
     Request.send('post', uri_path("customers",id.to_s,"update_billing_info"), params, env, headers)
   end
 
+  def self.contacts_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"contacts"), params, env, headers)
+  end
+
+  def self.assign_payment_role(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"assign_payment_role"), params, env, headers)
+  end
+
   def self.add_contact(id, params, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s,"add_contact"), params, env, headers)
   end
@@ -57,21 +82,57 @@ 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_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_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.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.record_excess_payment(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"record_excess_payment"), 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.collect_payment(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"collect_payment"), params, env, headers)
   end
 
   def self.delete(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s,"delete"), params, env, headers)
   end
 
+  def self.move(params, env=nil, headers={})
+    Request.send('post', uri_path("customers","move"), params, env, headers)
+  end
+
+  def self.change_billing_date(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"change_billing_date"), params, env, headers)
+  end
+
+  def self.merge(params, env=nil, headers={})
+    Request.send('post', uri_path("customers","merge"), params, env, headers)
+  end
+
+  def self.clear_personal_data(id, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"clear_personal_data"), {}, env, headers)
+  end
+
+  def self.relationships(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"relationships"), params, env, headers)
+  end
+
+  def self.delete_relationship(id, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"delete_relationship"), {}, env, headers)
+  end
+
+  def self.hierarchy(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"hierarchy"), params, env, headers)
+  end
+
   end # ~Customer
 end # ~ChargeBee

data/lib/chargebee/models/estimate.rb

@@ -1,21 +1,8 @@
 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, :invoice_estimates, :next_invoice_estimate,
+  :credit_note_estimates, :unbilled_charge_estimates
 
   # OPERATIONS
   #-----------
@@ -24,6 +11,10 @@ module ChargeBee
     Request.send('post', uri_path("estimates","create_subscription"), params, env, headers)
   end
 
+  def self.create_sub_for_customer_estimate(id, params, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"create_subscription_estimate"), params, env, headers)
+  end
+
   def self.update_subscription(params, env=nil, headers={})
     Request.send('post', uri_path("estimates","update_subscription"), params, env, headers)
   end
@@ -32,5 +23,25 @@ module ChargeBee
     Request.send('get', uri_path("subscriptions",id.to_s,"renewal_estimate"), params, env, headers)
   end
 
+  def self.upcoming_invoices_estimate(id, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"upcoming_invoices_estimate"), {}, env, headers)
+  end
+
+  def self.change_term_end(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end_estimate"), params, env, headers)
+  end
+
+  def self.cancel_subscription(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"cancel_subscription_estimate"), params, env, headers)
+  end
+
+  def self.pause_subscription(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"pause_subscription_estimate"), params, env, headers)
+  end
+
+  def self.resume_subscription(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"resume_subscription_estimate"), params, env, headers)
+  end
+
   end # ~Estimate
 end # ~ChargeBee

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/export.rb

@@ -0,0 +1,87 @@
+module ChargeBee
+  class Export < Model
+
+    class Download < Model
+      attr_accessor :download_url, :valid_till
+    end
+
+  attr_accessor :id, :operation_type, :mime_type, :status, :created_at, :download
+def wait_for_export_completion(env = nil, headers={})
+  env = env || ChargeBee.default_env
+  sleeptime = env.export_sleeptime
+
+  export_final = (1..50).inject(self) do |export|
+    break export if export.status != "in_process"
+    sleep(sleeptime)
+    self.class.retrieve(self.id, env, headers).export
+  end
+
+  # sync last fetched one with the current instance
+  new_values = export_final.instance_variable_get("@values")
+  self.instance_variable_set("@values", new_values)
+  self.load(new_values)
+
+  case export_final.status
+  when "in_process"
+    raise Error.new('Export is taking too long')
+  when "failed"
+    json_obj = Util.symbolize_keys(JSON.parse(self.error_json))
+    raise OperationFailedError.new(json_obj[:http_code], json_obj)
+  when "not_enabled", "_unknown"
+    raise Error.new("Export status is in wrong state #{self.status}")
+  end
+end
+
+  # OPERATIONS
+  #-----------
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("exports",id.to_s), {}, env, headers)
+  end
+
+  def self.revenue_recognition(params, env=nil, headers={})
+    Request.send('post', uri_path("exports","revenue_recognition"), params, env, headers)
+  end
+
+  def self.deferred_revenue(params, env=nil, headers={})
+    Request.send('post', uri_path("exports","deferred_revenue"), params, env, headers)
+  end
+
+  def self.plans(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","plans"), params, env, headers)
+  end
+
+  def self.addons(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","addons"), params, env, headers)
+  end
+
+  def self.coupons(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","coupons"), params, env, headers)
+  end
+
+  def self.customers(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","customers"), params, env, headers)
+  end
+
+  def self.subscriptions(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","subscriptions"), params, env, headers)
+  end
+
+  def self.invoices(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","invoices"), params, env, headers)
+  end
+
+  def self.credit_notes(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","credit_notes"), params, env, headers)
+  end
+
+  def self.transactions(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","transactions"), params, env, headers)
+  end
+
+  def self.orders(params={}, env=nil, headers={})
+    Request.send('post', uri_path("exports","orders"), params, env, headers)
+  end
+
+  end # ~Export
+end # ~ChargeBee

data/lib/chargebee/models/gift.rb

@@ -0,0 +1,43 @@
+module ChargeBee
+  class Gift < Model
+
+    class Gifter < Model
+      attr_accessor :customer_id, :invoice_id, :signature, :note
+    end
+
+    class GiftReceiver < Model
+      attr_accessor :customer_id, :subscription_id, :first_name, :last_name, :email
+    end
+
+    class GiftTimeline < Model
+      attr_accessor :status, :occurred_at
+    end
+
+  attr_accessor :id, :status, :scheduled_at, :auto_claim, :claim_expiry_date, :resource_version,
+  :updated_at, :gifter, :gift_receiver, :gift_timelines
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("gifts"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("gifts",id.to_s), {}, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("gifts"), params, env, headers)
+  end
+
+  def self.claim(id, env=nil, headers={})
+    Request.send('post', uri_path("gifts",id.to_s,"claim"), {}, env, headers)
+  end
+
+  def self.cancel(id, env=nil, headers={})
+    Request.send('post', uri_path("gifts",id.to_s,"cancel"), {}, env, headers)
+  end
+
+  end # ~Gift
+end # ~ChargeBee