recurly 4.57.0 → 4.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02596017f45c4a0f30364c23a90fe6eb1b0da5687651dea25146059002325f43'
-  data.tar.gz: ea769fbd9a052fa2c63c01bbcf281db0b9661d56acd883bb5d1c586e21682d18
+  metadata.gz: aa01a46479316edc7d1659eee1bb644658ac1b98b226a828f700f4e4604300b8
+  data.tar.gz: 9b940bfaaa7825fde720224a96206718612fd770edff7ce9b4a98a4b79ce3307
 SHA512:
-  metadata.gz: 6cd2acc0f9cb1c24a299c1a93364fc21b0e401a42e3a06beadd6fd3675005dd664dd197ebd4a398abfb0a247dbccd9516dcb43f33205c44a2430f3bede685664
-  data.tar.gz: 4ece7465ff9bf395aa2198d81bb663ba2f011618ccf285efa520b5273ea6e4862e0fa883251f8c838fff51c86182a7b284e587845b2ca6193b14a54597dca46a
+  metadata.gz: e3e62c1f06d5925e4ff0f729aa7c81e7753f221dacedc064da3fd18743219cd88b04d5550b64942355aa7c3bbe8309d163acfc78bca40638efc0ce1c9fc2c222
+  data.tar.gz: 58aba19b4411cc33dd7d556dc03413c73df4440424c7d3fcbe1b9cb2c0f8f9f529be371d9995873b6daf8bfa081188c31999f3c9cc2cf2b739684a2afd9fbafd

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [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)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#918](https://github.com/recurly/recurly-client-ruby/pull/918) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.57.0](https://github.com/recurly/recurly-client-ruby/tree/4.57.0) (2024-12-02)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.56.0...4.57.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.57'
+gem 'recurly', '~> 4.59'
 ```
 
 > *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
     #
@@ -2382,7 +2383,21 @@ module Recurly
       delete(path, **options)
     end
 
-    # List a site's external subscriptions
+    # Create an external subscription
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_external_subscription create_external_subscription api documentation}
+    #
+    # @param body [Requests::ExternalSubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalSubscriptionCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalSubscription] Returns the external subscription
+    #
+    def create_external_subscription(body:, **options)
+      path = "/external_subscriptions"
+      post(path, body, Requests::ExternalSubscriptionCreate, **options)
+    end
+
+    # List the external subscriptions on a site
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscriptions list_external_subscriptions api documentation}
     #
@@ -2413,6 +2428,21 @@ module Recurly
       get(path, **options)
     end
 
+    # Update an external subscription
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/put_external_subscription put_external_subscription api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param params [Hash] Optional query string parameters:
+    #        :body [Requests::ExternalSubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalSubscriptionUpdate}
+    #
+    # @return [Resources::ExternalSubscription] Settings for an external subscription.
+    #
+    def put_external_subscription(external_subscription_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}", external_subscription_id: external_subscription_id)
+      put(path, options[:body], Requests::ExternalSubscriptionUpdate, **options)
+    end
+
     # List the external invoices on an external subscription
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_invoices list_external_subscription_external_invoices api documentation}

data/lib/recurly/requests/account_external_subscription.rb

@@ -0,0 +1,14 @@
+# 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 AccountExternalSubscription < Request
+
+      # @!attribute account_code
+      #   @return [String] The account code of a new or existing account to be used when creating the external subscription.
+      define_attribute :account_code, String
+    end
+  end
+end

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/external_account_create.rb

@@ -11,7 +11,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
     end
   end

data/lib/recurly/requests/external_account_update.rb

@@ -11,7 +11,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
     end
   end

data/lib/recurly/requests/external_product_reference_base.rb

@@ -7,8 +7,8 @@ module Recurly
     class ExternalProductReferenceBase < Request
 
       # @!attribute external_connection_type
-      #   @return [String]
-      define_attribute :external_connection_type, String
+      #   @return [ExternalProductReferenceConnectionType] Represents the connection type. One of the connection types of your enabled App Connectors
+      define_attribute :external_connection_type, :ExternalProductReferenceConnectionType
 
       # @!attribute reference_code
       #   @return [String] A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.

data/lib/recurly/requests/external_product_reference_connection_type.rb

@@ -0,0 +1,10 @@
+# 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 ExternalProductReferenceConnectionType < Request
+    end
+  end
+end

data/lib/recurly/requests/external_product_reference_create.rb

@@ -7,8 +7,8 @@ module Recurly
     class ExternalProductReferenceCreate < Request
 
       # @!attribute external_connection_type
-      #   @return [String]
-      define_attribute :external_connection_type, String
+      #   @return [ExternalProductReferenceConnectionType] Represents the connection type. One of the connection types of your enabled App Connectors
+      define_attribute :external_connection_type, :ExternalProductReferenceConnectionType
 
       # @!attribute reference_code
       #   @return [String] A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.

data/lib/recurly/requests/external_product_reference_update.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 ExternalProductReferenceUpdate < Request
+
+      # @!attribute external_connection_type
+      #   @return [ExternalProductReferenceConnectionType] Represents the connection type. One of the connection types of your enabled App Connectors
+      define_attribute :external_connection_type, :ExternalProductReferenceConnectionType
+
+      # @!attribute reference_code
+      #   @return [String] A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
+      define_attribute :reference_code, String
+    end
+  end
+end

data/lib/recurly/requests/external_subscription_create.rb

@@ -0,0 +1,62 @@
+# 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 ExternalSubscriptionCreate < Request
+
+      # @!attribute account
+      #   @return [AccountExternalSubscription]
+      define_attribute :account, :AccountExternalSubscription
+
+      # @!attribute activated_at
+      #   @return [DateTime] When the external subscription was activated in the external platform.
+      define_attribute :activated_at, DateTime
+
+      # @!attribute app_identifier
+      #   @return [String] Identifier of the app that generated the external subscription.
+      define_attribute :app_identifier, String
+
+      # @!attribute auto_renew
+      #   @return [Boolean] An indication of whether or not the external subscription will auto-renew at the expiration date.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute expires_at
+      #   @return [DateTime] When the external subscription expires in the external platform.
+      define_attribute :expires_at, DateTime
+
+      # @!attribute external_id
+      #   @return [String] Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.
+      define_attribute :external_id, String
+
+      # @!attribute external_product_reference
+      #   @return [ExternalProductReferenceCreate]
+      define_attribute :external_product_reference, :ExternalProductReferenceCreate
+
+      # @!attribute imported
+      #   @return [Boolean] An indication of whether or not the external subscription was being created by a historical data import.
+      define_attribute :imported, :Boolean
+
+      # @!attribute last_purchased
+      #   @return [DateTime] When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
+      define_attribute :last_purchased, DateTime
+
+      # @!attribute quantity
+      #   @return [Integer] An indication of the quantity of a subscribed item's quantity.
+      define_attribute :quantity, Integer
+
+      # @!attribute state
+      #   @return [String] External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
+      define_attribute :state, String
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] When the external subscription trial period ends in the external platform.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute trial_started_at
+      #   @return [DateTime] When the external subscription trial period started in the external platform.
+      define_attribute :trial_started_at, DateTime
+    end
+  end
+end

data/lib/recurly/requests/external_subscription_update.rb

@@ -0,0 +1,58 @@
+# 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 ExternalSubscriptionUpdate < Request
+
+      # @!attribute activated_at
+      #   @return [DateTime] When the external subscription was activated in the external platform.
+      define_attribute :activated_at, DateTime
+
+      # @!attribute app_identifier
+      #   @return [String] Identifier of the app that generated the external subscription.
+      define_attribute :app_identifier, String
+
+      # @!attribute auto_renew
+      #   @return [Boolean] An indication of whether or not the external subscription will auto-renew at the expiration date.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute expires_at
+      #   @return [DateTime] When the external subscription expires in the external platform.
+      define_attribute :expires_at, DateTime
+
+      # @!attribute external_id
+      #   @return [String] Id of the subscription in the external system, i.e. Apple App Store or Google Play Store.
+      define_attribute :external_id, String
+
+      # @!attribute external_product_reference
+      #   @return [ExternalProductReferenceUpdate]
+      define_attribute :external_product_reference, :ExternalProductReferenceUpdate
+
+      # @!attribute imported
+      #   @return [Boolean] An indication of whether or not the external subscription was being created by a historical data import.
+      define_attribute :imported, :Boolean
+
+      # @!attribute last_purchased
+      #   @return [DateTime] When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
+      define_attribute :last_purchased, DateTime
+
+      # @!attribute quantity
+      #   @return [Integer] An indication of the quantity of a subscribed item's quantity.
+      define_attribute :quantity, Integer
+
+      # @!attribute state
+      #   @return [String] External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
+      define_attribute :state, String
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] When the external subscription trial period ends in the external platform.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute trial_started_at
+      #   @return [DateTime] When the external subscription trial period started in the external platform.
+      define_attribute :trial_started_at, DateTime
+    end
+  end
+end

data/lib/recurly/requests/invoice_create.rb

@@ -6,6 +6,14 @@ module Recurly
   module Requests
     class InvoiceCreate < Request
 
+      # @!attribute business_entity_code
+      #   @return [String] The `business_entity_code` is the value that represents a specific business entity for an end customer which will be assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_code, String
+
+      # @!attribute business_entity_id
+      #   @return [String] The `business_entity_id` is the value that represents a specific business entity for an end customer which will be assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_id, String
+
       # @!attribute charge_customer_notes
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for charge invoices. Specify custom notes to add or override Customer Notes on charge invoices.
       define_attribute :charge_customer_notes, String

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/requests/purchase_create.rb

@@ -14,6 +14,14 @@ module Recurly
       #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
       define_attribute :billing_info_id, String
 
+      # @!attribute business_entity_code
+      #   @return [String] The `business_entity_code` is the value that represents a specific business entity for an end customer. When `business_entity_code` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_code, String
+
+      # @!attribute business_entity_id
+      #   @return [String] The `business_entity_id` is the value that represents a specific business entity for an end customer. When `business_entity_id` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_id, String
+
       # @!attribute collection_method
       #   @return [String] Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
       define_attribute :collection_method, String
@@ -70,6 +78,10 @@ module Recurly
       #   @return [String] Terms and conditions to be put on the purchase invoice.
       define_attribute :terms_and_conditions, String
 
+      # @!attribute transaction
+      #   @return [Hash] (Transaction Data, Card on File) - Options for flagging transactions as Customer or Merchant Initiated Unscheduled.
+      define_attribute :transaction, Hash
+
       # @!attribute transaction_type
       #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
       define_attribute :transaction_type, String

data/lib/recurly/requests/subscription_change_create.rb

@@ -14,6 +14,14 @@ module Recurly
       #   @return [SubscriptionChangeBillingInfoCreate]
       define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate
 
+      # @!attribute business_entity_code
+      #   @return [String] The `business_entity_code` is the value that represents a specific business entity for an end customer. When `business_entity_code` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used. Only allowed if the `timeframe` is not `now`.
+      define_attribute :business_entity_code, String
+
+      # @!attribute business_entity_id
+      #   @return [String] The `business_entity_id` is the value that represents a specific business entity for an end customer. When `business_entity_id` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used. Only allowed if the `timeframe` is not `now`.
+      define_attribute :business_entity_id, String
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String

data/lib/recurly/requests/subscription_create.rb

@@ -26,6 +26,14 @@ module Recurly
       #   @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
       define_attribute :bulk, :Boolean
 
+      # @!attribute business_entity_code
+      #   @return [String] The `business_entity_code` is the value that represents a specific business entity for an end customer. When `business_entity_code` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_code, String
+
+      # @!attribute business_entity_id
+      #   @return [String] The `business_entity_id` is the value that represents a specific business entity for an end customer. When `business_entity_id` is used to assign a business entity to the subscription, all future billing events for the subscription will bill to the specified business entity. Available when the `Multiple Business Entities` feature is enabled. If both `business_entity_id` and `business_entity_code` are present, `business_entity_id` will be used.
+      define_attribute :business_entity_id, String
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String

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/business_entity_mini.rb

@@ -0,0 +1,26 @@
+# 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 BusinessEntityMini < Resource
+
+      # @!attribute code
+      #   @return [String] The entity code of the business entity.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] Business entity ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] This name describes your business entity and will appear on the invoice.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

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/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/subscription.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [String] Billing Info ID.
       define_attribute :billing_info_id, String
 
+      # @!attribute business_entity_id
+      #   @return [String] The ID of the business entity associated with the subscription. This will be `null` if the subscription relies on resolving the business entity during renewal.
+      define_attribute :business_entity_id, String
+
       # @!attribute canceled_at
       #   @return [DateTime] Canceled at
       define_attribute :canceled_at, DateTime

data/lib/recurly/resources/subscription_change.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
       define_attribute :billing_info, :SubscriptionChangeBillingInfo
 
+      # @!attribute business_entity
+      #   @return [BusinessEntityMini] Business entity details
+      define_attribute :business_entity, :BusinessEntityMini
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime

data/lib/recurly/resources/transaction.rb

@@ -90,6 +90,10 @@ module Recurly
       #   @return [String] Transaction ID
       define_attribute :id, String
 
+      # @!attribute indicator
+      #   @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
+
       # @!attribute invoice
       #   @return [InvoiceMini] Invoice mini details
       define_attribute :invoice, :InvoiceMini
@@ -102,6 +106,10 @@ module Recurly
       #   @return [String] IP address provided when the billing information was collected:  - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.
       define_attribute :ip_address_v4, String
 
+      # @!attribute merchant_reason_code
+      #   @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.
+      define_attribute :merchant_reason_code, String
+
       # @!attribute object
       #   @return [String] Object type
       define_attribute :object, String

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.57.0"
+  VERSION = "4.59.0"
 end