recurly 4.34.0 → 4.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d58e029341b54321e97343bfaec205f5bc54ff3dc701dce3e14b61aab34be77
-  data.tar.gz: 0bf3d6ec35a4902fe4b70036287e65b146bfa541b2e6c0689e34180c663decf1
+  metadata.gz: 63627cfe02c6b1f623b0ec942fbdfefcc602baab2ba76c210b5b3946610c6010
+  data.tar.gz: eab3fc22497332fec976abbfb79cd9c4a33a54c0755d701d445b4a54ac0fb34f
 SHA512:
-  metadata.gz: 5e90264d1c835e0fab6a9c59346deb9833799e9d0366a9be770293a85e0a5f65cd86503c17adc684652374b9b78c31539f24cd6bf92d55096e446ad11a28657b
-  data.tar.gz: d3717f71919f049cb49bc0ad797d6a9d9d33a7c2214df50fcb3cd295195038f75422d21c019b0e2f52b1c9a1ab256edcfac355aefd17b9203a6b7a6be39d5f18
+  metadata.gz: 20999a85623503c5af9e2e7bd2097dc900729a01b96e9c9e758f409594f6b2130627cef2c49a06a750227359679f8bbed5a4c9e727401c6de528ebf1f19634dd
+  data.tar.gz: c042cf9edadd7293aea0550297a720c5ff212402c765d7a86e3c8c545d7c9023e162b6a08d94abd4576c66156ab5cd4cca6105003d2489a3474a24ad69c4874b

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.36.0](https://github.com/recurly/recurly-client-ruby/tree/4.36.0) (2023-05-23)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.35.0...4.36.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (gateway_attributes on PaymentMethod) [#846](https://github.com/recurly/recurly-client-ruby/pull/846) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.35.0](https://github.com/recurly/recurly-client-ruby/tree/4.35.0) (2023-05-03)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.34.0...4.35.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#843](https://github.com/recurly/recurly-client-ruby/pull/843) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.34.0](https://github.com/recurly/recurly-client-ruby/tree/4.34.0) (2023-04-26)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.33.0...4.34.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.34'
+gem 'recurly', '~> 4.36'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/requests/billing_info_create.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String] Fraud Session ID
       define_attribute :fraud_session_id, String
 
+      # @!attribute gateway_attributes
+      #   @return [GatewayAttributes] Additional attributes to send to the gateway.
+      define_attribute :gateway_attributes, :GatewayAttributes
+
       # @!attribute gateway_code
       #   @return [String] An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
       define_attribute :gateway_code, String

data/lib/recurly/requests/gateway_attributes.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 GatewayAttributes < Request
+
+      # @!attribute account_reference
+      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code.
+      define_attribute :account_reference, String
+    end
+  end
+end

data/lib/recurly/resources/gateway_attributes.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 GatewayAttributes < Resource
+
+      # @!attribute account_reference
+      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+      define_attribute :account_reference, String
+    end
+  end
+end

data/lib/recurly/resources/payment_method.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Credit card number's first six digits.
       define_attribute :first_six, String
 
+      # @!attribute gateway_attributes
+      #   @return [GatewayAttributes] Gateway specific attributes associated with this PaymentMethod
+      define_attribute :gateway_attributes, :GatewayAttributes
+
       # @!attribute gateway_code
       #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String

data/lib/recurly/resources/tax_detail.rb

@@ -6,12 +6,24 @@ module Recurly
   module Resources
     class TaxDetail < Resource
 
+      # @!attribute billable
+      #   @return [Boolean] Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
+      define_attribute :billable, :Boolean
+
+      # @!attribute level
+      #   @return [String] Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled.
+      define_attribute :level, String
+
+      # @!attribute name
+      #   @return [String] Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled.
+      define_attribute :name, String
+
       # @!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.
+      #   @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. Not present when Avalara for Communications is enabled.
       define_attribute :region, String
 
       # @!attribute tax
@@ -19,7 +31,7 @@ module Recurly
       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.
+      #   @return [String] Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.
       define_attribute :type, String
     end
   end

data/lib/recurly/resources/tax_info.rb

@@ -7,19 +7,19 @@ module Recurly
     class TaxInfo < Resource
 
       # @!attribute rate
-      #   @return [Float] Rate
+      #   @return [Float] The combined tax rate. Not present when Avalara for Communications is enabled.
       define_attribute :rate, Float
 
       # @!attribute region
-      #   @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.
+      #   @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. Not present when Avalara for Communications is enabled.
       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.
+      #   @return [Array[TaxDetail]] Provides additional tax details for Communications taxes when Avalara for Communications is enabled or 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 LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
       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.
+      #   @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. Not present when Avalara for Communications is enabled.
       define_attribute :type, String
     end
   end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.34.0"
+  VERSION = "4.36.0"
 end

data/openapi/api.yaml

@@ -199,11 +199,13 @@ x-tagGroups:
   - purchase
   - usage
   - automated_exports
+  - gift_cards
+- name: App Management
+  tags:
   - external_subscriptions
   - external_invoices
   - external_products
   - external_accounts
-  - gift_cards
 - name: Products and Promotions
   tags:
   - item
@@ -349,7 +351,7 @@ tags:
     Recurly platform and instead is managed by third-party platforms like Apple App
     Store and Google Play Store.
 - name: external_invoices
-  x-displayName: External Invoices
+  x-displayName: External Invoice
   description: An invoice from an external resource that is not managed by the Recurly
     platform and instead is managed by third-party platforms like Apple App Store
     and Google Play Store.
@@ -363,7 +365,7 @@ tags:
   description: Add gift card purchases to your checkout and allow gift card recipients
     to redeem the gift card for credit towards any of your products.
 - name: external_accounts
-  x-displayName: External Accounts
+  x-displayName: External Account
   description: An account from an external resource that is not managed by the Recurly
     platform and instead is managed by third-party platforms like Apple App Store
     and Google Play Store.
@@ -17851,6 +17853,17 @@ components:
           title: An identifier for a specific payment gateway. Must be used in conjunction
             with `gateway_token`.
           maxLength: 12
+        gateway_attributes:
+          type: object
+          description: Additional attributes to send to the gateway.
+          x-class-name: GatewayAttributes
+          properties:
+            account_reference:
+              type: string
+              description: Used by Adyen gateways. The Shopper Reference value used
+                when the external token was created. Must be used in conjunction with
+                gateway_token and gateway_code.
+              maxLength: 264
         amazon_billing_agreement_id:
           type: string
           title: Amazon billing agreement ID
@@ -22347,23 +22360,29 @@ components:
           description: 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.
+            Not present when Avalara for Communications is enabled.
         region:
           type: string
           title: Region
           description: 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.
+            the regional tax, like VAT, GST, or PST. Not present when Avalara for
+            Communications is enabled.
         rate:
           type: number
           format: float
           title: Rate
+          description: The combined tax rate. Not present when Avalara for Communications
+            is enabled.
         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.
+          description: Provides additional tax details for Communications taxes when
+            Avalara for Communications is enabled or 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 LineItemList. Only populated for a single LineItem
+            fetch when Avalara for Communications is enabled.
           items:
             "$ref": "#/components/schemas/TaxDetail"
     TaxDetail:
@@ -22373,13 +22392,15 @@ components:
         type:
           type: string
           title: Type
-          description: Provides the tax type for the region. For Canadian Sales Tax,
+          description: Provides the tax type for the region or type of Comminications
+            tax when Avalara for Communications is enabled. 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.
+            Not present when Avalara for Communications is enabled.
         rate:
           type: number
           format: float
@@ -22390,6 +22411,22 @@ components:
           format: float
           title: Tax
           description: The total tax applied for this tax type.
+        name:
+          type: string
+          title: Name
+          description: Provides the name of the Communications tax applied. Present
+            only when Avalara for Communications is enabled.
+        level:
+          type: string
+          title: Level
+          description: Provides the jurisdiction level for the Communications tax
+            applied. Example values include city, state and federal. Present only
+            when Avalara for Communications is enabled.
+        billable:
+          type: boolean
+          title: Billable
+          description: Whether or not the line item is taxable. Only populated for
+            a single LineItem fetch when Avalara for Communications is enabled.
     Transaction:
       type: object
       properties:
@@ -23580,6 +23617,16 @@ components:
           type: string
           description: An identifier for a specific payment gateway.
           maxLength: 13
+        gateway_attributes:
+          type: object
+          description: Gateway specific attributes associated with this PaymentMethod
+          x-class-name: GatewayAttributes
+          properties:
+            account_reference:
+              type: string
+              description: Used by Adyen gateways. The Shopper Reference value used
+                when the external token was created.
+              maxLength: 264
         billing_agreement_id:
           type: string
           description: Billing Agreement identifier. Only present for Amazon or Paypal
@@ -24288,6 +24335,7 @@ components:
     ExternalPaymentMethodEnum:
       type: string
       enum:
+      - bacs
       - ach
       - amazon
       - apple_pay
@@ -24408,6 +24456,7 @@ components:
       enum:
       - api
       - chargeback
+      - external_recovery
       - force_collect
       - hpp
       - merchant
@@ -24477,6 +24526,7 @@ components:
     PaymentMethodEnum:
       type: string
       enum:
+      - bacs
       - amazon
       - amazon_billing_agreement
       - apple_pay

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.34.0
+  version: 4.36.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ files:
 - lib/recurly/requests/external_account_update.rb
 - lib/recurly/requests/external_refund.rb
 - lib/recurly/requests/external_transaction.rb
+- lib/recurly/requests/gateway_attributes.rb
 - lib/recurly/requests/gift_card_create.rb
 - lib/recurly/requests/gift_card_delivery_create.rb
 - lib/recurly/requests/gift_card_redeem.rb
@@ -265,6 +266,7 @@ files:
 - lib/recurly/resources/external_product_reference_mini.rb
 - lib/recurly/resources/external_subscription.rb
 - lib/recurly/resources/fraud_info.rb
+- lib/recurly/resources/gateway_attributes.rb
 - lib/recurly/resources/gift_card.rb
 - lib/recurly/resources/gift_card_delivery.rb
 - lib/recurly/resources/granted_by.rb
@@ -336,7 +338,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.34.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.36.0
 post_install_message: 
 rdoc_options: []
 require_paths: