recurly 4.61.0 → 4.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a8df861361535389368703276de1922da24d7dc17c552b2edc543df637ef4c4
-  data.tar.gz: ce07391eb63826ee943db984fa24c39908781ac9d4211efdcfff9a49b2788d6a
+  metadata.gz: 41a9b56094ce43db43642988272dc0177597ed7985883a934061a10cfcd16088
+  data.tar.gz: 4be1a63d519b8901ea44fdf0f888f383b4d0d6e4550aabed50500cd6d1e6d0c8
 SHA512:
-  metadata.gz: 6685a1d2f404014e8adce298cf3b600a9ff8c32b7c083a7eb2c487fec896be34383d6747ab7c9acb8cb27ad25da932e8d1ffb58529f7f1cc68e533ab4bd1294b
-  data.tar.gz: 357ed12ca060869d6830b4059f2c28472f3255a16f2fbc1ced135cfcb7608ef29e5e0bcc7523a61919a7d6c19975af0bd489e0667b0679a4b6517af1cfcc1e82
+  metadata.gz: 8104a2fcfebe0f66a31b07eb916446dce62fe8ac710a53d610063df7d69d7e2b7e098e9fb05b6568f2a63dbf212e18fc25b8591ae851bf55da39fe32d64b750c
+  data.tar.gz: f6f3eb51d8bc7b19344a8399c3e12ddc72938d9d2bbc2c1baea6dee963afbd7ff2c225d23136fa55b7af2881a5a1a122a3b42d99a1b23b84ff8ffb5540a4a0e2

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [4.62.0](https://github.com/recurly/recurly-client-ruby/tree/4.62.0) (2025-04-10)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.61.0...4.62.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25: Create External Invoices [#926](https://github.com/recurly/recurly-client-ruby/pull/926) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#924](https://github.com/recurly/recurly-client-ruby/pull/924) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.61.0](https://github.com/recurly/recurly-client-ruby/tree/4.61.0) (2025-03-15)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.60.0...4.61.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.61'
+gem 'recurly', '~> 4.62'
 ```
 
 > *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

@@ -2463,6 +2463,21 @@ module Recurly
       pager(path, **options)
     end
 
+    # Create an external invoice
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_external_invoice create_external_invoice api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param body [Requests::ExternalInvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalInvoiceCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalInvoice] Returns the external invoice
+    #
+    def create_external_invoice(external_subscription_id:, body:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_invoices", external_subscription_id: external_subscription_id)
+      post(path, body, Requests::ExternalInvoiceCreate, **options)
+    end
+
     # List a site's invoices
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}

data/lib/recurly/requests/billing_info_create.rb

@@ -110,6 +110,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 return_url
+      #   @return [String] Specifies a URL to which a consumer will be redirected upon completion of a redirect payment flow. Only redirect payment flows operating through Adyen Components will utilize this return URL.
+      define_attribute :return_url, String
+
       # @!attribute roku_billing_agreement_id
       #   @return [String] Roku's CIB if billing through Roku
       define_attribute :roku_billing_agreement_id, String

data/lib/recurly/requests/external_charge_create.rb

@@ -0,0 +1,30 @@
+# 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 ExternalChargeCreate < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String]
+      define_attribute :description, String
+
+      # @!attribute external_product_reference
+      #   @return [ExternalProductReferenceCreate]
+      define_attribute :external_product_reference, :ExternalProductReferenceCreate
+
+      # @!attribute quantity
+      #   @return [Integer]
+      define_attribute :quantity, Integer
+
+      # @!attribute unit_amount
+      #   @return [String]
+      define_attribute :unit_amount, String
+    end
+  end
+end

data/lib/recurly/requests/external_invoice_create.rb

@@ -0,0 +1,42 @@
+# 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 ExternalInvoiceCreate < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute external_id
+      #   @return [String] An identifier which associates the external invoice to a corresponding object in an external platform.
+      define_attribute :external_id, String
+
+      # @!attribute external_payment_phase
+      #   @return [ExternalPaymentPhaseBase]
+      define_attribute :external_payment_phase, :ExternalPaymentPhaseBase
+
+      # @!attribute external_payment_phase_id
+      #   @return [String] External payment phase ID, e.g. `a34ypb2ef9w1`.
+      define_attribute :external_payment_phase_id, String
+
+      # @!attribute line_items
+      #   @return [Array[ExternalChargeCreate]]
+      define_attribute :line_items, Array, { :item_type => :ExternalChargeCreate }
+
+      # @!attribute purchased_at
+      #   @return [DateTime] When the invoice was created in the external platform.
+      define_attribute :purchased_at, DateTime
+
+      # @!attribute state
+      #   @return [String]
+      define_attribute :state, String
+
+      # @!attribute total
+      #   @return [String]
+      define_attribute :total, String
+    end
+  end
+end

data/lib/recurly/requests/external_payment_phase_base.rb

@@ -0,0 +1,50 @@
+# 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 ExternalPaymentPhaseBase < Request
+
+      # @!attribute amount
+      #   @return [String] Allows up to 9 decimal places
+      define_attribute :amount, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute ending_billing_period_index
+      #   @return [Integer] Ending Billing Period Index
+      define_attribute :ending_billing_period_index, Integer
+
+      # @!attribute ends_at
+      #   @return [DateTime] Ends At
+      define_attribute :ends_at, DateTime
+
+      # @!attribute offer_name
+      #   @return [String] Name of the discount offer given, e.g. "introductory"
+      define_attribute :offer_name, String
+
+      # @!attribute offer_type
+      #   @return [String] Type of discount offer given, e.g. "FREE_TRIAL"
+      define_attribute :offer_type, String
+
+      # @!attribute period_count
+      #   @return [Integer] Number of billing periods
+      define_attribute :period_count, Integer
+
+      # @!attribute period_length
+      #   @return [String] Billing cycle length
+      define_attribute :period_length, String
+
+      # @!attribute started_at
+      #   @return [DateTime] Started At
+      define_attribute :started_at, DateTime
+
+      # @!attribute starting_billing_period_index
+      #   @return [Integer] Starting Billing Period Index
+      define_attribute :starting_billing_period_index, Integer
+    end
+  end
+end

data/lib/recurly/requests/payment_gateway_references.rb

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

data/lib/recurly/requests/subscription_create.rb

@@ -111,7 +111,7 @@ module Recurly
       define_attribute :shipping, :SubscriptionShippingCreate
 
       # @!attribute starts_at
-      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      #   @return [DateTime] If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
       define_attribute :starts_at, DateTime
 
       # @!attribute tax_inclusive

data/lib/recurly/requests/subscription_purchase.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :shipping, :SubscriptionShippingPurchase
 
       # @!attribute starts_at
-      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      #   @return [DateTime] If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
       define_attribute :starts_at, DateTime
 
       # @!attribute tax_inclusive

data/lib/recurly/resources/payment_gateway_references.rb

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

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.61.0"
+  VERSION = "4.62.0"
 end

data/openapi/api.yaml

@@ -8380,6 +8380,44 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+    post:
+      tags:
+      - external_invoices
+      operationId: create_external_invoice
+      summary: Create an external invoice
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/ExternalInvoiceCreate"
+        required: true
+      responses:
+        '201':
+          description: Returns the external invoice
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalInvoice"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: External subscription cannot be completed for the specified
+            reason.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/invoices":
     get:
       tags:
@@ -18948,6 +18986,12 @@ components:
           description: Represents the card network preference associated with the
             billing info for dual badged cards. Must be a supported card network.
           "$ref": "#/components/schemas/CardNetworkEnum"
+        return_url:
+          type: string
+          title: Return URL
+          description: Specifies a URL to which a consumer will be redirected upon
+            completion of a redirect payment flow. Only redirect payment flows operating
+            through Adyen Components will utilize this return URL.
     BillingInfoVerify:
       type: object
       properties:
@@ -21322,8 +21366,8 @@ components:
           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.
+            a Stripe gateway or Ebanx gateway is used, this value will need to be
+            accompanied by its reference_type.
         reference_type:
           type: string
           title: Reference Type
@@ -23682,7 +23726,7 @@ components:
           type: string
           format: date-time
           title: Start date
-          description: If set, the subscription will begin in the future on this date.
+          description: If set, the subscription will begin on this specified date.
             The subscription will apply the setup fee and trial period, unless the
             plan has no trial.
         next_bill_date:
@@ -23855,7 +23899,7 @@ components:
           type: string
           format: date-time
           title: Start date
-          description: If set, the subscription will begin in the future on this date.
+          description: If set, the subscription will begin on this specified date.
             The subscription will apply the setup fee and trial period, unless the
             plan has no trial.
         next_bill_date:
@@ -26564,11 +26608,12 @@ components:
     PaymentGatewayReferencesEnum:
       type: string
       description: The type of reference token. Required if token is passed in for
-        Stripe Gateway.
+        Stripe Gateway or Ebanx UPI.
       enum:
       - stripe_confirmation_token
       - stripe_customer
       - stripe_payment_method
+      - upi_vpa
     GatewayTransactionTypeEnum:
       type: string
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.61.0
+  version: 4.62.0
 platform: ruby
 authors:
 - Recurly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-15 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -186,6 +186,9 @@ files:
 - lib/recurly/requests/dunning_campaigns_bulk_update.rb
 - lib/recurly/requests/external_account_create.rb
 - lib/recurly/requests/external_account_update.rb
+- lib/recurly/requests/external_charge_create.rb
+- lib/recurly/requests/external_invoice_create.rb
+- lib/recurly/requests/external_payment_phase_base.rb
 - lib/recurly/requests/external_product_create.rb
 - lib/recurly/requests/external_product_reference_base.rb
 - lib/recurly/requests/external_product_reference_connection_type.rb
@@ -378,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.61.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.62.0
 post_install_message:
 rdoc_options: []
 require_paths: