chargebee 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e91a90da69999c446d0f339ddaccef3239841ea
-  data.tar.gz: 8584192a936b3f00d2c842d4747be030b571ef78
+  metadata.gz: 65e6e95db66864efd299e96eda68304c07b587fb
+  data.tar.gz: 2ef8f249d2f102e142f6c4fa7b562b53be51f318
 SHA512:
-  metadata.gz: f0a0dfbc6687ceb4af29180ecc689bfe9836c3ac43ec48b6e4ef601b2651c9e5d991ff584e71dae0976850ce6b32cacdca5f823500e6e3720881d211711dac5f
-  data.tar.gz: ee4c770b3a428cf8fabb0407c6bb5d3aa1269ffaced5909339225261b31b8522ac24a061fdea340804ac9ce35708d483ab69989174a1450ce7ee91cbd9cc2fff
+  metadata.gz: 40fa38ae24cba51b64b07a3daa2626bc599efbe04c18258ce81c607aeec5205cede94f2094a3e4998dabe2643c4f31954fa7918c32c65e1bf8cd9b5f4a2d10ce
+  data.tar.gz: b6c913a7f1c9f42c2c6806ac2164bc6113888501a28edb928b29d220dfbdb2d6e191c36c533ca03a67c82d46ad10db815bcd90bac6a05eb468cce6c9bcf5fe12

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+### v2.17.0 (2022-07-18)
+* * *
+
+### Fixes:
+* Fixed Status Enum related issues
+* Fixed EmbeddedResource related issues 
+
+#### New endpoints:
+* hostedpage#PreCancel has been added to the hostedpage resource.
+
+#### New attributes:
+* business_entity_id have been added to the CreditNote, Customer,HostedPage, Invoice, PaymentIntent, Quote, Subscription and Transaction resources.
+* coupon_set_code have been added to the CreditNote, CreditNoteEstimate, Invoice, InvoiceEstimate, Quote and QuoteLineGroup resources.
+* List of SubscriptionEstimate have been added to Estimate resource.
+
+#### New Resource:
+* ImpactedSubscription, ImpactedItem, Purchase have been added.
+
+#### New Enum values:
+* direct_debit has been added to payment_method_type enum.
+* bancontact, not_applicable added to payment_source_card_brand enum.
+* business_entity added to entity_type Enum
+* business_entity_created, business_entity_updated, business_entity_deleted, purchase_created added to event_type Enum
+* chargebee_payments added to gateway Enum
+
+
 ### v2.16.0 (2022-05-23)
 * * *
 

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.16.0'
-  s.date              = '2022-05-23'
+  s.version           = '2.17.0'
+  s.date              = '2022-07-18'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
 
@@ -60,6 +60,8 @@ Gem::Specification.new do |s|
     lib/chargebee/models/gift.rb
     lib/chargebee/models/hierarchy.rb
     lib/chargebee/models/hosted_page.rb
+    lib/chargebee/models/impacted_item.rb
+    lib/chargebee/models/impacted_subscription.rb
     lib/chargebee/models/invoice.rb
     lib/chargebee/models/invoice_estimate.rb
     lib/chargebee/models/item.rb
@@ -73,6 +75,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/plan.rb
     lib/chargebee/models/portal_session.rb
     lib/chargebee/models/promotional_credit.rb
+    lib/chargebee/models/purchase.rb
     lib/chargebee/models/quote.rb
     lib/chargebee/models/quote_line_group.rb
     lib/chargebee/models/quoted_charge.rb

data/lib/chargebee/models/addon.rb

@@ -20,7 +20,7 @@ module ChargeBee
     Request.send('post', uri_path("addons"), params, env, headers)
   end
 
-  def self.update(id, params={}, env=nil, headers={})
+  def self.update(id, params, env=nil, headers={})
     Request.send('post', uri_path("addons",id.to_s), params, env, headers)
   end
 

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
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model
@@ -42,7 +42,8 @@ module ChargeBee
   :amount_available, :refunded_at, :voided_at, :generated_at, :resource_version, :updated_at,
   :channel, :einvoice, :sub_total, :sub_total_in_local_currency, :total_in_local_currency, :local_currency_code,
   :round_off_amount, :fractional_correction, :line_items, :discounts, :line_item_discounts, :line_item_tiers,
-  :taxes, :line_item_taxes, :linked_refunds, :allocations, :deleted, :create_reason_code, :vat_number_prefix
+  :taxes, :line_item_taxes, :linked_refunds, :allocations, :deleted, :create_reason_code, :vat_number_prefix,
+  :business_entity_id
 
   # OPERATIONS
   #-----------

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
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class Tax < Model

data/lib/chargebee/models/customer.rb

@@ -43,11 +43,12 @@ module ChargeBee
   :exempt_number, :resource_version, :updated_at, :locale, :billing_date, :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, :preferred_currency_code, :promotional_credits,
-  :unbilled_charges, :refundable_credits, :excess_payments, :balances, :entity_identifiers, :is_einvoice_enabled,
-  :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
+  :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, :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_override.rb

@@ -1,12 +1,7 @@
 module ChargeBee
   class EntitlementOverride < Model
 
-    class EmbeddedResource < Model
-      attr_accessor 
-    end
-
-  attr_accessor :id, :entity_id, :entity_type, :feature_id, :feature_name, :value, :name, :expires_at,
-  :embedded
+  attr_accessor :id, :entity_id, :entity_type, :feature_id, :feature_name, :value, :name, :expires_at
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/estimate.rb

@@ -1,8 +1,8 @@
 module ChargeBee
   class Estimate < Model
 
-  attr_accessor :created_at, :subscription_estimate, :invoice_estimate, :invoice_estimates, :next_invoice_estimate,
-  :credit_note_estimates, :unbilled_charge_estimates
+  attr_accessor :created_at, :subscription_estimate, :subscription_estimates, :invoice_estimate,
+  :invoice_estimates, :next_invoice_estimate, :credit_note_estimates, :unbilled_charge_estimates
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/hosted_page.rb

@@ -2,7 +2,7 @@ module ChargeBee
   class HostedPage < Model
 
   attr_accessor :id, :type, :url, :state, :failure_reason, :pass_thru_content, :embed, :created_at,
-  :expires_at, :updated_at, :resource_version, :checkout_info
+  :expires_at, :updated_at, :resource_version, :checkout_info, :business_entity_id
 
   class Content < Result
   end
@@ -26,7 +26,7 @@ module ChargeBee
     Request.send('post', uri_path("hosted_pages","checkout_one_time"), params, env, headers)
   end
 
-  def self.checkout_one_time_for_items(params={}, env=nil, headers={})
+  def self.checkout_one_time_for_items(params, env=nil, headers={})
     Request.send('post', uri_path("hosted_pages","checkout_one_time_for_items"), params, env, headers)
   end
 
@@ -94,5 +94,9 @@ module ChargeBee
     Request.send_list_request('get', uri_path("hosted_pages"), params, env, headers)
   end
 
+  def self.pre_cancel(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","pre_cancel"), params, env, headers)
+  end
+
   end # ~HostedPage
 end # ~ChargeBee

data/lib/chargebee/models/impacted_item.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class ImpactedItem < Model
+
+    class Download < Model
+      attr_accessor :download_url, :valid_till, :mime_type
+    end
+
+  attr_accessor :count, :download, :items
+
+  # OPERATIONS
+  #-----------
+
+  end # ~ImpactedItem
+end # ~ChargeBee

data/lib/chargebee/models/impacted_subscription.rb

@@ -0,0 +1,14 @@
+module ChargeBee
+  class ImpactedSubscription < Model
+
+    class Download < Model
+      attr_accessor :download_url, :valid_till, :mime_type
+    end
+
+  attr_accessor :count, :download, :subscription_ids
+
+  # OPERATIONS
+  #-----------
+
+  end # ~ImpactedSubscription
+end # ~ChargeBee

data/lib/chargebee/models/invoice.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model
@@ -74,7 +74,7 @@ module ChargeBee
   :line_items, :discounts, :line_item_discounts, :taxes, :line_item_taxes, :line_item_tiers, :linked_payments,
   :dunning_attempts, :applied_credits, :adjustment_credit_notes, :issued_credit_notes, :linked_orders,
   :notes, :shipping_address, :billing_address, :einvoice, :payment_owner, :void_reason_code, :deleted,
-  :vat_number_prefix, :channel
+  :vat_number_prefix, :channel, :business_entity_id
 
   # OPERATIONS
   #-----------

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
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class Tax < Model

data/lib/chargebee/models/item_entitlement.rb

@@ -1,11 +1,7 @@
 module ChargeBee
   class ItemEntitlement < Model
 
-    class EmbeddedResource < Model
-      attr_accessor 
-    end
-
-  attr_accessor :id, :item_id, :item_type, :feature_id, :feature_name, :value, :name, :embedded
+  attr_accessor :id, :item_id, :item_type, :feature_id, :feature_name, :value, :name
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/payment_intent.rb

@@ -7,7 +7,7 @@ module ChargeBee
 
   attr_accessor :id, :status, :currency_code, :amount, :gateway_account_id, :expires_at, :reference_id,
   :payment_method_type, :success_url, :failure_url, :created_at, :modified_at, :resource_version,
-  :updated_at, :customer_id, :gateway, :active_payment_attempt
+  :updated_at, :customer_id, :gateway, :active_payment_attempt, :business_entity_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/payment_source.rb

@@ -27,7 +27,7 @@ module ChargeBee
 
   attr_accessor :id, :resource_version, :updated_at, :created_at, :customer_id, :type, :reference_id,
   :status, :gateway, :gateway_account_id, :ip_address, :issuing_country, :card, :bank_account,
-  :amazon_payment, :upi, :paypal, :mandates, :deleted
+  :amazon_payment, :upi, :paypal, :mandates, :deleted, :business_entity_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/plan.rb

@@ -34,7 +34,7 @@ module ChargeBee
     Request.send('post', uri_path("plans"), params, env, headers)
   end
 
-  def self.update(id, params={}, env=nil, headers={})
+  def self.update(id, params, env=nil, headers={})
     Request.send('post', uri_path("plans",id.to_s), params, env, headers)
   end
 

data/lib/chargebee/models/purchase.rb

@@ -0,0 +1,18 @@
+module ChargeBee
+  class Purchase < Model
+
+  attr_accessor :id, :customer_id, :created_at, :modified_at, :subscription_ids, :invoice_ids
+
+  # OPERATIONS
+  #-----------
+
+  def self.create(params, env=nil, headers={})
+    Request.send('post', uri_path("purchases"), params, env, headers)
+  end
+
+  def self.estimate(params, env=nil, headers={})
+    Request.send('post', uri_path("purchases","estimate"), params, env, headers)
+  end
+
+  end # ~Purchase
+end # ~ChargeBee

data/lib/chargebee/models/quote.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class Discount < Model
-      attr_accessor :amount, :description, :entity_type, :entity_id
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model
@@ -38,7 +38,7 @@ 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, :currency_code, :notes, :shipping_address, :billing_address, :contract_term_start,
-  :contract_term_end, :contract_term_termination_fee
+  :contract_term_end, :contract_term_termination_fee, :business_entity_id
 
   # 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
+      attr_accessor :amount, :description, :entity_type, :entity_id, :coupon_set_code
     end
 
     class LineItemDiscount < Model

data/lib/chargebee/models/subscription.rb

@@ -53,7 +53,7 @@ module ChargeBee
   :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
+  :free_period, :free_period_unit, :create_pending_invoices, :auto_close_invoices, :business_entity_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/subscription_entitlement.rb

@@ -2,15 +2,11 @@ module ChargeBee
   class SubscriptionEntitlement < Model
 
     class Component < Model
-      attr_accessor 
-    end
-
-    class EmbeddedResource < Model
-      attr_accessor 
+      attr_accessor :entitlement_overrides
     end
 
   attr_accessor :id, :subscription_id, :feature_id, :feature_name, :feature_unit, :value, :name,
-  :is_overridden, :is_enabled, :expires_at, :components, :embedded
+  :is_overridden, :is_enabled, :expires_at, :components
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/transaction.rb

@@ -23,7 +23,7 @@ module ChargeBee
   :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,
   :amount_capturable, :reversal_transaction_id, :linked_invoices, :linked_credit_notes, :linked_refunds,
-  :linked_payments, :deleted, :iin, :last4, :merchant_reference_id
+  :linked_payments, :deleted, :iin, :last4, :merchant_reference_id, :business_entity_id
 
   # OPERATIONS
   #-----------

data/lib/chargebee/result.rb

@@ -117,13 +117,15 @@ module ChargeBee
 
     def estimate() 
         estimate = get(:estimate, Estimate, {},
-        {:subscription_estimate => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :invoice_estimates => InvoiceEstimate, :next_invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate, :unbilled_charge_estimates => UnbilledCharge});
+        {:subscription_estimate => SubscriptionEstimate, :subscription_estimates => SubscriptionEstimate, :invoice_estimate => InvoiceEstimate, :invoice_estimates => InvoiceEstimate, :next_invoice_estimate => InvoiceEstimate, :credit_note_estimates => CreditNoteEstimate, :unbilled_charge_estimates => UnbilledCharge});
         estimate.init_dependant(@response[:estimate], :subscription_estimate,
         {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant(@response[:estimate], :invoice_estimate,
         {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant(@response[:estimate], :next_invoice_estimate,
         {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
+        estimate.init_dependant_list(@response[:estimate], :subscription_estimates,
+        {:shipping_address => SubscriptionEstimate::ShippingAddress, :contract_term => SubscriptionEstimate::ContractTerm});
         estimate.init_dependant_list(@response[:estimate], :invoice_estimates,
         {:line_items => InvoiceEstimate::LineItem, :discounts => InvoiceEstimate::Discount, :taxes => InvoiceEstimate::Tax, :line_item_taxes => InvoiceEstimate::LineItemTax, :line_item_tiers => InvoiceEstimate::LineItemTier, :line_item_discounts => InvoiceEstimate::LineItemDiscount});
         estimate.init_dependant_list(@response[:estimate], :credit_note_estimates,
@@ -278,24 +280,39 @@ module ChargeBee
         return feature;
     end
 
+    def impacted_subscription() 
+        impacted_subscription = get(:impacted_subscription, ImpactedSubscription,
+        {:download => ImpactedSubscription::Download});
+        return impacted_subscription;
+    end
+
+    def impacted_item() 
+        impacted_item = get(:impacted_item, ImpactedItem,
+        {:download => ImpactedItem::Download});
+        return impacted_item;
+    end
+
     def subscription_entitlement() 
         subscription_entitlement = get(:subscription_entitlement, SubscriptionEntitlement,
-        {:component => SubscriptionEntitlement::Component, :embedded_resource => SubscriptionEntitlement::EmbeddedResource});
+        {:component => SubscriptionEntitlement::Component});
         return subscription_entitlement;
     end
 
     def item_entitlement() 
-        item_entitlement = get(:item_entitlement, ItemEntitlement,
-        {:embedded_resource => ItemEntitlement::EmbeddedResource});
+        item_entitlement = get(:item_entitlement, ItemEntitlement);
         return item_entitlement;
     end
 
     def entitlement_override() 
-        entitlement_override = get(:entitlement_override, EntitlementOverride,
-        {:embedded_resource => EntitlementOverride::EmbeddedResource});
+        entitlement_override = get(:entitlement_override, EntitlementOverride);
         return entitlement_override;
     end
 
+    def purchase() 
+        purchase = get(:purchase, Purchase);
+        return purchase;
+    end
+
 
     def unbilled_charges()
         unbilled_charges = get_list(:unbilled_charges, UnbilledCharge,

data/lib/chargebee.rb

@@ -53,7 +53,7 @@ require File.dirname(__FILE__) + '/chargebee/models/usage.rb'
 
 module ChargeBee
 
-  VERSION = '2.16.0'
+  VERSION = '2.17.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.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -136,6 +136,8 @@ files:
 - lib/chargebee/models/gift.rb
 - lib/chargebee/models/hierarchy.rb
 - lib/chargebee/models/hosted_page.rb
+- lib/chargebee/models/impacted_item.rb
+- lib/chargebee/models/impacted_subscription.rb
 - lib/chargebee/models/invoice.rb
 - lib/chargebee/models/invoice_estimate.rb
 - lib/chargebee/models/item.rb
@@ -149,6 +151,7 @@ files:
 - lib/chargebee/models/plan.rb
 - lib/chargebee/models/portal_session.rb
 - lib/chargebee/models/promotional_credit.rb
+- lib/chargebee/models/purchase.rb
 - lib/chargebee/models/quote.rb
 - lib/chargebee/models/quote_line_group.rb
 - lib/chargebee/models/quoted_charge.rb