recurly 4.48.1 → 4.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e4b84ed92642304d316caef8e02440f25b3aa86b53f4aa409be552ba6ea528
-  data.tar.gz: de9d27ad9767114b32a7aedd451b4f0ad3f84868e2ce9477001a3df08db5401f
+  metadata.gz: 9deb4deb5ca3391327d77c6a0e01784b582d552822ca1a049549b02ba457d0cc
+  data.tar.gz: 68d1bc0fe11b5dadde464dd7b450765751fe528d482394205afaeda885e2e63c
 SHA512:
-  metadata.gz: 57aa7328b70c2e729f0d5b6ab3f0b0d31767b99209c61452240534a728dca5744361f8f955547a6c786fa82ee23aa6da664adf14b5a24468de76002972654f4e
-  data.tar.gz: fc8b24b5cc0bcb0651d277f5c594866fd58bfcb6797c5ff09283338c3cc1fb8761871f3789e46b6108df7fa51b7a4fdb04f116605a597153f6463a9c4bc6c3e1
+  metadata.gz: 508098f34e9196704e4a6d511c4e6f7654008fb25b025984582dfc60f707a4dfb8cd8f4b1945d4522b932a6cd919c553443e42a67f3e484e2bfe590e7dff3734
+  data.tar.gz: b594596975bb8f5b5e1b5cce5f37ac7c60bc14ed5252379741d5c6bbbe59f0ef8c849a1dd80ae190d0aebf758148e4733f9d87b20e5ed0b4eab8af0d34fb8ee9

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.50.0](https://github.com/recurly/recurly-client-ruby/tree/4.50.0) (2024-05-08)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.49.0...4.50.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Proration Settings) [#901](https://github.com/recurly/recurly-client-ruby/pull/901) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.49.0](https://github.com/recurly/recurly-client-ruby/tree/4.49.0) (2024-05-01)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.48.1...4.49.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25  (Auth & Capture) [#900](https://github.com/recurly/recurly-client-ruby/pull/900) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.48.1](https://github.com/recurly/recurly-client-ruby/tree/4.48.1) (2024-04-02)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.48.0...4.48.1)

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.48'
+gem 'recurly', '~> 4.50'
 ```
 
 > *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

@@ -4277,6 +4277,48 @@ module Recurly
       post(path, body, Requests::PurchaseCreate, **options)
     end
 
+    # Authorize a purchase
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_authorize_purchase create_authorize_purchase api documentation}
+    #
+    # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] Returns the authorize invoice
+    #
+    def create_authorize_purchase(body:, **options)
+      path = "/purchases/authorize"
+      post(path, body, Requests::PurchaseCreate, **options)
+    end
+
+    # Capture a purchase
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_capture_purchase create_capture_purchase api documentation}
+    #
+    # @param transaction_id [String] Transaction ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] Returns the captured invoice
+    #
+    def create_capture_purchase(transaction_id:, **options)
+      path = interpolate_path("/purchases/{transaction_id}/capture", transaction_id: transaction_id)
+      post(path, **options)
+    end
+
+    # Cancel Purchase
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/cancelPurchase cancelPurchase api documentation}
+    #
+    # @param transaction_id [String] Transaction ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] Returns the cancelled invoice
+    #
+    def cancelPurchase(transaction_id:, **options)
+      path = interpolate_path("/purchases/{transaction_id}/cancel/", transaction_id: transaction_id)
+      post(path, **options)
+    end
+
     # List the dates that have an available export to download.
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documentation}

data/lib/recurly/requests/invoice_create.rb

@@ -27,7 +27,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute po_number

data/lib/recurly/requests/proration_settings.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 ProrationSettings < Request
+
+      # @!attribute charge
+      #   @return [String] Determines how the amount charged is determined for this change
+      define_attribute :charge, String
+
+      # @!attribute credit
+      #   @return [String] Determines how the amount credited is determined for this change
+      define_attribute :credit, String
+    end
+  end
+end

data/lib/recurly/requests/purchase_create.rb

@@ -51,7 +51,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute po_number

data/lib/recurly/requests/subscription_change_create.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute plan_code
@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
+      # @!attribute proration_settings
+      #   @return [ProrationSettings] Allows you to control how any resulting charges and credits will be calculated and prorated.
+      define_attribute :proration_settings, :ProrationSettings
+
       # @!attribute quantity
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer

data/lib/recurly/requests/subscription_create.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute next_bill_date

data/lib/recurly/requests/subscription_update.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute next_bill_date

data/lib/recurly/resources/invoice.rb

@@ -87,7 +87,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute number

data/lib/recurly/resources/subscription.rb

@@ -111,7 +111,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute net_terms_type
-      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.  This field is only available when the EOM Net Terms feature is enabled.
+      #   @return [String] Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
       define_attribute :net_terms_type, String
 
       # @!attribute object

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.48.1"
+  VERSION = "4.50.0"
 end

data/openapi/api.yaml

@@ -15470,6 +15470,132 @@ paths:
           validation: %v\", e)\n\t\treturn nil, err\n\t}\n\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Created ChargeInvoice
           with UUID: %s.\\n\", collection.ChargeInvoice.Uuid)\n"
+  "/purchases/authorize":
+    post:
+      tags:
+      - purchase
+      operationId: create_authorize_purchase
+      summary: Authorize a purchase
+      description: |-
+        A purchase is a hybrid checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type.
+
+        The authorize endpoint will create a pending purchase that can be activated at a later time once payment has been completed on an external source.
+
+        For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/PurchaseCreate"
+        required: true
+      responses:
+        '200':
+          description: Returns the authorize invoice
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: authorize purchase 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: []
+  "/purchases/{transaction_id}/capture":
+    post:
+      tags:
+      - purchase
+      parameters:
+      - "$ref": "#/components/parameters/transaction_id"
+      operationId: create_capture_purchase
+      summary: Capture a purchase
+      description: |-
+        A purchase is a hybrid checkout containing at least one or more
+        subscriptions or one-time charges (adjustments) and supports both coupon
+        and gift card redemptions. All items purchased will be on one invoice
+        and paid for with one transaction. A purchase is only a request data
+        type and is not persistent in Recurly and an invoice collection will be
+        the returned type.
+
+
+        Capture an open Authorization request
+      responses:
+        '200':
+          description: Returns the captured invoice
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Capture purchase 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: []
+  "/purchases/{transaction_id}/cancel/":
+    parameters:
+    - "$ref": "#/components/parameters/transaction_id"
+    post:
+      summary: Cancel Purchase
+      description: |
+        A purchase is a hybrid checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type.
+
+        Cancel an open Authorization request
+      tags:
+      - purchase
+      operationId: cancelPurchase
+      responses:
+        '200':
+          description: Returns the cancelled invoice
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Cancel purchase 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: []
   "/export_dates":
     get:
       tags:
@@ -21127,6 +21253,34 @@ components:
           description: |
             The percentage taken of the monetary amount of usage tracked.
             This can be up to 4 decimal places represented as a string.
+    ProrationSettings:
+      type: object
+      title: Proration Settings
+      description: Allows you to control how any resulting charges and credits will
+        be calculated and prorated.
+      properties:
+        charge:
+          "$ref": "#/components/schemas/ProrationSettingsChargeEnum"
+        credit:
+          "$ref": "#/components/schemas/ProrationSettingsCreditEnum"
+    ProrationSettingsChargeEnum:
+      type: string
+      title: Charge
+      description: Determines how the amount charged is determined for this change
+      default: prorated_amount
+      enum:
+      - full_amount
+      - prorated_amount
+      - none
+    ProrationSettingsCreditEnum:
+      type: string
+      title: Credit
+      description: Determines how the amount credited is determined for this change
+      default: prorated_amount
+      enum:
+      - full_amount
+      - prorated_amount
+      - none
     Settings:
       type: object
       properties:
@@ -22350,6 +22504,8 @@ components:
           description: The new set of ramp intervals for the subscription.
           items:
             "$ref": "#/components/schemas/SubscriptionRampInterval"
+        proration_settings:
+          "$ref": "#/components/schemas/ProrationSettings"
     SubscriptionChangeShippingCreate:
       type: object
       title: Shipping details that will be changed on a subscription
@@ -25178,8 +25334,6 @@ components:
         Optionally supplied string that may be either `net` or `eom` (end-of-month).
         When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date.
         When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.
-
-        This field is only available when the EOM Net Terms feature is enabled.
       enum:
       - net
       - eom

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.48.1
+  version: 4.50.0
 platform: ruby
 authors:
 - Recurly
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - lib/recurly/requests/plan_ramp_pricing.rb
 - lib/recurly/requests/plan_update.rb
 - lib/recurly/requests/pricing.rb
+- lib/recurly/requests/proration_settings.rb
 - lib/recurly/requests/purchase_create.rb
 - lib/recurly/requests/shipping_address_create.rb
 - lib/recurly/requests/shipping_address_update.rb
@@ -350,8 +351,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.48.1
-post_install_message:
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.50.0
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -366,8 +367,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: The ruby client for Recurly's V3 API
 test_files: []