chargebee 2.27.1 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e3b484d27a54b2d9f61499b7564d1977a181ce
-  data.tar.gz: a593b6873269dad17647d2d0d8a666c3c7218378
+  metadata.gz: 05f9c3ec4f1ff2e33d378f56a27e511d0b399528
+  data.tar.gz: 2b719615782c37002f70d6f63e2458d89f841374
 SHA512:
-  metadata.gz: b21345c220461ae7aa6c89129d7fcbb84857924e256fbad7f861028d5dfd0f0fb86917c2ad73164d670589c5dc935ea4b5a9e64c13fe7dc76569ec1ecd7111ca
-  data.tar.gz: e4149744cf10a05235a587609c2c6ace3dfaf6affabbf3b90136c6f017362dc439715c641c958e1e37a7825ea13ee19234e77faf59cbc2092c3c7eaf58d06666
+  metadata.gz: 5fc5b20f9d95df510c6b2323840c1b8db2788d0cb8bb88ab8444d8879b9ff49856150193d597a1264c8e5682a3d319c558adae4f802fcb13401f140991703d22
+  data.tar.gz: e6a3eccd9fa61cd526023a4cd01ba7b8a85e91082821a02f38335116f3e8b6041121b7ef364946949f393fcd9510fa541eb38b6230703ed8f3db3239d515a195

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+### v2.28.0 (2023-06-30)
+* * *
+
+#### New endpoints:
+* ViewVoucher#ViewVoucherRequest has been added to the HostedPage resource.
+* InvoiceListPaymentReferenceNumbers#InvoiceListPaymentReferenceNumbersRequest has been added to the Invoice resource.
+
+#### New Resource:
+* PaymentReferenceNumber has been added.
+
+#### New attributes:
+* local_currency_exchange_rate has been added to the CreditNote and Invoice resource. 
+
+#### New Enum values:
+* view_voucher has been added to Type enum in HostedPage resource.
+* paused has been added in StoreStatus enum in InAppSubscription resource.
+* metrics_global and windcave has been added in Gateway enum. 
+
+
+#### New Input parameters:
+* payment_initiator has been added to Customers#CollectPaymentRequest. 
+* payment_initiator has been added to Invoice#CreateRequest.
+* payment_initiator has been added to Invoice#ChargeRequest.
+* payment_initiator has been added to Invoice#ChargeAddonRequest.
+* payment_initiator has been added to Invoice#CollectPaymentRequest.
+* payment_initiator has been added to Subscription#CreateRequest.
+* payment_initiator has been added to Invoice#CreateForChargeItemRequest.
+* payment_initiator has been added to Subscription#CreateForCustomerRequest.
+* payment_initiator has been added to Subscription#CreateWithItemsRequest.
+* payment_initiator has been added to Subscription#UpdateForItemsRequest.
+* payment_initiator has been added to Subscription#ReactivateRequest.
+* payment_initiator has been added to Subscription#ResumeRequest.
+* payment_reference_numbers[id] has been added to Invoice#ImportInvoiceRequest.
+* payment_reference_numbers[type] has been added to Invoice#ImportInvoiceRequest.
+* payment_reference_numbers[number] has been added to Invoice#ImportInvoiceRequest.
+
+
 ### v2.27.0 (2023-05-31)
 * * *
 

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![gem](https://img.shields.io/gem/v/chargebee.svg?maxAge=2)](https://rubygems.org/gems/chargebee)
+[![gem](https://img.shields.io/gem/dtv/chargebee.svg?maxAge=2)](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).
 

data/chargebee.gemspec

@@ -4,10 +4,13 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.required_ruby_version = '>= 1.9.3'
   s.name              = 'chargebee'
-  s.version           = '2.27.1'
-  s.date              = '2023-05-31'
+  s.version           = '2.28.0'
+  s.date              = '2023-06-30'
   s.summary     = "Ruby client for Chargebee API."
   s.description = "Subscription Billing - Simple. Secure. Affordable. More details at www.chargebee.com."
+  s.metadata = {
+    "changelog_uri" => "https://github.com/chargebee/chargebee-ruby/blob/master/CHANGELOG.md"
+  }
 
   s.authors = ['Rajaraman S', 'Thiyagarajan T']
   s.email = ['rr@chargebee.com', 'thiyagu@chargebee.com']
@@ -17,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+  s.extra_rdoc_files = %w[README.md LICENSE]
 
   s.add_dependency('json_pure', '~> 2.1')
   s.add_dependency('rest-client', '>=1.8', '<=2.0.2')
@@ -32,7 +35,6 @@ Gem::Specification.new do |s|
     Gemfile.lock
     LICENSE
     README.md
-    README.rdoc
     Rakefile
     chargebee.gemspec
     lib/chargebee.rb
@@ -77,6 +79,7 @@ Gem::Specification.new do |s|
     lib/chargebee/models/non_subscription.rb
     lib/chargebee/models/order.rb
     lib/chargebee/models/payment_intent.rb
+    lib/chargebee/models/payment_reference_number.rb
     lib/chargebee/models/payment_source.rb
     lib/chargebee/models/payment_voucher.rb
     lib/chargebee/models/plan.rb

data/lib/chargebee/models/credit_note.rb

@@ -50,8 +50,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,
-  :business_entity_id, :shipping_address, :billing_address
+  :taxes, :line_item_taxes, :linked_refunds, :allocations, :deleted, :local_currency_exchange_rate,
+  :create_reason_code, :vat_number_prefix, :business_entity_id, :shipping_address, :billing_address
 
   # OPERATIONS
   #-----------

data/lib/chargebee/models/customer.rb

@@ -53,7 +53,7 @@ module ChargeBee
   # OPERATIONS
   #-----------
 
-  def self.create(params, env=nil, headers={})
+  def self.create(params={}, env=nil, headers={})
     Request.send('post', uri_path("customers"), params, env, headers)
   end
 
@@ -65,7 +65,7 @@ module ChargeBee
     Request.send('get', uri_path("customers",id.to_s), {}, env, headers)
   end
 
-  def self.update(id, params, env=nil, headers={})
+  def self.update(id, params={}, env=nil, headers={})
     Request.send('post', uri_path("customers",id.to_s), params, env, headers)
   end
 

data/lib/chargebee/models/hosted_page.rb

@@ -102,5 +102,9 @@ module ChargeBee
     Request.send('post', uri_path("hosted_pages","events"), params, env, headers)
   end
 
+  def self.view_voucher(params, env=nil, headers={})
+    Request.send('post', uri_path("hosted_pages","view_voucher"), params, env, headers)
+  end
+
   end # ~HostedPage
 end # ~ChargeBee

data/lib/chargebee/models/invoice.rb

@@ -69,12 +69,12 @@ module ChargeBee
   :price_type, :date, :due_date, :net_term_days, :exchange_rate, :currency_code, :total, :amount_paid,
   :amount_adjusted, :write_off_amount, :credits_applied, :amount_due, :paid_at, :dunning_status,
   :next_retry_at, :voided_at, :resource_version, :updated_at, :sub_total, :sub_total_in_local_currency,
-  :total_in_local_currency, :local_currency_code, :tax, :first_invoice, :new_sales_amount, :has_advance_charges,
-  :term_finalized, :is_gifted, :generated_at, :expected_payment_date, :amount_to_collect, :round_off_amount,
-  :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, :business_entity_id
+  :total_in_local_currency, :local_currency_code, :tax, :local_currency_exchange_rate, :first_invoice,
+  :new_sales_amount, :has_advance_charges, :term_finalized, :is_gifted, :generated_at, :expected_payment_date,
+  :amount_to_collect, :round_off_amount, :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, :business_entity_id
 
   # OPERATIONS
   #-----------
@@ -147,6 +147,10 @@ module ChargeBee
     Request.send('get', uri_path("invoices",id.to_s,"download_einvoice"), {}, env, headers)
   end
 
+  def self.list_payment_reference_numbers(params={}, env=nil, headers={})
+    Request.send('get', uri_path("invoices","payment_reference_numbers"), params, env, headers)
+  end
+
   def self.add_charge(id, params, env=nil, headers={})
     Request.send('post', uri_path("invoices",id.to_s,"add_charge"), params, env, headers)
   end

data/lib/chargebee/models/payment_reference_number.rb

@@ -0,0 +1,10 @@
+module ChargeBee
+  class PaymentReferenceNumber < Model
+
+  attr_accessor :id, :type, :number, :invoice_id
+
+  # OPERATIONS
+  #-----------
+
+  end # ~PaymentReferenceNumber
+end # ~ChargeBee

data/lib/chargebee/result.rb

@@ -96,6 +96,11 @@ module ChargeBee
         return invoice;
     end
 
+    def payment_reference_number() 
+        payment_reference_number = get(:payment_reference_number, PaymentReferenceNumber);
+        return payment_reference_number;
+    end
+
     def tax_withheld() 
         tax_withheld = get(:tax_withheld, TaxWithheld);
         return tax_withheld;

data/lib/chargebee.rb

@@ -68,7 +68,7 @@ require File.dirname(__FILE__) + '/chargebee/models/token.rb'
 
 module ChargeBee
 
-  VERSION = '2.27.1'
+  VERSION = '2.28.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.27.1
+  version: 2.28.0
 platform: ruby
 authors:
 - Rajaraman S
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -100,7 +100,7 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - LICENSE
 files:
 - CHANGELOG.md
@@ -108,7 +108,6 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - chargebee.gemspec
 - lib/chargebee.rb
@@ -153,6 +152,7 @@ files:
 - lib/chargebee/models/non_subscription.rb
 - lib/chargebee/models/order.rb
 - lib/chargebee/models/payment_intent.rb
+- lib/chargebee/models/payment_reference_number.rb
 - lib/chargebee/models/payment_source.rb
 - lib/chargebee/models/payment_voucher.rb
 - lib/chargebee/models/plan.rb
@@ -189,7 +189,8 @@ files:
 homepage: https://apidocs.chargebee.com/api/docs?lang=ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/chargebee/chargebee-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8

data/README.rdoc

@@ -1,41 +0,0 @@
-= Chargebee Ruby Client Library - API V2
-
-{<img src="https://img.shields.io/gem/v/chargebee.svg?maxAge=2592000"/>}[https://rubygems.org/gems/chargebee]
-{<img src="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
-
-For API reference see {here}[https://apidocs.chargebee.com/docs/api?lang=ruby]
-
-== Usage
-
-To create a new subscription:
-
-    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}"
-
-== License
-
-See the LICENSE file.
-