recurly 4.3.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946f99f504cb40b5cfe6d19fa930a2a2f56e9e65896ae117f51f6dc765c93520
-  data.tar.gz: 17f8e1d63237dd4a442afa351a89a84880ae189a31224b3de855d2c932808397
+  metadata.gz: 2e93393e1aee1ef2ace7f7df79d0f815b9ab54a99189807f92070b327d940307
+  data.tar.gz: 2ea549f2a93dda275202ce603c6a53e8b00a88c2eda91d212f473c66a0bea981
 SHA512:
-  metadata.gz: a882e57fd39d3519f308f1bcaeb5a3eced0674ab9d6b2425b561b7a66a30e414df91e844c6b237239e45c796a30999a0ba6137aadbaa955cfb5d4f702ee817cf
-  data.tar.gz: 1d5ba672b2caf851be6dd564b3fec80572588620bd3ca5a01729e0bba5b5a5ec4c05957ff54daa18cadba2554bb1a7c417c1931eb9eddab511e887245494bed3
+  metadata.gz: e64f85ad01d99cb0001717137bfe8011c06cee11e5ac932d26042f297261d50d8ab54dfbf926c8811ae5f370c12609410fcaac082fa40c1abca3b99de7eaacd5
+  data.tar.gz: de50a1d18e695ce700b0f1125a68045c07e212c919236a485df2dcb21ed7e16b035cafde525c07c43275629c8fc64640565c605fb2d9c86ed5b41d70e4e3e0c7

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [4.7.0](https://github.com/recurly/recurly-client-ruby/tree/4.7.0) (2021-08-19)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.6.0...4.7.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (get_preview_renewal) [#722](https://github.com/recurly/recurly-client-ruby/pull/722) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [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)

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.3'
+gem 'recurly', '~> 4.7'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -3300,6 +3300,20 @@ module Recurly
       put(path, **options)
     end
 
+    # Fetch a preview of a subscription's renewal invoice(s)
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documenation}
+    #
+    # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
+    #
+    def get_preview_renewal(subscription_id:, **options)
+      path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
+      get(path, **options)
+    end
+
     # Fetch a subscription's pending change
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change 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

@@ -71,11 +71,11 @@ module Recurly
       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/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_pause.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionPause < Request
 
       # @!attribute remaining_pause_cycles
-      #   @return [Integer] Number of billing cycles to pause the subscriptions.
+      #   @return [Integer] Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.
       define_attribute :remaining_pause_cycles, Integer
     end
   end

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_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_info.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :region, String
 
       # @!attribute tax_details
-      #   @return [Array[TaxDetail]]
+      #   @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

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.3.0"
+  VERSION = "4.7.0"
 end

data/openapi/api.yaml

@@ -3846,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);
@@ -5426,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);
@@ -8957,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());
@@ -9587,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);
@@ -10256,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);
@@ -12434,6 +12434,43 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/subscriptions/{subscription_id}/preview_renewal":
+    get:
+      tags:
+      - subscription
+      operationId: get_preview_renewal
+      summary: Fetch a preview of a subscription's renewal invoice(s)
+      description: The subscriptions's renewal invoice(s) will be returned if they
+        exist; if they don't (for example, if the subscription is not set to renew),
+        it will return an result with no invoices.
+      parameters:
+      - "$ref": "#/components/parameters/subscription_id"
+      responses:
+        '200':
+          description: A preview of the subscription's renewal invoice(s).
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Invalid or unpermitted parameter.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site ID or subscription ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/subscriptions/{subscription_id}/change":
     get:
       tags:
@@ -13891,7 +13928,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());
           }
@@ -15482,7 +15526,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"
@@ -16066,7 +16110,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
@@ -16156,11 +16201,12 @@ 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
@@ -17229,7 +17275,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
@@ -18742,7 +18789,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
@@ -18797,7 +18844,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
@@ -19047,7 +19094,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:
@@ -19596,6 +19643,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:
@@ -19700,6 +19762,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
@@ -19797,7 +19861,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
@@ -19923,7 +19990,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
@@ -20042,7 +20112,8 @@ components:
         remaining_pause_cycles:
           type: integer
           title: Remaining pause cycles
-          description: Number of billing cycles to pause the subscriptions.
+          description: Number of billing cycles to pause the subscriptions. A value
+            of 0 will cancel any pending pauses on the subscription.
       required:
       - remaining_pause_cycles
     SubscriptionShipping:
@@ -20153,15 +20224,15 @@ components:
           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 info
-      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.
+      title: Tax detail
       properties:
         type:
           type: string
@@ -20279,7 +20350,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
@@ -20764,6 +20836,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.
@@ -21484,6 +21561,7 @@ components:
       - invalid_data
       - invalid_email
       - invalid_gateway_configuration
+      - invalid_gateway_access_token
       - invalid_issuer
       - invalid_login
       - invalid_merchant_type
@@ -21576,3 +21654,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.3.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,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
@@ -259,6 +260,7 @@ 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
@@ -295,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.3.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.7.0
 post_install_message: 
 rdoc_options: []
 require_paths: