chargebee 2.43.0 → 2.44.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533136088d4dfb93a64e6d2546065a4c1ffe773b
-  data.tar.gz: 176094c703322fe13acd445e6236c474989bd475
+  metadata.gz: 3621b2495d5b64a5507c2cdd14d16971bf3e763b
+  data.tar.gz: 49fc6659643194faadec24341e5796ab8c1d7215
 SHA512:
-  metadata.gz: c46e55103dfd5b6a0d4c126b6af7a7f9a150912e727cf0ad48fa59165700da57540bc6bf629581d53920c61e032933dbe13a773b36af1d964586cd3b50f4e4d3
-  data.tar.gz: bb6d40c077f78aec27c5900d44fd8a8a8b96189e8f118025cfc0c5a451ee02dce9c38f4ec3f2c400cd0e6ec9dd47bbd500d30e35f2e755419ee253cd9b7aeafe
+  metadata.gz: 578e9cdb85549a4078c8260822c377c7f728db26d3ad207c639a6e7082209b4197a9d569cbb8cca0bf30295883a61a71578ee8a3e2d77252344585e852329f20
+  data.tar.gz: 384b676a1a73e51ae91de6a6ba9378088586ba3b642470080ee6025a6129106cc3d44b4f4b35f841c928ae9e77cb0b9516b7da6e8dd805ecfd0ddd56557f42f2

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+### 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)
+* * *
+
+#### New Resource:
+* PaymentScheduleScheme has been added. 
+* PaymentSchedule has been added. 
+
+### New Endpoints: 
+* Invoice#ApplyPaymentScheduleScheme has been added. 
+* Invoice#PaymentSchedules has been added. 
+
+### New Attributes 
+* bundle_items[] has been added to Items. 
+* bundle_configuration has been added to Items.
+
+#### New Input parameters: 
+* bundle_configuration has been added to Items#CreateParams, Items#UpdateParams & Items#ListParams.
+* bundle_items_to_add[] has been added to Items#CreateParams & Items#UpdateParams.  
+* bundle_items_to_update[] has been added to Items#UpdateParams.
+* bundle_items_to_remove[] has been added to Items#UpdateParams.
+* payment_schedule has been added to Purchase#CreateParams.
+
+### New Enum Values:
+* payment_schedules_created has been added to EventTypeEnum.
+* payment_schedules_updated has been added to EventTypeEnum.
+* payment_schedule_scheme_created has been added to EventTypeEnum.
+* payment_schedule_scheme_deleted has been added to EventTypeEnum.
+
+### Removed Resource: 
+* Installment has been removed. 
+* InstallmentConfig has been removed.
+* InstallmentDetail has been removed.
+
+### Removed Endpoints: 
+* Invoice#Installments has been removed. 
+
+### Removed Input parameters: 
+* installment_info has been removed from Purchase#CreateParams.
+
+### Removed Enum Values: 
+* invoice_installments_created has been removed from EventTypeEnum.
+* invoice_installment_updated has been removed from EventTypeEnum.
+* installment_config_created has been removed from EventTypeEnum.
+* installment_config_deleted has been removed from EventTypeEnum.
+
 ### v2.43.0 (2024-08-29)
 * * *
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.43.0)
+    chargebee (2.44.1)
       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.43.0'
-  s.date              = '2024-08-29'
+  s.version           = '2.44.1'
+  s.date              = '2024-10-03'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -79,9 +79,6 @@ Gem::Specification.new do |s|
     lib/chargebee/models/impacted_item_price.rb
     lib/chargebee/models/impacted_subscription.rb
     lib/chargebee/models/in_app_subscription.rb
-    lib/chargebee/models/installment.rb
-    lib/chargebee/models/installment_config.rb
-    lib/chargebee/models/installment_detail.rb
     lib/chargebee/models/invoice.rb
     lib/chargebee/models/invoice_estimate.rb
     lib/chargebee/models/item.rb
@@ -94,6 +91,8 @@ Gem::Specification.new do |s|
     lib/chargebee/models/order.rb
     lib/chargebee/models/payment_intent.rb
     lib/chargebee/models/payment_reference_number.rb
+    lib/chargebee/models/payment_schedule.rb
+    lib/chargebee/models/payment_schedule_scheme.rb
     lib/chargebee/models/payment_source.rb
     lib/chargebee/models/payment_voucher.rb
     lib/chargebee/models/plan.rb

data/lib/chargebee/models/invoice.rb

@@ -228,8 +228,12 @@ module ChargeBee
     Request.send('post', uri_path("invoices",id.to_s,"update_details"), params, env, headers)
   end
 
-  def self.installments(id, params, env=nil, headers={})
-    Request.send('post', uri_path("invoices",id.to_s,"installments"), params, env, headers)
+  def self.apply_payment_schedule_scheme(id, params, env=nil, headers={})
+    Request.send('post', uri_path("invoices",id.to_s,"apply_payment_schedule_scheme"), params, env, headers)
+  end
+
+  def self.payment_schedules(id, env=nil, headers={})
+    Request.send('get', uri_path("invoices",id.to_s,"payment_schedules"), {}, env, headers)
   end
 
   def self.resend_einvoice(id, env=nil, headers={})

data/lib/chargebee/models/item.rb

@@ -5,10 +5,18 @@ module ChargeBee
       attr_accessor :id
     end
 
+    class BundleItem < Model
+      attr_accessor :item_id, :item_type, :quantity, :price_allocation
+    end
+
+    class BundleConfiguration < Model
+      attr_accessor :type
+    end
+
   attr_accessor :id, :name, :external_name, :description, :status, :resource_version, :updated_at,
   :item_family_id, :type, :is_shippable, :is_giftable, :redirect_url, :enabled_for_checkout, :enabled_in_portal,
   :included_in_mrr, :item_applicability, :gift_claim_redirect_url, :unit, :metered, :usage_calculation,
-  :archived_at, :channel, :applicable_items, :metadata
+  :archived_at, :channel, :applicable_items, :bundle_items, :bundle_configuration, :metadata
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/payment_schedule.rb

@@ -0,0 +1,15 @@
+module ChargeBee
+  class PaymentSchedule < Model
+
+    class ScheduleEntry < Model
+      attr_accessor :id, :date, :amount, :status
+    end
+
+  attr_accessor :id, :scheme_id, :entity_type, :entity_id, :amount, :created_at, :resource_version,
+  :updated_at, :currency_code, :schedule_entries
+
+  # OPERATIONS
+  #-----------
+
+  end # ~PaymentSchedule
+end # ~ChargeBee

data/lib/chargebee/models/payment_schedule_scheme.rb

@@ -0,0 +1,27 @@
+module ChargeBee
+  class PaymentScheduleScheme < Model
+
+    class PreferredSchedule < Model
+      attr_accessor :period, :amount_percentage
+    end
+
+  attr_accessor :id, :description, :number_of_schedules, :period_unit, :period, :created_at, :resource_version,
+  :updated_at, :preferred_schedules
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("payment_schedule_schemes"), params, env, headers)
+  end
+
+  def self.retrieve(id, env=nil, headers={})
+    Request.send('get', uri_path("payment_schedule_schemes",id.to_s), {}, env, headers)
+  end
+
+  def self.delete(id, env=nil, headers={})
+    Request.send('post', uri_path("payment_schedule_schemes",id.to_s,"delete"), {}, env, headers)
+  end
+
+  end # ~PaymentScheduleScheme
+end # ~ChargeBee

data/lib/chargebee/result.rb

@@ -106,6 +106,12 @@ module ChargeBee
         return payment_reference_number;
     end
 
+    def payment_schedule() 
+        payment_schedule = get(:payment_schedule, PaymentSchedule,
+        {:schedule_entries => PaymentSchedule::ScheduleEntry});
+        return payment_schedule;
+    end
+
     def tax_withheld() 
         tax_withheld = get(:tax_withheld, TaxWithheld);
         return tax_withheld;
@@ -289,7 +295,7 @@ module ChargeBee
 
     def item() 
         item = get(:item, Item,
-        {:applicable_items => Item::ApplicableItem});
+        {:applicable_items => Item::ApplicableItem, :bundle_items => Item::BundleItem, :bundle_configuration => Item::BundleConfiguration});
         return item;
     end
 
@@ -413,21 +419,10 @@ module ChargeBee
         return ramp;
     end
 
-    def installment_config() 
-        installment_config = get(:installment_config, InstallmentConfig,
-        {:installments => InstallmentConfig::Installment});
-        return installment_config;
-    end
-
-    def installment() 
-        installment = get(:installment, Installment);
-        return installment;
-    end
-
-    def installment_detail() 
-        installment_detail = get(:installment_detail, InstallmentDetail,
-        {:installments => InstallmentDetail::Installment});
-        return installment_detail;
+    def payment_schedule_scheme() 
+        payment_schedule_scheme = get(:payment_schedule_scheme, PaymentScheduleScheme,
+        {:preferred_schedules => PaymentScheduleScheme::PreferredSchedule});
+        return payment_schedule_scheme;
     end
 
     def pricing_page_session() 
@@ -453,6 +448,12 @@ module ChargeBee
         return invoices;
     end
 
+    def payment_schedules() 
+        payment_schedules = get_list(:payment_schedules, PaymentSchedule,
+        {:schedule_entries => PaymentSchedule::ScheduleEntry});
+        return payment_schedules;
+    end
+
     def credit_notes() 
         credit_notes = get_list(:credit_notes, CreditNote,
         {:einvoice => CreditNote::Einvoice, :line_items => CreditNote::LineItem, :discounts => CreditNote::Discount, :line_item_discounts => CreditNote::LineItemDiscount, :line_item_tiers => CreditNote::LineItemTier, :taxes => CreditNote::Tax, :line_item_taxes => CreditNote::LineItemTax, :linked_refunds => CreditNote::LinkedRefund, :allocations => CreditNote::Allocation, :shipping_address => CreditNote::ShippingAddress, :billing_address => CreditNote::BillingAddress, :site_details_at_creation => CreditNote::SiteDetailsAtCreation, :tax_origin => CreditNote::TaxOrigin});

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

@@ -68,7 +68,6 @@ require File.dirname(__FILE__) + '/chargebee/models/tax_withheld.rb'
 require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 require File.dirname(__FILE__) + '/chargebee/models/non_subscription.rb'
 require File.dirname(__FILE__) + '/chargebee/models/price_variant'
-require File.dirname(__FILE__) + '/chargebee/models/installment_detail'
 require File.dirname(__FILE__) + '/chargebee/models/ramp'
 require File.dirname(__FILE__) + '/chargebee/models/business_entity'
 require File.dirname(__FILE__) + '/chargebee/models/business_entity_transfer'
@@ -76,10 +75,12 @@ require File.dirname(__FILE__) + '/chargebee/models/currency'
 require File.dirname(__FILE__) + '/chargebee/models/pricing_page_session'
 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'
 
 module ChargeBee
 
-  VERSION = '2.43.0'
+  VERSION = '2.44.1'
 
   @@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.43.0
+  version: 2.44.1
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -152,9 +152,6 @@ files:
 - lib/chargebee/models/impacted_item_price.rb
 - lib/chargebee/models/impacted_subscription.rb
 - lib/chargebee/models/in_app_subscription.rb
-- lib/chargebee/models/installment.rb
-- lib/chargebee/models/installment_config.rb
-- lib/chargebee/models/installment_detail.rb
 - lib/chargebee/models/invoice.rb
 - lib/chargebee/models/invoice_estimate.rb
 - lib/chargebee/models/item.rb
@@ -167,6 +164,8 @@ files:
 - lib/chargebee/models/order.rb
 - lib/chargebee/models/payment_intent.rb
 - lib/chargebee/models/payment_reference_number.rb
+- lib/chargebee/models/payment_schedule.rb
+- lib/chargebee/models/payment_schedule_scheme.rb
 - lib/chargebee/models/payment_source.rb
 - lib/chargebee/models/payment_voucher.rb
 - lib/chargebee/models/plan.rb

data/lib/chargebee/models/installment.rb

@@ -1,18 +0,0 @@
-module ChargeBee
-  class Installment < Model
-
-  attr_accessor :id, :invoice_id, :date, :amount, :status, :created_at, :resource_version, :updated_at
-
-  # OPERATIONS
-  #-----------
-
-  def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("installments",id.to_s), {}, env, headers)
-  end
-
-  def self.list(params, env=nil, headers={})
-    Request.send_list_request('get', uri_path("installments"), params, env, headers)
-  end
-
-  end # ~Installment
-end # ~ChargeBee

data/lib/chargebee/models/installment_config.rb

@@ -1,27 +0,0 @@
-module ChargeBee
-  class InstallmentConfig < Model
-
-    class Installment < Model
-      attr_accessor :period, :amount_percentage
-    end
-
-  attr_accessor :id, :description, :number_of_installments, :period_unit, :period, :preferred_day,
-  :created_at, :resource_version, :updated_at, :installments
-
-  # OPERATIONS
-  #-----------
-
-  def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("installment_configs"), params, env, headers)
-  end
-
-  def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("installment_configs",id.to_s), {}, env, headers)
-  end
-
-  def self.delete(id, env=nil, headers={})
-    Request.send('post', uri_path("installment_configs",id.to_s,"delete"), {}, env, headers)
-  end
-
-  end # ~InstallmentConfig
-end # ~ChargeBee

data/lib/chargebee/models/installment_detail.rb

@@ -1,14 +0,0 @@
-module ChargeBee
-  class InstallmentDetail < Model
-
-    class Installment < Model
-      attr_accessor :id, :invoice_id, :date, :amount, :status, :created_at, :resource_version, :updated_at
-    end
-
-  attr_accessor :id, :invoice_id, :amount, :installments
-
-  # OPERATIONS
-  #-----------
-
-  end # ~InstallmentDetail
-end # ~ChargeBee