chargebee 1.7.5 → 2.6.8

data/lib/chargebee/models/plan.rb

@@ -1,10 +1,30 @@
 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,
-  :invoice_notes, :taxable, :meta_data
+    class Tier < Model
+      attr_accessor :starting_unit, :ending_unit, :price
+    end
+
+    class ApplicableAddon < Model
+      attr_accessor :id
+    end
+
+    class AttachedAddon < Model
+      attr_accessor :id, :quantity, :billing_cycles, :type
+    end
+
+    class EventBasedAddon < Model
+      attr_accessor :id, :quantity, :on_event, :charge_once
+    end
+
+  attr_accessor :id, :name, :invoice_name, :description, :price, :currency_code, :period, :period_unit,
+  :trial_period, :trial_period_unit, :pricing_model, :charge_model, :free_quantity, :setup_cost,
+  :downgrade_penalty, :status, :archived_at, :billing_cycles, :redirect_url, :enabled_in_hosted_pages,
+  :enabled_in_portal, :addon_applicability, :tax_code, :avalara_sale_type, :avalara_transaction_type,
+  :avalara_service_type, :sku, :accounting_code, :accounting_category1, :accounting_category2,
+  :is_shippable, :shipping_frequency_period, :shipping_frequency_period_unit, :resource_version,
+  :updated_at, :giftable, :claim_url, :invoice_notes, :taxable, :tax_profile_id, :meta_data, :tiers,
+  :applicable_addons, :attached_addons, :event_based_addons
 
   # OPERATIONS
   #-----------
@@ -18,7 +38,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={})
@@ -29,5 +49,13 @@ module ChargeBee
     Request.send('post', uri_path("plans",id.to_s,"delete"), {}, env, headers)
   end
 
+  def self.copy(params, env=nil, headers={})
+    Request.send('post', uri_path("plans","copy"), params, env, headers)
+  end
+
+  def self.unarchive(id, env=nil, headers={})
+    Request.send('post', uri_path("plans",id.to_s,"unarchive"), {}, env, headers)
+  end
+
   end # ~Plan
 end # ~ChargeBee

data/lib/chargebee/models/promotional_credit.rb

@@ -0,0 +1,31 @@
+module ChargeBee
+  class PromotionalCredit < Model
+
+  attr_accessor :id, :customer_id, :type, :amount, :currency_code, :description, :credit_type,
+  :reference, :closing_balance, :done_by, :created_at
+
+  # OPERATIONS
+  #-----------
+
+  def self.add(params, env=nil, headers={})
+    Request.send('post', uri_path("promotional_credits","add"), params, env, headers)
+  end
+
+  def self.deduct(params, env=nil, headers={})
+    Request.send('post', uri_path("promotional_credits","deduct"), params, env, headers)
+  end
+
+  def self.set(params, env=nil, headers={})
+    Request.send('post', uri_path("promotional_credits","set"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("promotional_credits"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("promotional_credits",id.to_s), {}, env, headers)
+  end
+
+  end # ~PromotionalCredit
+end # ~ChargeBee

data/lib/chargebee/models/quote.rb

@@ -0,0 +1,77 @@
+module ChargeBee
+  class Quote < 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 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 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
+
+  attr_accessor :id, :name, :po_number, :customer_id, :subscription_id, :invoice_id, :status,
+  :operation_type, :vat_number, :price_type, :valid_till, :date, :sub_total, :total, :credits_applied,
+  :amount_paid, :amount_due, :resource_version, :updated_at, :currency_code, :line_items, :discounts,
+  :line_item_discounts, :taxes, :line_item_taxes, :notes, :shipping_address, :billing_address
+
+  # OPERATIONS
+  #-----------
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("quotes",id.to_s), {}, env, headers)
+  end
+
+  def self.create_sub_for_customer_quote(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"create_subscription_quote"), params, env, headers)
+  end
+
+  def self.update_subscription_quote(params, env=nil, headers={})
+    Request.send('post', uri_path("quotes","update_subscription_quote"), params, env, headers)
+  end
+
+  def self.create_for_onetime_charges(params, env=nil, headers={})
+    Request.send('post', uri_path("quotes","create_for_onetime_charges"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("quotes"), params, env, headers)
+  end
+
+  def self.convert(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("quotes",id.to_s,"convert"), params, env, headers)
+  end
+
+  def self.update_status(id, params, env=nil, headers={})
+    Request.send('post', uri_path("quotes",id.to_s,"update_status"), params, env, headers)
+  end
+
+  def self.delete(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("quotes",id.to_s,"delete"), params, env, headers)
+  end
+
+  def self.pdf(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("quotes",id.to_s,"pdf"), params, env, headers)
+  end
+
+  end # ~Quote
+end # ~ChargeBee

data/lib/chargebee/models/resource_migration.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class ResourceMigration < Model
+
+  attr_accessor :from_site, :entity_type, :entity_id, :status, :errors, :created_at, :updated_at
+
+  # OPERATIONS
+  #-----------
+
+  def self.retrieve_latest(params, env=nil, headers={})
+    Request.send('get', uri_path("resource_migrations","retrieve_latest"), params, env, headers)
+  end
+
+  end # ~ResourceMigration
+end # ~ChargeBee

data/lib/chargebee/models/site_migration_detail.rb

@@ -0,0 +1,15 @@
+module ChargeBee
+  class SiteMigrationDetail < Model
+
+  attr_accessor :entity_id, :other_site_name, :entity_id_at_other_site, :migrated_at, :entity_type,
+  :status
+
+  # OPERATIONS
+  #-----------
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("site_migration_details"), params, env, headers)
+  end
+
+  end # ~SiteMigrationDetail
+end # ~ChargeBee

data/lib/chargebee/models/subscription.rb

@@ -2,7 +2,15 @@ module ChargeBee
   class Subscription < Model
 
     class Addon < Model
-      attr_accessor :id, :quantity
+      attr_accessor :id, :quantity, :unit_price, :amount, :trial_end, :remaining_billing_cycles
+    end
+
+    class EventBasedAddon < Model
+      attr_accessor :id, :quantity, :unit_price, :service_period_in_days, :on_event, :charge_once
+    end
+
+    class ChargedEventBasedAddon < Model
+      attr_accessor :id, :last_charged_at
     end
 
     class Coupon < Model
@@ -10,14 +18,22 @@ 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 ReferralInfo < Model
+      attr_accessor :referral_code, :coupon_code, :referrer_id, :external_reference_id, :reward_status, :referral_system, :account_id, :campaign_id, :external_campaign_id, :friend_offer_type, :referrer_reward_type, :notify_referral_system, :destination_url, :post_purchase_widget_enabled
     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,
-  :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
+  attr_accessor :id, :customer_id, :currency_code, :plan_id, :plan_quantity, :plan_unit_price,
+  :setup_fee, :plan_amount, :billing_period, :billing_period_unit, :plan_free_quantity, :status,
+  :start_date, :trial_start, :trial_end, :current_term_start, :current_term_end, :next_billing_at,
+  :remaining_billing_cycles, :po_number, :created_at, :started_at, :activated_at, :gift_id, :override_relationship,
+  :pause_date, :resume_date, :cancelled_at, :cancel_reason, :affiliate_token, :created_from_ip,
+  :resource_version, :updated_at, :has_scheduled_changes, :payment_source_id, :auto_collection,
+  :due_invoices_count, :due_since, :total_dues, :mrr, :exchange_rate, :base_currency_code, :addons,
+  :event_based_addons, :charged_event_based_addons, :coupon, :coupons, :shipping_address, :referral_info,
+  :invoice_notes, :meta_data, :deleted
 
   # OPERATIONS
   #-----------
@@ -31,7 +47,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={})
@@ -54,6 +70,10 @@ module ChargeBee
     Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_cancellation"), params, env, headers)
   end
 
+  def self.remove_coupons(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_coupons"), params, env, headers)
+  end
+
   def self.update(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("subscriptions",id.to_s), params, env, headers)
   end
@@ -78,9 +98,41 @@ module ChargeBee
     Request.send('post', uri_path("subscriptions",id.to_s,"charge_addon_at_term_end"), params, env, headers)
   end
 
+  def self.charge_future_renewals(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"charge_future_renewals"), params, env, headers)
+  end
+
+  def self.import_subscription(params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions","import_subscription"), params, env, headers)
+  end
+
+  def self.import_for_customer(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"import_subscription"), params, env, headers)
+  end
+
+  def self.override_billing_profile(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"override_billing_profile"), params, env, headers)
+  end
+
   def self.delete(id, env=nil, headers={})
     Request.send('post', uri_path("subscriptions",id.to_s,"delete"), {}, env, headers)
   end
 
+  def self.pause(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"pause"), params, env, headers)
+  end
+
+  def self.resume(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"resume"), params, env, headers)
+  end
+
+  def self.remove_scheduled_pause(id, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_pause"), {}, env, headers)
+  end
+
+  def self.remove_scheduled_resumption(id, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_resumption"), {}, env, headers)
+  end
+
   end # ~Subscription
 end # ~ChargeBee

data/lib/chargebee/models/subscription_estimate.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class SubscriptionEstimate < Model
+
+    class ShippingAddress < Model
+      attr_accessor :first_name, :last_name, :email, :company, :phone, :line1, :line2, :line3, :city, :state_code, :state, :country, :zip, :validation_status
+    end
+
+  attr_accessor :id, :currency_code, :status, :next_billing_at, :pause_date, :resume_date, :shipping_address
+
+  # OPERATIONS
+  #-----------
+
+  end # ~SubscriptionEstimate
+end # ~ChargeBee

data/lib/chargebee/models/third_party_payment_method.rb

@@ -0,0 +1,10 @@
+module ChargeBee
+  class ThirdPartyPaymentMethod < Model
+
+  attr_accessor :type, :gateway, :gateway_account_id, :reference_id
+
+  # OPERATIONS
+  #-----------
+
+  end # ~ThirdPartyPaymentMethod
+end # ~ChargeBee

data/lib/chargebee/models/time_machine.rb

@@ -0,0 +1,47 @@
+module ChargeBee
+  class TimeMachine < Model
+
+  attr_accessor :name, :time_travel_status, :genesis_time, :destination_time, :failure_code, :failure_reason,
+  :error_json
+  def wait_for_time_travel_completion(env = nil)
+    env = env || ChargeBee.default_env
+    sleeptime = env.time_machine_sleeptime
+
+    tm = (1..30).inject(self) do |time_machine|
+      break time_machine if time_machine.time_travel_status != "in_progress"
+      sleep(sleeptime)
+      self.class.retrieve(self.name, env).time_machine
+    end
+
+    # sync last fetched one with the current instance
+    new_values = tm.instance_variable_get("@values")
+    self.instance_variable_set("@values", new_values)
+    self.load(new_values)
+
+    case tm.time_travel_status
+    when "in_progress"
+      raise Error.new('The time travel is taking too much time')
+    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("Time travel status is in wrong state #{self.time_travel_status}")
+    end
+  end
+  # OPERATIONS
+  #-----------
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("time_machines",id.to_s), {}, env, headers)
+  end
+
+  def self.start_afresh(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("time_machines",id.to_s,"start_afresh"), params, env, headers)
+  end
+
+  def self.travel_forward(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("time_machines",id.to_s,"travel_forward"), params, env, headers)
+  end
+
+  end # ~TimeMachine
+end # ~ChargeBee

data/lib/chargebee/models/token.rb

@@ -0,0 +1,11 @@
+module ChargeBee
+  class Token < Model
+
+  attr_accessor :id, :gateway, :gateway_account_id, :payment_method_type, :status, :id_at_vault,
+  :vault, :ip_address, :created_at, :expired_at
+
+  # OPERATIONS
+  #-----------
+
+  end # ~Token
+end # ~ChargeBee

data/lib/chargebee/models/transaction.rb

@@ -2,23 +2,42 @@ 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
       attr_accessor :txn_id, :txn_status, :txn_date, :txn_amount
     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
+    class LinkedPayment < Model
+      attr_accessor :id, :status, :amount, :date
+    end
+
+  attr_accessor :id, :customer_id, :subscription_id, :gateway_account_id, :payment_source_id,
+  :payment_method, :reference_number, :gateway, :type, :date, :settled_at, :currency_code, :amount,
+  :id_at_gateway, :status, :fraud_flag, :initiator_type, :three_d_secure, :authorization_reason,
+  :error_code, :error_text, :voided_at, :resource_version, :updated_at, :fraud_reason, :amount_unused,
+  :masked_card_number, :reference_transaction_id, :refunded_txn_id, :reference_authorization_id,
+  :amount_capturable, :reversal_transaction_id, :linked_invoices, :linked_credit_notes, :linked_refunds,
+  :linked_payments, :deleted
 
   # OPERATIONS
   #-----------
 
+  def self.create_authorization(params, env=nil, headers={})
+    Request.send('post', uri_path("transactions","create_authorization"), params, env, headers)
+  end
+
+  def self.void_transaction(id, env=nil, headers={})
+    Request.send('post', uri_path("transactions",id.to_s,"void"), {}, env, headers)
+  end
+
   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={})
@@ -29,16 +48,16 @@ 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)
+  def self.delete_offline_transaction(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("transactions",id.to_s,"delete_offline_transaction"), params, env, headers)
   end
 
   end # ~Transaction