recurly 4.68.0 → 4.69.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/.bumpversion.cfg +1 -1
 - data/CHANGELOG.md +11 -0
 - data/GETTING_STARTED.md +1 -1
 - data/lib/recurly/requests/billing_info_create.rb +1 -1
 - data/lib/recurly/requests/subscription_create.rb +1 -1
 - data/lib/recurly/resources/transaction.rb +4 -0
 - data/lib/recurly/resources/transaction_next_action.rb +18 -0
 - data/lib/recurly/version.rb +1 -1
 - data/openapi/api.yaml +35 -3
 - metadata +4 -3
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 5b47a550c5fcd45124c917ca4c4dba881b5b6d045bcba8ec50b9c17a62704f49
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: 4af34eb50bb46053e22ce93ce26939c2be6ead84f8e7b8697e77ecdbdcc1f2dd
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: 9cf13b027e609eedcb85f67af12a151ce40536ca3bf3e06adc4014b3fdb31cc8818f027d488b72419424a75ce0c0ec5034ea29c3584939ba809227f6c593b1f5
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: dcd17df5feb98ee03ae155e4067b4abbedb573c29c14ef2bb32317c5cde933d6007c9fb300856b9082186396cd347f02a6aa78f419ca4867c291da1c75c7153c
         
     | 
    
        data/.bumpversion.cfg
    CHANGED
    
    
    
        data/CHANGELOG.md
    CHANGED
    
    | 
         @@ -1,5 +1,16 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            # Changelog
         
     | 
| 
       2 
2 
     | 
    
         | 
| 
      
 3 
     | 
    
         
            +
            ## [4.69.0](https://github.com/recurly/recurly-client-ruby/tree/4.69.0) (2025-11-03)
         
     | 
| 
      
 4 
     | 
    
         
            +
             
     | 
| 
      
 5 
     | 
    
         
            +
            [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.68.0...4.69.0)
         
     | 
| 
      
 6 
     | 
    
         
            +
             
     | 
| 
      
 7 
     | 
    
         
            +
             
     | 
| 
      
 8 
     | 
    
         
            +
            **Merged Pull Requests**
         
     | 
| 
      
 9 
     | 
    
         
            +
             
     | 
| 
      
 10 
     | 
    
         
            +
            - Generated Latest Changes for v2021-02-25 [#939](https://github.com/recurly/recurly-client-ruby/pull/939) ([recurly-integrations](https://github.com/recurly-integrations))
         
     | 
| 
      
 11 
     | 
    
         
            +
             
     | 
| 
      
 12 
     | 
    
         
            +
             
     | 
| 
      
 13 
     | 
    
         
            +
             
     | 
| 
       3 
14 
     | 
    
         
             
            ## [4.68.0](https://github.com/recurly/recurly-client-ruby/tree/4.68.0) (2025-10-09)
         
     | 
| 
       4 
15 
     | 
    
         | 
| 
       5 
16 
     | 
    
         
             
            [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.67.0...4.68.0)
         
     | 
    
        data/GETTING_STARTED.md
    CHANGED
    
    | 
         @@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API. 
     | 
|
| 
       5 
5 
     | 
    
         
             
            In your Gemfile, add `recurly` as a dependency.
         
     | 
| 
       6 
6 
     | 
    
         | 
| 
       7 
7 
     | 
    
         
             
            ```ruby
         
     | 
| 
       8 
     | 
    
         
            -
            gem 'recurly', '~> 4. 
     | 
| 
      
 8 
     | 
    
         
            +
            gem 'recurly', '~> 4.69'
         
     | 
| 
       9 
9 
     | 
    
         
             
            ```
         
     | 
| 
       10 
10 
     | 
    
         | 
| 
       11 
11 
     | 
    
         
             
            > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
         
     | 
| 
         @@ -151,7 +151,7 @@ module Recurly 
     | 
|
| 
       151 
151 
     | 
    
         
             
                  define_attribute :transaction_type, String
         
     | 
| 
       152 
152 
     | 
    
         | 
| 
       153 
153 
     | 
    
         
             
                  # @!attribute type
         
     | 
| 
       154 
     | 
    
         
            -
                  #   @return [String] The payment method type for a non-credit card based billing info. `bacs`  
     | 
| 
      
 154 
     | 
    
         
            +
                  #   @return [String] The payment method type for a non-credit card based billing info. `bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values.
         
     | 
| 
       155 
155 
     | 
    
         
             
                  define_attribute :type, String
         
     | 
| 
       156 
156 
     | 
    
         | 
| 
       157 
157 
     | 
    
         
             
                  # @!attribute vat_number
         
     | 
| 
         @@ -59,7 +59,7 @@ module Recurly 
     | 
|
| 
       59 
59 
     | 
    
         
             
                  define_attribute :customer_notes, String
         
     | 
| 
       60 
60 
     | 
    
         | 
| 
       61 
61 
     | 
    
         
             
                  # @!attribute gateway_code
         
     | 
| 
       62 
     | 
    
         
            -
                  #   @return [String] If present, this subscription's transactions will use the payment gateway with this code.
         
     | 
| 
      
 62 
     | 
    
         
            +
                  #   @return [String] If present, this subscription's subsequent transactions will use the payment gateway with this code. To select a payment gateway to use when creating a Subscription, be sure to set the `account.billing_info.gateway_code` as well.
         
     | 
| 
       63 
63 
     | 
    
         
             
                  define_attribute :gateway_code, String
         
     | 
| 
       64 
64 
     | 
    
         | 
| 
       65 
65 
     | 
    
         
             
                  # @!attribute gift_card_redemption_code
         
     | 
| 
         @@ -110,6 +110,10 @@ module Recurly 
     | 
|
| 
       110 
110 
     | 
    
         
             
                  #   @return [String] This conditional parameter is useful for merchants in specific industries who need to submit one-time Merchant Initiated transactions in specific cases. Not all gateways support these methods, but will support a generic one-time Merchant Initiated transaction. Only use this if the initiator value is "merchant". Otherwise, it will be ignored.   - Incremental: Send `incremental` with an additional purchase if the original authorization amount is not sufficient to cover the costs of your service or product. For example, if the customer adds goods or services or there are additional expenses.   - No Show: Send `no_show` if you charge customers a fee due to an agreed-upon cancellation policy in your industry.   - Resubmission: Send `resubmission` if you need to attempt collection on a declined transaction. You may also use the force collection behavior which has the same effect.   - Service Extension: Send `service_extension` if you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement.   - Split Shipment: Send `split_shipment` if you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session.   - Top Up: Send `top_up` if you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.
         
     | 
| 
       111 
111 
     | 
    
         
             
                  define_attribute :merchant_reason_code, String
         
     | 
| 
       112 
112 
     | 
    
         | 
| 
      
 113 
     | 
    
         
            +
                  # @!attribute next_action
         
     | 
| 
      
 114 
     | 
    
         
            +
                  #   @return [TransactionNextAction] Next action values are used for any required customer follow-up action. Currently, this is supported for Ebanx when using Pix Automatico.
         
     | 
| 
      
 115 
     | 
    
         
            +
                  define_attribute :next_action, :TransactionNextAction
         
     | 
| 
      
 116 
     | 
    
         
            +
             
     | 
| 
       113 
117 
     | 
    
         
             
                  # @!attribute object
         
     | 
| 
       114 
118 
     | 
    
         
             
                  #   @return [String] Object type
         
     | 
| 
       115 
119 
     | 
    
         
             
                  define_attribute :object, String
         
     | 
| 
         @@ -0,0 +1,18 @@ 
     | 
|
| 
      
 1 
     | 
    
         
            +
            # This file is automatically created by Recurly's OpenAPI generation process
         
     | 
| 
      
 2 
     | 
    
         
            +
            # and thus any edits you make by hand will be lost. If you wish to make a
         
     | 
| 
      
 3 
     | 
    
         
            +
            # change to this file, please create a Github issue explaining the changes you
         
     | 
| 
      
 4 
     | 
    
         
            +
            # need and we will usher them to the appropriate places.
         
     | 
| 
      
 5 
     | 
    
         
            +
            module Recurly
         
     | 
| 
      
 6 
     | 
    
         
            +
              module Resources
         
     | 
| 
      
 7 
     | 
    
         
            +
                class TransactionNextAction < Resource
         
     | 
| 
      
 8 
     | 
    
         
            +
             
     | 
| 
      
 9 
     | 
    
         
            +
                  # @!attribute type
         
     | 
| 
      
 10 
     | 
    
         
            +
                  #   @return [String] The type of next action required.
         
     | 
| 
      
 11 
     | 
    
         
            +
                  define_attribute :type, String
         
     | 
| 
      
 12 
     | 
    
         
            +
             
     | 
| 
      
 13 
     | 
    
         
            +
                  # @!attribute value
         
     | 
| 
      
 14 
     | 
    
         
            +
                  #   @return [String] The value associated with the next action type.
         
     | 
| 
      
 15 
     | 
    
         
            +
                  define_attribute :value, String
         
     | 
| 
      
 16 
     | 
    
         
            +
                end
         
     | 
| 
      
 17 
     | 
    
         
            +
              end
         
     | 
| 
      
 18 
     | 
    
         
            +
            end
         
     | 
    
        data/lib/recurly/version.rb
    CHANGED
    
    
    
        data/openapi/api.yaml
    CHANGED
    
    | 
         @@ -18373,9 +18373,11 @@ components: 
     | 
|
| 
       18373 
18373 
     | 
    
         
             
                    street1:
         
     | 
| 
       18374 
18374 
     | 
    
         
             
                      type: string
         
     | 
| 
       18375 
18375 
     | 
    
         
             
                      title: Street 1
         
     | 
| 
      
 18376 
     | 
    
         
            +
                      maxLength: 50
         
     | 
| 
       18376 
18377 
     | 
    
         
             
                    street2:
         
     | 
| 
       18377 
18378 
     | 
    
         
             
                      type: string
         
     | 
| 
       18378 
18379 
     | 
    
         
             
                      title: Street 2
         
     | 
| 
      
 18380 
     | 
    
         
            +
                      maxLength: 50
         
     | 
| 
       18379 
18381 
     | 
    
         
             
                    city:
         
     | 
| 
       18380 
18382 
     | 
    
         
             
                      type: string
         
     | 
| 
       18381 
18383 
     | 
    
         
             
                      title: City
         
     | 
| 
         @@ -23977,8 +23979,10 @@ components: 
     | 
|
| 
       23977 
23979 
     | 
    
         
             
                    gateway_code:
         
     | 
| 
       23978 
23980 
     | 
    
         
             
                      type: string
         
     | 
| 
       23979 
23981 
     | 
    
         
             
                      title: Gateway Code
         
     | 
| 
       23980 
     | 
    
         
            -
                      description: If present, this subscription's transactions will 
     | 
| 
       23981 
     | 
    
         
            -
                        gateway with this code.
         
     | 
| 
      
 23982 
     | 
    
         
            +
                      description: If present, this subscription's subsequent transactions will
         
     | 
| 
      
 23983 
     | 
    
         
            +
                        use the payment gateway with this code. To select a payment gateway to
         
     | 
| 
      
 23984 
     | 
    
         
            +
                        use when creating a Subscription, be sure to set the `account.billing_info.gateway_code`
         
     | 
| 
      
 23985 
     | 
    
         
            +
                        as well.
         
     | 
| 
       23982 
23986 
     | 
    
         
             
                      maxLength: 13
         
     | 
| 
       23983 
23987 
     | 
    
         
             
                    transaction_type:
         
     | 
| 
       23984 
23988 
     | 
    
         
             
                      description: An optional type designation for the payment gateway transaction
         
     | 
| 
         @@ -24634,6 +24638,22 @@ components: 
     | 
|
| 
       24634 
24638 
     | 
    
         
             
                      title: VAT Number
         
     | 
| 
       24635 
24639 
     | 
    
         
             
                    fraud_info:
         
     | 
| 
       24636 
24640 
     | 
    
         
             
                      "$ref": "#/components/schemas/TransactionFraudInfo"
         
     | 
| 
      
 24641 
     | 
    
         
            +
                    next_action:
         
     | 
| 
      
 24642 
     | 
    
         
            +
                      type: object
         
     | 
| 
      
 24643 
     | 
    
         
            +
                      x-class-name: TransactionNextAction
         
     | 
| 
      
 24644 
     | 
    
         
            +
                      description: Next action values are used for any required customer follow-up
         
     | 
| 
      
 24645 
     | 
    
         
            +
                        action. Currently, this is supported for Ebanx when using Pix Automatico.
         
     | 
| 
      
 24646 
     | 
    
         
            +
                      properties:
         
     | 
| 
      
 24647 
     | 
    
         
            +
                        type:
         
     | 
| 
      
 24648 
     | 
    
         
            +
                          type: string
         
     | 
| 
      
 24649 
     | 
    
         
            +
                          title: Next action type
         
     | 
| 
      
 24650 
     | 
    
         
            +
                          description: The type of next action required.
         
     | 
| 
      
 24651 
     | 
    
         
            +
                          "$ref": "#/components/schemas/NextActionTypeEnum"
         
     | 
| 
      
 24652 
     | 
    
         
            +
                        value:
         
     | 
| 
      
 24653 
     | 
    
         
            +
                          type: string
         
     | 
| 
      
 24654 
     | 
    
         
            +
                          title: Next action value
         
     | 
| 
      
 24655 
     | 
    
         
            +
                          description: The value associated with the next action type.
         
     | 
| 
      
 24656 
     | 
    
         
            +
                      title: Next action
         
     | 
| 
       24637 
24657 
     | 
    
         
             
                TransactionFraudInfo:
         
     | 
| 
       24638 
24658 
     | 
    
         
             
                  type: object
         
     | 
| 
       24639 
24659 
     | 
    
         
             
                  title: Fraud information
         
     | 
| 
         @@ -27043,9 +27063,11 @@ components: 
     | 
|
| 
       27043 
27063 
     | 
    
         
             
                  - credit_card
         
     | 
| 
       27044 
27064 
     | 
    
         
             
                  - eft
         
     | 
| 
       27045 
27065 
     | 
    
         
             
                  - google_pay
         
     | 
| 
      
 27066 
     | 
    
         
            +
                  - mercadopago
         
     | 
| 
       27046 
27067 
     | 
    
         
             
                  - money_order
         
     | 
| 
       27047 
27068 
     | 
    
         
             
                  - other
         
     | 
| 
       27048 
27069 
     | 
    
         
             
                  - paypal
         
     | 
| 
      
 27070 
     | 
    
         
            +
                  - pix_automatico
         
     | 
| 
       27049 
27071 
     | 
    
         
             
                  - roku
         
     | 
| 
       27050 
27072 
     | 
    
         
             
                  - sepadirectdebit
         
     | 
| 
       27051 
27073 
     | 
    
         
             
                  - wire_transfer
         
     | 
| 
         @@ -27183,6 +27205,11 @@ components: 
     | 
|
| 
       27183 
27205 
     | 
    
         
             
                  - scheduled
         
     | 
| 
       27184 
27206 
     | 
    
         
             
                  - success
         
     | 
| 
       27185 
27207 
     | 
    
         
             
                  - void
         
     | 
| 
      
 27208 
     | 
    
         
            +
                NextActionTypeEnum:
         
     | 
| 
      
 27209 
     | 
    
         
            +
                  type: string
         
     | 
| 
      
 27210 
     | 
    
         
            +
                  description: The type of next action required for the transaction.
         
     | 
| 
      
 27211 
     | 
    
         
            +
                  enum:
         
     | 
| 
      
 27212 
     | 
    
         
            +
                  - qr_code
         
     | 
| 
       27186 
27213 
     | 
    
         
             
                CvvCheckEnum:
         
     | 
| 
       27187 
27214 
     | 
    
         
             
                  type: string
         
     | 
| 
       27188 
27215 
     | 
    
         
             
                  enum:
         
     | 
| 
         @@ -27259,6 +27286,9 @@ components: 
     | 
|
| 
       27259 
27286 
     | 
    
         
             
                  - boleto
         
     | 
| 
       27260 
27287 
     | 
    
         
             
                  - cash_app
         
     | 
| 
       27261 
27288 
     | 
    
         
             
                  - upi_autopay
         
     | 
| 
      
 27289 
     | 
    
         
            +
                  - pix_automatico
         
     | 
| 
      
 27290 
     | 
    
         
            +
                  - mercadopago
         
     | 
| 
      
 27291 
     | 
    
         
            +
                  - klarna
         
     | 
| 
       27262 
27292 
     | 
    
         
             
                CardTypeEnum:
         
     | 
| 
       27263 
27293 
     | 
    
         
             
                  type: string
         
     | 
| 
       27264 
27294 
     | 
    
         
             
                  enum:
         
     | 
| 
         @@ -27584,10 +27614,12 @@ components: 
     | 
|
| 
       27584 
27614 
     | 
    
         
             
                AchTypeEnum:
         
     | 
| 
       27585 
27615 
     | 
    
         
             
                  type: string
         
     | 
| 
       27586 
27616 
     | 
    
         
             
                  description: The payment method type for a non-credit card based billing info.
         
     | 
| 
       27587 
     | 
    
         
            -
                    `bacs`  
     | 
| 
      
 27617 
     | 
    
         
            +
                    `bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values.
         
     | 
| 
       27588 
27618 
     | 
    
         
             
                  enum:
         
     | 
| 
       27589 
27619 
     | 
    
         
             
                  - bacs
         
     | 
| 
       27590 
27620 
     | 
    
         
             
                  - becs
         
     | 
| 
      
 27621 
     | 
    
         
            +
                  - pix-automatico
         
     | 
| 
      
 27622 
     | 
    
         
            +
                  - mercadopago
         
     | 
| 
       27591 
27623 
     | 
    
         
             
                AchAccountTypeEnum:
         
     | 
| 
       27592 
27624 
     | 
    
         
             
                  type: string
         
     | 
| 
       27593 
27625 
     | 
    
         
             
                  description: The bank account type. (ACH only)
         
     | 
    
        metadata
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: recurly
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 4. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 4.69.0
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - Recurly
         
     | 
| 
       8 
8 
     | 
    
         
             
            autorequire:
         
     | 
| 
       9 
9 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       10 
10 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       11 
     | 
    
         
            -
            date: 2025- 
     | 
| 
      
 11 
     | 
    
         
            +
            date: 2025-11-03 00:00:00.000000000 Z
         
     | 
| 
       12 
12 
     | 
    
         
             
            dependencies:
         
     | 
| 
       13 
13 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       14 
14 
     | 
    
         
             
              name: base64
         
     | 
| 
         @@ -356,6 +356,7 @@ files: 
     | 
|
| 
       356 
356 
     | 
    
         
             
            - lib/recurly/resources/transaction.rb
         
     | 
| 
       357 
357 
     | 
    
         
             
            - lib/recurly/resources/transaction_error.rb
         
     | 
| 
       358 
358 
     | 
    
         
             
            - lib/recurly/resources/transaction_fraud_info.rb
         
     | 
| 
      
 359 
     | 
    
         
            +
            - lib/recurly/resources/transaction_next_action.rb
         
     | 
| 
       359 
360 
     | 
    
         
             
            - lib/recurly/resources/transaction_payment_gateway.rb
         
     | 
| 
       360 
361 
     | 
    
         
             
            - lib/recurly/resources/unique_coupon_code.rb
         
     | 
| 
       361 
362 
     | 
    
         
             
            - lib/recurly/resources/unique_coupon_code_params.rb
         
     | 
| 
         @@ -386,7 +387,7 @@ metadata: 
     | 
|
| 
       386 
387 
     | 
    
         
             
              changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
         
     | 
| 
       387 
388 
     | 
    
         
             
              documentation_uri: https://recurly.github.io/recurly-client-ruby/
         
     | 
| 
       388 
389 
     | 
    
         
             
              homepage_uri: https://github.com/recurly/recurly-client-ruby
         
     | 
| 
       389 
     | 
    
         
            -
              source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4. 
     | 
| 
      
 390 
     | 
    
         
            +
              source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.69.0
         
     | 
| 
       390 
391 
     | 
    
         
             
            post_install_message:
         
     | 
| 
       391 
392 
     | 
    
         
             
            rdoc_options: []
         
     | 
| 
       392 
393 
     | 
    
         
             
            require_paths:
         
     |