recurly 4.54.0 → 4.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de32666d545fd3100563208ae94a0dd4da8e690bcea56f779b3137420ed78e48
-  data.tar.gz: 3ee298baf72eae17a3156b5ed26dc469e776736529f9fa384861261b57de9377
+  metadata.gz: 885e9961b071423aee754fd426c09c14a4851482a7b3bf831fc2932fefedc27b
+  data.tar.gz: 81847095f9f134a62a3b8fb416b60ecbdfc4cfbc0ceb12e8f2610445409ed6b3
 SHA512:
-  metadata.gz: bd369659c65c2d6626aed9a683a882f0cdbe38595df8ac528dd0700647717cead0bf02f48c5b7993528d3184d06acc0c073747bac8ab4e42ec79ae3643df27bd
-  data.tar.gz: 025c1494cfceccd81d917922140260144b0fda63bf93ff0c23a126cce76a160a078fa1b433cd04144f4f0528357b72d538652aed121c548dd3d70dc05476eb61
+  metadata.gz: dc3e5d23a58ad5cc97319b61cb684ea29f42017f8ba2c687ae8477ffdc7c80516cde907d532c4bf2f3deed8f644dce17119a45fa62e32bb8f2beabf34b3e4352
+  data.tar.gz: bfbab980d669b9ac37718eaa8028b8da1fac07f1ec31625ee80c84dbfc49c9ad6ac4d3b262ef06bd5dedc6dcf066e4dd19f173a1db5e8a75038f5d7b8f67c887

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.56.0](https://github.com/recurly/recurly-client-ruby/tree/4.56.0) (2024-10-30)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.55.0...4.56.0)
+
+
+**Merged Pull Requests**
+
+- Adds bulk parameter to SubscriptionCreate and SubscriptionPurchase [#915](https://github.com/recurly/recurly-client-ruby/pull/915) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.55.0](https://github.com/recurly/recurly-client-ruby/tree/4.55.0) (2024-08-28)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.54.0...4.55.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (add UUID to external subscriptions) [#914](https://github.com/recurly/recurly-client-ruby/pull/914) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.54.0](https://github.com/recurly/recurly-client-ruby/tree/4.54.0) (2024-08-21)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.53.0...4.54.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.54'
+gem 'recurly', '~> 4.56'
 ```
 
 > *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

@@ -2403,7 +2403,7 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription get_external_subscription api documentation}
     #
-    # @param external_subscription_id [String] External subscription ID or external_id. For ID no prefix is used e.g. +e28zov4fw0v2+. For external_id use prefix +external-id-+, e.g. +external-id-123456+.
+    # @param external_subscription_id [String] External subscription ID, external_id or uuid. For ID no prefix is used e.g. +e28zov4fw0v2+. For external_id use prefix +external-id-+, e.g. +external-id-123456+ and for uuid use prefix +uuid-+ e.g. +uuid-7293239bae62777d8c1ae044a9843633+.
     # @param params [Hash] Optional query string parameters:
     #
     # @return [Resources::ExternalSubscription] Settings for an external subscription.

data/lib/recurly/requests/subscription_create.rb

@@ -22,6 +22,10 @@ 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 bulk
+      #   @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 collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String

data/lib/recurly/requests/subscription_purchase.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [Boolean] Whether the subscription renews at the end of its term.
       define_attribute :auto_renew, :Boolean
 
+      # @!attribute bulk
+      #   @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 custom_fields
       #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
       define_attribute :custom_fields, Array, { :item_type => :CustomField }

data/lib/recurly/resources/external_subscription.rb

@@ -89,6 +89,10 @@ module Recurly
       # @!attribute updated_at
       #   @return [DateTime] When the external subscription was updated in Recurly.
       define_attribute :updated_at, DateTime
+
+      # @!attribute uuid
+      #   @return [String] Universally Unique Identifier created automatically.
+      define_attribute :uuid, String
     end
   end
 end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.54.0"
+  VERSION = "4.56.0"
 end

data/openapi/api.yaml

@@ -9915,10 +9915,11 @@ paths:
       summary: Refund an invoice
       description: |
         There are two ways to do a refund:
-        * refund a specific amount which is divided across all the line items.
-        * refund quantities of line items.
-        If you want to refund the entire refundable amount on the invoice, the
-        simplest way is to do `type=amount` without specifiying an `amount`.
+        * Apply a specific dollar/cent amount or percentage amount to an entire invoice, which will refund the resulting amount across all line items on the invoice.
+          * If you want to refund the entire refundable amount on the invoice, the simplest way is to do `type=amount` without specifiying an `amount`.
+          * Note: You must have the Credit Memos feature flag enabled on your site to utilize percentage amount refunds on invoices.
+        * Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund.
+          * Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items.
       parameters:
       - "$ref": "#/components/parameters/invoice_id"
       requestBody:
@@ -16743,8 +16744,9 @@ components:
     external_subscription_id_fetch:
       name: external_subscription_id
       in: path
-      description: External subscription ID or external_id. For ID no prefix is used
-        e.g. `e28zov4fw0v2`. For external_id use prefix `external-id-`, e.g. `external-id-123456`.
+      description: External subscription ID, external_id or uuid. For ID no prefix
+        is used e.g. `e28zov4fw0v2`. For external_id use prefix `external-id-`, e.g.
+        `external-id-123456` and for uuid use prefix `uuid-` e.g. `uuid-7293239bae62777d8c1ae044a9843633`.
       required: true
       schema:
         type: string
@@ -23561,6 +23563,12 @@ components:
           title: Gift card Redemption Code
           description: A gift card redemption code to be redeemed on the purchase
             invoice.
+        bulk:
+          type: boolean
+          description: 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.
+          default: false
       required:
       - plan_code
       - currency
@@ -23663,6 +23671,12 @@ components:
           description: The new set of ramp intervals for the subscription.
           items:
             "$ref": "#/components/schemas/SubscriptionRampInterval"
+        bulk:
+          type: boolean
+          description: 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.
+          default: false
       required:
       - plan_code
     SubscriptionUpdate:
@@ -25100,6 +25114,10 @@ components:
           title: External Id
           description: The id of the subscription in the external systems., I.e. Apple
             App Store or Google Play Store.
+        uuid:
+          type: string
+          title: Uuid
+          description: Universally Unique Identifier created automatically.
         last_purchased:
           type: string
           format: date-time

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.54.0
+  version: 4.56.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -355,7 +355,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.54.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.56.0
 post_install_message: 
 rdoc_options: []
 require_paths: