chargebee 2.47.0 → 2.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6faa46d51fb6ea60406a763027cc3b76c7478ce4
-  data.tar.gz: 72dc97688118a2b2563c6e1de9a4e41d6ce80986
+  metadata.gz: f35c3629f938f3db764288c1d2c9912bf8a09f04
+  data.tar.gz: 73bb6f3da742431e15568e749ac4504b217339a9
 SHA512:
-  metadata.gz: e54108ac52fb4bbd9463959f602d5fdbd5655a3e3b38665b7f420a027ed5c90bf30c4bd340ff270caddaa53666148e2b184ddc8e5a9758cf33f2b40cd92206f7
-  data.tar.gz: be4ad479e9ea815ea9f803065dcbb3822a352381fc38b8f553006a86f1ca9a76521170b1d2dbfe985864ee9e6ed8a58a3d2d7990e8ce92afb1194c1786969886
+  metadata.gz: 4e5f6ab315172e433117dcac5f3abe73383df3821fb2133e2fbe3eaf0c5eb6d248f489c5750938f13ea7792de1e64c78ef5992566d62644a98030ba7483c817b
+  data.tar.gz: 611845925d8b5d050d1ba30e6987d190f5724549ccaa9cb5f4d5b6d6ef9c0bf5221cbc8a4b1c47dbb4ed8dca9ddbb76e1364ac8712d729da521a0b2e3fe0b8c1

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+### v2.48.0 (2024-12-19)
+* * * 
+
+#### New Resource: 
+* Configuration has been added. 
+
+#### New Attribute:
+* discount_type has been added to CreditNote#Discount.
+* discount_type has been added to CreditNoteEstimate#Discount.
+* discount_type has been added to Invoice#Discount.
+* discount_type has been added to InvoiceEstimate#Discount.
+* discount_type has been added to QuoteLineGroup#Discount.
+* initial_purchase_transaction has been added to OmnichannelSubscription.
+* error_cause_id has been added to GatewayErrorDetail.
+* error_cause_id has been added to Transaction#GatewayErrorDetail.
+* error_cause_id has been added to APIError.
+* deleted has been added to Quote. 
+* current_term_start has been added to QuotedSubscripiton#SubscriptionItem.
+* current_term_end has been added to QuotedSubscripiton#SubscriptionItem.
+* next_billing_at has been added to QuotedSubscripiton#SubscriptionItem.
+* current_term_start has been added to Subscription#SubscriptionItem.
+* current_term_end has been added to Subscription#SubscriptionItem.
+* next_billing_at has been added to Subscription#SubscriptionItem.
+* billing_override has been added to Subscription. 
+* grace_period_expires_at has been added to OmnichannelSubscriptionItem.
+
+#### New Input Params:
+* billing_override has been added to Subscription#CreateWithItemsInputParam.
+* billing_override has been added to Subscription#UpdateForItemsInputParam.
+
+#### New Enum Values:
+* OMNICHANNEL_SUBSCRIPTION_IMPORTED has been added to EventTypeEnum.
+* DISABLED has been added to Event#WebhookStatus.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_STARTED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_EXPIRED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_STARTED has been added to EventTypeEnum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_EXPIRED has been added to EventTypeEnum. 
+* IGNORED has been added to RecordedPurchase#StatusEnum.
+* IN_DUNNING & IN_GRACE_PERIOD have been added to OmnichannelSubscriptionItem#StatusEnum.
+
+
+###  v2.47.1 (2024-12-10)
+
+#### New Feature:
+* Result can be accessed in hash format using `.get_raw_response` method.
+* ListResult can be accessed in hash format using `.get_raw_response` method.
+
 ###  v2.47.0 (2024-11-27)
 
 #### New Resource:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.47.0)
+    chargebee (2.48.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.47.0'
-  s.date              = '2024-11-27'
+  s.version           = '2.48.0'
+  s.date              = '2024-12-19'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/business_entity_transfer.rb
     lib/chargebee/models/card.rb
     lib/chargebee/models/comment.rb
+    lib/chargebee/models/configuration.rb
     lib/chargebee/models/contact.rb
     lib/chargebee/models/contract_term.rb
     lib/chargebee/models/coupon.rb

data/lib/chargebee/errors.rb

@@ -13,7 +13,7 @@ module ChargeBee
 
   class APIError < Error
 
-    attr_reader  :http_status_code, :type, :api_error_code, :param, :json_obj,
+    attr_reader  :http_status_code, :type, :api_error_code, :param, :json_obj, :error_cause_id,
                  #Deprecated attributes
                  :http_code, :http_body, :error_code
     
@@ -24,6 +24,7 @@ module ChargeBee
       @type = json_obj[:type]
       @api_error_code = json_obj[:api_error_code]
       @param = json_obj[:param]
+      @error_cause_id = json_obj[:error_cause_id]
 
       #Deprecated attributes
       @error_code = json_obj[:error_code]

data/lib/chargebee/list_result.rb

@@ -21,7 +21,11 @@ module ChargeBee
     def get_response_headers()
       @rheaders
     end
-    
+
+    def get_raw_response()
+      @response
+    end
+
     private
     def initItems()
       @response.each do |item|

data/lib/chargebee/models/configuration.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class Configuration < Model
+
+  attr_accessor :domain, :product_catalog_version
+
+  # OPERATIONS
+  #-----------
+
+  def self.list(env=nil, headers={})
+    Request.send_list_request('get', uri_path("configurations"), {}, env, headers)
+  end
+
+  end # ~Configuration
+end # ~ChargeBee

data/lib/chargebee/models/credit_note.rb

@@ -10,7 +10,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model

data/lib/chargebee/models/credit_note_estimate.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class Tax < Model

data/lib/chargebee/models/gateway_error_detail.rb

@@ -3,7 +3,7 @@ module ChargeBee
 
   attr_accessor :request_id, :error_category, :error_code, :error_message, :decline_code, :decline_message,
   :network_error_code, :network_error_message, :error_field, :recommendation_code, :recommendation_message,
-  :processor_error_code, :processor_error_message
+  :processor_error_code, :processor_error_message, :error_cause_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/invoice.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model

data/lib/chargebee/models/invoice_estimate.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class Tax < Model

data/lib/chargebee/models/omnichannel_subscription.rb

@@ -1,8 +1,12 @@
 module ChargeBee
   class OmnichannelSubscription < Model
 
+    class OmnichannelTransaction < Model
+      attr_accessor :id, :id_at_source, :app_id, :price_currency, :price_units, :price_nanos, :type, :transacted_at, :created_at, :resource_version
+    end
+
   attr_accessor :id, :id_at_source, :app_id, :source, :customer_id, :created_at, :resource_version,
-  :omnichannel_subscription_items
+  :omnichannel_subscription_items, :initial_purchase_transaction
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/omnichannel_subscription_item.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class OmnichannelSubscriptionItem < Model
 
   attr_accessor :id, :item_id_at_source, :status, :current_term_start, :current_term_end, :expired_at,
-  :expiration_reason, :cancelled_at, :cancellation_reason, :resource_version
+  :expiration_reason, :cancelled_at, :cancellation_reason, :grace_period_expires_at, :resource_version
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quote.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model
@@ -38,7 +38,8 @@ module ChargeBee
   :sub_total, :total, :credits_applied, :amount_paid, :amount_due, :version, :resource_version,
   :updated_at, :vat_number_prefix, :line_items, :discounts, :line_item_discounts, :taxes, :line_item_taxes,
   :line_item_tiers, :tax_category, :currency_code, :notes, :shipping_address, :billing_address,
-  :contract_term_start, :contract_term_end, :contract_term_termination_fee, :business_entity_id
+  :contract_term_start, :contract_term_end, :contract_term_termination_fee, :business_entity_id,
+  :deleted
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/quote_line_group.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
+      attr_accessor :amount, :description, :entity_type, :discount_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model

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, :usage_accumulation_reset_frequency
+      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :current_term_start, :current_term_end, :next_billing_at, :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, :usage_accumulation_reset_frequency
+      attr_accessor :item_price_id, :item_type, :quantity, :quantity_in_decimal, :metered_quantity, :last_calculated_at, :unit_price, :unit_price_in_decimal, :amount, :current_term_start, :current_term_end, :next_billing_at, :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
@@ -37,6 +37,10 @@ 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 BillingOverride < Model
+      attr_accessor :max_excess_payment_usage, :max_refundable_credits_usage
+    end
+
     class ContractTerm < Model
       attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end, :total_contract_value, :total_contract_value_before_tax, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
     end
@@ -56,9 +60,9 @@ module ChargeBee
   :offline_payment_method, :channel, :net_term_days, :active_id, :subscription_items, :item_tiers,
   :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, :deleted, :changes_scheduled_at, :contract_term,
-  :cancel_reason_code, :free_period, :free_period_unit, :create_pending_invoices, :auto_close_invoices,
-  :discounts, :business_entity_id, :metadata
+  :referral_info, :billing_override, :invoice_notes, :meta_data, :deleted, :changes_scheduled_at,
+  :contract_term, :cancel_reason_code, :free_period, :free_period_unit, :create_pending_invoices,
+  :auto_close_invoices, :discounts, :business_entity_id, :metadata
     def metadata
     warn "[DEPRECATION] `metadata` is deprecated please use meta_data instead."
     @metadata

data/lib/chargebee/models/transaction.rb

@@ -18,7 +18,7 @@ module ChargeBee
     end
 
     class GatewayErrorDetail < Model
-      attr_accessor :request_id, :error_category, :error_code, :error_message, :decline_code, :decline_message, :network_error_code, :network_error_message, :error_field, :recommendation_code, :recommendation_message, :processor_error_code, :processor_error_message
+      attr_accessor :request_id, :error_category, :error_code, :error_message, :decline_code, :decline_message, :network_error_code, :network_error_message, :error_field, :recommendation_code, :recommendation_message, :processor_error_code, :processor_error_message, :error_cause_id
     end
 
   attr_accessor :id, :customer_id, :subscription_id, :gateway_account_id, :payment_source_id,

data/lib/chargebee/result.rb

@@ -23,7 +23,7 @@ module ChargeBee
 
     def subscription() 
         subscription = get(:subscription, Subscription,
-        {:subscription_items => Subscription::SubscriptionItem, :item_tiers => Subscription::ItemTier, :charged_items => Subscription::ChargedItem, :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, :discounts => Subscription::Discount});
+        {:subscription_items => Subscription::SubscriptionItem, :item_tiers => Subscription::ItemTier, :charged_items => Subscription::ChargedItem, :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, :billing_override => Subscription::BillingOverride, :contract_term => Subscription::ContractTerm, :discounts => Subscription::Discount});
         return subscription;
     end
 
@@ -329,6 +329,11 @@ module ChargeBee
         return differential_price;
     end
 
+    def configuration() 
+        configuration = get(:configuration, Configuration);
+        return configuration;
+    end
+
     def feature() 
         feature = get(:feature, Feature,
         {:levels => Feature::Level});
@@ -389,7 +394,7 @@ module ChargeBee
         return non_subscription;
     end
 
-    def entitlement_override()
+    def entitlement_override() 
         entitlement_override = get(:entitlement_override, EntitlementOverride);
         return entitlement_override;
     end
@@ -498,6 +503,12 @@ module ChargeBee
         return downloads;
     end
 
+    def configurations() 
+        configurations = get_list(:configurations, Configuration,
+        {});
+        return configurations;
+    end
+
     def in_app_subscriptions() 
         in_app_subscriptions = get_list(:in_app_subscriptions, InAppSubscription,
         {});
@@ -509,6 +520,10 @@ module ChargeBee
         JSON.pretty_generate(@response)
     end
 
+    def get_raw_response()
+      @response;
+    end
+
     private
     def get_list(type, klass, sub_types = {}, dependant_types = {}, dependant_sub_types = {})
       if(@response[type] == nil)

data/lib/chargebee.rb

@@ -82,11 +82,12 @@ require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription'
 require File.dirname(__FILE__) + '/chargebee/models/omnichannel_transaction'
 require File.dirname(__FILE__) + '/chargebee/models/recorded_purchase'
 require File.dirname(__FILE__) + '/chargebee/models/omnichannel_subscription_item'
+require File.dirname(__FILE__) + '/chargebee/models/configuration'
 
 
 module ChargeBee
 
-  VERSION = '2.47.0'
+  VERSION = '2.48.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.47.0
+  version: 2.48.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -124,6 +124,7 @@ files:
 - lib/chargebee/models/business_entity_transfer.rb
 - lib/chargebee/models/card.rb
 - lib/chargebee/models/comment.rb
+- lib/chargebee/models/configuration.rb
 - lib/chargebee/models/contact.rb
 - lib/chargebee/models/contract_term.rb
 - lib/chargebee/models/coupon.rb