chargebee 2.35.0 → 2.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706ca84b567482469d3f7016ad9e195f5b940c9b
-  data.tar.gz: f24e923b78fe0091bf2a70c3336d7a9b2cb6f613
+  metadata.gz: 45abe2c92535d08351ca9b61d44a046a0984afc9
+  data.tar.gz: 972e2b5273e8847ec0a5a806612d1d7bcfdcbb6b
 SHA512:
-  metadata.gz: 92e90b41e6590edf6ca1fa77c67b0e339ff6b83f7f3d7a90a555bc03753117388fdf5765e299a58dff546c909d82fb99f2fa2f4b1c1c8c4c7d73fcbadcecb368
-  data.tar.gz: be11ca3fb36d2a55c0c75cc5eb6e634b94374f0021569bc9d6f9f49ee7d00385a04875933c6665ee8cb8e4fb67ae7d1cb7c8b5aec96be11bcbcb2f5d0a7f1435
+  metadata.gz: bfb01b0e012e35c94fe157d8326e150da7a9ca7c1cf5a396f35a4bbcebe2b5d930582ebad490dfb2cd9a972145a347f329f70ae93f384787aa0f9a5aa9580813
+  data.tar.gz: 59da9114427471744bd80fa4f4b49fbe4664cd4a76d13bb050adc794f97014540b76e3a3f402c334c54069c0955ab44f0a79e585c13467eb3bc856d5f5f61707

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### v2.36.0 (2024-02-29)
+* * *
+
+#### New attributes:
+* usage_percentage has been added to QuoteLineGroup resource.
+* usage_percentage has been added to Quote resource.
+* usage_percentage has been added to CreditNoteEstimate resource.
+* usage_percentage has been added to CreditNote resource.
+* usage_percentage has been added to InvoiceEstimate resource.
+* usage_percentage has been added to Invoice resource.
+* error_detail of type GatewayErrorDetail has been added to PaymentIntent#PaymentAttempt subResource.
+* origin_user has been added to Event resource.
+* proration_type has been added to QuotedSubscription#SubscriptionItem and Subscription#SubscriptionItem subResources
+* network_error_message, recommendation_message, processor_error_code, processor_error_message has been added to Transaction#GatewayErrorDetail subResource.
+
+#### New Enum values:
+* TAX_NOT_CONFIGURED_EXTERNAL_PROVIDER has been added to TaxExemptReasonEnum.
+
+#### New Input parameters:
+* billing_address has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* transactions[amount] has been added to Invoice#ApplyPaymentsRequest.
+
 ### v2.35.0 (2024-01-31)
 * * *
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.35.0)
+    chargebee (2.36.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.35.0'
-  s.date              = '2024-01-31'
+  s.version           = '2.36.0'
+  s.date              = '2024-02-29'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -66,6 +66,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/event.rb
     lib/chargebee/models/export.rb
     lib/chargebee/models/feature.rb
+    lib/chargebee/models/gateway_error_detail.rb
     lib/chargebee/models/gift.rb
     lib/chargebee/models/hierarchy.rb
     lib/chargebee/models/hosted_page.rb
@@ -79,7 +80,6 @@ Gem::Specification.new do |s|
     lib/chargebee/models/item_family.rb
     lib/chargebee/models/item_price.rb
     lib/chargebee/models/model.rb
-    lib/chargebee/models/non_subscription.rb
     lib/chargebee/models/order.rb
     lib/chargebee/models/payment_intent.rb
     lib/chargebee/models/payment_reference_number.rb

data/lib/chargebee/models/credit_note.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class LineItem < Model
-      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/credit_note_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class CreditNoteEstimate < 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, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/event.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
   attr_accessor :id, :occurred_at, :source, :user, :webhook_status, :webhook_failure_reason, :webhooks,
-  :event_type, :api_version
+  :event_type, :api_version, :origin_user
 
   class Content < Result
   end

data/lib/chargebee/models/export.rb

@@ -6,6 +6,7 @@ module ChargeBee
     end
 
   attr_accessor :id, :operation_type, :mime_type, :status, :created_at, :download
+
 def wait_for_export_completion(env = nil, headers={})
   env = env || ChargeBee.default_env
   sleeptime = env.export_sleeptime

data/lib/chargebee/models/gateway_error_detail.rb

@@ -0,0 +1,12 @@
+module ChargeBee
+  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
+
+  # OPERATIONS
+  #-----------
+
+  end # ~GatewayErrorDetail
+end # ~ChargeBee

data/lib/chargebee/models/invoice.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Invoice < 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, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/invoice_estimate.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class InvoiceEstimate < 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, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/payment_intent.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class PaymentIntent < Model
 
     class PaymentAttempt < Model
-      attr_accessor :id, :status, :payment_method_type, :id_at_gateway, :error_code, :error_text, :created_at, :modified_at
+      attr_accessor :id, :status, :payment_method_type, :id_at_gateway, :error_code, :error_text, :created_at, :modified_at, :error_detail
     end
 
   attr_accessor :id, :status, :currency_code, :amount, :gateway_account_id, :expires_at, :reference_id,

data/lib/chargebee/models/quote.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class Quote < 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, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < Model

data/lib/chargebee/models/quote_line_group.rb

@@ -2,7 +2,7 @@ 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, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
+      attr_accessor :id, :subscription_id, :date_from, :date_to, :unit_amount, :quantity, :amount, :pricing_model, :is_taxed, :tax_amount, :tax_rate, :unit_amount_in_decimal, :quantity_in_decimal, :amount_in_decimal, :discount_amount, :item_level_discount_amount, :usage_percentage, :reference_line_item_id, :description, :entity_description, :entity_type, :tax_exempt_reason, :entity_id, :customer_id
     end
 
     class Discount < 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, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option
+      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, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type
     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, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option
+      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, :free_quantity, :free_quantity_in_decimal, :trial_end, :billing_cycles, :service_period_days, :charge_on_event, :charge_once, :charge_on_option, :proration_type
     end
 
     class ItemTier < Model

data/lib/chargebee/models/time_machine.rb

@@ -3,6 +3,7 @@ module ChargeBee
 
   attr_accessor :name, :time_travel_status, :genesis_time, :destination_time, :failure_code, :failure_reason,
   :error_json
+
   def wait_for_time_travel_completion(env = nil)
     env = env || ChargeBee.default_env
     sleeptime = env.time_machine_sleeptime
@@ -28,6 +29,7 @@ module ChargeBee
       raise Error.new("Time travel status is in wrong state #{self.time_travel_status}")
     end
   end
+
   # OPERATIONS
   #-----------
 

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, :error_field, :recommendation_code
+      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
     end
 
   attr_accessor :id, :customer_id, :subscription_id, :gateway_account_id, :payment_source_id,

data/lib/chargebee/result.rb

@@ -11,7 +11,7 @@ module ChargeBee
     def get_response_headers()
         @rheaders
     end
-    
+
     def is_idempotency_replayed()
         replayed_header = get_response_headers[IDEMPOTENCY_REPLAYED_HEADER]
         if replayed_header != nil
@@ -272,6 +272,11 @@ module ChargeBee
         return payment_intent;
     end
 
+    def gateway_error_detail() 
+        gateway_error_detail = get(:gateway_error_detail, GatewayErrorDetail);
+        return gateway_error_detail;
+    end
+
     def item_family() 
         item_family = get(:item_family, ItemFamily);
         return item_family;
@@ -329,21 +334,16 @@ module ChargeBee
         return item_entitlement;
     end
 
-    def entitlement()
+    def entitlement() 
         entitlement = get(:entitlement, Entitlement);
         return entitlement;
     end
 
-    def in_app_subscription()
+    def in_app_subscription() 
         in_app_subscription = get(:in_app_subscription, InAppSubscription);
         return in_app_subscription;
     end
 
-    def non_subscription() 
-        non_subscription = get(:non_subscription, NonSubscription);
-        return non_subscription;
-    end
-
     def entitlement_override() 
         entitlement_override = get(:entitlement_override, EntitlementOverride);
         return entitlement_override;
@@ -360,54 +360,53 @@ module ChargeBee
         return payment_voucher;
     end
 
-    def unbilled_charges()
-        unbilled_charges = get_list(:unbilled_charges, UnbilledCharge,
-        {:tiers => UnbilledCharge::Tier});
-        return unbilled_charges;
-    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});
-        return credit_notes;
-    end
-    
-    def advance_invoice_schedules()
+    def advance_invoice_schedules() 
         advance_invoice_schedules = get_list(:advance_invoice_schedules, AdvanceInvoiceSchedule,
         {:fixed_interval_schedule => AdvanceInvoiceSchedule::FixedIntervalSchedule, :specific_dates_schedule => AdvanceInvoiceSchedule::SpecificDatesSchedule});
         return advance_invoice_schedules;
     end
-    
-    def hierarchies()
+
+    def hierarchies() 
         hierarchies = get_list(:hierarchies, Hierarchy,
         {});
         return hierarchies;
     end
-    
-    def downloads()
-        downloads = get_list(:downloads, Download,
-        {});
-        return downloads;
-    end
-    
-    def invoices()
+
+    def invoices() 
         invoices = get_list(:invoices, Invoice,
         {:line_items => Invoice::LineItem, :discounts => Invoice::Discount, :line_item_discounts => Invoice::LineItemDiscount, :taxes => Invoice::Tax, :line_item_taxes => Invoice::LineItemTax, :line_item_tiers => Invoice::LineItemTier, :linked_payments => Invoice::LinkedPayment, :dunning_attempts => Invoice::DunningAttempt, :applied_credits => Invoice::AppliedCredit, :adjustment_credit_notes => Invoice::AdjustmentCreditNote, :issued_credit_notes => Invoice::IssuedCreditNote, :linked_orders => Invoice::LinkedOrder, :notes => Invoice::Note, :shipping_address => Invoice::ShippingAddress, :statement_descriptor => Invoice::StatementDescriptor, :billing_address => Invoice::BillingAddress, :einvoice => Invoice::Einvoice});
         return invoices;
     end
-    
+
     def differential_prices()
         differential_prices = get_list(:differential_prices, DifferentialPrice,
         {:tiers => DifferentialPrice::Tier, :parent_periods => DifferentialPrice::ParentPeriod});
         return differential_prices;
     end
-    
-    def in_app_subscriptions()
+    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});
+        return credit_notes;
+    end
+
+    def unbilled_charges() 
+        unbilled_charges = get_list(:unbilled_charges, UnbilledCharge,
+        {:tiers => UnbilledCharge::Tier});
+        return unbilled_charges;
+    end
+
+    def downloads() 
+        downloads = get_list(:downloads, Download,
+        {});
+        return downloads;
+    end
+
+    def in_app_subscriptions() 
         in_app_subscriptions = get_list(:in_app_subscriptions, InAppSubscription,
         {});
         return in_app_subscriptions;
     end
-    
+
 
     def to_s(*args)
         JSON.pretty_generate(@response)

data/lib/chargebee.rb

@@ -68,7 +68,7 @@ require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 
 module ChargeBee
 
-  VERSION = '2.35.0'
+  VERSION = '2.36.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.35.0
+  version: 2.36.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -139,6 +139,7 @@ files:
 - lib/chargebee/models/event.rb
 - lib/chargebee/models/export.rb
 - lib/chargebee/models/feature.rb
+- lib/chargebee/models/gateway_error_detail.rb
 - lib/chargebee/models/gift.rb
 - lib/chargebee/models/hierarchy.rb
 - lib/chargebee/models/hosted_page.rb
@@ -152,7 +153,6 @@ files:
 - lib/chargebee/models/item_family.rb
 - lib/chargebee/models/item_price.rb
 - lib/chargebee/models/model.rb
-- lib/chargebee/models/non_subscription.rb
 - lib/chargebee/models/order.rb
 - lib/chargebee/models/payment_intent.rb
 - lib/chargebee/models/payment_reference_number.rb

data/lib/chargebee/models/non_subscription.rb

@@ -1,14 +0,0 @@
-module ChargeBee
-  class NonSubscription < Model
-
-  attr_accessor :app_id, :invoice_id, :customer_id, :charge_id
-
-  # OPERATIONS
-  #-----------
-
-  def self.process_receipt(id, params, env=nil, headers={})
-    Request.send('post', uri_path("non_subscriptions",id.to_s,"one_time_purchase"), params, env, headers)
-  end
-
-  end # ~NonSubscription
-end # ~ChargeBee