chargebee 2.24.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a9362e4ef388e73d2664362adfc29ad58156c08
-  data.tar.gz: 813149625fe51364a45da1c0e8fd97bd78ceb818
+  metadata.gz: 47e67b64038c0962879a8cdc8b5fcfdb9188f7a6
+  data.tar.gz: 21248229802c3b25e40c6a43a7ccc1a0d23b7fb4
 SHA512:
-  metadata.gz: 65f7645d7b39d76d4c234828616995ddb03159978a0cf542b2732cafb81dab70923ee50d41c1ac893294197faff4870a729191702ee9578f6d9ecaa21e662b44
-  data.tar.gz: 90c6412b8612dd53ad6a1d4c7eb54a4da0067e81aacb6814531329c27ebdf82c03d50ec853c8f29e834e0a76802cb44f03455218bc72687c5a50b40902682dc6
+  metadata.gz: 2c5dc16a5704ca0b088200f37d95b03d36c5e94e4723f21f636037c883e2073e1ce7d2191a8d0633f9e5549aea03dfbcf3a285aefa799051ee03fea8d7c69e73
+  data.tar.gz: 8809d69227fe4269056c867f8f98965195f34ea454f2deb0c843eb268c99060ad0b0f5d2b6d4dcc8ece1b0b75d4d4f9226ce5b33104f5e1354a402c668069567

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+### v2.26.0 (2023-05-16)
+* * *
+
+#### New Feature:
+* Added utility to pass **Idempotency key** along with request headers to allow a safe retry of POST requests.
+* Added is_idempotency_replayed() utility to differentiate between original and replayed requests.
+* Added get_response_headers() utility to fetch the response headers.
+
+
+### v2.25.0 (2023-04-28)
+* * *
+
+#### Fixes:
+* SubscriptionId attribute has been maid as required in InAppSubscription resource.
+
+#### New Attributes: 
+* TotalContractValueBeforeTax has been added to the ContractTerm resource.
+* TotalContractValueBeforeTax#SubscriptionContractTerm has been added to the Subscription resource.
+* TotalContractValueBeforeTax#SubscriptionEstimateContractTerm has been addded to the SubscriptionEstimate resource.
+* CouponConstraints has been added to the Coupon resource.
+
+#### New Resource:
+* NonSubscription have been added.
+
+#### Added Input Parameters:
+* contract_term[total_amount_raised_before_tax]#ImportSubscriptionRequest, contract_term[total_amount_raised_before_tax]#ImportForItemsRequest, contract_term[total_amount_raised_before_tax]#ImportContractTermRequest and contract_term[total_amount_raised_before_tax]#ImportForCustomerRequest parameter has been added to Subscription resource.
+* contract_term[total_contract_value_before_tax]#ImportContractTermRequest parameter has been added to Subscription resource.
+* coupon_constraints[entity_type]#CreateForItemsRequestParams, coupon_constraints[type]#CreateForItemsRequestParams and coupon_constraints[value]#CreateForItemsRequestParams parameter has been added to the Coupon resource.
+* coupon_constraints[entity_type]#UpdateForItemsRequestParams, coupon_constraints[type]#UpdateForItemsRequestParams and coupon_constraints[value]#UpdateForItemsRequestParams parameter has been added to the Coupon resource.
+* export_type#CustomersRequest and export_type#SubscriptionsRequest parameter has been added to the Export resource.
+
+#### New Enum Class:
+* ExportType has been added.
+
+#### New Enum values:
+* pending_authorization has been added to StatusEnum#PaymentIntentPaymentAttempt to the PaymentIntent resource.
+
+
 ### v2.24.0 (2023-03-24)
 * * *
 

data/Gemfile.lock

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

data/README.md

@@ -0,0 +1,77 @@
+# Chargebee Ruby Client Library - API V2
+
+[![gem](https://img.shields.io/gem/v/chargebee.svg?maxAge=2592000)](https://rubygems.org/gems/chargebee)
+[![gem](https://img.shields.io/gem/dtv/chargebee.svg?maxAge=2592000)](https://rubygems.org/gems/chargebee)
+
+This is the Ruby Library for integrating with Chargebee. Sign up for a Chargebee account {here}[https://www.chargebee.com].
+
+Chargebee now supports two API versions - [V1](https://apidocs.chargebee.com/docs/api/v1) and [V2](https://apidocs.chargebee.com/docs/api), of which V2 is the latest release and all future developments will happen in V2. This library is for <b>API version V2</b>. If you’re looking for V1, head to [chargebee-v1 branch](https://github.com/chargebee/chargebee-ruby/tree/chargebee-v1).
+
+## Installation
+
+Install the latest version of the gem with the following command...
+
+    $ sudo gem install chargebee -v '~>2'
+
+
+## Requirements
+
+* Ruby 1.9.3 or above.
+* rest-client
+
+## Documentation
+
+See our [Ruby API Reference](https://apidocs.chargebee.com/docs/api?lang=ruby "API Reference").
+
+## Usage
+
+### To create a new subscription:
+
+```ruby
+ChargeBee.configure({:api_key => "your_api_key" , :site => "your_site"})
+result = ChargeBee::Subscription.create({
+	:id => "sub_KyVqDh__dev__NTn4VZZ1", 
+	:plan_id => "basic", 
+})
+subscription = result.subscription
+puts "created subscription is #{subscription}"
+```
+
+### Create an Idempotent Request
+
+[Idempotency keys](https://apidocs.chargebee.com/docs/api) are passed along with request headers to allow a safe retry of POST requests. 
+
+```ruby
+require 'chargebee'
+ChargeBee.configure({:api_key => "your_api_key" , :site => "your_site"})
+result = ChargeBee::Customer.create({
+  :first_name => "John",
+  :last_name => "Doe",
+  :email => "john@test.com",
+  :locale => "fr-CA",
+  :billing_address => {
+    :first_name => "John",
+    :last_name => "Doe",
+    :line1 => "PO Box 9999",
+    :city => "Walnut",
+    :state => "California",
+    :zip => "91789",
+    :country => "US"
+    }
+  },
+  nil,
+  {"chargebee-idempotency-key" => "<<UUID>>"} # Replace <<UUID>> with a unique string
+)
+customer = result.customer
+card = result.card
+responseHeader = result.get_response_headers # Retrieves response headers
+puts(responseHeader)
+idempotencyReplayedValue = result.is_idempotency_replayed # Retrieves Idempotency replayed header value
+puts(idempotencyReplayedValue)
+```
+`is_idempotency_replayed` method can be accessed to differentiate between original and replayed requests.
+
+## License
+
+See the LICENSE file.
+

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.24.0'
-  s.date              = '2023-03-24'
+  s.version           = '2.26.0'
+  s.date              = '2023-05-16'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
 
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     Gemfile
     Gemfile.lock
     LICENSE
+    README.md
     README.rdoc
     Rakefile
     chargebee.gemspec
@@ -73,6 +74,7 @@ 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_source.rb

data/lib/chargebee/list_result.rb

@@ -10,12 +10,17 @@ module ChargeBee
     
     attr_reader :next_offset
 
-    def initialize(response, next_offset=nil)
+    def initialize(response, next_offset=nil, rheaders = nil)
       @response = response
+      @rheaders = rheaders
       @list = Array.new
       @next_offset = JSON.parse(next_offset).to_s if next_offset
       initItems()
     end
+
+    def get_response_headers()
+      @rheaders
+    end
     
     private
     def initItems()

data/lib/chargebee/models/contract_term.rb

@@ -2,7 +2,8 @@ module ChargeBee
   class ContractTerm < Model
 
   attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end,
-  :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+  :total_contract_value, :total_contract_value_before_tax, :cancellation_cutoff_period, :created_at,
+  :subscription_id, :remaining_billing_cycles
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/coupon.rb

@@ -9,11 +9,15 @@ module ChargeBee
       attr_accessor :item_type, :currencies, :item_family_ids, :item_price_periods
     end
 
+    class CouponConstraint < Model
+      attr_accessor :entity_type, :type, :value
+    end
+
   attr_accessor :id, :name, :invoice_name, :discount_type, :discount_percentage, :discount_amount,
   :discount_quantity, :currency_code, :duration_type, :duration_month, :valid_till, :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
+  :item_constraints, :item_constraint_criteria, :redemptions, :invoice_notes, :meta_data, :coupon_constraints
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/non_subscription.rb

@@ -0,0 +1,14 @@
+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

data/lib/chargebee/models/subscription.rb

@@ -38,7 +38,7 @@ module ChargeBee
     end
 
     class ContractTerm < Model
-      attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end, :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+      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
 
     class Discount < Model

data/lib/chargebee/models/subscription_entitlement.rb

@@ -5,8 +5,8 @@ module ChargeBee
       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
+  attr_accessor :subscription_id, :feature_id, :feature_name, :feature_unit, :value, :name, :is_overridden,
+  :is_enabled, :expires_at, :components
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/subscription_estimate.rb

@@ -6,7 +6,7 @@ module ChargeBee
     end
 
     class ContractTerm < Model
-      attr_accessor :id, :status, :contract_start, :contract_end, :billing_cycle, :action_at_term_end, :total_contract_value, :cancellation_cutoff_period, :created_at, :subscription_id, :remaining_billing_cycles
+      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
 
   attr_accessor :id, :currency_code, :status, :trial_end_action, :next_billing_at, :pause_date,

data/lib/chargebee/request.rb

@@ -15,11 +15,11 @@ module ChargeBee
     def self.send(method, url, params={}, env=nil, headers={})
       env ||= ChargeBee.default_env
       ser_params = Util.serialize(params)
-      resp = Rest.request(method, url, env, ser_params||={}, headers)
+      resp, rheaders = Rest.request(method, url, env, ser_params||={}, headers)
       if resp.has_key?(:list)
-        ListResult.new(resp[:list], resp[:next_offset]) 
+        ListResult.new(resp[:list], resp[:next_offset], rheaders) 
       else 
-        Result.new(resp)
+        Result.new(resp, rheaders)
       end
     end
       

data/lib/chargebee/rest.rb

@@ -54,6 +54,7 @@ module ChargeBee
       rescue Exception => e
             raise IOError.new("IO Exception when trying to connect to chargebee with url #{opts[:url]} . Reason #{e}",e)        
       end
+      rheaders = response.headers
       rbody = response.body
       rcode = response.code
       begin
@@ -68,7 +69,7 @@ module ChargeBee
         end
       end
       resp = Util.symbolize_keys(resp)
-      resp
+      return resp, rheaders
     end
     
     def self.handle_for_error(e, rcode=nil, rbody=nil)

data/lib/chargebee/result.rb

@@ -1,10 +1,26 @@
 module ChargeBee
   class Result
 
-    def initialize(response)
-      @response = response
+    IDEMPOTENCY_REPLAYED_HEADER = :chargebee_idempotency_replayed
+
+    def initialize(response, rheaders = nil)
+        @response = response
+        @rheaders = rheaders
+    end
+
+    def get_response_headers()
+        @rheaders
     end
     
+    def is_idempotency_replayed()
+        replayed_header = get_response_headers[IDEMPOTENCY_REPLAYED_HEADER]
+        if replayed_header != nil
+           return !!replayed_header
+        else
+           return false
+        end
+    end
+
     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});
@@ -178,7 +194,7 @@ module ChargeBee
 
     def coupon() 
         coupon = get(:coupon, Coupon,
-        {:item_constraints => Coupon::ItemConstraint, :item_constraint_criteria => Coupon::ItemConstraintCriteria});
+        {:item_constraints => Coupon::ItemConstraint, :item_constraint_criteria => Coupon::ItemConstraintCriteria, :coupon_constraints => Coupon::CouponConstraint});
         return coupon;
     end
 
@@ -313,6 +329,11 @@ module ChargeBee
         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;

data/lib/chargebee.rb

@@ -68,7 +68,7 @@ require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 
 module ChargeBee
 
-  VERSION = '2.24.0'
+  VERSION = '2.26.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.24.0
+  version: 2.26.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -107,6 +107,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.md
 - README.rdoc
 - Rakefile
 - chargebee.gemspec
@@ -149,6 +150,7 @@ 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_source.rb