chargebee 2.6.5 → 2.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62b859bf08abeecaad8d3292c9b39496bc7539d7
-  data.tar.gz: 86fb5d6bfb6bf77d801d47e934205013bc07f605
+  metadata.gz: 2caaa7324faa9cd840b2e5141d5f4c835cb4639c
+  data.tar.gz: 88819266680175a0faaa1cc032323c48ccfff883
 SHA512:
-  metadata.gz: eacfe3dc90493b846df7d8a8ea41028d11fca01d7436d0874787049f63fdcc87a2e16f8d4b0160d315ecc6948794a8fdacde0e03d418aff0ec1e484ce6b2cabc
-  data.tar.gz: 44f22e8f161e7e87ce1d0cd300a28bc25541fa2bd2147ae526a2306e135979c9444f15165b96f71c72cbb4950a3e1bdd1abb13908d14a994c69314963d1600a6
+  metadata.gz: 921d5beb7c8e8387cba3befeb077deac8f1c8a9033027de2000c91a4c4844fc4be1fa8a64d2c935e8cf0d4b1dc09e82f426875699452a41ac545224356a93fa0
+  data.tar.gz: 499d68d00d054fd7777158ecdd69885705ecf06e2f884eeda0c8369cccb39597f1ab1f5adb71d98b51bcee21925af10c6c749e8e328a12d12742e4a85ec49bd2

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+### v2.6.6 (2019-07-08)
+* * *
+
+* The resources hierarchy and token are added.
+* Value ‘day’ is added in period_unit and shipping_frequency_period_unit .
+* The parameters fractional_correction, comment, date_from and date_to are added in Create credit note API.
+* The attribute customer_id is added to line_item sub resource of Credit note, Credit note estimate, Invoice, Invoice estimate and Quote.
+* Endpoints Link a customer, Delink a customer, Get hierarchy, CreateUsingToken are added.
+* The attributes business_customer_without_vat_number and relationship are added to customer resource.
+* The filter parameters parent_id, payment_owner_id, invoice_owner_id are added in List customers, Export revenue recognition reports, Export Deferred Revenue Reports and Export customers APIs.
+* The parameter token_id is added in Collect payment API.
+* Event types hierarchy_created, hierarchy_deleted, token_created, token_consumed and token_expired are added.
+* The parameter service_period_in_days is added in Create subscription estimate, Create subscription for customer estimate, Update subscription estimate, Checkout new, Checkout existing, Create subscription for customer quote, Update subscription quote, Create subscription, Create subscription for customer, Update subscription, Import subscription and Import subscription for customer.
+* The filter parameter payment_owner is added in Export revenue recognition reports,Export Deferred Revenue Reports, Export Invoice and List Invoice APIs.
+* The attribute payment_owner is added to invoice.
+* The attributes date_from and date_to are added to Create an invoice, create a invoice for add-on and create a invoice for charge,Create a quote for one-time charges, Add charge at term end and Add add-on at term end.
+* The parameter comment is added to Stop dunning, Apply payments, Apply credits, Add charge, Add add-on charge, Update details and Close Invoice APIs.
+* The parameter ‘claim_credits’ is added to delete invoice API.
+* The attribute override_relationship is added to subscription resource.
+* The parameter token_id is added to Create subscription API.
+* The parameter override_relationship is added to Create subscription for customer and Update subscription APIs.
+* The attribute service_period_in_days is added to event add ons sub resource.
+
 ### v2.6.5 (2019-04-11)
 * * *
 

data/chargebee.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '2.6.5'
-  s.date              = '2019-04-11'
+  s.version           = '2.6.6'
+  s.date              = '2019-07-08'
 
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
     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
@@ -70,6 +71,7 @@ Gem::Specification.new do |s|
     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

data/lib/chargebee.rb

@@ -45,7 +45,7 @@ require File.dirname(__FILE__) + '/chargebee/models/contact.rb'
 
 module ChargeBee
 
-  VERSION = '2.6.5'
+  VERSION = '2.6.6'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/lib/chargebee/models/credit_note.rb

@@ -2,7 +2,7 @@ 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
+      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
@@ -36,8 +36,8 @@ module ChargeBee
   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, :round_off_amount,
-  :line_items, :discounts, :line_item_discounts, :line_item_tiers, :taxes, :line_item_taxes, :linked_refunds,
-  :allocations, :deleted
+  :fractional_correction, :line_items, :discounts, :line_item_discounts, :line_item_tiers, :taxes,
+  :line_item_taxes, :linked_refunds, :allocations, :deleted
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/credit_note_estimate.rb

@@ -2,7 +2,7 @@ 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
+      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

data/lib/chargebee/models/customer.rb

@@ -21,6 +21,10 @@ module ChargeBee
       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,
   :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,
@@ -28,7 +32,8 @@ module ChargeBee
   :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, :customer_type
+  :balances, :meta_data, :deleted, :registered_for_gst, :business_customer_without_vat_number,
+  :customer_type, :relationship
 
   # OPERATIONS
   #-----------
@@ -117,5 +122,17 @@ module ChargeBee
     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/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/invoice.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Invoice < 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
+      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
@@ -64,7 +64,7 @@ module ChargeBee
   :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,
   :applied_credits, :adjustment_credit_notes, :issued_credit_notes, :linked_orders, :notes, :shipping_address,
-  :billing_address, :deleted
+  :billing_address, :payment_owner, :deleted
 
   # OPERATIONS
   #-----------
@@ -81,8 +81,8 @@ 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={})
@@ -125,8 +125,8 @@ module ChargeBee
     Request.send('post', uri_path("invoices",id.to_s,"add_addon_charge"), params, env, headers)
   end
 
-  def self.close(id, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"close"), {}, 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={})

data/lib/chargebee/models/invoice_estimate.rb

@@ -2,7 +2,7 @@ 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
+      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

data/lib/chargebee/models/payment_source.rb

@@ -32,6 +32,10 @@ module ChargeBee
     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_card(params, env=nil, headers={})
     Request.send('post', uri_path("payment_sources","create_card"), params, env, headers)
   end

data/lib/chargebee/models/quote.rb

@@ -2,7 +2,7 @@ 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
+      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

data/lib/chargebee/models/subscription.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class EventBasedAddon < Model
-      attr_accessor :id, :quantity, :unit_price, :on_event, :charge_once
+      attr_accessor :id, :quantity, :unit_price, :service_period_in_days, :on_event, :charge_once
     end
 
     class ChargedEventBasedAddon < Model
@@ -28,12 +28,12 @@ module ChargeBee
   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
+  :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
   #-----------

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

@@ -13,15 +13,25 @@ module ChargeBee
 
     def customer() 
         customer = get(:customer, Customer,
-        {:billing_address => Customer::BillingAddress, :referral_urls => Customer::ReferralUrl, :contacts => Customer::Contact, :payment_method => Customer::PaymentMethod, :balances => Customer::Balance});
+        {:billing_address => Customer::BillingAddress, :referral_urls => Customer::ReferralUrl, :contacts => Customer::Contact, :payment_method => Customer::PaymentMethod, :balances => Customer::Balance, :relationship => Customer::Relationship});
         return customer;
     end
 
+    def hierarchy() 
+        hierarchy = get(:hierarchy, Hierarchy);
+        return hierarchy;
+    end
+
     def contact() 
         contact = get(:contact, Contact);
         return contact;
     end
 
+    def token() 
+        token = get(:token, Token);
+        return token;
+    end
+
     def payment_source() 
         payment_source = get(:payment_source, PaymentSource,
         {:card => PaymentSource::Card, :bank_account => PaymentSource::BankAccount, :amazon_payment => PaymentSource::AmazonPayment, :paypal => PaymentSource::Paypal});
@@ -201,12 +211,21 @@ module ChargeBee
         return credit_notes;
     end
     
+    def hierarchies()
+        hierarchies = get_list(:hierarchies, Hierarchy,
+        {});
+        return hierarchies;
+    end
+    
     def invoices()
         invoices = get_list(:invoices, Invoice,
         {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :billing_address => Invoice::BillingAddress});
         return invoices;
     end
     
+    def to_s(*args) 
+      JSON.pretty_generate(@response) 
+    end
 
     private
     def get_list(type, klass, sub_types = {}, dependant_types = {}, dependant_sub_types = {})
@@ -232,9 +251,5 @@ module ChargeBee
       return klass.construct(@response[type], sub_types, dependant_types)
     end
 
-    def to_s(*args) 
-      JSON.pretty_generate(@response) 
-    end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.6.5
+  version: 2.6.6
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -109,6 +109,7 @@ files:
 - 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
@@ -125,6 +126,7 @@ files:
 - 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