recurly 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78ae5aced00577f6e7c354c710b0624e439ac0cc036f28248ea3f3d4e648fe9f
-  data.tar.gz: 82616234dcb6b27a02ae189cfd114e0efcbd568f23935c1c3fa9a2a4485616f1
+  metadata.gz: ab15012ab4dc0ad0a98506632f63d7496dd6a4efe39d970810f353c10b10a22d
+  data.tar.gz: cec6000b28ccbf14ed002a73476c296df2d46b6266664e24b0978e6e1ed0600e
 SHA512:
-  metadata.gz: d19bd177df130213c78cc8789fbe235ac836140eceaea7e62e4d4511ab99206f948e91ce4c60de0d133a959a301ce1428cdc4aea17273dc3dcb9761a9ca31605
-  data.tar.gz: 6ec907716dd89c09698714e2959511e11c461d1414b821e027e2b28616b9bb7b64043fb0d8f301a87971eab5bdea249f0e3b0b987bc83e841ba1e6e706321802
+  metadata.gz: 53a4a6da3a7e648e813678acc0a3f565ecead9c0c114fad15f75b4eeb46f2c049e689d563db26ea5fb958ca40e318f1e7a28ed435b9a14fefe4bb0fbc9bc45fd
+  data.tar.gz: a384b0e85ebad2b40a2aa4c1909c57c0e16065b2aa63c2084b815fdb1f6be81e2d97fa4e7bcaf22ce6599c7ddd7fd6935476e2f3f49aef5952f9cc4467d1484f

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [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)

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

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_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_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_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/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.4.0"
+  VERSION = "4.5.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);
@@ -13891,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());
           }
@@ -15482,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"
@@ -16066,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
@@ -16156,11 +16164,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
@@ -18743,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
@@ -18798,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
@@ -19048,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:
@@ -19810,7 +19819,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
@@ -19936,7 +19948,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
@@ -20166,15 +20181,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
@@ -20292,7 +20307,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
@@ -20777,6 +20793,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.
@@ -21497,6 +21518,7 @@ components:
       - invalid_data
       - invalid_email
       - invalid_gateway_configuration
+      - invalid_gateway_access_token
       - invalid_issuer
       - invalid_login
       - invalid_merchant_type
@@ -21589,3 +21611,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.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -296,7 +296,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.4.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.5.0
 post_install_message: 
 rdoc_options: []
 require_paths: