chargebee 2.7.4 → 2.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69b3a070bf7594f8459633844634e69b4b05b4f7
-  data.tar.gz: 8f7e92de0dc6c0cb5d886bc3d7f813671014c720
+  metadata.gz: 4eb42cd957b47fe9e72bb151935bfddbf5e926aa
+  data.tar.gz: c6be1ee5be0019030bad155fffe46c9f57c363f4
 SHA512:
-  metadata.gz: 5c94d56a121e93d3914b56b3278c532ececbc1c9aa72d58e2f1023d03eb0353260c401067273272f9875d06e76b1327a35f0a1101b12d77b7dbb1dd6fb780bc8
-  data.tar.gz: b42fee4d30900dffdd3c0694dd0713b398e56670e62e1e907023113764ec8570a7b7162b7ee7254ac1bedf602207fecc7f66542134989ca6bb7503d66a8cf5a2
+  metadata.gz: 3cb242d499446aebbfad8c28b180d124def0a62461c750b062b9c18adbc86008331fb0653818f8f1b418fd9e0e04d40c007cfd0b2135ff09036077aa8f829f0e
+  data.tar.gz: 41e5160fe429abbebb14c23bbe60c08fb4c2e7577d5f700dfadc3fd01e196282b74e6c40811a5116712c25f06183f2c35df77e6f45e471b319dc379b7d642200

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### v2.7.5 (2020-04-03)
+* * *
+
+* A subresource contract_term has been added in Subscription resource
+* New endpoint refund_a_credit_note has been added in Credit notes resource
+* New endpoint list_quote_line_groups has been added in Quotes resource
+* New endpoint list_contract_terms_for_a_subscription has been added in Subscriptions resource
+* New input parameter contract_term_billing_cycle_on_renewal, contract_term[action_at_term_end], contract_term[cancellation_cutoff_period] has been added in create_a_subscription, create_subscription_for_customer, update_a_subscription and reactivate_a_subscription apis
+* New input parameter contract_term_cancel_option has been added in cancel_a_subscription api
+* New input parameter contract_term[action_at_term_end], contract_term[cancellation_cutoff_period], subscription[contract_term_billing_cycle_on_renewal] has been added in create_subscription_estimate, create_subscription_for_a_customer_estimate, checkout_new_subscription, checkout_existing_subscription apis
+* New input parameter business_customer_without_vat_number has been added in create_a_customer and update_billing_info_for_a_customer apis
+* New input parameter addons[service_period] replaces the parameter addons[date_from] and addons[date_to] in create_a_quote_for_one-time_charges api
+* New input parameter charges[service_period] replaces the parameter charges[date_from] and charges[date_to] in create_a_quote_for_one-time_charges api
+* New input parameter consolidated_view has been added in retrieve_quote_as_pdf api
+* New input parameter customer[business_customer_without_vat_number] has been added in create_a_subscription, update_a_subscription apis
+* New value CHECKOUT_COM has been added in gateway enum
+* New value CONTRACT_TERMINATION has been added to eventBasedAddons onEvent enum
+* New values IDEAL, GOOGLE_PAY has been added to payment types enum
+* New event types CONTRACT_TERM_CREATED, CONTRACT_TERM_RENEWED, CONTRACT_TERM_TERMINATED, CONTRACT_TERM_COMPLETED, CONTRACT_TERM_CANCELLED have been added
+
 ### v2.7.4(2020-02-06)
 * * *
 

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.7.4'
-  s.date              = '2020-02-06'
+  s.version           = '2.7.5'
+  s.date              = '2020-04-03'
 
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/card.rb
     lib/chargebee/models/comment.rb
     lib/chargebee/models/contact.rb
+    lib/chargebee/models/contract_term.rb
     lib/chargebee/models/coupon.rb
     lib/chargebee/models/coupon_code.rb
     lib/chargebee/models/coupon_set.rb
@@ -66,6 +67,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/portal_session.rb
     lib/chargebee/models/promotional_credit.rb
     lib/chargebee/models/quote.rb
+    lib/chargebee/models/quote_line_group.rb
     lib/chargebee/models/resource_migration.rb
     lib/chargebee/models/site_migration_detail.rb
     lib/chargebee/models/subscription.rb

data/lib/chargebee.rb

@@ -47,7 +47,7 @@ require File.dirname(__FILE__) + '/chargebee/models/payment_intent.rb'
 
 module ChargeBee
 
-  VERSION = '2.7.4'
+  VERSION = '2.7.5'
 
   @@default_env = nil
   @@verify_ca_certs = true

data/lib/chargebee/models/contract_term.rb

@@ -0,0 +1,11 @@
+module ChargeBee
+  class ContractTerm < Model
+
+  attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end,
+  :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+
+  # OPERATIONS
+  #-----------
+
+  end # ~ContractTerm
+end # ~ChargeBee

data/lib/chargebee/models/credit_note.rb

@@ -55,6 +55,10 @@ module ChargeBee
     Request.send('post', uri_path("credit_notes",id.to_s,"pdf"), params, env, headers)
   end
 
+  def self.refund(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("credit_notes",id.to_s,"refund"), 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

data/lib/chargebee/models/customer.rb

@@ -32,8 +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, :business_customer_without_vat_number,
-  :customer_type, :client_profile_id, :relationship
+  :balances, :meta_data, :deleted, :registered_for_gst, :customer_type, :business_customer_without_vat_number,
+  :client_profile_id, :relationship
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quote.rb

@@ -58,6 +58,10 @@ module ChargeBee
     Request.send_list_request('get', uri_path("quotes"), params, env, headers)
   end
 
+  def self.quote_line_groups_for_quote(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("quotes",id.to_s,"quote_line_groups"), 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

data/lib/chargebee/models/quote_line_group.rb

@@ -0,0 +1,31 @@
+module ChargeBee
+  class QuoteLineGroup < 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
+
+  attr_accessor :id, :sub_total, :total, :credits_applied, :amount_paid, :amount_due, :charge_event,
+  :billing_cycle_number, :line_items, :discounts, :line_item_discounts, :taxes, :line_item_taxes
+
+  # OPERATIONS
+  #-----------
+
+  end # ~QuoteLineGroup
+end # ~ChargeBee

data/lib/chargebee/models/subscription.rb

@@ -25,15 +25,19 @@ module ChargeBee
       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
 
+    class ContractTerm < Model
+      attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end, :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+    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
+  :remaining_billing_cycles, :po_number, :created_at, :started_at, :activated_at, :gift_id, :contract_term_billing_cycle_on_renewal,
+  :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, :contract_term
 
   # OPERATIONS
   #-----------
@@ -54,6 +58,10 @@ module ChargeBee
     Request.send('get', uri_path("customers",id.to_s,"subscriptions"), params, env, headers)
   end
 
+  def self.contract_terms_for_subscription(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("subscriptions",id.to_s,"contract_terms"), params, env, headers)
+  end
+
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("subscriptions",id.to_s), {}, env, headers)
   end

data/lib/chargebee/models/subscription_estimate.rb

@@ -5,7 +5,12 @@ module ChargeBee
       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
+    class ContractTerm < Model
+      attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end, :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+    end
+
+  attr_accessor :id, :currency_code, :status, :next_billing_at, :pause_date, :resume_date, :shipping_address,
+  :contract_term
 
   # OPERATIONS
   #-----------

data/lib/chargebee/result.rb

@@ -7,10 +7,15 @@ module ChargeBee
     
     def subscription() 
         subscription = get(:subscription, Subscription,
-        {:addons => Subscription::Addon, :event_based_addons => Subscription::EventBasedAddon, :charged_event_based_addons => Subscription::ChargedEventBasedAddon, :coupons => Subscription::Coupon, :shipping_address => Subscription::ShippingAddress, :referral_info => Subscription::ReferralInfo});
+        {:addons => Subscription::Addon, :event_based_addons => Subscription::EventBasedAddon, :charged_event_based_addons => Subscription::ChargedEventBasedAddon, :coupons => Subscription::Coupon, :shipping_address => Subscription::ShippingAddress, :referral_info => Subscription::ReferralInfo, :contract_term => Subscription::ContractTerm});
         return subscription;
     end
 
+    def contract_term() 
+        contract_term = get(:contract_term, ContractTerm);
+        return contract_term;
+    end
+
     def customer() 
         customer = get(:customer, Customer,
         {:billing_address => Customer::BillingAddress, :referral_urls => Customer::ReferralUrl, :contacts => Customer::Contact, :payment_method => Customer::PaymentMethod, :balances => Customer::Balance, :relationship => Customer::Relationship});
@@ -103,7 +108,7 @@ module ChargeBee
         estimate = get(:estimate, Estimate, {},
         {:subscription_estimate => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :invoice_estimates => InvoiceEstimate, :next_invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate, :unbilled_charge_estimates => UnbilledCharge});
         estimate.init_dependant(@response[:estimate], :subscription_estimate,
-        {:shipping_address => SubscriptionEstimate::ShippingAddress});
+        {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant(@response[:estimate], :invoice_estimate,
         {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant(@response[:estimate], :next_invoice_estimate,
@@ -123,6 +128,12 @@ module ChargeBee
         return quote;
     end
 
+    def quote_line_group() 
+        quote_line_group = get(:quote_line_group, QuoteLineGroup,
+        {:line_items => QuoteLineGroup::LineItem, :discounts => QuoteLineGroup::Discount, :line_item_discounts => QuoteLineGroup::LineItemDiscount, :taxes => QuoteLineGroup::Tax, :line_item_taxes => QuoteLineGroup::LineItemTax});
+        return quote_line_group;
+    end
+
     def plan() 
         plan = get(:plan, Plan,
         {:tiers => Plan::Tier, :applicable_addons => Plan::ApplicableAddon, :attached_addons => Plan::AttachedAddon, :event_based_addons => Plan::EventBasedAddon});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.7.4
+  version: 2.7.5
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -98,6 +98,7 @@ files:
 - lib/chargebee/models/card.rb
 - lib/chargebee/models/comment.rb
 - lib/chargebee/models/contact.rb
+- lib/chargebee/models/contract_term.rb
 - lib/chargebee/models/coupon.rb
 - lib/chargebee/models/coupon_code.rb
 - lib/chargebee/models/coupon_set.rb
@@ -121,6 +122,7 @@ files:
 - lib/chargebee/models/portal_session.rb
 - lib/chargebee/models/promotional_credit.rb
 - lib/chargebee/models/quote.rb
+- lib/chargebee/models/quote_line_group.rb
 - lib/chargebee/models/resource_migration.rb
 - lib/chargebee/models/site_migration_detail.rb
 - lib/chargebee/models/subscription.rb