chargebee 2.44.0 → 2.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44da361071398b749b3cfe048a50212229dc63d5
-  data.tar.gz: 61146139b6c738cdec5dfd56365896c0ab8ebcc6
+  metadata.gz: b208888f008a46366fe669c8e57d02499d746c17
+  data.tar.gz: b442b3269d75b8f48cbf7c5419d505d5c064c471
 SHA512:
-  metadata.gz: 2d3d45972fb75a39b58c075ede16dd7478a883b7aff76777434bbe7b803f25d4f31aee680f44898fbcab524943b6a23761f326a5af414aeb2445bc92c69c8a3a
-  data.tar.gz: 9f0ebf9ce1b70a1d5d59c0f7001a02701bc9aacf1a5dbbbfecb1eb766321c02e90084cb6286a6cd41716525f9e31b3265d2d2a9d646f9c5f0d2e546babcac890
+  metadata.gz: 5ea145f8734b23ac354601d483db3558989cf2d1f23bbe9fcdf4a76ba38591df9a6e9e9dd9fd0b11753cc615818298987ae9e8d5ccf85106179bf4ade88db351
+  data.tar.gz: 9ec01d94c69b6bb3fd7bba84611bf1dfb63de1aff226c8fa02f952ce029a23ad909174f4de302ca7147149ca05d96bd67c747cdcfbed42356c40f368edb3f480

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+###  v2.45.0 (2024-10-17)
+* * *
+
+#### New Resource:
+* PaymentScheduleEstimate has been added. 
+
+### New Attributes: 
+* payment_schedule_estimates has been added to Estimate. 
+* usage_accumulation_reset_frequency has been added to ItemPrice.
+* name has been added to PaymentScheduleScheme.
+* usage_accumulation_reset_frequency has been added to QuotedSubscription#SubscriptionItem.
+* usage_accumulation_reset_frequency has been added to Subscription#SubscriptionItem.
+
+### New Endpoints: 
+* Estimate#PaymentSchedule has been added. 
+
+### New Input Params: 
+* usage_accumulation_reset_frequency has been added to ItemPrice#CreateParams. 
+* usage_accumulation_reset_frequency has been added to ItemPrice#UpdateParams. 
+* discounts has been added to PricingPageSession#CreateForNewSubscriptionParams.
+* discounts has been added to PricingPageSession#CreateForExistingSubscriptionParams.
+* invoice_immediately has been added to Quote#ConvertParams.
+
+### v2.44.1 (2024-10-03)
+* * *
+
+#### Bug Fixes:
+* metadata field not working bug fixed. 
+* meta_data field not working bug fixed.
+
 ### v2.44.0 (2024-09-19)
 * * *
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.44.0)
+    chargebee (2.45.0)
       cgi (>= 0.1.0, < 1.0.0)
       json_pure (~> 2.1)
       rest-client (>= 1.8, <= 2.0.2)

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.44.0'
-  s.date              = '2024-09-19'
+  s.version           = '2.45.0'
+  s.date              = '2024-10-17'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -92,6 +92,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/payment_intent.rb
     lib/chargebee/models/payment_reference_number.rb
     lib/chargebee/models/payment_schedule.rb
+    lib/chargebee/models/payment_schedule_estimate.rb
     lib/chargebee/models/payment_schedule_scheme.rb
     lib/chargebee/models/payment_source.rb
     lib/chargebee/models/payment_voucher.rb

data/lib/chargebee/models/estimate.rb

@@ -2,7 +2,8 @@ module ChargeBee
   class Estimate < Model
 
   attr_accessor :created_at, :subscription_estimate, :subscription_estimates, :invoice_estimate,
-  :invoice_estimates, :next_invoice_estimate, :credit_note_estimates, :unbilled_charge_estimates
+  :invoice_estimates, :payment_schedule_estimates, :next_invoice_estimate, :credit_note_estimates,
+  :unbilled_charge_estimates
 
   # OPERATIONS
   #-----------
@@ -83,5 +84,9 @@ module ChargeBee
     Request.send('post', uri_path("estimates","create_invoice_for_items"), params, env, headers)
   end
 
+  def self.payment_schedules(params, env=nil, headers={})
+    Request.send('post', uri_path("estimates","payment_schedules"), params, env, headers)
+  end
+
   end # ~Estimate
 end # ~ChargeBee

data/lib/chargebee/models/item_price.rb

@@ -21,9 +21,9 @@ module ChargeBee
   :price_variant_id, :proration_type, :pricing_model, :price, :price_in_decimal, :period, :currency_code,
   :period_unit, :trial_period, :trial_period_unit, :trial_end_action, :shipping_period, :shipping_period_unit,
   :billing_cycles, :free_quantity, :free_quantity_in_decimal, :channel, :resource_version, :updated_at,
-  :created_at, :archived_at, :invoice_notes, :tiers, :is_taxable, :tax_detail, :tax_providers_fields,
-  :accounting_detail, :metadata, :item_type, :archivable, :parent_item_id, :show_description_in_invoices,
-  :show_description_in_quotes
+  :created_at, :usage_accumulation_reset_frequency, :archived_at, :invoice_notes, :tiers, :is_taxable,
+  :tax_detail, :tax_providers_fields, :accounting_detail, :metadata, :item_type, :archivable,
+  :parent_item_id, :show_description_in_invoices, :show_description_in_quotes
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/payment_schedule_estimate.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class PaymentScheduleEstimate < Model
+
+    class ScheduleEntry < Model
+      attr_accessor :id, :date, :amount, :status
+    end
+
+  attr_accessor :id, :scheme_id, :entity_type, :entity_id, :amount, :currency_code, :schedule_entries
+
+  # OPERATIONS
+  #-----------
+
+  end # ~PaymentScheduleEstimate
+end # ~ChargeBee

data/lib/chargebee/models/payment_schedule_scheme.rb

@@ -5,8 +5,8 @@ module ChargeBee
       attr_accessor :period, :amount_percentage
     end
 
-  attr_accessor :id, :description, :number_of_schedules, :period_unit, :period, :created_at, :resource_version,
-  :updated_at, :preferred_schedules
+  attr_accessor :id, :name, :description, :number_of_schedules, :period_unit, :period, :created_at,
+  :resource_version, :updated_at, :preferred_schedules
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quoted_subscription.rb

@@ -14,7 +14,7 @@ module ChargeBee
     end
 
     class SubscriptionItem < Model
-      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type
+      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type, :usage_accumulation_reset_frequency
     end
 
     class ItemTier < Model

data/lib/chargebee/models/subscription.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Subscription < Model
 
     class SubscriptionItem < Model
-      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type
+      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :amount_in_decimal, :billing_period, :billing_period_unit, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type, :usage_accumulation_reset_frequency
     end
 
     class ItemTier < Model

data/lib/chargebee/result.rb

@@ -154,7 +154,7 @@ module ChargeBee
 
     def estimate() 
         estimate = get(:estimate, Estimate, {},
-        {:subscription_estimate => SubscriptionEstimate, :subscription_estimates => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :invoice_estimates => InvoiceEstimate, :next_invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate, :unbilled_charge_estimates => UnbilledCharge});
+        {:subscription_estimate => SubscriptionEstimate, :subscription_estimates => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :invoice_estimates => InvoiceEstimate, :payment_schedule_estimates => PaymentScheduleEstimate, :next_invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate, :unbilled_charge_estimates => UnbilledCharge});
         estimate.init_dependant(@response[:estimate], :subscription_estimate,
         {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant(@response[:estimate], :invoice_estimate,
@@ -165,6 +165,8 @@ module ChargeBee
         {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant_list(@response[:estimate], :invoice_estimates,
         {: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_list(@response[:estimate], :payment_schedule_estimates,
+        {:schedule_entries => PaymentScheduleEstimate::ScheduleEntry});
         estimate.init_dependant_list(@response[:estimate], :credit_note_estimates,
         {:line_items => CreditNoteEstimate::LineItem, :discounts => CreditNoteEstimate::Discount, :taxes => CreditNoteEstimate::Tax, :line_item_taxes => CreditNoteEstimate::LineItemTax, :line_item_discounts => CreditNoteEstimate::LineItemDiscount, :line_item_tiers => CreditNoteEstimate::LineItemTier});
         estimate.init_dependant_list(@response[:estimate], :unbilled_charge_estimates,

data/lib/chargebee/util.rb

@@ -6,7 +6,9 @@ module ChargeBee
       case value
         when Hash
           value.each do |k, v|
-            if(v.kind_of? Hash or v.kind_of? Array)
+            if k == :metadata or k == :meta_data  # metadata is encoded as a JSON string instead of URL-encoded.
+              serialized.merge!({k.to_s => as_str(v)})
+            elsif(v.kind_of? Hash or v.kind_of? Array)
               serialized.merge!(serialize(v, k))
             else
               key = "#{(prefix!=nil) ? prefix:''}#{(prefix!=nil) ? '['+k.to_s+']' : k}#{(idx != nil) ? '['+idx.to_s+']':''}"
@@ -17,7 +19,7 @@ module ChargeBee
           value.each_with_index do |v, i|
             serialized.merge!(serialize(v, prefix, i))
           end
-        else
+      else
            if(idx != nil and prefix != nil)
               key = "#{prefix}[#{idx.to_s}]"
               serialized.merge!({key => as_str(value)})

data/lib/chargebee.rb

@@ -77,10 +77,12 @@ require File.dirname(__FILE__) + '/chargebee/models/metadata'
 require File.dirname(__FILE__) + '/chargebee/models/customer_entitlement'
 require File.dirname(__FILE__) + '/chargebee/models/payment_schedule'
 require File.dirname(__FILE__) + '/chargebee/models/payment_schedule_scheme'
+require File.dirname(__FILE__) + '/chargebee/models/payment_schedule_estimate'
+
 
 module ChargeBee
 
-  VERSION = '2.44.0'
+  VERSION = '2.45.0'
 
   @@default_env = nil
   @@verify_ca_certs = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chargebee
 version: !ruby/object:Gem::Version
-  version: 2.44.0
+  version: 2.45.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -165,6 +165,7 @@ files:
 - lib/chargebee/models/payment_intent.rb
 - lib/chargebee/models/payment_reference_number.rb
 - lib/chargebee/models/payment_schedule.rb
+- lib/chargebee/models/payment_schedule_estimate.rb
 - lib/chargebee/models/payment_schedule_scheme.rb
 - lib/chargebee/models/payment_source.rb
 - lib/chargebee/models/payment_voucher.rb