chargebee 2.49.0 → 2.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a52725486531b040a5d430e9889b0b33b3953ba8
-  data.tar.gz: a66b2838d48287dae8fe2fd6b7c3d874ac5cd84f
+  metadata.gz: 51f672d93e3588e1122bc33079ffb5dcd0166482
+  data.tar.gz: f10f7eb5479f868a660f1cb40017e63c46ba0e77
 SHA512:
-  metadata.gz: 6df1cd531937cc375146bdfc1b1d1e0432cfbe811c50a2c5204bd72ea5035053f1a058eedefaad9acafca5d7d469feeaa165b87517d88133178708ca3efa25ac
-  data.tar.gz: 75910fe9baf6ff616fd80f33f5c5ee561b65eac8bd2ab39ed3407d17af4b799c429a2f1a39db5c02001285ca4d773026d97e05e747560db07fface445e1e5277
+  metadata.gz: 9f6acd4b1500db07a3baddd58a560509aeab003a8c8b17c299111761828884f66d185013d2b80e592b1bcc68b74f02b1e69bd412eb174bdf24f3731464828d6c
+  data.tar.gz: aee56f6821ac4fd0c16e780312bdc2589573a6ce24153b5277dedbc9fd1f882e5535e914535e54ae36f4d361b494d27999ecdf3ccb9e1e2fe4bc2b7f3e0dacba

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+### v2.50.0 (2025-02-10)
+* * * 
+
+#### New Resources:
+* Rule has been added. 
+* UsageEvent has been added.
+
+#### New Attribute: 
+* deleted has been added to AttachedItem.
+* deleted has been added to Coupon.
+* deleted has been added to DifferentialPrice.
+* deleted has been added to ItemFamily.
+* deleted has been added to ItemPrice.
+* deleted has been added to Item.
+* deleted has been added to PriceVariant.
+* tax_application has abeend added to CreditNote#Allocation.
+* tax_application has been added to Invoice#AppliedCredit.
+* line_item_credit has been added to Invoice.
+
+#### New Input Params:
+* exhausted_coupon_ids has been added to Subscription#ImportForItems.
+
+#### New Enums 
+* STORE has been added in CreditNote#TypeEnum.
+* STORE has been added in CreditNoteEstimate#TypeEnum.
+* STORE has been added in Order#TypeEnum.
+* TaxApplicationEnum has been added in CreditNote#Application.
+* TaxApplicationEnum has been added in Invoice#AppliedCredit.
+* RECORDED_PURCHASE has been added in EntityTypeEnum.
+* RECORD_PURCHASE_FAILED, has been added in EventTypeEnum.
+
+#### Deleted Input Params
+* tax_providers_fields has been removed from Customer#MoveParams. 
+* tax_providers_fields has been removed from Customer#MergeParams
+
+#### Deprecated input params. 
+* deprecated label in discount_quantity has been removed from Coupon#CreateParams.
+* deprecated label in discount_quantity has been removed from Coupon#UpdateParams.
+* deprecated label in discount_quantity has been removed from Coupon#CreateForItemsParams.
+* deprecated label in discount_quantity has been removed from Coupon#UpdateForItemsParams.
+
 ### v2.49.0 (2025-01-16)
 
 #### New Feature 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chargebee (2.49.0)
+    chargebee (2.50.0)
       cgi (>= 0.1.0, < 1.0.0)
       json_pure (~> 2.1)
 

data/README.md

@@ -17,7 +17,6 @@ Install the latest version of the gem with the following command...
 ## Requirements
 
 * Ruby 1.9.3 or above.
-* rest-client
 
 ## 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.49.0'
-  s.date              = '2025-01-16'
+  s.version           = '2.50.0'
+  s.date              = '2025-02-10'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
   s.metadata = {
@@ -112,6 +112,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/ramp.rb
     lib/chargebee/models/recorded_purchase.rb
     lib/chargebee/models/resource_migration.rb
+    lib/chargebee/models/rule.rb
     lib/chargebee/models/site_migration_detail.rb
     lib/chargebee/models/subscription.rb
     lib/chargebee/models/subscription_entitlement.rb
@@ -123,6 +124,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/transaction.rb
     lib/chargebee/models/unbilled_charge.rb
     lib/chargebee/models/usage.rb
+    lib/chargebee/models/usage_event.rb
     lib/chargebee/models/virtual_bank_account.rb
     lib/chargebee/nativeRequest.rb
     lib/chargebee/request.rb

data/lib/chargebee/environment.rb

@@ -25,7 +25,14 @@ module ChargeBee
       end
     end
 
-    def api_url(url)
+    def api_url(url, sub_domain=nil)
+      if(sub_domain != nil)
+        if($CHARGEBEE_DOMAIN == nil)
+          @api_endpoint = "https://#{@site}.#{sub_domain}.chargebee.com/api/#{API_VERSION}"
+        else
+          @api_endpoint = "#{$ENV_PROTOCOL == nil ? "http": "https"}://#{@site}.#{sub_domain}.#{$CHARGEBEE_DOMAIN}/api/#{API_VERSION}"
+        end
+      end
       url = @api_endpoint + url
     end
   end

data/lib/chargebee/list_result.rb

@@ -1,18 +1,19 @@
 require 'forwardable'
 
 module ChargeBee
-  class ListResult 
+  class ListResult
     extend Forwardable
     include Enumerable
-    
+
     def_delegator :@list, :each, :each
     def_delegator :@list, :length, :length
-    
+
     attr_reader :next_offset
 
-    def initialize(response, next_offset=nil, rheaders = nil)
+    def initialize(response, next_offset=nil, rheaders = nil, http_status_code=nil)
       @response = response
       @rheaders = rheaders
+      @http_status_code = http_status_code
       @list = Array.new
       @next_offset = JSON.parse(next_offset).to_s if next_offset
       initItems()
@@ -25,6 +26,9 @@ module ChargeBee
     def get_raw_response()
       @response
     end
+    def get_http_status_code()
+      @http_status_code
+    end
 
     private
     def initItems()
@@ -32,6 +36,6 @@ module ChargeBee
         @list.push(Result.new(item))
       end
     end
-  
+
   end
 end

data/lib/chargebee/models/addon.rb

@@ -22,31 +22,47 @@ module ChargeBee
   #-----------
 
   def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("addons"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("addons"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.update(id, params, env=nil, headers={})
-    Request.send('post', uri_path("addons",id.to_s), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("addons",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("addons"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("addons"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("addons",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("addons",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete(id, env=nil, headers={})
-    Request.send('post', uri_path("addons",id.to_s,"delete"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("addons",id.to_s,"delete"), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.copy(params, env=nil, headers={})
-    Request.send('post', uri_path("addons","copy"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("addons","copy"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.unarchive(id, env=nil, headers={})
-    Request.send('post', uri_path("addons",id.to_s,"unarchive"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("addons",id.to_s,"unarchive"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Addon

data/lib/chargebee/models/address.rb

@@ -8,11 +8,15 @@ module ChargeBee
   #-----------
 
   def self.retrieve(params, env=nil, headers={})
-    Request.send('get', uri_path("addresses"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("addresses"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.update(params, env=nil, headers={})
-    Request.send('post', uri_path("addresses"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("addresses"), params, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Address

data/lib/chargebee/models/attached_item.rb

@@ -3,29 +3,39 @@ module ChargeBee
 
   attr_accessor :id, :parent_item_id, :item_id, :type, :status, :quantity, :quantity_in_decimal,
   :billing_cycles, :charge_on_event, :charge_once, :created_at, :resource_version, :updated_at,
-  :channel, :business_entity_id
+  :channel, :business_entity_id, :deleted
 
   # OPERATIONS
   #-----------
 
   def self.create(id, params, env=nil, headers={})
-    Request.send('post', uri_path("items",id.to_s,"attached_items"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("items",id.to_s,"attached_items"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.update(id, params, env=nil, headers={})
-    Request.send('post', uri_path("attached_items",id.to_s), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("attached_items",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, params, env=nil, headers={})
-    Request.send('get', uri_path("attached_items",id.to_s), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("attached_items",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete(id, params, env=nil, headers={})
-    Request.send('post', uri_path("attached_items",id.to_s,"delete"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("attached_items",id.to_s,"delete"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(id, params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("items",id.to_s,"attached_items"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("items",id.to_s,"attached_items"), params, env, headers,nil, false, jsonKeys)
   end
 
   end # ~AttachedItem

data/lib/chargebee/models/business_entity.rb

@@ -7,11 +7,15 @@ module ChargeBee
   #-----------
 
   def self.create_transfers(params, env=nil, headers={})
-    Request.send('post', uri_path("business_entities","transfers"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("business_entities","transfers"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.get_transfers(params={}, env=nil, headers={})
-    Request.send('get', uri_path("business_entities","transfers"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("business_entities","transfers"), params, env, headers,nil, false, jsonKeys)
   end
 
   end # ~BusinessEntity

data/lib/chargebee/models/card.rb

@@ -11,23 +11,33 @@ module ChargeBee
   #-----------
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("cards",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("cards",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.update_card_for_customer(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"credit_card"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("customers",id.to_s,"credit_card"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.switch_gateway_for_customer(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"switch_gateway"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("customers",id.to_s,"switch_gateway"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.copy_card_for_customer(id, params, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"copy_card"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("customers",id.to_s,"copy_card"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete_card_for_customer(id, env=nil, headers={})
-    Request.send('post', uri_path("customers",id.to_s,"delete_card"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("customers",id.to_s,"delete_card"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Card

data/lib/chargebee/models/comment.rb

@@ -7,19 +7,27 @@ module ChargeBee
   #-----------
 
   def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("comments"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("comments"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("comments",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("comments",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("comments"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("comments"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete(id, env=nil, headers={})
-    Request.send('post', uri_path("comments",id.to_s,"delete"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("comments",id.to_s,"delete"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Comment

data/lib/chargebee/models/configuration.rb

@@ -7,7 +7,9 @@ module ChargeBee
   #-----------
 
   def self.list(env=nil, headers={})
-    Request.send_list_request('get', uri_path("configurations"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("configurations"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Configuration

data/lib/chargebee/models/coupon.rb

@@ -18,45 +18,75 @@ module ChargeBee
   :max_redemptions, :status, :apply_discount_on, :apply_on, :plan_constraint, :addon_constraint,
   :created_at, :archived_at, :resource_version, :updated_at, :included_in_mrr, :period, :period_unit,
   :plan_ids, :addon_ids, :item_constraints, :item_constraint_criteria, :redemptions, :invoice_notes,
-  :meta_data, :coupon_constraints
+  :meta_data, :coupon_constraints, :deleted
 
   # OPERATIONS
   #-----------
 
   def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("coupons"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("coupons"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.create_for_items(params, env=nil, headers={})
-    Request.send('post', uri_path("coupons","create_for_items"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+        :item_price_ids => 1,
+        :item_family_ids => 1,
+        :currencies => 1,
+        :item_price_periods => 1,
+    }
+    Request.send('post', uri_path("coupons","create_for_items"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.update_for_items(id, params, env=nil, headers={})
-    Request.send('post', uri_path("coupons",id.to_s,"update_for_items"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+        :item_price_ids => 1,
+        :item_family_ids => 1,
+        :currencies => 1,
+        :item_price_periods => 1,
+    }
+    Request.send('post', uri_path("coupons",id.to_s,"update_for_items"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("coupons"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("coupons"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("coupons",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("coupons",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.update(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("coupons",id.to_s), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("coupons",id.to_s), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete(id, env=nil, headers={})
-    Request.send('post', uri_path("coupons",id.to_s,"delete"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupons",id.to_s,"delete"), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.copy(params, env=nil, headers={})
-    Request.send('post', uri_path("coupons","copy"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupons","copy"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.unarchive(id, env=nil, headers={})
-    Request.send('post', uri_path("coupons",id.to_s,"unarchive"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupons",id.to_s,"unarchive"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~Coupon

data/lib/chargebee/models/coupon_code.rb

@@ -7,19 +7,27 @@ module ChargeBee
   #-----------
 
   def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("coupon_codes"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupon_codes"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("coupon_codes",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("coupon_codes",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("coupon_codes"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("coupon_codes"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.archive(id, env=nil, headers={})
-    Request.send('post', uri_path("coupon_codes",id.to_s,"archive"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupon_codes",id.to_s,"archive"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~CouponCode

data/lib/chargebee/models/coupon_set.rb

@@ -7,31 +7,47 @@ module ChargeBee
   #-----------
 
   def self.create(params, env=nil, headers={})
-    Request.send('post', uri_path("coupon_sets"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("coupon_sets"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.add_coupon_codes(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("coupon_sets",id.to_s,"add_coupon_codes"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupon_sets",id.to_s,"add_coupon_codes"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.list(params={}, env=nil, headers={})
-    Request.send_list_request('get', uri_path("coupon_sets"), params, env, headers)
+    jsonKeys = { 
+    }
+    Request.send_list_request('get', uri_path("coupon_sets"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.retrieve(id, env=nil, headers={})
-    Request.send('get', uri_path("coupon_sets",id.to_s), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('get', uri_path("coupon_sets",id.to_s), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.update(id, params={}, env=nil, headers={})
-    Request.send('post', uri_path("coupon_sets",id.to_s,"update"), params, env, headers)
+    jsonKeys = { 
+        :meta_data => 0,
+    }
+    Request.send('post', uri_path("coupon_sets",id.to_s,"update"), params, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete(id, env=nil, headers={})
-    Request.send('post', uri_path("coupon_sets",id.to_s,"delete"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupon_sets",id.to_s,"delete"), {}, env, headers,nil, false, jsonKeys)
   end
 
   def self.delete_unused_coupon_codes(id, env=nil, headers={})
-    Request.send('post', uri_path("coupon_sets",id.to_s,"delete_unused_coupon_codes"), {}, env, headers)
+    jsonKeys = { 
+    }
+    Request.send('post', uri_path("coupon_sets",id.to_s,"delete_unused_coupon_codes"), {}, env, headers,nil, false, jsonKeys)
   end
 
   end # ~CouponSet