recurly 3.28.0 → 3.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f358220bcde59e70cefed04b0f39869b5e976a2f5b8051bf0938d9a2d98659fe
-  data.tar.gz: fb89656186be6d4a34d042daf0a7fe46d0e36cc272441c102df9141354c37966
+  metadata.gz: d7989dd4fbadfae7f91fa74b1d0c449d15a25f8353effe843920e62aef460c08
+  data.tar.gz: a11feb7a78daf76d06725d5bee7d67c6369eb24496013a6425633ac43b6cdded
 SHA512:
-  metadata.gz: af696c3da92306020d79701b60a4134c536349f0946b399dab177af36f519fc2d2947ac1c49e3fdf6c3fecdaaa05820f0cb1eb32859eead6585b4f607664f3e8
-  data.tar.gz: 1b241b8ea83c74e31e653af77d8992ad1f2cd38a19732bb3030244b89ddf0820d84e55175333c1368e29ab2e8204d98429cb9af7941f10b04ac433e9f1f6be5d
+  metadata.gz: 59efb8e9ae948e5bc2820023f108dfe0e5b56839a30a65a1692d8b6cc0030a3cc1a56c3fc14dad3d8b681d72ec48236fb5115c022e24e12bfa9b0bd0c50b4a62
+  data.tar.gz: cc15baa7ddcc508e672b96bb0840c1b36604d1051e636ef41d4ab03bc0f316245694dc0577a28303726c59027af006edb4ef4c11b02e60eb46d093a43e6f5175

data/.bumpversion.cfg

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

data/.github/workflows/pr-review.yml

@@ -0,0 +1,27 @@
+name: PR Review
+
+on:
+  pull_request:
+    types:
+      - opened
+      - repoened
+      - edited
+      - synchronize
+      - labeled
+      - unlabeled
+
+concurrency: 
+  group: ${{ github.workflow }} - ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  label-checker:
+    runs-on: ubuntu-latest
+    name: Label Checker
+    steps:
+      - name: Check Labels
+        uses: docker://agilepathway/pull-request-label-checker:latest
+        with:
+          one_of: V3
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+ 

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.29.0](https://github.com/recurly/recurly-client-ruby/tree/3.29.0) (2024-05-24)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.28.0...3.29.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10 [#903](https://github.com/recurly/recurly-client-ruby/pull/903) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [3.28.0](https://github.com/recurly/recurly-client-ruby/tree/3.28.0) (2023-05-23)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.27.0...3.28.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', '~> 3.28'
+gem 'recurly', '~> 3.29'
 ```
 
 > *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

@@ -739,6 +739,7 @@ module Recurly
     #   * Records are returned in an arbitrary order. Since results are all
     #     returned at once you can sort the records yourself.
     #
+    # @param state [String] Invoice state.
     # @param limit [Integer] Limit number of records 1-200.
     # @param order [String] Sort order.
     # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -1952,6 +1953,7 @@ module Recurly
     #   * Records are returned in an arbitrary order. Since results are all
     #     returned at once you can sort the records yourself.
     #
+    # @param state [String] Invoice state.
     # @param limit [Integer] Limit number of records 1-200.
     # @param order [String] Sort order.
     # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
@@ -3367,6 +3369,7 @@ module Recurly
     #   * Records are returned in an arbitrary order. Since results are all
     #     returned at once you can sort the records yourself.
     #
+    # @param state [String] Invoice state.
     # @param limit [Integer] Limit number of records 1-200.
     # @param order [String] Sort order.
     # @param sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending

data/lib/recurly/requests/account_create.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/account_purchase.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/account_update.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/requests/address.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/requests/billing_info_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @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 card_network_preference
+      #   @return [String] Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
+      define_attribute :card_network_preference, String
+
       # @!attribute company
       #   @return [String] Company name
       define_attribute :company, String
@@ -90,6 +94,10 @@ module Recurly
       #   @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 roku_billing_agreement_id
+      #   @return [String] Roku's CIB if billing through Roku
+      define_attribute :roku_billing_agreement_id, String
+
       # @!attribute routing_number
       #   @return [String] The bank's rounting number. (ACH only)
       define_attribute :routing_number, String

data/lib/recurly/requests/gateway_attributes.rb

@@ -7,7 +7,7 @@ module Recurly
     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.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen The Shopper Reference value used when the external token was created. Must be used in conjunction with gateway_token and gateway_code. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end

data/lib/recurly/requests/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/requests/shipping_address_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/shipping_address_update.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

data/lib/recurly/resources/account.rb

@@ -50,6 +50,10 @@ module Recurly
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute entity_use_code
+      #   @return [String] The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.
+      define_attribute :entity_use_code, String
+
       # @!attribute exemption_certificate
       #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
       define_attribute :exemption_certificate, String

data/lib/recurly/resources/address.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/resources/gateway_attributes.rb

@@ -7,7 +7,7 @@ module Recurly
     class GatewayAttributes < Resource
 
       # @!attribute account_reference
-      #   @return [String] Used by Adyen gateways. The Shopper Reference value used when the external token was created.
+      #   @return [String] Used by Adyen and Braintree gateways. For Adyen the Shopper Reference value used when the external token was created. For Braintree the PayPal PayerID is populated in the response.
       define_attribute :account_reference, String
     end
   end

data/lib/recurly/resources/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/resources/payment_method.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
       define_attribute :billing_agreement_id, String
 
+      # @!attribute card_network_preference
+      #   @return [String] Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
+      define_attribute :card_network_preference, String
+
       # @!attribute card_type
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
       define_attribute :card_type, String

data/lib/recurly/resources/shipping_address.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

data/lib/recurly/resources/subscription_ramp_interval_response.rb

@@ -6,6 +6,10 @@ module Recurly
   module Resources
     class SubscriptionRampIntervalResponse < Resource
 
+      # @!attribute ending_on
+      #   @return [DateTime] Date the ramp interval ends
+      define_attribute :ending_on, DateTime
+
       # @!attribute remaining_billing_cycles
       #   @return [Integer] Represents how many billing cycles are left in a ramp interval.
       define_attribute :remaining_billing_cycles, Integer
@@ -14,6 +18,10 @@ module Recurly
       #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
 
+      # @!attribute starting_on
+      #   @return [DateTime] Date the ramp interval starts
+      define_attribute :starting_on, DateTime
+
       # @!attribute unit_amount
       #   @return [Integer] Represents the price for the ramp interval.
       define_attribute :unit_amount, Integer

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.28.0"
+  VERSION = "3.29.0"
 end

data/openapi/api.yaml

@@ -885,7 +885,7 @@ paths:
           Alabama St.\"),\n\t\t\tCity:       recurly.String(\"San Francisco\"),\n\t\t\tPostalCode:
           recurly.String(\"94110\"),\n\t\t\tCountry:    recurly.String(\"US\"),\n\t\t\tRegion:
           \    recurly.String(\"CA\"),\n\t\t},\n\t\tNumber: recurly.String(\"4111111111111111\"),\n\t\tMonth:
-          \ recurly.String(\"12\"),\n\t\tYear:   recurly.String(\"22\"),\n\t\tCvv:
+          \ recurly.String(\"12\"),\n\t\tYear:   recurly.String(\"30\"),\n\t\tCvv:
           \   recurly.String(\"123\"),\n\t},\n}\n\naccount, err := client.CreateAccount(accountReq)\nif
           e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeValidation
           {\n\t\tfmt.Printf(\"Failed validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
@@ -3195,6 +3195,7 @@ paths:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/invoice_state"
       - "$ref": "#/components/parameters/limit"
       - "$ref": "#/components/parameters/order"
       - "$ref": "#/components/parameters/sort_dates"
@@ -7394,6 +7395,7 @@ paths:
       parameters:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/invoice_state"
       - "$ref": "#/components/parameters/limit"
       - "$ref": "#/components/parameters/order"
       - "$ref": "#/components/parameters/sort_dates"
@@ -7888,8 +7890,6 @@ paths:
       summary: Apply available credit to a pending or past due charge invoice
       description: Apply credit payment to the outstanding balance on an existing
         charge invoice from an account’s available balance from existing credit invoices.
-        Credit that was refunded from the invoice cannot be applied back to the invoice
-        as payment.
       parameters:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/invoice_id"
@@ -13059,6 +13059,7 @@ paths:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/subscription_id"
       - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/invoice_state"
       - "$ref": "#/components/parameters/limit"
       - "$ref": "#/components/parameters/order"
       - "$ref": "#/components/parameters/sort_dates"
@@ -14724,6 +14725,18 @@ components:
       required: true
       schema:
         type: string
+    invoice_state:
+      name: state
+      in: query
+      description: Invoice state.
+      schema:
+        type: string
+        default: all
+        enum:
+        - pending
+        - past_due
+        - paid
+        - failed
     measured_unit_id:
       name: measured_unit_id
       in: path
@@ -15662,6 +15675,11 @@ components:
           "$ref": "#/components/schemas/BillingInfoCreate"
         custom_fields:
           "$ref": "#/components/schemas/CustomFields"
+        entity_use_code:
+          type: string
+          description: The Avalara AvaTax value that can be passed to identify the
+            customer type for tax purposes. The range of values can be A - R (more
+            info at Avalara). Value is case-sensitive.
     AccountResponse:
       type: object
       properties:
@@ -15781,6 +15799,11 @@ components:
           "$ref": "#/components/schemas/BillingInfo"
         custom_fields:
           "$ref": "#/components/schemas/CustomFields"
+        entity_use_code:
+          type: string
+          description: The Avalara AvaTax value that can be passed to identify the
+            customer type for tax purposes. The range of values can be A - R (more
+            info at Avalara). Value is case-sensitive.
     AccountNote:
       type: object
       required:
@@ -15932,6 +15955,11 @@ components:
           type: string
           title: Country
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
     AddOnMini:
       type: object
       title: Add-on mini details
@@ -16652,16 +16680,30 @@ components:
           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.
+              description: Used by Adyen and Braintree gateways. For Adyen The Shopper
+                Reference value used when the external token was created. Must be
+                used in conjunction with gateway_token and gateway_code. For Braintree
+                the PayPal PayerID is populated in the response.
               maxLength: 264
+        card_network_preference:
+          type: string
+          description: Represents the card network preference associated with the
+            billing info for dual badged cards. Must be a supported card network.
+          enum:
+          - Bancontact
+          - CartesBancaires
+          - Dankort
+          - MasterCard
+          - Visa
         amazon_billing_agreement_id:
           type: string
           title: Amazon billing agreement ID
         paypal_billing_agreement_id:
           type: string
           title: PayPal billing agreement ID
+        roku_billing_agreement_id:
+          type: string
+          title: Roku's CIB if billing through Roku
         fraud_session_id:
           type: string
           title: Fraud Session ID
@@ -19734,6 +19776,11 @@ components:
           type: string
           maxLength: 50
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
         created_at:
           type: string
           title: Created at
@@ -19789,6 +19836,11 @@ components:
           type: string
           maxLength: 50
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
       required:
       - first_name
       - last_name
@@ -20039,6 +20091,11 @@ components:
           type: string
           maxLength: 50
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
     Site:
       type: object
       properties:
@@ -21334,6 +21391,14 @@ components:
         remaining_billing_cycles:
           type: integer
           description: Represents how many billing cycles are left in a ramp interval.
+        starting_on:
+          type: string
+          format: date-time
+          title: Date the ramp interval starts
+        ending_on:
+          type: string
+          format: date-time
+          title: Date the ramp interval ends
         unit_amount:
           type: integer
           description: Represents the price for the ramp interval.
@@ -22275,9 +22340,20 @@ components:
           properties:
             account_reference:
               type: string
-              description: Used by Adyen gateways. The Shopper Reference value used
-                when the external token was created.
+              description: Used by Adyen and Braintree gateways. For Adyen the Shopper
+                Reference value used when the external token was created. For Braintree
+                the PayPal PayerID is populated in the response.
               maxLength: 264
+        card_network_preference:
+          type: string
+          description: Represents the card network preference associated with the
+            billing info for dual badged cards. Must be a supported card network.
+          enum:
+          - Bancontact
+          - CartesBancaires
+          - Dankort
+          - MasterCard
+          - Visa
         billing_agreement_id:
           type: string
           description: Billing Agreement identifier. Only present for Amazon or Paypal

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.28.0
+  version: 3.29.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2024-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - ".github/ISSUE_TEMPLATE/question-or-other.md"
 - ".github/workflows/ci.yml"
 - ".github/workflows/docs.yml"
+- ".github/workflows/pr-review.yml"
 - ".gitignore"
 - ".rspec"
 - ".yardopts"
@@ -308,7 +309,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/3.28.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.29.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -324,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: The ruby client for Recurly's V3 API