chargebee 2.6.4 → 2.6.6

data/lib/chargebee/models/subscription.rb

@@ -1,138 +1,138 @@
-module ChargeBee
-  class Subscription < Model
-
-    class Addon < Model
-      attr_accessor :id, :quantity, :unit_price, :amount, :trial_end, :remaining_billing_cycles
-    end
-
-    class EventBasedAddon < Model
-      attr_accessor :id, :quantity, :unit_price, :on_event, :charge_once
-    end
-
-    class ChargedEventBasedAddon < Model
-      attr_accessor :id, :last_charged_at
-    end
-
-    class Coupon < Model
-      attr_accessor :coupon_id, :apply_till, :applied_count, :coupon_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 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, :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, :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
-  #-----------
-
-  def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions"), params, env, headers)
-  end
-
-  def self.create_for_customer(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
-  end
-
-  def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("subscriptions"), params, env, headers)
-  end
-
-  def self.subscriptions_for_customer(id, params={}, env=nil, headers={})
-    Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
-  end
-
-  def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers)
-  end
-
-  def self.retrieve_with_scheduled_changes(id, env=nil, headers={})
-    Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_with_scheduled_changes"), {}, env, headers)
-  end
-
-  def self.remove_scheduled_changes(id, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_changes"), {}, env, headers)
-  end
-
-  def self.remove_scheduled_cancellation(id, params={}, env=nil, headers={})
-    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
-
-  def self.change_term_end(id, params, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env, headers)
-  end
-
-  def self.cancel(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env, headers)
-  end
-
-  def self.reactivate(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env, headers)
-  end
-
-  def self.add_charge_at_term_end(id, params, env=nil, headers={})
-    Request.send('post', uri_path("subscriptions",id.to_s,"add_charge_at_term_end"), params, env, headers)
-  end
-
-  def self.charge_addon_at_term_end(id, params, env=nil, headers={})
-    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
+module ChargeBee
+  class Subscription < Model
+
+    class Addon < Model
+      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
+      attr_accessor :coupon_id, :apply_till, :applied_count, :coupon_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 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, :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
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions"), params, env, headers)
+  end
+
+  def self.create_for_customer(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("subscriptions"), params, env, headers)
+  end
+
+  def self.subscriptions_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers)
+  end
+
+  def self.retrieve_with_scheduled_changes(id, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s,"retrieve_with_scheduled_changes"), {}, env, headers)
+  end
+
+  def self.remove_scheduled_changes(id, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"remove_scheduled_changes"), {}, env, headers)
+  end
+
+  def self.remove_scheduled_cancellation(id, params={}, env=nil, headers={})
+    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
+
+  def self.change_term_end(id, params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"change_term_end"), params, env, headers)
+  end
+
+  def self.cancel(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"cancel"), params, env, headers)
+  end
+
+  def self.reactivate(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"reactivate"), params, env, headers)
+  end
+
+  def self.add_charge_at_term_end(id, params, env=nil, headers={})
+    Request.send('post', uri_path("subscriptions",id.to_s,"add_charge_at_term_end"), params, env, headers)
+  end
+
+  def self.charge_addon_at_term_end(id, params, env=nil, headers={})
+    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

@@ -1,14 +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
+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

@@ -1,10 +1,10 @@
-module ChargeBee
-  class ThirdPartyPaymentMethod < Model
-
-  attr_accessor :type, :gateway, :gateway_account_id, :reference_id
-
-  # OPERATIONS
-  #-----------
-
-  end # ~ThirdPartyPaymentMethod
+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

@@ -1,47 +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
+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

@@ -1,63 +1,63 @@
-module ChargeBee
-  class Transaction < Model
-
-    class LinkedInvoice < Model
-      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
-
-    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, :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_list_request('get', uri_path("transactions"), params, env, headers)
-  end
-
-  def self.transactions_for_customer(id, params={}, env=nil, headers={})
-    Request.send('get', uri_path("customers",id.to_s,"transactions"), params, env, headers)
-  end
-
-  def self.transactions_for_subscription(id, params={}, env=nil, headers={})
-    Request.send('get', uri_path("subscriptions",id.to_s,"transactions"), params, env, headers)
-  end
-
-  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.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
+module ChargeBee
+  class Transaction < Model
+
+    class LinkedInvoice < Model
+      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
+
+    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, :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_list_request('get', uri_path("transactions"), params, env, headers)
+  end
+
+  def self.transactions_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"transactions"), params, env, headers)
+  end
+
+  def self.transactions_for_subscription(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s,"transactions"), params, env, headers)
+  end
+
+  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.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
 end # ~ChargeBee