recurly 4.58.0 → 4.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74ffec1395f2101981161d4c237e809df86cc7107ce8a6721b3ba3f98e5fe9f
-  data.tar.gz: 239bbfe41b4cd46e9a2ced544e1e7fe78ffaf3eafcb25acf6d31b63cde0fe071
+  metadata.gz: eba1e494499b41ba8c1913b09f627369318b5daa55e5923faf82cfbbde4d0f28
+  data.tar.gz: da464a775040b1d5ea33b66feb1698f5aa68d18fc075f4218e2cf3d1b739d05c
 SHA512:
-  metadata.gz: 1b52c5bbb2fb3cf771add224e7a74ecf8e9cdca61ce11c088a856fc758ecae07bc3f3767477e2b940687100cfd34f4c932e5bb3933c739864701d9b7761c7bdb
-  data.tar.gz: eb4001c518a55424eeb4cbc72e3d5f7a2c6a50d6246b8d94c51b83cb923d579af1c144746765bad3aa133391401c8fafd843e446716cde8e1242e4f03fffe7c5
+  metadata.gz: f25c9d51a4dbc24b1a1dc838737e9252ca85ef9193333d6d988cbeffa7421d5a6154a6dd5558c36b1d462f6c9064403a6ba04be6507590cebbf6e2019c63e96a
+  data.tar.gz: c9884672aa89ee2ba372f9397e829aca30c9308632a20211a6836cdf4f846160fca252a7f32e23c860c113290c94cfc9cfa41bc85326893cb98cf9d7bc48b0c2

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [4.60.0](https://github.com/recurly/recurly-client-ruby/tree/4.60.0) (2025-03-14)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.59.0...4.60.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#923](https://github.com/recurly/recurly-client-ruby/pull/923) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.59.0](https://github.com/recurly/recurly-client-ruby/tree/4.59.0) (2025-02-26)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.58.0...4.59.0)
+
+
+**Merged Pull Requests**
+
+- Add `funding_source` to `BillingInfo` and `Transaction` [#921](https://github.com/recurly/recurly-client-ruby/pull/921) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#919](https://github.com/recurly/recurly-client-ruby/pull/919) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.58.0](https://github.com/recurly/recurly-client-ruby/tree/4.58.0) (2024-12-16)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.57.0...4.58.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.58'
+gem 'recurly', '~> 4.60'
 ```
 
 > *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

@@ -1698,6 +1698,7 @@ module Recurly
     #        :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
     #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
     #
+    #        :redeemed [String] Filter unique coupon codes by redemption status. +true+ for redeemed, +false+ for not redeemed.
     #
     # @return [Pager<Resources::UniqueCouponCode>] A list of unique coupon codes that were generated
     #

data/lib/recurly/requests/billing_info_create.rb

@@ -63,7 +63,7 @@ module Recurly
       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`.
+      #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String
 
       # @!attribute gateway_token
@@ -98,6 +98,10 @@ module Recurly
       #   @return [String] Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
       define_attribute :online_banking_payment_type, String
 
+      # @!attribute payment_gateway_references
+      #   @return [Array[PaymentGatewayReferences]] Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.
+      define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }
+
       # @!attribute paypal_billing_agreement_id
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String

data/lib/recurly/requests/coupon_bulk_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class CouponBulkCreate < Request
 
       # @!attribute number_of_unique_codes
-      #   @return [Integer] The quantity of unique coupon codes to generate
+      #   @return [Integer] The quantity of unique coupon codes to generate. A bulk coupon can have up to 100,000 unique codes (or your site's configured limit).
       define_attribute :number_of_unique_codes, Integer
     end
   end

data/lib/recurly/requests/payment_gateway_references.rb

@@ -0,0 +1,18 @@
+# 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 PaymentGatewayReferences < Request
+
+      # @!attribute reference_type
+      #   @return [String] The type of reference token. Required if token is passed in for Stripe Gateway.
+      define_attribute :reference_type, String
+
+      # @!attribute token
+      #   @return [String] Reference value used when the external token was created. If Stripe gateway is used, this value will need to be accompanied by its reference_type.
+      define_attribute :token, String
+    end
+  end
+end

data/lib/recurly/resources/billing_info.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute payment_gateway_references
+      #   @return [Array[PaymentGatewayReferences]] Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.
+      define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }
+
       # @!attribute payment_method
       #   @return [PaymentMethod]
       define_attribute :payment_method, :PaymentMethod

data/lib/recurly/resources/external_account.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :external_account_code, String
 
       # @!attribute external_connection_type
-      #   @return [String] Represents the connection type. `AppleAppStore` or `GooglePlayStore`
+      #   @return [String] Represents the connection type. One of the connection types of your enabled App Connectors
       define_attribute :external_connection_type, String
 
       # @!attribute id

data/lib/recurly/resources/invoice.rb

@@ -114,6 +114,10 @@ module Recurly
       #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.
       define_attribute :previous_invoice_id, String
 
+      # @!attribute reference_only_currency_conversion
+      #   @return [ReferenceOnlyCurrencyConversion] Reference Only Currency Conversion
+      define_attribute :reference_only_currency_conversion, :ReferenceOnlyCurrencyConversion
+
       # @!attribute refundable_amount
       #   @return [Float] The refundable amount on a charge invoice. It will be null for all other invoices.
       define_attribute :refundable_amount, Float

data/lib/recurly/resources/payment_gateway_references.rb

@@ -0,0 +1,18 @@
+# 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 PaymentGatewayReferences < Resource
+
+      # @!attribute reference_type
+      #   @return [String] The type of reference token. Required if token is passed in for Stripe Gateway.
+      define_attribute :reference_type, String
+
+      # @!attribute token
+      #   @return [String] Reference value used when the external token was created. If Stripe gateway is used, this value will need to be accompanied by its reference_type.
+      define_attribute :token, String
+    end
+  end
+end

data/lib/recurly/resources/payment_method.rb

@@ -23,7 +23,7 @@ module Recurly
       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.
+      #   @return [String] The 2-letter ISO 3166-1 alpha-2 country code associated with the card's issuer, if known.
       define_attribute :cc_bin_country, String
 
       # @!attribute exp_month
@@ -38,6 +38,10 @@ module Recurly
       #   @return [String] Credit card number's first six digits.
       define_attribute :first_six, String
 
+      # @!attribute funding_source
+      #   @return [String] The funding source of the card, if known.
+      define_attribute :funding_source, String
+
       # @!attribute gateway_attributes
       #   @return [GatewayAttributes] Gateway specific attributes associated with this PaymentMethod
       define_attribute :gateway_attributes, :GatewayAttributes

data/lib/recurly/resources/reference_only_currency_conversion.rb

@@ -0,0 +1,22 @@
+# 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 ReferenceOnlyCurrencyConversion < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute subtotal_in_cents
+      #   @return [Float] The subtotal converted to the currency.
+      define_attribute :subtotal_in_cents, Float
+
+      # @!attribute tax_in_cents
+      #   @return [Float] The tax converted to the currency.
+      define_attribute :tax_in_cents, Float
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.58.0"
+  VERSION = "4.60.0"
 end

data/openapi/api.yaml

@@ -6265,8 +6265,7 @@ paths:
               schema:
                 "$ref": "#/components/schemas/UniqueCouponCodeParams"
         '400':
-          description: Invalid or unpermitted parameter; perhaps you tried to generate
-            more than 200 codes at a time?
+          description: Invalid or unpermitted parameter.
           content:
             application/json:
               schema:
@@ -6348,6 +6347,7 @@ paths:
       - "$ref": "#/components/parameters/sort_dates"
       - "$ref": "#/components/parameters/filter_begin_time"
       - "$ref": "#/components/parameters/filter_end_time"
+      - "$ref": "#/components/parameters/filter_redeemed"
       responses:
         '200':
           description: A list of unique coupon codes that were generated
@@ -17184,6 +17184,13 @@ components:
         - `type=legacy`, only legacy invoices will be returned.
       schema:
         "$ref": "#/components/schemas/FilterInvoiceTypeEnum"
+    filter_redeemed:
+      name: redeemed
+      in: query
+      description: Filter unique coupon codes by redemption status. `true` for redeemed,
+        `false` for not redeemed.
+      schema:
+        "$ref": "#/components/schemas/FilterRedeemedEnum"
     export_date:
       name: export_date
       in: path
@@ -18733,6 +18740,12 @@ components:
           description: The `backup_payment_method` field is used to indicate a billing
             info as a backup on the account that will be tried if the initial billing
             info used for an invoice is declined.
+        payment_gateway_references:
+          type: array
+          description: Array of Payment Gateway References, each a reference to a
+            third-party gateway object of varying types.
+          items:
+            "$ref": "#/components/schemas/PaymentGatewayReferences"
         created_at:
           type: string
           format: date-time
@@ -18815,9 +18828,21 @@ components:
           maxLength: 50
         gateway_code:
           type: string
-          title: An identifier for a specific payment gateway. Must be used in conjunction
-            with `gateway_token`.
+          title: An identifier for a specific payment gateway.
           maxLength: 12
+        payment_gateway_references:
+          type: array
+          description: Array of Payment Gateway References, each a reference to a
+            third-party gateway object of varying types.
+          items:
+            "$ref": "#/components/schemas/PaymentGatewayReferences"
+          properties:
+            token:
+              type: string
+              maxLength: 50
+            reference_type:
+              type: string
+              "$ref": "#/components/schemas/PaymentGatewayReferencesEnum"
         gateway_attributes:
           type: object
           description: Additional attributes to send to the gateway.
@@ -19282,9 +19307,9 @@ components:
         number_of_unique_codes:
           type: integer
           title: Number of unique codes
-          description: The quantity of unique coupon codes to generate
+          description: The quantity of unique coupon codes to generate. A bulk coupon
+            can have up to 100,000 unique codes (or your site's configured limit).
           minimum: 1
-          maximum: 200
     CouponMini:
       type: object
       properties:
@@ -20251,6 +20276,8 @@ components:
           format: float
           title: Tax
           description: The total tax on this invoice.
+        reference_only_currency_conversion:
+          "$ref": "#/components/schemas/ReferenceOnlyCurrencyConversion"
         total:
           type: number
           format: float
@@ -21285,6 +21312,22 @@ components:
       - currency
       - unit_amount
       - type
+    PaymentGatewayReferences:
+      type: object
+      title: Payment Gateway References Object
+      description: Array of Payment Gateway References, each a reference to a third-party
+        gateway object of varying types.
+      properties:
+        token:
+          type: string
+          title: Token
+          description: Reference value used when the external token was created. If
+            Stripe gateway is used, this value will need to be accompanied by its
+            reference_type.
+        reference_type:
+          type: string
+          title: Reference Type
+          "$ref": "#/components/schemas/PaymentGatewayReferencesEnum"
     PlanMini:
       type: object
       title: Plan mini details
@@ -22248,6 +22291,25 @@ components:
           title: Updated at
           format: date-time
           readOnly: true
+    ReferenceOnlyCurrencyConversion:
+      type: object
+      title: Reference Only Currency Conversion
+      properties:
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+        subtotal_in_cents:
+          type: number
+          format: float
+          title: Subtotal In Cents
+          description: The subtotal converted to the currency.
+        tax_in_cents:
+          type: number
+          format: float
+          title: Tax In Cents
+          description: The tax converted to the currency.
     ShippingAddressCreate:
       type: object
       properties:
@@ -25273,7 +25335,8 @@ components:
           description: Represents the account code for the external account.
         external_connection_type:
           type: string
-          description: Represents the connection type. `AppleAppStore` or `GooglePlayStore`
+          description: Represents the connection type. One of the connection types
+            of your enabled App Connectors
         created_at:
           type: string
           format: date-time
@@ -25823,8 +25886,10 @@ components:
         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.
+            the card's issuer, if known.
+        funding_source:
+          "$ref": "#/components/schemas/CardFundingSourceEnum"
+          description: The funding source of the card, if known.
         gateway_code:
           type: string
           description: An identifier for a specific payment gateway.
@@ -26430,6 +26495,11 @@ components:
       - credit
       - legacy
       - non-legacy
+    FilterRedeemedEnum:
+      type: string
+      enum:
+      - true
+      - false
     ChannelEnum:
       type: string
       enum:
@@ -26491,6 +26561,14 @@ components:
       enum:
       - email
       - post
+    PaymentGatewayReferencesEnum:
+      type: string
+      description: The type of reference token. Required if token is passed in for
+        Stripe Gateway.
+      enum:
+      - stripe_confirmation_token
+      - stripe_customer
+      - stripe_payment_method
     GatewayTransactionTypeEnum:
       type: string
       enum:
@@ -26964,6 +27042,14 @@ components:
       - Dankort
       - MasterCard
       - Visa
+    CardFundingSourceEnum:
+      type: string
+      enum:
+      - credit
+      - debit
+      - charge
+      - prepaid
+      - deferred_debit
     AccountTypeEnum:
       type: string
       enum:

data/recurly.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
   # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "base64", "~> 0.2.0"
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.58.0
+  version: 4.60.0
 platform: ruby
 authors:
 - Recurly
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +213,7 @@ files:
 - lib/recurly/requests/line_item_refund.rb
 - lib/recurly/requests/measured_unit_create.rb
 - lib/recurly/requests/measured_unit_update.rb
+- lib/recurly/requests/payment_gateway_references.rb
 - lib/recurly/requests/percentage_tier.rb
 - lib/recurly/requests/percentage_tiers_by_currency.rb
 - lib/recurly/requests/plan_create.rb
@@ -300,6 +315,7 @@ files:
 - lib/recurly/resources/item_mini.rb
 - lib/recurly/resources/line_item.rb
 - lib/recurly/resources/measured_unit.rb
+- lib/recurly/resources/payment_gateway_references.rb
 - lib/recurly/resources/payment_method.rb
 - lib/recurly/resources/percentage_tier.rb
 - lib/recurly/resources/percentage_tiers_by_currency.rb
@@ -311,6 +327,7 @@ files:
 - lib/recurly/resources/plan_ramp_interval.rb
 - lib/recurly/resources/plan_ramp_pricing.rb
 - lib/recurly/resources/pricing.rb
+- lib/recurly/resources/reference_only_currency_conversion.rb
 - lib/recurly/resources/settings.rb
 - lib/recurly/resources/shipping_address.rb
 - lib/recurly/resources/shipping_method.rb
@@ -361,8 +378,8 @@ 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.58.0
-post_install_message: 
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.60.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -378,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The ruby client for Recurly's V3 API
 test_files: []