chargebee 2.42.0 → 2.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0137cfd34ae7b2042cd9b32bb3df75e6829201a2
-  data.tar.gz: b162dbdd738a3db62701e938d0aa4ba644213409
+  metadata.gz: 44da361071398b749b3cfe048a50212229dc63d5
+  data.tar.gz: 61146139b6c738cdec5dfd56365896c0ab8ebcc6
 SHA512:
-  metadata.gz: 0a0e3363748e28dd07474497d96dc1870c5df87b6c8e9c8f6e7e4878cba3532df164fbd008bb0e4eb67cab1db67eab470ac8feefd5b3229ba1b438ba642f0caa
-  data.tar.gz: d542240692d07385b3ec2cde793883c2ef1ca0532ad66056ad9561c26d5e457c84b27ffcc09c398e445598ae8d25f3fd19497b4c2518a5e22ca4c71d5a8e069c
+  metadata.gz: 2d3d45972fb75a39b58c075ede16dd7478a883b7aff76777434bbe7b803f25d4f31aee680f44898fbcab524943b6a23761f326a5af414aeb2445bc92c69c8a3a
+  data.tar.gz: 9f0ebf9ce1b70a1d5d59c0f7001a02701bc9aacf1a5dbbbfecb1eb766321c02e90084cb6286a6cd41716525f9e31b3265d2d2a9d646f9c5f0d2e546babcac890

data/CHANGELOG.md

@@ -1,3 +1,67 @@
+### 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)
+* * *
+
+#### New Resource:
+* CustomerEntitlement has been added. 
+
+#### New Endpoints:
+* Ramp#UpdateRequest has been added to Ramp resource.
+* Transaction#ReconcileRequest has been added to Transaction resource. 
+
+### New Attributes: 
+* arr has been added to Subscription. 
+
+### New Enum Values: 
+* customer_entitlements_updated has been added to EntityTypeEnum.
+* subscription_moved_in has been added in EventType enum.
+* subscription_moved_out has been added in EventType enum.
+* subscription_movement_failed has been added in EventType enum.
+
 ### v2.42.0 (2024-08-14)
 * * *
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.42.0)
+    chargebee (2.44.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.42.0'
-  s.date              = '2024-08-14'
+  s.version           = '2.44.0'
+  s.date              = '2024-09-19'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -61,6 +61,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/csv_tax_rule.rb
     lib/chargebee/models/currency.rb
     lib/chargebee/models/customer.rb
+    lib/chargebee/models/customer_entitlement.rb
     lib/chargebee/models/differential_price.rb
     lib/chargebee/models/discount.rb
     lib/chargebee/models/download.rb
@@ -78,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
@@ -93,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/customer_entitlement.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class CustomerEntitlement < Model
+
+  attr_accessor :customer_id, :subscription_id, :feature_id, :value, :name, :is_enabled
+
+  # OPERATIONS
+  #-----------
+
+  def self.entitlements_for_customer(id, params={}, env=nil, headers={})
+    Request.send('get', uri_path("customers",id.to_s,"customer_entitlements"), params, env, headers)
+  end
+
+  end # ~CustomerEntitlement
+end # ~ChargeBee

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/models/ramp.rb

@@ -36,6 +36,10 @@ module ChargeBee
     Request.send('post', uri_path("subscriptions",id.to_s,"create_ramp"), params, env, headers)
   end
 
+  def self.update(id, params, env=nil, headers={})
+    Request.send('post', uri_path("ramps",id.to_s,"update"), params, env, headers)
+  end
+
   def self.retrieve(id, env=nil, headers={})
     Request.send('get', uri_path("ramps",id.to_s), {}, env, headers)
   end

data/lib/chargebee/models/subscription.rb

@@ -54,7 +54,7 @@ module ChargeBee
   :created_from_ip, :resource_version, :updated_at, :has_scheduled_advance_invoices, :has_scheduled_changes,
   :payment_source_id, :plan_free_quantity_in_decimal, :plan_amount_in_decimal, :cancel_schedule_created_at,
   :offline_payment_method, :channel, :net_term_days, :active_id, :subscription_items, :item_tiers,
-  :charged_items, :due_invoices_count, :due_since, :total_dues, :mrr, :exchange_rate, :base_currency_code,
+  :charged_items, :due_invoices_count, :due_since, :total_dues, :mrr, :arr, :exchange_rate, :base_currency_code,
   :addons, :event_based_addons, :charged_event_based_addons, :coupon, :coupons, :shipping_address,
   :referral_info, :invoice_notes, :meta_data, :metadata, :deleted, :changes_scheduled_at, :contract_term,
   :cancel_reason_code, :free_period, :free_period_unit, :create_pending_invoices, :auto_close_invoices,

data/lib/chargebee/models/transaction.rb

@@ -45,6 +45,10 @@ module ChargeBee
     Request.send('post', uri_path("transactions",id.to_s,"record_refund"), params, env, headers)
   end
 
+  def self.reconcile(id, params={}, env=nil, headers={})
+    Request.send('post', uri_path("transactions",id.to_s,"reconcile"), params, env, headers)
+  end
+
   def self.refund(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("transactions",id.to_s,"refund"), params, env, headers)
   end

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
 
@@ -356,6 +362,11 @@ module ChargeBee
         return subscription_entitlement;
     end
 
+    def customer_entitlement() 
+        customer_entitlement = get(:customer_entitlement, CustomerEntitlement);
+        return customer_entitlement;
+    end
+
     def item_entitlement() 
         item_entitlement = get(:item_entitlement, ItemEntitlement);
         return item_entitlement;
@@ -376,7 +387,7 @@ module ChargeBee
         return non_subscription;
     end
 
-    def entitlement_override() 
+    def entitlement_override()
         entitlement_override = get(:entitlement_override, EntitlementOverride);
         return entitlement_override;
     end
@@ -408,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() 
@@ -448,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.rb

@@ -68,17 +68,19 @@ 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'
 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.42.0'
+  VERSION = '2.44.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.42.0
+  version: 2.44.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -134,6 +134,7 @@ files:
 - lib/chargebee/models/csv_tax_rule.rb
 - lib/chargebee/models/currency.rb
 - lib/chargebee/models/customer.rb
+- lib/chargebee/models/customer_entitlement.rb
 - lib/chargebee/models/differential_price.rb
 - lib/chargebee/models/discount.rb
 - lib/chargebee/models/download.rb
@@ -151,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
@@ -166,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