recurly 4.2.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86a12242c76e7a5797ceb93597b6042871b5b6b27d6fd8f5dd193ae2ef198a59
-  data.tar.gz: 3f254d1aec8ee0f487c701e3db0835feae00878bbd4342b38d1fb5f7e46a9bf0
+  metadata.gz: 4b355c5446a85f7911c3f383a4c4a5f54ab5153fc2764680c4bd739aba9b3bc9
+  data.tar.gz: 1fa2e60c2bf6970b0d6187ae18130c0813551ccec839b9ee4e80e6e4a5e1a77c
 SHA512:
-  metadata.gz: 4998b18d4434ea368beb5d145e531ba593b694782fb76a43f14b9735fb55f70780e5b92978ec951cea9e4b8ffa38675bb1228c7d099a29771bc8c56aa1d96693
-  data.tar.gz: bcb489bdb2ef9f1f7abdbe0d321ab7d42343dae8df66aac610eb652de005c829c90193126c782b4dc5604cf4ae0e8632b0e262e172124c95d84c7f914b3558d7
+  metadata.gz: 3a71c147eb618bd49ef0350bf6492f1c8d0d0cafedfd6aebaf6a3ac35b9e13f11fa3ad7133baae2ec11b8e5ac7994e77ea768eceeaf90d2681e6c189e3723ced
+  data.tar.gz: 7dba56f22aacea3aad801bd5a5fd3d7f26a72b2d0a5aab7f1418865cbaf8d56da51d6682514a2752989b49b7e3bf04cb06d75aecd00f13fc3880317aee2f1915

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.2.0
+current_version = 4.6.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## [4.6.0](https://github.com/recurly/recurly-client-ruby/tree/4.6.0) (2021-08-11)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.5.0...4.6.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#720](https://github.com/recurly/recurly-client-ruby/pull/720) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.5.0](https://github.com/recurly/recurly-client-ruby/tree/4.5.0) (2021-08-02)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.4.0...4.5.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#714](https://github.com/recurly/recurly-client-ruby/pull/714) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.4.0](https://github.com/recurly/recurly-client-ruby/tree/4.4.0) (2021-06-15)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.3.0...4.4.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#705](https://github.com/recurly/recurly-client-ruby/pull/705) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.3.0](https://github.com/recurly/recurly-client-ruby/tree/4.3.0) (2021-06-04)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.2.0...4.3.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#702](https://github.com/recurly/recurly-client-ruby/pull/702) ([recurly-integrations](https://github.com/recurly-integrations))
+- Making #post allow a nil body [#699](https://github.com/recurly/recurly-client-ruby/pull/699) ([douglasmiller](https://github.com/douglasmiller))
+
+
+
 ## [4.2.0](https://github.com/recurly/recurly-client-ruby/tree/4.2.0) (2021-04-21)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.1.0...4.2.0)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.2'
+gem 'recurly', '~> 4.6'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client.rb

@@ -113,13 +113,15 @@ module Recurly
       handle_response! request, http_response
     end
 
-    def post(path, request_data, request_class, **options)
+    def post(path, request_data = nil, request_class = nil, **options)
       validate_options!(**options)
-      request_class.new(request_data).validate!
       request = Net::HTTP::Post.new build_url(path, options)
       request.set_content_type(JSON_CONTENT_TYPE)
       set_headers(request, options[:headers])
-      request.body = JSON.dump(request_data)
+      if request_data
+        request_class.new(request_data).validate!
+        request.body = JSON.dump(request_data)
+      end
       http_response = run_request(request, options)
       handle_response! request, http_response
     end

data/lib/recurly/client/operations.rb

@@ -452,6 +452,30 @@ module Recurly
       delete(path, **options)
     end
 
+    # Verify an account's credit card billing information
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documenation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param params [Hash] Optional query string parameters:
+    #        :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
+    #
+    # @return [Resources::Transaction] Transaction information from verify.
+    # @example
+    #   begin
+    #     transaction = @client.verify_billing_info(account_id: account_id)
+    #     puts "Got Transaction #{transaction}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
+    #
+    def verify_billing_info(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_info/verify", account_id: account_id)
+      post(path, options[:body], Requests::BillingInfoVerify, **options)
+    end
+
     # Get the list of billing information associated with an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documenation}
@@ -488,7 +512,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Set an account's billing information when the wallet feature is enabled
+    # Add new billing information on an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documenation}
     #

data/lib/recurly/requests/address.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute phone

data/lib/recurly/requests/billing_info_create.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :amazon_billing_agreement_id, String
 
       # @!attribute backup_payment_method
-      #   @return [Boolean] The `backup_payment_method` indicator is used to designate a billing info as a backup on the account that will be tried if the billing info marked `primary_payment_method` fails. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
+      #   @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
       define_attribute :backup_payment_method, :Boolean
 
       # @!attribute company
@@ -67,15 +67,15 @@ module Recurly
       define_attribute :paypal_billing_agreement_id, String
 
       # @!attribute primary_payment_method
-      #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+      #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
       # @!attribute tax_identifier
-      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.
+      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
       define_attribute :tax_identifier, String
 
       # @!attribute tax_identifier_type
-      #   @return [String] this field and a value of 'cpf' are required if adding a billing info that is an elo or hipercard type in Brazil.
+      #   @return [String] This field and a value of `cpf` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
       define_attribute :tax_identifier_type, String
 
       # @!attribute three_d_secure_action_result_token_id

data/lib/recurly/requests/billing_info_verify.rb

@@ -0,0 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class BillingInfoVerify < Request
+
+      # @!attribute gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_address.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

data/lib/recurly/requests/shipping_address_create.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/shipping_address_update.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/subscription_change_billing_info_create.rb

@@ -0,0 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class SubscriptionChangeBillingInfoCreate < Request
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfoCreate]
+      define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String

data/lib/recurly/requests/subscription_create.rb

@@ -99,7 +99,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_purchase.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount

data/lib/recurly/resources/address.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute phone

data/lib/recurly/resources/address_with_name.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

data/lib/recurly/resources/billing_info.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :address, :Address
 
       # @!attribute backup_payment_method
-      #   @return [Boolean] The `backup_payment_method` indicator is used to designate a billing info as a backup on the account that will be tried if the billing info marked `primary_payment_method` fails.
+      #   @return [Boolean] The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
       define_attribute :backup_payment_method, :Boolean
 
       # @!attribute company
@@ -51,7 +51,7 @@ module Recurly
       define_attribute :payment_method, :PaymentMethod
 
       # @!attribute primary_payment_method
-      #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
+      #   @return [Boolean] The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
       define_attribute :primary_payment_method, :Boolean
 
       # @!attribute updated_at

data/lib/recurly/resources/billing_info_updated_by.rb

@@ -7,7 +7,7 @@ module Recurly
     class BillingInfoUpdatedBy < Resource
 
       # @!attribute country
-      #   @return [String] Country of IP address, if known by Recurly.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.
       define_attribute :country, String
 
       # @!attribute ip

data/lib/recurly/resources/invoice.rb

@@ -111,7 +111,7 @@ module Recurly
       define_attribute :subscription_ids, Array, { :item_type => String }
 
       # @!attribute subtotal
-      #   @return [Float] The summation of charges, discounts, and credits, before tax.
+      #   @return [Float] The summation of charges and credits, before discounts and taxes.
       define_attribute :subtotal, Float
 
       # @!attribute tax

data/lib/recurly/resources/invoice_address.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

data/lib/recurly/resources/payment_method.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
       define_attribute :card_type, String
 
+      # @!attribute cc_bin_country
+      #   @return [String] The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
+      define_attribute :cc_bin_country, String
+
       # @!attribute exp_month
       #   @return [Integer] Expiration month.
       define_attribute :exp_month, Integer

data/lib/recurly/resources/shipping_address.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute created_at

data/lib/recurly/resources/subscription_change.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
+      define_attribute :billing_info, :SubscriptionChangeBillingInfo
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime

data/lib/recurly/resources/subscription_change_billing_info.rb

@@ -0,0 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class SubscriptionChangeBillingInfo < Resource
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/resources/tax_detail.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class TaxDetail < Resource
+
+      # @!attribute rate
+      #   @return [Float] Provides the tax rate for the region.
+      define_attribute :rate, Float
+
+      # @!attribute region
+      #   @return [String] Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code.
+      define_attribute :region, String
+
+      # @!attribute tax
+      #   @return [Float] The total tax applied for this tax type.
+      define_attribute :tax, Float
+
+      # @!attribute type
+      #   @return [String] Provides the tax type for the region. For Canadian Sales Tax, this will be GST, HST, QST or PST.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/tax_info.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
       define_attribute :region, String
 
+      # @!attribute tax_details
+      #   @return [Array[TaxDetail]] Provides additional tax details for Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItem.
+      define_attribute :tax_details, Array, { :item_type => :TaxDetail }
+
       # @!attribute type
       #   @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
       define_attribute :type, String

data/lib/recurly/resources/transaction.rb

@@ -87,7 +87,7 @@ module Recurly
       define_attribute :invoice, :InvoiceMini
 
       # @!attribute ip_address_country
-      #   @return [String] IP address's country
+      #   @return [String] Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
       define_attribute :ip_address_country, String
 
       # @!attribute ip_address_v4

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.2.0"
+  VERSION = "4.6.0"
 end

data/openapi/api.yaml

@@ -111,9 +111,11 @@ info:
     developers and those who are familiar with API technology. When using the
     API and passing error messages to target systems, be mindful that
     these messages may not make sense in the context of the target system.
-    Please consider changing these messages in target system to be better
+    Please consider changing these messages in the target system to be better
     suited to the audience of the system.
 
+    Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+
     ## Pagination
     ### Response Schema
     Every GET listing endpoint returns a response with the same schema:
@@ -190,6 +192,7 @@ x-tagGroups:
   - note
   - account_acquisition
   - billing_info
+  - billing_infos
   - subscription
   - subscription_change
   - shipping_address
@@ -260,9 +263,15 @@ tags:
     to match this data with revenue and billing data events in Recurly.
 - name: billing_info
   x-displayName: Billing Info
-  description: An account can have one stored payment method at a time. This can be
-    a credit card, PayPal, or bank account. Billing info is usually filled out by
-    the customer upon purchase or when they update their information.
+  description: Without the premium Wallet feature, an account can only have one stored
+    payment method at a time. Examples include credit cards, PayPal, or bank accounts.
+    Billing info is filled out by the customer upon purchase or when they update their
+    information.
+- name: billing_infos
+  x-displayName: Billing Infos
+  description: If the premium Wallet feature is enabled, an account can have multiple
+    payment methods stored. Examples include credit cards, PayPal, or bank accounts.
+    Primary or backup billing infos can be designated from these endpoints.
 - name: subscription
   x-displayName: Subscription
   description: Subscriptions are created when your customers subscribe to one of your
@@ -2297,10 +2306,141 @@ paths:
           {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Removed Billing
           Info: %v\", billingInfo)"
+  "/accounts/{account_id}/billing_info/verify":
+    post:
+      tags:
+      - billing_info
+      operationId: verify_billing_info
+      summary: Verify an account's credit card billing information
+      parameters:
+      - "$ref": "#/components/parameters/account_id"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/BillingInfoVerify"
+        required: false
+      responses:
+        '200':
+          description: Transaction information from verify.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Transaction"
+        '404':
+          description: Account has no billing information, or incorrect site or account
+            ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Invalid billing information, or error running the verification
+            transaction.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ErrorMayHaveTransaction"
+      x-code-samples:
+      - lang: Node.js
+        source: |
+          try {
+            const transaction = await client.verifyBillingInfo(accountId)
+            console.log('Fetched Transaction: ', transaction.id)
+          } catch (err) {
+            if (err instanceof recurly.errors.NotFoundError) {
+              // If the request was not found, you may want to alert the user or
+              // just return null
+              console.log('Resource Not Found')
+            } else {
+              // If we don't know what to do with the err, we should
+              // probably re-raise and let our web framework and logger handle it
+              console.log('Unknown Error: ', err)
+            }
+          }
+      - lang: Python
+        source: |
+          try:
+              transaction = client.verify_billing_info(account_id)
+              print("Got Transaction %s" % transaction)
+          except recurly.errors.NotFoundError:
+              # If the resource was not found, you may want to alert the user or
+              # just return nil
+              print("Resource Not Found")
+      - lang: ".NET"
+        source: |
+          try
+          {
+              Transaction transaction = client.VerifyBillingInfo(accountId);
+              Console.WriteLine($"Fetched transaction {transaction.Id}");
+          }
+          catch (Recurly.Errors.NotFound ex)
+          {
+              // If the resource was not found
+              // we may want to alert the user or just return null
+              Console.WriteLine($"Resource Not Found: {ex.Error.Message}");
+          }
+          catch (Recurly.Errors.ApiError ex)
+          {
+              // Use ApiError to catch a generic error from the API
+              Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
+          }
+      - lang: Ruby
+        source: |
+          begin
+            transaction = @client.verify_billing_info(account_id: account_id)
+            puts "Got Transaction #{transaction}"
+          rescue Recurly::Errors::NotFoundError
+            # If the resource was not found, you may want to alert the user or
+            # just return nil
+            puts "Resource Not Found"
+          end
+      - lang: Java
+        source: |
+          try {
+              final Transaction transaction = client.verifyBillingInfo(accountId);
+              System.out.println("Fetched transaction " + transaction.getId());
+          } catch (NotFoundException e) {
+              // If the resource was not found
+              // we may want to alert the user or just return null
+              System.out.println("Resource Not Found: " + e.getError().getMessage());
+          } catch (ApiException e) {
+              // Use ApiException to catch a generic error from the API
+              System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
+          }
+      - lang: PHP
+        source: |
+          try {
+              $transaction = $client->verifyBillingInfo($account_id);
+
+              echo 'Got Transaction:' . PHP_EOL;
+              var_dump($transaction);
+          } catch (\Recurly\Errors\NotFound $e) {
+              // Could not find the resource, you may want to inform the user
+              // or just return a NULL
+              echo 'Could not find resource.' . PHP_EOL;
+              var_dump($e);
+          } catch (\Recurly\RecurlyError $e) {
+              // Something bad happened... tell the user so that they can fix it?
+              echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
+          }
+      - lang: Go
+        source: "verifyBillingInfoParams := &recurly.VerifyBillingInfoParams{}\ntransaction,
+          err := client.VerifyBillingInfo(accountID, verifyBillingInfoParams)\nif
+          e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound
+          {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
+          Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Fetched Transaction:
+          %v\", transaction)"
   "/accounts/{account_id}/billing_infos":
     get:
       tags:
-      - billing_info
+      - billing_infos
       operationId: list_billing_infos
       summary: Get the list of billing information associated with an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
@@ -2333,9 +2473,9 @@ paths:
       x-code-samples: []
     post:
       tags:
-      - billing_info
+      - billing_infos
       operationId: create_billing_info
-      summary: Set an account's billing information when the wallet feature is enabled
+      summary: Add new billing information on an account
       description: |
         If you're using Recurly.js to securely submit data from webforms without sending it through your server,
         you can associate the billing information with an account by passing in the `token_id`. The only other
@@ -2393,7 +2533,7 @@ paths:
   "/accounts/{account_id}/billing_infos/{billing_info_id}":
     get:
       tags:
-      - billing_info
+      - billing_infos
       operationId: get_a_billing_info
       summary: Fetch a billing info
       parameters:
@@ -2415,7 +2555,7 @@ paths:
       x-code-samples: []
     put:
       tags:
-      - billing_info
+      - billing_infos
       operationId: update_a_billing_info
       summary: Update an account's billing information
       description: |
@@ -2475,7 +2615,7 @@ paths:
       x-code-samples: []
     delete:
       tags:
-      - billing_info
+      - billing_infos
       operationId: remove_a_billing_info
       summary: Remove an account's billing information
       parameters:
@@ -3706,7 +3846,7 @@ paths:
           try {
               LineItemCreate lineItemCreate = new LineItemCreate();
               lineItemCreate.setCurrency("USD");
-              lineItemCreate.setUnitAmount(1000.0f);
+              lineItemCreate.setUnitAmount(new BigDecimal("1000.0"));
               lineItemCreate.setType(Constants.LineItemType.CHARGE); // choose "credit" for a credit
 
               LineItem lineItem = client.createLineItem(accountId, lineItemCreate);
@@ -5286,7 +5426,7 @@ paths:
               List<CouponPricing> currencies = new ArrayList<CouponPricing>();
               CouponPricing couponPrice = new CouponPricing();
               couponPrice.setCurrency("USD");
-              couponPrice.setDiscount(10.0f);
+              couponPrice.setDiscount(new BigDecimal("10.0"));
               currencies.add(couponPrice);
 
               couponCreate.setCurrencies(currencies);
@@ -8817,7 +8957,7 @@ paths:
               final InvoiceRefund invoiceRefund = new InvoiceRefund();
               invoiceRefund.setCreditCustomerNotes("Notes on credits");
               invoiceRefund.setType(Constants.InvoiceRefundType.AMOUNT); // could also be "line_items"
-              invoiceRefund.setAmount(100f);
+              invoiceRefund.setAmount(new BigDecimal("100"));
 
               final Invoice invoice = client.refundInvoice(invoiceId, invoiceRefund);
               System.out.println("Refunded invoice " + invoice.getNumber());
@@ -9447,7 +9587,7 @@ paths:
               List<PlanPricing> currencies = new ArrayList<PlanPricing>();
               PlanPricing planPrice = new PlanPricing();
               planPrice.setCurrency("USD");
-              planPrice.setUnitAmount(10000.0f);
+              planPrice.setUnitAmount(new BigDecimal("10000"));
               currencies.add(planPrice);
 
               planCreate.setCurrencies(currencies);
@@ -10116,7 +10256,7 @@ paths:
               List<AddOnPricing> currencies = new ArrayList<AddOnPricing>();
               AddOnPricing addOnPrice = new AddOnPricing();
               addOnPrice.setCurrency("USD");
-              addOnPrice.setUnitAmount(10000.0f);
+              addOnPrice.setUnitAmount(new BigDecimal("10000.0"));
               currencies.add(addOnPrice);
 
               addOnCreate.setCurrencies(currencies);
@@ -13751,7 +13891,14 @@ paths:
               // why. You can find the invalid params and reasons in e.getError().getParams()
               System.out.println("Failed validation: " + e.getError().getMessage());
               System.out.println("Params: " + e.getError().getParams());
-          } catch (ApiException e) {
+          } catch (TransactionException e) {
+              TransactionError tError = e.getError().getTransactionError();
+              if (tError.getCategory() == Constants.ErrorCategory.THREE_D_SECURE_ACTION_REQUIRED) {
+                  String actionTokenId = tError.getThreeDSecureActionTokenId();
+                  System.out.println("Got 3DSecure TransactionError token: " + actionTokenId);
+              }
+          }
+          catch (ApiException e) {
               // Use ApiException to catch a generic error from the API
               System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
           }
@@ -15342,7 +15489,7 @@ components:
         country:
           type: string
           title: Country
-          description: Country, 2-letter ISO code.
+          description: Country, 2-letter ISO 3166-1 alpha-2 code.
     AddressWithName:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -15897,19 +16044,14 @@ components:
               title: Kount rules
         primary_payment_method:
           type: boolean
-          description: The `primary_payment_method` indicator is used to designate
-            the primary billing info on the account. The first billing info created
-            on an account will always become primary. Adding additional billing infos
-            provides the flexibility to mark another billing info as primary, or adding
-            additional non-primary billing infos. This can be accomplished by passing
-            the `primary_payment_method` indicator. When adding billing infos via
-            the billing_info and /accounts endpoints, this value is not permitted,
-            and will return an error if provided.
+          description: The `primary_payment_method` field is used to indicate the
+            primary billing info on the account. The first billing info created on
+            an account will always become primary. This payment method will be used
         backup_payment_method:
           type: boolean
-          description: The `backup_payment_method` indicator is used to designate
-            a billing info as a backup on the account that will be tried if the billing
-            info marked `primary_payment_method` fails.
+          description: The `backup_payment_method` field is used to indicate a billing
+            info as a backup on the account that will be tried if the initial billing
+            info used for an invoice is declined.
         created_at:
           type: string
           format: date-time
@@ -15931,7 +16073,8 @@ components:
               maxLength: 20
             country:
               type: string
-              description: Country of IP address, if known by Recurly.
+              description: Country, 2-letter ISO 3166-1 alpha-2 code matching the
+                origin IP address, if known by Recurly.
               maxLength: 2
     BillingInfoCreate:
       type: object
@@ -16021,32 +16164,39 @@ components:
         tax_identifier:
           type: string
           description: Tax identifier is required if adding a billing info that is
-            a consumer card in Brazil. This would be the customer's CPF, CPF is a
-            Brazilian tax identifier for all tax paying residents.
+            a consumer card in Brazil or in Argentina. This would be the customer's
+            CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for
+            all residents who pay taxes in Brazil and Argentina respectively.
         tax_identifier_type:
-          description: this field and a value of 'cpf' are required if adding a billing
-            info that is an elo or hipercard type in Brazil.
+          description: This field and a value of `cpf` or `cuit` are required if adding
+            a billing info that is an elo or hipercard type in Brazil or in Argentina.
           "$ref": "#/components/schemas/TaxIdentifierTypeEnum"
         primary_payment_method:
           type: boolean
           title: Primary Payment Method
-          description: The `primary_payment_method` indicator is used to designate
-            the primary billing info on the account. The first billing info created
-            on an account will always become primary. Adding additional billing infos
+          description: The `primary_payment_method` field is used to designate the
+            primary billing info on the account. The first billing info created on
+            an account will always become primary. Adding additional billing infos
             provides the flexibility to mark another billing info as primary, or adding
             additional non-primary billing infos. This can be accomplished by passing
-            the `primary_payment_method` indicator. When adding billing infos via
-            the billing_info and /accounts endpoints, this value is not permitted,
-            and will return an error if provided.
+            the `primary_payment_method` with a value of `true`. When adding billing
+            infos via the billing_info and /accounts endpoints, this value is not
+            permitted, and will return an error if provided.
         backup_payment_method:
           type: boolean
-          description: The `backup_payment_method` indicator is used to designate
-            a billing info as a backup on the account that will be tried if the billing
-            info marked `primary_payment_method` fails. All payment methods, including
-            the billing info marked `primary_payment_method` can be set as a backup.
-            An account can have a maximum of 1 backup, if a user sets a different
-            payment method as a backup, the existing backup will no longer be marked
-            as such.
+          description: The `backup_payment_method` field is used to designate a billing
+            info as a backup on the account that will be tried if the initial billing
+            info used for an invoice is declined. All payment methods, including the
+            billing info marked `primary_payment_method` can be set as a backup. An
+            account can have a maximum of 1 backup, if a user sets a different payment
+            method as a backup, the existing backup will no longer be marked as such.
+    BillingInfoVerify:
+      type: object
+      properties:
+        gateway_code:
+          type: string
+          description: An identifier for a specific payment gateway.
+          maxLength: 13
     Coupon:
       type: object
       properties:
@@ -17088,7 +17238,8 @@ components:
           type: number
           format: float
           title: Subtotal
-          description: The summation of charges, discounts, and credits, before tax.
+          description: The summation of charges and credits, before discounts and
+            taxes.
         tax:
           type: number
           format: float
@@ -18601,7 +18752,7 @@ components:
         country:
           type: string
           maxLength: 50
-          description: Country, 2-letter ISO code.
+          description: Country, 2-letter ISO 3166-1 alpha-2 code.
         created_at:
           type: string
           title: Created at
@@ -18656,7 +18807,7 @@ components:
         country:
           type: string
           maxLength: 50
-          description: Country, 2-letter ISO code.
+          description: Country, 2-letter ISO 3166-1 alpha-2 code.
       required:
       - first_name
       - last_name
@@ -18906,7 +19057,7 @@ components:
         country:
           type: string
           maxLength: 50
-          description: Country, 2-letter ISO code.
+          description: Country, 2-letter ISO 3166-1 alpha-2 code.
     Site:
       type: object
       properties:
@@ -19455,6 +19606,21 @@ components:
           format: date-time
           title: Deleted at
           readOnly: true
+        billing_info:
+          "$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
+    SubscriptionChangeBillingInfo:
+      type: object
+      description: Accept nested attributes for three_d_secure_action_result_token_id
+      properties:
+        three_d_secure_action_result_token_id:
+          type: string
+          title: 3-D Secure action result token ID
+          description: A token generated by Recurly.js after completing a 3-D Secure
+            device fingerprinting or authentication challenge.
+          maxLength: 22
+    SubscriptionChangeBillingInfoCreate:
+      allOf:
+      - "$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
     SubscriptionChangeCreate:
       type: object
       properties:
@@ -19559,6 +19725,8 @@ components:
             created by this request. Supports 'moto' value, which is the acronym for
             mail order and telephone transactions.
           "$ref": "#/components/schemas/GatewayTransactionTypeEnum"
+        billing_info:
+          "$ref": "#/components/schemas/SubscriptionChangeBillingInfoCreate"
     SubscriptionChangeShippingCreate:
       type: object
       title: Shipping details that will be changed on a subscription
@@ -19656,7 +19824,10 @@ components:
           format: date-time
           title: Trial ends at
           description: If set, overrides the default trial behavior for the subscription.
-            The date must be in the future.
+            When the current date time or a past date time is provided the subscription
+            will begin with no trial phase (overriding any plan default trial). When
+            a future date time is provided the subscription will begin with a trial
+            phase ending at the specified date time.
         starts_at:
           type: string
           format: date-time
@@ -19782,7 +19953,10 @@ components:
           format: date-time
           title: Trial ends at
           description: If set, overrides the default trial behavior for the subscription.
-            The date must be in the future.
+            When the current date time or a past date time is provided the subscription
+            will begin with no trial phase (overriding any plan default trial). When
+            a future date time is provided the subscription will begin with a trial
+            phase ending at the specified date time.
         starts_at:
           type: string
           format: date-time
@@ -20010,6 +20184,38 @@ components:
           type: number
           format: float
           title: Rate
+        tax_details:
+          type: array
+          description: Provides additional tax details for Canadian Sales Tax when
+            there is tax applied at both the country and province levels. This will
+            only be populated for the Invoice response when fetching a single invoice
+            and not for the InvoiceList or LineItem.
+          items:
+            "$ref": "#/components/schemas/TaxDetail"
+    TaxDetail:
+      type: object
+      title: Tax detail
+      properties:
+        type:
+          type: string
+          title: Type
+          description: Provides the tax type for the region. For Canadian Sales Tax,
+            this will be GST, HST, QST or PST.
+        region:
+          type: string
+          title: Region
+          description: Provides the tax region applied on an invoice. For Canadian
+            Sales Tax, this will be either the 2 letter province code or country code.
+        rate:
+          type: number
+          format: float
+          title: Rate
+          description: Provides the tax rate for the region.
+        tax:
+          type: number
+          format: float
+          title: Tax
+          description: The total tax applied for this tax type.
     Transaction:
       type: object
       properties:
@@ -20106,7 +20312,8 @@ components:
             - When the merchant enters billing information using the UI, no IP address is recorded.
         ip_address_country:
           type: string
-          title: IP address's country
+          title: Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known
+            by Recurly.
         status_code:
           type: string
           title: Status code
@@ -20591,6 +20798,11 @@ components:
           description: A token used in place of a credit card in order to perform
             transactions.
           maxLength: 50
+        cc_bin_country:
+          type: string
+          description: The 2-letter ISO 3166-1 alpha-2 country code associated with
+            the credit card BIN, if known by Recurly. Available on the BillingInfo
+            object only. Available when the BIN country lookup feature is enabled.
         gateway_code:
           type: string
           description: An identifier for a specific payment gateway.
@@ -21311,6 +21523,7 @@ components:
       - invalid_data
       - invalid_email
       - invalid_gateway_configuration
+      - invalid_gateway_access_token
       - invalid_issuer
       - invalid_login
       - invalid_merchant_type
@@ -21403,3 +21616,4 @@ components:
       type: string
       enum:
       - cpf
+      - cuit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - lib/recurly/requests/add_on_update.rb
 - lib/recurly/requests/address.rb
 - lib/recurly/requests/billing_info_create.rb
+- lib/recurly/requests/billing_info_verify.rb
 - lib/recurly/requests/coupon_bulk_create.rb
 - lib/recurly/requests/coupon_create.rb
 - lib/recurly/requests/coupon_pricing.rb
@@ -190,6 +191,7 @@ files:
 - lib/recurly/requests/subscription_add_on_tier.rb
 - lib/recurly/requests/subscription_add_on_update.rb
 - lib/recurly/requests/subscription_cancel.rb
+- lib/recurly/requests/subscription_change_billing_info_create.rb
 - lib/recurly/requests/subscription_change_create.rb
 - lib/recurly/requests/subscription_change_shipping_create.rb
 - lib/recurly/requests/subscription_create.rb
@@ -258,7 +260,9 @@ files:
 - lib/recurly/resources/subscription_add_on.rb
 - lib/recurly/resources/subscription_add_on_tier.rb
 - lib/recurly/resources/subscription_change.rb
+- lib/recurly/resources/subscription_change_billing_info.rb
 - lib/recurly/resources/subscription_shipping.rb
+- lib/recurly/resources/tax_detail.rb
 - lib/recurly/resources/tax_info.rb
 - lib/recurly/resources/tier.rb
 - lib/recurly/resources/tier_pricing.rb
@@ -293,7 +297,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.2.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.6.0
 post_install_message: 
 rdoc_options: []
 require_paths: