chargebee 2.33.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6db0cf1fa6d27d9811bf9f1bc349f881472d714
-  data.tar.gz: 5847634a85f9c1c1425f7030c14e1a87d624d6b1
+  metadata.gz: 706ca84b567482469d3f7016ad9e195f5b940c9b
+  data.tar.gz: f24e923b78fe0091bf2a70c3336d7a9b2cb6f613
 SHA512:
-  metadata.gz: b7ccc0f75bbecb3992f4632372051a40222068ebf053dc481f1a6b20f92651a7d1bea19e6e34c02edeb343c3a4caf66165cc5db1da2aeaa5d924a5546e610140
-  data.tar.gz: a2be218a7df4f31f91369d3b7c97d3e4ff7c7ccc3201ea182d06e26a152d9b60b4dc3630fa7a8b418254e102bac6790d3136b5df2c2c329ae3f85ec47d14c48d
+  metadata.gz: 92e90b41e6590edf6ca1fa77c67b0e339ff6b83f7f3d7a90a555bc03753117388fdf5765e299a58dff546c909d82fb99f2fa2f4b1c1c8c4c7d73fcbadcecb368
+  data.tar.gz: be11ca3fb36d2a55c0c75cc5eb6e634b94374f0021569bc9d6f9f49ee7d00385a04875933c6665ee8cb8e4fb67ae7d1cb7c8b5aec96be11bcbcb2f5d0a7f1435

data/CHANGELOG.md

@@ -1,3 +1,60 @@
+### v2.35.0 (2024-01-31)
+* * *
+
+#### New Enum values:
+* item_price_entitlements_updated has been added to EventTypeEnum.
+* item_price_entitlements_removed has been added to EventTypeEnum.
+
+#### New Input parameters:
+* layout has been added to HostedPage#AcceptQuoteRequest in HostedPage resource.
+
+### v2.34.0 (2024-01-04)
+* * *
+
+#### Fixes:
+* Fixed Custom fields names with spaces issue.
+
+#### New resources:
+* Entitlements has been added.
+
+#### New attributes:
+* date_to, date_from, prorated_taxable_amount has been added to quote_line_group.
+* date_to, date_from, prorated_taxable_amount has been added to quote.
+* date_to, date_from, prorated_taxable_amount has been added to credit_note_estimate.
+* date_to, date_from, prorated_taxable_amount has been added to credit_note.
+* date_to, date_from, prorated_taxable_amount has been added to invoice_estimate.
+* date_to, date_from, prorated_taxable_amount has been added to order.
+* date_to, date_from, prorated_taxable_amount has been added to invoice.
+* active_id has been added to customers.
+* active_id has been added to subscriptions.
+* reference_id has been made optional for payment_sources/create_using_permanent_token
+* custom_payment_method_id has been added to transactions.
+* custom_payment_method_name has been added to transactions.
+* error_detail has been added to transactions.
+
+
+#### New Enum values:
+* CMR_FALABELLA, TARJETA_NARANJA, NATIVA, CENCOSUD, CABAL, ARGENCARD, ELO, HIPERCARD, CARNET, RUPAY, MAESTRO has been added to Card#CardTypeEnum
+* Transferred has been added to Subscription#StatusEnum.
+* Transferred has been added to SubscriptionEstimate#StatusEnum.
+* AutomatedBankTransfer has been added to PaymentMethodEnum.
+* UsAutomatedBankTransfer, GbAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer has been added to VirtualBankAccount#SchemeEnum.
+* CustomerBusinessEntityChanged, SubscriptionBusinessEntityChanged has been added to EventTypeEnum.
+* Dlocal has been added to GatewayEnum.
+* UsAutomatedBankTransfer, UkAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer, Custom has been added to OfflinePaymentMethodEnum.
+* AutomatedBankTransfer has been added to PaymentMethodEnum.
+* AutomatedBankTransfer has been added to PaymentMethodTypeEnum.
+
+#### New Input parameters:
+* custom_payment_method_name has been added to Transactions#RecordRefundRequest.
+* proration_type has been added to Subscription#UpdateForItemsRequest.
+* proration_type has been added to ItemPrice.
+* payment_initiator has been added to Invoice.
+* payment_method_token, customer_profile_token, network_transaction_id, mandate_id, skip_retrieval, card, billing_address has been added to PaymentSource#CreateUsingPermanentTokenRequest.
+* subscription_items[proration_type] has been added to Estimate#UpdateSubscriptionForItemsRequest.
+* transaction[custom_payment_method_id] has been added to Customer#RecordExcessPaymentRequest.
+* transaction[custom_payment_method_id] has been added to CreditNote#RecordRefundRequest.
+
 ### v2.33.0 (2023-11-30)
 * * *
 

data/Gemfile.lock

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

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2023 ChargeBee, Inc.
+Copyright (c) 2011-2024 ChargeBee, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

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.33.0'
-  s.date              = '2023-11-30'
+  s.version           = '2.35.0'
+  s.date              = '2024-01-31'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -60,6 +60,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/differential_price.rb
     lib/chargebee/models/discount.rb
     lib/chargebee/models/download.rb
+    lib/chargebee/models/entitlement.rb
     lib/chargebee/models/entitlement_override.rb
     lib/chargebee/models/estimate.rb
     lib/chargebee/models/event.rb

data/lib/chargebee/models/credit_note.rb

@@ -26,7 +26,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LinkedRefund < Model

data/lib/chargebee/models/credit_note_estimate.rb

@@ -14,7 +14,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LineItemDiscount < Model

data/lib/chargebee/models/customer.rb

@@ -42,13 +42,13 @@ module ChargeBee
   :is_location_valid, :created_at, :created_from_ip, :exemption_details, :taxability, :entity_code,
   :exempt_number, :resource_version, :updated_at, :locale, :billing_date, :billing_month, :billing_date_mode,
   :billing_day_of_week, :billing_day_of_week_mode, :pii_cleared, :auto_close_invoices, :channel,
-  :card_status, :fraud_flag, :primary_payment_source_id, :backup_payment_source_id, :billing_address,
-  :referral_urls, :contacts, :payment_method, :invoice_notes, :business_entity_id, :preferred_currency_code,
-  :promotional_credits, :unbilled_charges, :refundable_credits, :excess_payments, :balances, :entity_identifiers,
-  :is_einvoice_enabled, :einvoicing_method, :meta_data, :deleted, :registered_for_gst, :consolidated_invoicing,
-  :customer_type, :business_customer_without_vat_number, :client_profile_id, :relationship, :use_default_hierarchy_settings,
-  :parent_account_access, :child_account_access, :vat_number_prefix, :entity_identifier_scheme,
-  :entity_identifier_standard
+  :active_id, :card_status, :fraud_flag, :primary_payment_source_id, :backup_payment_source_id,
+  :billing_address, :referral_urls, :contacts, :payment_method, :invoice_notes, :business_entity_id,
+  :preferred_currency_code, :promotional_credits, :unbilled_charges, :refundable_credits, :excess_payments,
+  :balances, :entity_identifiers, :is_einvoice_enabled, :einvoicing_method, :meta_data, :deleted,
+  :registered_for_gst, :consolidated_invoicing, :customer_type, :business_customer_without_vat_number,
+  :client_profile_id, :relationship, :use_default_hierarchy_settings, :parent_account_access,
+  :child_account_access, :vat_number_prefix, :entity_identifier_scheme, :entity_identifier_standard
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/entitlement.rb

@@ -0,0 +1,18 @@
+module ChargeBee
+  class Entitlement < Model
+
+  attr_accessor :id, :entity_id, :entity_type, :feature_id, :feature_name, :value, :name
+
+  # OPERATIONS
+  #-----------
+
+  def self.list(params={}, env=nil, headers={})
+    Request.send_list_request('get', uri_path("entitlements"), params, env, headers)
+  end
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("entitlements"), params, env, headers)
+  end
+
+  end # ~Entitlement
+end # ~ChargeBee

data/lib/chargebee/models/invoice.rb

@@ -18,7 +18,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LineItemTier < Model

data/lib/chargebee/models/invoice_estimate.rb

@@ -14,7 +14,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LineItemTier < Model

data/lib/chargebee/models/item_price.rb

@@ -14,11 +14,11 @@ module ChargeBee
     end
 
   attr_accessor :id, :name, :item_family_id, :product_id, :item_id, :description, :status, :external_name,
-  :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, :accounting_detail, :metadata,
-  :item_type, :archivable, :parent_item_id, :show_description_in_invoices, :show_description_in_quotes
+  :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, :accounting_detail,
+  :metadata, :item_type, :archivable, :parent_item_id, :show_description_in_invoices, :show_description_in_quotes
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/model.rb

@@ -36,10 +36,14 @@ module ChargeBee
                       v
                     end
 
-          instance_variable_set("@#{k}", set_val)
+          instance_variable_set("@#{replace_white_space_with_underscore(k)}", set_val)
         end
       end
     end
+
+    def replace_white_space_with_underscore(s)
+      s.to_s.tr(" ", "_")
+    end
       
     def method_missing(m, *args, &block)
       if(@values.has_key?(m))

data/lib/chargebee/models/order.rb

@@ -14,7 +14,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LineItemDiscount < Model

data/lib/chargebee/models/quote.rb

@@ -18,7 +18,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
     class LineItemTier < Model

data/lib/chargebee/models/quote_line_group.rb

@@ -18,7 +18,7 @@ module ChargeBee
     end
 
     class LineItemTax < Model
-      attr_accessor :line_item_id, :tax_name, :tax_rate, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
+      attr_accessor :line_item_id, :tax_name, :tax_rate, :date_to, :date_from, :prorated_taxable_amount, :is_partial_tax_applied, :is_non_compliance_tax, :taxable_amount, :tax_amount, :tax_juris_type, :tax_juris_name, :tax_juris_code, :tax_amount_in_local_currency, :local_currency_code
     end
 
   attr_accessor :version, :id, :sub_total, :total, :credits_applied, :amount_paid, :amount_due,

data/lib/chargebee/models/subscription.rb

@@ -53,12 +53,12 @@ module ChargeBee
   :override_relationship, :pause_date, :resume_date, :cancelled_at, :cancel_reason, :affiliate_token,
   :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, :subscription_items, :item_tiers, :charged_items,
-  :due_invoices_count, :due_since, :total_dues, :mrr, :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, :discounts,
-  :business_entity_id
+  :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,
+  :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,
+  :discounts, :business_entity_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/transaction.rb

@@ -17,13 +17,18 @@ module ChargeBee
       attr_accessor :id, :status, :amount, :date
     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
+    end
+
   attr_accessor :id, :customer_id, :subscription_id, :gateway_account_id, :payment_source_id,
   :payment_method, :reference_number, :gateway, :type, :date, :settled_at, :exchange_rate, :currency_code,
   :amount, :id_at_gateway, :status, :fraud_flag, :initiator_type, :three_d_secure, :authorization_reason,
-  :error_code, :error_text, :voided_at, :resource_version, :updated_at, :fraud_reason, :amount_unused,
-  :masked_card_number, :reference_transaction_id, :refunded_txn_id, :reference_authorization_id,
+  :error_code, :error_text, :voided_at, :resource_version, :updated_at, :fraud_reason, :custom_payment_method_id,
+  :amount_unused, :masked_card_number, :reference_transaction_id, :refunded_txn_id, :reference_authorization_id,
   :amount_capturable, :reversal_transaction_id, :linked_invoices, :linked_credit_notes, :linked_refunds,
-  :linked_payments, :deleted, :iin, :last4, :merchant_reference_id, :business_entity_id, :payment_method_details
+  :linked_payments, :deleted, :iin, :last4, :merchant_reference_id, :business_entity_id, :payment_method_details,
+  :error_detail, :custom_payment_method_name
 
   # OPERATIONS
   #-----------

data/lib/chargebee/result.rb

@@ -4,7 +4,7 @@ module ChargeBee
     IDEMPOTENCY_REPLAYED_HEADER = :chargebee_idempotency_replayed
 
     def initialize(response, rheaders = nil)
-        @response = response
+      @response = response
         @rheaders = rheaders
     end
 
@@ -132,7 +132,7 @@ module ChargeBee
 
     def transaction() 
         transaction = get(:transaction, Transaction,
-        {:linked_invoices => Transaction::LinkedInvoice, :linked_credit_notes => Transaction::LinkedCreditNote, :linked_refunds => Transaction::LinkedRefund, :linked_payments => Transaction::LinkedPayment});
+        {:linked_invoices => Transaction::LinkedInvoice, :linked_credit_notes => Transaction::LinkedCreditNote, :linked_refunds => Transaction::LinkedRefund, :linked_payments => Transaction::LinkedPayment, :gateway_error_detail => Transaction::GatewayErrorDetail});
         return transaction;
     end
 
@@ -329,7 +329,12 @@ module ChargeBee
         return item_entitlement;
     end
 
-    def in_app_subscription() 
+    def entitlement()
+        entitlement = get(:entitlement, Entitlement);
+        return entitlement;
+    end
+
+    def in_app_subscription()
         in_app_subscription = get(:in_app_subscription, InAppSubscription);
         return in_app_subscription;
     end

data/lib/chargebee.rb

@@ -68,7 +68,7 @@ require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 
 module ChargeBee
 
-  VERSION = '2.33.0'
+  VERSION = '2.35.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.33.0
+  version: 2.35.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -133,6 +133,7 @@ files:
 - lib/chargebee/models/differential_price.rb
 - lib/chargebee/models/discount.rb
 - lib/chargebee/models/download.rb
+- lib/chargebee/models/entitlement.rb
 - lib/chargebee/models/entitlement_override.rb
 - lib/chargebee/models/estimate.rb
 - lib/chargebee/models/event.rb