chargebee 1.7.5 → 2.6.8

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2016 ChargeBee, Inc.
+Copyright (c) 2011-2019 ChargeBee, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -1,32 +1,39 @@
-= Chargebee Ruby Client Library - API V1
+= Chargebee Ruby Client Library - API V2
 
-The ruby library for integrating with Chargebee Recurring Billing and Subscription Management solution.
+{<img src="https://img.shields.io/gem/v/chargebee.svg?maxAge=2592000"/>}[https://rubygems.org/gems/chargebee]
+{<img src="https://img.shields.io/gem/dtv/chargebee.svg?maxAge=2592000"/>}[https://rubygems.org/gems/chargebee]
 
-Chargebee now supports two API versions - {V1}[https://apidocs.chargebee.com/docs/api/v1] and {V2}[https://apidocs.chargebee.com/docs/api]. This library is for our <b>older API version V1</b>. The library for V2 can be found in the {master branch}[https://github.com/chargebee/chargebee-ruby]. 
+This is the Ruby Library for integrating with Chargebee. Sign up for a Chargebee account {here}[https://www.chargebee.com].
 
-You'd want to upgrade to V2 to benefit from the new functionality. Click here for the {API V2 Upgradation Guide}[https://apidocs.chargebee.com/docs/api/v1#api-v2-upgradation-guide].
+Chargebee now supports two API versions - {V1}[https://apidocs.chargebee.com/docs/api/v1] and {V2}[https://apidocs.chargebee.com/docs/api], of which V2 is the latest release and all future developments will happen in V2. This library is for <b>API version V2</b>. If you’re looking for V1, head to {chargebee-v1 branch}[https://github.com/chargebee/chargebee-ruby/tree/chargebee-v1].
 
 == Installation
 
 Install the latest version of the gem with the following command...
-  
-    $ sudo gem install chargebee -v '~>1'
+
+    $ sudo gem install chargebee -v '~>2'
+	
+
+== Requirements
+
+* Ruby 1.9.3 or above.
+* rest-client
 
 == Documentation
 
-For API reference see {here}[https://apidocs.chargebee.com/docs/api/v1/?lang=ruby]
+For API reference see {here}[https://apidocs.chargebee.com/docs/api?lang=ruby]
 
 == Usage
 
 To create a new subscription:
-  
-  ChargeBee.configure({:api_key => "your_api_key"}, {:site => "your_site"})
-  result = ChargeBee::Subscription.create({
-  :id => "sub_KyVqDh__dev__NTn4VZZ1", 
-  :plan_id => "basic", 
-  })
-  subscription = result.subscription
-  puts "created subscription is #{subscription}"
+
+    ChargeBee.configure({:api_key => "your_api_key" , :site => "your_site"})
+    result = ChargeBee::Subscription.create({
+    	:id => "sub_KyVqDh__dev__NTn4VZZ1", 
+    	:plan_id => "basic", 
+    })
+    subscription = result.subscription
+    puts "created subscription is #{subscription}"
 
 == License
 

data/chargebee.gemspec

@@ -2,10 +2,10 @@ Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '1.3.5'
-
+  s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '1.7.5'
-  s.date              = '2019-08-27'
+  s.version           = '2.6.8'
+  s.date              = '2019-08-07'
 
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
@@ -13,15 +13,15 @@ Gem::Specification.new do |s|
   s.authors = ['Rajaraman S', 'Thiyagarajan T']
   s.email = ['rr@chargebee.com', 'thiyagu@chargebee.com']
   s.homepage = 'https://apidocs.chargebee.com/api/docs?lang=ruby'
-  
+  s.license = 'MIT'
 
   s.require_paths = %w[lib]
 
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.rdoc LICENSE]
 
-  s.add_dependency('json_pure', '~> 1.5')
-  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('json_pure', '~> 2.1')
+  s.add_dependency('rest-client', '>= 1.8', '< 3.0')
 
   s.add_development_dependency('rspec', '~> 3.0.0')
   s.add_development_dependency('mocha')
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     README.rdoc
     Rakefile
     chargebee.gemspec
+    lib/.DS_Store
     lib/chargebee.rb
     lib/chargebee/environment.rb
     lib/chargebee/errors.rb
@@ -41,21 +42,39 @@ Gem::Specification.new do |s|
     lib/chargebee/models/address.rb
     lib/chargebee/models/card.rb
     lib/chargebee/models/comment.rb
+    lib/chargebee/models/contact.rb
     lib/chargebee/models/coupon.rb
     lib/chargebee/models/coupon_code.rb
+    lib/chargebee/models/coupon_set.rb
+    lib/chargebee/models/credit_note.rb
+    lib/chargebee/models/credit_note_estimate.rb
     lib/chargebee/models/customer.rb
     lib/chargebee/models/download.rb
     lib/chargebee/models/estimate.rb
     lib/chargebee/models/event.rb
+    lib/chargebee/models/export.rb
+    lib/chargebee/models/gift.rb
+    lib/chargebee/models/hierarchy.rb
     lib/chargebee/models/hosted_page.rb
     lib/chargebee/models/invoice.rb
+    lib/chargebee/models/invoice_estimate.rb
     lib/chargebee/models/model.rb
     lib/chargebee/models/order.rb
-    lib/chargebee/models/payment_intent.rb
+    lib/chargebee/models/payment_source.rb
     lib/chargebee/models/plan.rb
     lib/chargebee/models/portal_session.rb
+    lib/chargebee/models/promotional_credit.rb
+    lib/chargebee/models/quote.rb
+    lib/chargebee/models/resource_migration.rb
+    lib/chargebee/models/site_migration_detail.rb
     lib/chargebee/models/subscription.rb
+    lib/chargebee/models/subscription_estimate.rb
+    lib/chargebee/models/third_party_payment_method.rb
+    lib/chargebee/models/time_machine.rb
+    lib/chargebee/models/token.rb
     lib/chargebee/models/transaction.rb
+    lib/chargebee/models/unbilled_charge.rb
+    lib/chargebee/models/virtual_bank_account.rb
     lib/chargebee/request.rb
     lib/chargebee/rest.rb
     lib/chargebee/result.rb
@@ -63,6 +82,7 @@ Gem::Specification.new do |s|
     lib/ssl/ca-certs.crt
     spec/chargebee/list_result_spec.rb
     spec/chargebee_spec.rb
+    spec/errors_spec.rb
     spec/sample_response.rb
     spec/spec_helper.rb
   ]

data/lib/chargebee.rb

@@ -11,29 +11,46 @@ require File.dirname(__FILE__) + '/chargebee/models/model'
 require File.dirname(__FILE__) + '/chargebee/models/subscription'
 require File.dirname(__FILE__) + '/chargebee/models/customer'
 require File.dirname(__FILE__) + '/chargebee/models/card'
+require File.dirname(__FILE__) + '/chargebee/models/third_party_payment_method'
 require File.dirname(__FILE__) + '/chargebee/models/address'
 require File.dirname(__FILE__) + '/chargebee/models/transaction'
 require File.dirname(__FILE__) + '/chargebee/models/invoice'
 require File.dirname(__FILE__) + '/chargebee/models/order'
+require File.dirname(__FILE__) + '/chargebee/models/credit_note'
 require File.dirname(__FILE__) + '/chargebee/models/estimate'
+require File.dirname(__FILE__) + '/chargebee/models/subscription_estimate'
+require File.dirname(__FILE__) + '/chargebee/models/invoice_estimate'
+require File.dirname(__FILE__) + '/chargebee/models/credit_note_estimate'
 require File.dirname(__FILE__) + '/chargebee/models/hosted_page'
 require File.dirname(__FILE__) + '/chargebee/models/event'
 require File.dirname(__FILE__) + '/chargebee/models/plan'
 require File.dirname(__FILE__) + '/chargebee/models/addon'
 require File.dirname(__FILE__) + '/chargebee/models/coupon'
 require File.dirname(__FILE__) + '/chargebee/models/coupon_code'
+require File.dirname(__FILE__) + '/chargebee/models/coupon_set'
 require File.dirname(__FILE__) + '/chargebee/models/comment'
 require File.dirname(__FILE__) + '/chargebee/models/portal_session'
 require File.dirname(__FILE__) + '/chargebee/models/download'
-require File.dirname(__FILE__) + '/chargebee/models/payment_intent'
+require File.dirname(__FILE__) + '/chargebee/models/site_migration_detail'
+require File.dirname(__FILE__) + '/chargebee/models/resource_migration'
+require File.dirname(__FILE__) + '/chargebee/models/payment_source'
+require File.dirname(__FILE__) + '/chargebee/models/unbilled_charge'
+require File.dirname(__FILE__) + '/chargebee/models/time_machine'
+require File.dirname(__FILE__) + '/chargebee/models/promotional_credit.rb'
+require File.dirname(__FILE__) + '/chargebee/models/virtual_bank_account.rb'
+require File.dirname(__FILE__) + '/chargebee/models/export'
+require File.dirname(__FILE__) + '/chargebee/models/gift'
+require File.dirname(__FILE__) + '/chargebee/models/quote'
+require File.dirname(__FILE__) + '/chargebee/models/contact.rb'
 
 module ChargeBee
 
-  VERSION = '1.7.5'
+  VERSION = '2.6.8'
 
   @@default_env = nil
   @@verify_ca_certs = true
   @@ca_cert_path = File.join(File.dirname(__FILE__), '/ssl/ca-certs.crt')
+  @@user_agent = "Chargebee-Ruby-Client v#{self::VERSION}"
 
   def self.configure(options)
     @@default_env = Environment.new(options)
@@ -55,5 +72,14 @@ module ChargeBee
     @@ca_cert_path
   end
 
+
+  def self.source(source)
+    @@user_agent = @@user_agent + ' ' + source unless source.nil?
+  end
+
+  def self.user_agent
+    @@user_agent
+  end
+
 end
 

data/lib/chargebee/environment.rb

@@ -1,11 +1,17 @@
 module ChargeBee
   class Environment
-    API_VERSION = "v1" 
-    attr_accessor :api_key, :site
-    attr_reader :api_endpoint 
-      
+    API_VERSION = "v2"
+    # in seconds
+    TIME_MACHINE_TIMEOUT = 3
+    EXPORT_TIMEOUT = 10
+
+    attr_accessor :api_key, :site, :time_machine_sleeptime, :export_sleeptime
+    attr_reader :api_endpoint
+
     def initialize(options)
-      [:api_key, :site].each do |attr|
+      options[:time_machine_sleeptime] ||= TIME_MACHINE_TIMEOUT
+      options[:export_sleeptime] ||= EXPORT_TIMEOUT
+      [:api_key, :site, :time_machine_sleeptime, :export_sleeptime].each do |attr|
         instance_variable_set "@#{attr}", options[attr]
       end
       if($CHARGEBEE_DOMAIN == nil)
@@ -18,6 +24,5 @@ module ChargeBee
     def api_url(url)
       url = @api_endpoint + url
     end
-    
   end
 end

data/lib/chargebee/errors.rb

@@ -13,7 +13,7 @@ module ChargeBee
 
   class APIError < Error
 
-    attr_reader  :http_status_code, :message, :type, :api_error_code, :param, :json_obj,
+    attr_reader  :http_status_code, :type, :api_error_code, :param, :json_obj,
                  #Deprecated attributes
                  :http_code, :http_body, :error_code
     

data/lib/chargebee/models/addon.rb

@@ -1,8 +1,15 @@
 module ChargeBee
   class Addon < Model
 
-  attr_accessor :id, :name, :invoice_name, :description, :type, :charge_type, :price, :period,
-  :period_unit, :unit, :status, :archived_at, :enabled_in_portal, :invoice_notes, :taxable, :meta_data
+    class Tier < Model
+      attr_accessor :starting_unit, :ending_unit, :price
+    end
+
+  attr_accessor :id, :name, :invoice_name, :description, :pricing_model, :type, :charge_type,
+  :price, :currency_code, :period, :period_unit, :unit, :status, :archived_at, :enabled_in_portal,
+  :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, :invoice_notes, :taxable, :tax_profile_id, :meta_data, :tiers
 
   # OPERATIONS
   #-----------
@@ -16,7 +23,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("addons"), params, env, headers)
+    Request.send_list_request('get', uri_path("addons"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})
@@ -27,5 +34,13 @@ module ChargeBee
     Request.send('post', uri_path("addons",id.to_s,"delete"), {}, env, headers)
   end
 
+  def self.copy(params, env=nil, headers={})
+    Request.send('post', uri_path("addons","copy"), params, env, headers)
+  end
+
+  def self.unarchive(id, env=nil, headers={})
+    Request.send('post', uri_path("addons",id.to_s,"unarchive"), {}, env, headers)
+  end
+
   end # ~Addon
 end # ~ChargeBee

data/lib/chargebee/models/address.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Address < Model
 
   attr_accessor :label, :first_name, :last_name, :email, :company, :phone, :addr, :extended_addr,
-  :extended_addr2, :city, :state_code, :state, :country, :zip, :subscription_id
+  :extended_addr2, :city, :state_code, :state, :country, :zip, :validation_status, :subscription_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/card.rb

@@ -1,9 +1,10 @@
 module ChargeBee
   class Card < Model
 
-  attr_accessor :status, :gateway, :reference_id, :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
+  attr_accessor :payment_source_id, :status, :gateway, :gateway_account_id, :ref_tx_id, :first_name,
+  :last_name, :iin, :last4, :card_type, :funding_type, :expiry_month, :expiry_year, :issuing_country,
+  :billing_addr1, :billing_addr2, :billing_city, :billing_state_code, :billing_state, :billing_country,
+  :billing_zip, :created_at, :resource_version, :updated_at, :ip_address, :customer_id, :masked_number
 
   # OPERATIONS
   #-----------
@@ -16,14 +17,14 @@ 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
 
+  def self.copy_card_for_customer(id, params, env=nil, headers={})
+    Request.send('post', uri_path("customers",id.to_s,"copy_card"), params, env, headers)
+  end
+
   def self.delete_card_for_customer(id, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s,"delete_card"), {}, env, headers)
   end

data/lib/chargebee/models/comment.rb

@@ -15,7 +15,7 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("comments"), params, env, headers)
+    Request.send_list_request('get', uri_path("comments"), params, env, headers)
   end
 
   def self.delete(id, env=nil, headers={})

data/lib/chargebee/models/contact.rb

@@ -0,0 +1,11 @@
+module ChargeBee
+  class Contact < Model
+
+  attr_accessor :id, :first_name, :last_name, :email, :phone, :label, :enabled, :send_account_email,
+  :send_billing_email
+
+  # OPERATIONS
+  #-----------
+
+  end # ~Contact
+end # ~ChargeBee

data/lib/chargebee/models/coupon.rb

@@ -2,9 +2,9 @@ module ChargeBee
   class Coupon < Model
 
   attr_accessor :id, :name, :invoice_name, :discount_type, :discount_percentage, :discount_amount,
-  :discount_quantity, :duration_type, :duration_month, :valid_till, :max_redemptions, :status,
-  :apply_discount_on, :apply_on, :plan_constraint, :addon_constraint, :created_at, :archived_at,
-  :plan_ids, :addon_ids, :redemptions, :invoice_notes, :meta_data
+  :discount_quantity, :currency_code, :duration_type, :duration_month, :valid_till, :max_redemptions,
+  :status, :apply_discount_on, :apply_on, :plan_constraint, :addon_constraint, :created_at, :archived_at,
+  :resource_version, :updated_at, :plan_ids, :addon_ids, :redemptions, :invoice_notes, :meta_data
 
   # OPERATIONS
   #-----------
@@ -14,12 +14,28 @@ module ChargeBee
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send('get', uri_path("coupons"), params, env, headers)
+    Request.send_list_request('get', uri_path("coupons"), params, env, headers)
   end
 
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("coupons",id.to_s), {}, env, headers)
   end
 
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("coupons",id.to_s), params, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("coupons",id.to_s,"delete"), {}, env, headers)
+  end
+
+  def self.copy(params, env=nil, headers={})
+    Request.send('post', uri_path("coupons","copy"), params, env, headers)
+  end
+
+  def self.unarchive(id, env=nil, headers={})
+    Request.send('post', uri_path("coupons",id.to_s,"unarchive"), {}, env, headers)
+  end
+
   end # ~Coupon
 end # ~ChargeBee

data/lib/chargebee/models/coupon_code.rb

@@ -1,7 +1,7 @@
 module ChargeBee
   class CouponCode < Model
 
-  attr_accessor :code, :coupon_id, :coupon_set_name
+  attr_accessor :code, :status, :coupon_id, :coupon_set_id, :coupon_set_name
 
   # OPERATIONS
   #-----------
@@ -14,5 +14,13 @@ module ChargeBee
     Request.send('get', uri_path("coupon_codes",id.to_s), {}, env, headers)
   end
 
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("coupon_codes"), params, env, headers)
+  end
+
+  def self.archive(id, env=nil, headers={})
+    Request.send('post', uri_path("coupon_codes",id.to_s,"archive"), {}, env, headers)
+  end
+
   end # ~CouponCode
 end # ~ChargeBee

data/lib/chargebee/models/coupon_set.rb

@@ -0,0 +1,38 @@
+module ChargeBee
+  class CouponSet < Model
+
+  attr_accessor :id, :coupon_id, :name, :total_count, :redeemed_count, :archived_count, :meta_data
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("coupon_sets"), params, env, headers)
+  end
+
+  def self.add_coupon_codes(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("coupon_sets",id.to_s,"add_coupon_codes"), params, env, headers)
+  end
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("coupon_sets"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("coupon_sets",id.to_s), {}, env, headers)
+  end
+
+  def self.update(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("coupon_sets",id.to_s,"update"), params, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("coupon_sets",id.to_s,"delete"), {}, env, headers)
+  end
+
+  def self.delete_unused_coupon_codes(id, env=nil, headers={})
+    Request.send('post', uri_path("coupon_sets",id.to_s,"delete_unused_coupon_codes"), {}, env, headers)
+  end
+
+  end # ~CouponSet
+end # ~ChargeBee