recurly 4.63.0 → 4.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb49608ae75d7232218279a89c1f8c054696b2704054b7f0d5606338724ed327
-  data.tar.gz: b2b433901e9f01228213da877bd363b2314b126c14d41b937d6facbf675d0353
+  metadata.gz: a2b423c29b03e3ece31a18fa41ad5b52a6f1d23c68c2e9aa346dfde9f948a179
+  data.tar.gz: 640b7806f97778059ef0d301616a00cd04a57e4140584348b4c21b734bc88c82
 SHA512:
-  metadata.gz: 6394559860aa49980037f205757265106c52cff92a756e75935f5a6432f0c945357428095bf90b10a573c2bf1362060df2ab778df6bb62a9bb6a5667bc7c7aac
-  data.tar.gz: a2d1e9375579ba500a0d68beb4499b9471a5da9acdc325f2d417f88bc4e49cfed900a00f61bf7854fb007f05746a9dfe0703b36228767bfaebe3323e119bcd17
+  metadata.gz: 42ac8c24f569ec13bdc3b0689328a0fab71c800c4ba634d3784bb625d4f4ea60d85a38872569ef706d0741cdecd0ddc8a40dc499f8ec9213d7534930d2f0e326
+  data.tar.gz: 1ef7f980560ef757d8b78a709e7a3920938f70bb75881a06fe3539b93cf3800fb731ddc28bdd1c2aaf606070cab753bacf0a689cfd936942171a9f53ee8c34a2

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [4.64.0](https://github.com/recurly/recurly-client-ruby/tree/4.64.0) (2025-06-11)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.63.0...4.64.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#929](https://github.com/recurly/recurly-client-ruby/pull/929) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#928](https://github.com/recurly/recurly-client-ruby/pull/928) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.63.0](https://github.com/recurly/recurly-client-ruby/tree/4.63.0) (2025-04-16)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.62.0...4.63.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.63'
+gem 'recurly', '~> 4.64'
 ```
 
 > *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

@@ -589,6 +589,38 @@ module Recurly
       delete(path, **options)
     end
 
+    # Verify a billing information's credit card
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_infos verify_billing_infos api documentation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
+    # @param params [Hash] Optional query string parameters:
+    #        :body [Requests::BillingInfoVerify] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerify}
+    #
+    # @return [Resources::Transaction] Transaction information from verify.
+    #
+    def verify_billing_infos(account_id:, billing_info_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify", account_id: account_id, billing_info_id: billing_info_id)
+      post(path, options[:body], Requests::BillingInfoVerify, **options)
+    end
+
+    # Verify a billing information's credit card cvv
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_infos_cvv verify_billing_infos_cvv api documentation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
+    # @param body [Requests::BillingInfoVerifyCVV] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoVerifyCVV}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::Transaction] Transaction information from verify.
+    #
+    def verify_billing_infos_cvv(account_id:, billing_info_id:, body:, **options)
+      path = interpolate_path("/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv", account_id: account_id, billing_info_id: billing_info_id)
+      post(path, body, Requests::BillingInfoVerifyCVV, **options)
+    end
+
     # List the coupon redemptions for an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}

data/lib/recurly/requests/billing_info_create.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :address, :Address
 
       # @!attribute amazon_billing_agreement_id
-      #   @return [String] Amazon billing agreement ID
+      #   @return [String] Only supported on Amazon V1. For Amazon V2, use token_id with Recurly.js.
       define_attribute :amazon_billing_agreement_id, String
 
       # @!attribute backup_payment_method

data/lib/recurly/requests/billing_info_verify.rb

@@ -9,6 +9,10 @@ module Recurly
       # @!attribute gateway_code
       #   @return [String] An identifier for a specific payment gateway.
       define_attribute :gateway_code, String
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
     end
   end
 end

data/lib/recurly/requests/billing_info_verify_cvv.rb

@@ -6,6 +6,18 @@ module Recurly
   module Requests
     class BillingInfoVerifyCVV < Request
 
+      # @!attribute gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, String
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+
+      # @!attribute token_id
+      #   @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
+      define_attribute :token_id, String
+
       # @!attribute verification_value
       #   @return [String] Unique security code for a credit card.
       define_attribute :verification_value, String

data/lib/recurly/requests/line_item_create.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :liability_gl_account_id, String
 
       # @!attribute origin
-      #   @return [String] Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site and `type` is `credit`. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements.  Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true.  This origin creates a charge and opposite credit on the account to be used for future invoices.
+      #   @return [String] Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site, `type` is `credit` and `tax_exempt` is `true` if you are using taxes. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements.  Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true.  This origin creates a charge and opposite credit on the account to be used for future invoices.
       define_attribute :origin, String
 
       # @!attribute origin_tax_address_source

data/lib/recurly/requests/subscription_ramp_interval.rb

@@ -11,8 +11,8 @@ module Recurly
       define_attribute :starting_billing_cycle, Integer
 
       # @!attribute unit_amount
-      #   @return [Integer] Represents the price for the ramp interval.
-      define_attribute :unit_amount, Integer
+      #   @return [Float] Represents the price for the ramp interval.
+      define_attribute :unit_amount, Float
     end
   end
 end

data/lib/recurly/resources/invoice.rb

@@ -138,6 +138,10 @@ module Recurly
       #   @return [Float] The summation of charges and credits, before discounts and taxes.
       define_attribute :subtotal, Float
 
+      # @!attribute subtotal_after_discount
+      #   @return [Float] The summation of charges and credits, after discounts applied.
+      define_attribute :subtotal_after_discount, Float
+
       # @!attribute tax
       #   @return [Float] The total tax on this invoice.
       define_attribute :tax, Float

data/lib/recurly/resources/line_item.rb

@@ -23,7 +23,7 @@ module Recurly
       define_attribute :add_on_id, String
 
       # @!attribute amount
-      #   @return [Float] `(quantity * unit_amount) - (discount + tax)`
+      #   @return [Float] `(quantity * unit_amount) - discount + tax`
       define_attribute :amount, Float
 
       # @!attribute avalara_service_type

data/lib/recurly/resources/transaction.rb

@@ -90,9 +90,9 @@ module Recurly
       #   @return [String] Transaction ID
       define_attribute :id, String
 
-      # @!attribute indicator
+      # @!attribute initiator
       #   @return [String] Must be sent for one-time transactions in order to provide context on which entity is submitting the transaction to ensure proper fraud checks are observed, such as 3DS. If the customer is in session, send `customer`. If this is a merchant initiated one-time transaction, send `merchant`.
-      define_attribute :indicator, String
+      define_attribute :initiator, String
 
       # @!attribute invoice
       #   @return [InvoiceMini] Invoice mini details

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.63.0"
+  VERSION = "4.64.0"
 end

data/openapi/api.yaml

@@ -2793,6 +2793,97 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/accounts/{account_id}/billing_infos/{billing_info_id}/verify":
+    post:
+      tags:
+      - billing_infos
+      operationId: verify_billing_infos
+      summary: Verify a billing information's credit card
+      parameters:
+      - "$ref": "#/components/parameters/account_id"
+      - "$ref": "#/components/parameters/billing_info_id"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/BillingInfoVerify"
+        required: false
+      responses:
+        '200':
+          description: Transaction information from verify.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Transaction"
+        '404':
+          description: Billing information not found, or incorrect site or account
+            ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Invalid billing information, or error running the verification
+            transaction.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ErrorMayHaveTransaction"
+      x-code-samples: []
+  "/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv":
+    post:
+      tags:
+      - billing_infos
+      operationId: verify_billing_infos_cvv
+      summary: Verify a billing information's credit card cvv
+      parameters:
+      - "$ref": "#/components/parameters/account_id"
+      - "$ref": "#/components/parameters/billing_info_id"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/BillingInfoVerifyCVV"
+      responses:
+        '200':
+          description: Transaction information from verify.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Transaction"
+        '404':
+          description: Billing information not found, or incorrect site or account
+            ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Invalid billing information, or error running the verification
+            transaction.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ErrorMayHaveTransaction"
+        '429':
+          description: Too many CVV verification attempts.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/accounts/{account_id}/coupon_redemptions":
     get:
       tags:
@@ -10830,7 +10921,7 @@ paths:
           }
       - lang: Go
         source: "planReq := &recurly.PlanCreate{\n\tCode: &planCode,\n\tName: recurly.String(\"Monthly
-          Coffee Subscription\"),\n\tCurrencies: []recurly.PlanPricingCreate{\n\t\t{\n\t\t\tCurrency:
+          Coffee Subscription\"),\n\tCurrencies: &[]recurly.PlanPricingCreate{\n\t\t{\n\t\t\tCurrency:
           \  recurly.String(\"USD\"),\n\t\t\tUnitAmount: recurly.Float(10000),\n\t\t},\n\t},\n}\n\nplan,
           err := client.CreatePlan(planReq)\nif e, ok := err.(*recurly.Error); ok
           {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
@@ -11499,7 +11590,7 @@ paths:
           }
       - lang: Go
         source: "addOnReq := &recurly.AddOnCreate{\n\tCode: &addOnCode,\n\tName: recurly.String(\"Fresh
-          beans shipped monthly\"),\n\tCurrencies: []recurly.AddOnPricingCreate{\n\t\t{\n\t\t\tCurrency:
+          beans shipped monthly\"),\n\tCurrencies: &[]recurly.AddOnPricingCreate{\n\t\t{\n\t\t\tCurrency:
           \  recurly.String(\"USD\"),\n\t\t\tUnitAmount: recurly.Float(10),\n\t\t},\n\t},\n}\n\nplanAddOn,
           err := client.CreatePlanAddOn(planID, addOnReq)\nif e, ok := err.(*recurly.Error);
           ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
@@ -15274,7 +15365,7 @@ paths:
       - lang: Go
         source: "purchaseReq := &recurly.PurchaseCreate{\n\tCurrency: recurly.String(\"USD\"),\n\tAccount:
           &recurly.AccountPurchase{\n\t\tCode: recurly.String(accountCode),\n\t},\n\tSubscriptions:
-          []recurly.SubscriptionPurchase{\n\t\t{\n\t\t\tPlanCode:     recurly.String(planCode),\n\t\t\tNextBillDate:
+          &[]recurly.SubscriptionPurchase{\n\t\t{\n\t\t\tPlanCode:     recurly.String(planCode),\n\t\t\tNextBillDate:
           recurly.Time(time.Date(2078, time.November, 10, 23, 0, 0, 0, time.UTC)),\n\t\t},\n\t},\n\tShipping:
           &recurly.ShippingPurchase{\n\t\tAddressId: recurly.String(shippingAddressID),\n\t},\n}\n\ncollection,
           err := client.CreatePurchase(purchaseReq)\nif e, ok := err.(*recurly.Error);
@@ -15508,7 +15599,7 @@ paths:
       - lang: Go
         source: "purchaseReq := &recurly.PurchaseCreate{\n\tCurrency: recurly.String(\"USD\"),\n\tAccount:
           &recurly.AccountPurchase{\n\t\tCode: recurly.String(account.Code),\n\t},\n\tSubscriptions:
-          []recurly.SubscriptionPurchase{\n\t\t{\n\t\t\tPlanCode:     recurly.String(plan.Code),\n\t\t\tNextBillDate:
+          &[]recurly.SubscriptionPurchase{\n\t\t{\n\t\t\tPlanCode:     recurly.String(plan.Code),\n\t\t\tNextBillDate:
           recurly.Time(time.Date(2078, time.November, 10, 23, 0, 0, 0, time.UTC)),\n\t\t},\n\t},\n\tShipping:
           &recurly.ShippingPurchase{\n\t\tAddressId: recurly.String(shippingAddressID),\n\t},\n}\ncollection,
           err := client.PreviewPurchase(purchaseReq)\nif e, ok := err.(*recurly.Error);
@@ -15776,12 +15867,12 @@ paths:
               var_dump($e);
           }
       - lang: Go
-        source: "purchaseReq := &recurly.PurchaseCreate{\n\tCurrency: recurly.String(\"EUR\"),\n\tAccount:
+        source: "purchaseReq := &recurly.PurchaseCreate{\n\tCurrency: recurly.String(\"USD\"),\n\tAccount:
           &recurly.AccountPurchase{\n\t\tCode:  recurly.String(accountCode),\n\t\tEmail:
           recurly.String(\"benjamin@example.com\"),\n\t\tBillingInfo: &recurly.BillingInfoCreate{\n\t\t\tFirstName:
           \               recurly.String(\"Benjamin\"),\n\t\t\tLastName:                 recurly.String(\"Du
           Monde\"),\n\t\t\tOnlineBankingPaymentType: recurly.String(\"ideal\"),\n\t\t},\n\t},\n\tLineItems:
-          []recurly.LineItemCreate{\n\t\t{\n\t\t\tCurrency:   recurly.String(\"EUR\"),\n\t\t\tUnitAmount:
+          &[]recurly.LineItemCreate{\n\t\t{\n\t\t\tCurrency:   recurly.String(\"USD\"),\n\t\t\tUnitAmount:
           recurly.Float(1000),\n\t\t\tType:       recurly.String(\"charge\"),\n\t\t},\n\t},\n}\ncollection,
           err := client.CreatePendingPurchase(purchaseReq)\nif e, ok := err.(*recurly.Error);
           ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
@@ -18896,6 +18987,8 @@ components:
         amazon_billing_agreement_id:
           type: string
           title: Amazon billing agreement ID
+          description: Only supported on Amazon V1. For Amazon V2, use token_id with
+            Recurly.js.
         paypal_billing_agreement_id:
           type: string
           title: PayPal billing agreement ID
@@ -18999,12 +19092,27 @@ components:
           type: string
           description: An identifier for a specific payment gateway.
           maxLength: 13
+        three_d_secure_action_result_token_id:
+          type: string
+          description: A token generated by Recurly.js after completing a 3-D Secure
+            device fingerprinting or authentication challenge.
     BillingInfoVerifyCVV:
       type: object
       properties:
         verification_value:
           type: string
           description: Unique security code for a credit card.
+        gateway_code:
+          type: string
+          description: An identifier for a specific payment gateway.
+          maxLength: 13
+        three_d_secure_action_result_token_id:
+          type: string
+          description: A token generated by Recurly.js after completing a 3-D Secure
+            device fingerprinting or authentication challenge.
+        token_id:
+          type: string
+          description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
     Coupon:
       type: object
       properties:
@@ -20315,6 +20423,11 @@ components:
           title: Subtotal
           description: The summation of charges and credits, before discounts and
             taxes.
+        subtotal_after_discount:
+          type: number
+          format: float
+          title: Subtotal After Discount
+          description: The summation of charges and credits, after discounts applied.
         tax:
           type: number
           format: float
@@ -20958,7 +21071,7 @@ components:
           type: number
           format: float
           title: Total after discounts and taxes
-          description: "`(quantity * unit_amount) - (discount + tax)`"
+          description: "`(quantity * unit_amount) - discount + tax`"
         description:
           type: string
           title: Description
@@ -21327,12 +21440,12 @@ components:
         origin:
           title: Origin
           description: Origin `external_gift_card` is allowed if the Gift Cards feature
-            is enabled on your site and `type` is `credit`. Set this value in order
-            to track gift card credits from external gift cards (like InComm). It
-            also skips billing information requirements.  Origin `prepayment` is only
-            allowed if `type` is `charge` and `tax_exempt` is left blank or set to
-            true.  This origin creates a charge and opposite credit on the account
-            to be used for future invoices.
+            is enabled on your site, `type` is `credit` and `tax_exempt` is `true`
+            if you are using taxes. Set this value in order to track gift card credits
+            from external gift cards (like InComm). It also skips billing information
+            requirements.  Origin `prepayment` is only allowed if `type` is `charge`
+            and `tax_exempt` is left blank or set to true.  This origin creates a
+            charge and opposite credit on the account to be used for future invoices.
           "$ref": "#/components/schemas/LineItemCreateOriginEnum"
         custom_fields:
           "$ref": "#/components/schemas/CustomFields"
@@ -24152,7 +24265,8 @@ components:
           description: Represents the billing cycle where a ramp interval starts.
           default: 1
         unit_amount:
-          type: integer
+          type: number
+          format: float
           description: Represents the price for the ramp interval.
     SubscriptionRampIntervalResponse:
       type: object
@@ -24279,8 +24393,8 @@ components:
           maxLength: 13
         account:
           "$ref": "#/components/schemas/AccountMini"
-        indicator:
-          "$ref": "#/components/schemas/TransactionIndicatorEnum"
+        initiator:
+          "$ref": "#/components/schemas/TransactionInitiatorEnum"
         invoice:
           "$ref": "#/components/schemas/InvoiceMini"
         merchant_reason_code:
@@ -24837,8 +24951,8 @@ components:
           allOf:
           - type: object
             properties:
-              indicator:
-                "$ref": "#/components/schemas/Transaction/properties/indicator"
+              initiator:
+                "$ref": "#/components/schemas/Transaction/properties/initiator"
               merchant_reason_code:
                 "$ref": "#/components/schemas/Transaction/properties/merchant_reason_code"
         customer_notes:
@@ -26613,8 +26727,6 @@ components:
         Stripe Gateway or Ebanx UPI.
       enum:
       - stripe_confirmation_token
-      - stripe_customer
-      - stripe_payment_method
       - upi_vpa
     GatewayTransactionTypeEnum:
       type: string
@@ -26978,6 +27090,12 @@ components:
       - recurring
       - refunded_externally
       - transparent
+      - token_api
+      - api_force_collect
+      - api_sub_change
+      - api_verify_card
+      - refund_balance
+      - amazon_v2_ipn
     TransactionStatusEnum:
       type: string
       enum:
@@ -27464,7 +27582,7 @@ components:
       - service_extension
       - split_shipment
       - top_up
-    TransactionIndicatorEnum:
+    TransactionInitiatorEnum:
       type: string
       description: Must be sent for one-time transactions in order to provide context
         on which entity is submitting the transaction to ensure proper fraud checks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.63.0
+  version: 4.64.0
 platform: ruby
 authors:
 - Recurly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -381,7 +381,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.63.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.64.0
 post_install_message:
 rdoc_options: []
 require_paths: