recurly 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4030ed5d0b3caab223006348f1f47342e2bf331fa5dcdc13f4679ac7b3b58b45
-  data.tar.gz: 65a37eab661fdb72b9bb42720ba81c07cafd10c0a48c1d8d2cc51baf01a8e979
+  metadata.gz: 5e07115aaa76b090899e7a8b3fbd473aa4c3d9b53f1a0c2e6610bb48e3cfd2c0
+  data.tar.gz: 0e9dd8516ed793916175fb8e500894925cfe030f8fa6a3b1457420ab3b23a12f
 SHA512:
-  metadata.gz: 8569f9f4a8f3bc5722603036cfd16aa90fcbf8a48a14725f7d520d894de505c01b16a6ea2005fa1f43e24f58101f21159ee972ada8bd2390ed4ad901a3310cc8
-  data.tar.gz: 4eb5ec05dabac2b015aea206c59c9eb1ae3c06b8e56b660dd1417d9349cb6be02db179fa423a9cc841800c5b4b33dd8528c31ec342e2331d66c122bed173b032
+  metadata.gz: 1b159f6322d33ebdac54a9645c9f791c2bbbc22f42b1b398c4f478b657322f001bfc3275870918e2bca88d599d2409fdf3863a485afd0ee5e2d17c67db012362
+  data.tar.gz: 06ed96e99e5e910accf623edd708d36bfa38d439ee4ec7b7e59cdfb8b13cba09e4061ce827e03e66144823c5cd95df4c2741e9e5dd9ee746611ba4a8ef55e817

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
-## [3.7.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
+## [3.8.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
 
-[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.6.0...HEAD)
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.7.0...HEAD)
+
+**Implemented enhancements:**
+
+- Wed Jul  1 02:06:24 UTC 2020 Upgrade API version v2019-10-10 [\#605](https://github.com/recurly/recurly-client-ruby/pull/605) ([douglasmiller](https://github.com/douglasmiller))
+
+**Merged pull requests:**
+
+- Release 3.8.0 [\#606](https://github.com/recurly/recurly-client-ruby/pull/606) ([douglasmiller](https://github.com/douglasmiller))
+
+## [3.7.0](https://github.com/recurly/recurly-client-ruby/tree/3.7.0) (2020-06-30)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.6.0...3.7.0)
 
 **Implemented enhancements:**
 

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', '~> 3.7'
+gem 'recurly', '~> 3.8'
 ```
 
 > *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

@@ -2948,6 +2948,19 @@ module Recurly
       delete(path, **options)
     end
 
+    # Preview a new subscription change
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#operation/preview_subscription_change preview_subscription_change api documenation}
+    #
+    # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
+    # @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    # @return [Resources::SubscriptionChangePreview] A subscription change.
+    def preview_subscription_change(subscription_id:, body:, **options)
+      path = interpolate_path("/subscriptions/{subscription_id}/change/preview", subscription_id: subscription_id)
+      post(path, body, Requests::SubscriptionChangeCreate, **options)
+    end
+
     # List a subscription's invoices
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_invoices list_subscription_invoices api documenation}

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -6,6 +6,10 @@ module Recurly
   module Requests
     class SubscriptionAddOnCreate < Request
 
+      # @!attribute add_on_source
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      define_attribute :add_on_source, String
+
       # @!attribute code
       #   @return [String] Add-on code
       define_attribute :code, String

data/lib/recurly/resources/subscription_add_on.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [AddOnMini] Just the important parts.
       define_attribute :add_on, :AddOnMini
 
+      # @!attribute add_on_source
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      define_attribute :add_on_source, String
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime

data/lib/recurly/resources/subscription_change_preview.rb

@@ -0,0 +1,74 @@
+# 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 SubscriptionChangePreview < Resource
+
+      # @!attribute activate_at
+      #   @return [DateTime] Activated at
+      define_attribute :activate_at, DateTime
+
+      # @!attribute activated
+      #   @return [Boolean] Returns `true` if the subscription change is activated.
+      define_attribute :activated, :Boolean
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute id
+      #   @return [String] The ID of the Subscription Change.
+      define_attribute :id, String
+
+      # @!attribute invoice_collection
+      #   @return [InvoiceCollection] Invoice collection
+      define_attribute :invoice_collection, :InvoiceCollection
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plan
+      #   @return [PlanMini] Just the important parts.
+      define_attribute :plan, :PlanMini
+
+      # @!attribute quantity
+      #   @return [Integer] Subscription quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShipping] Subscription shipping details
+      define_attribute :shipping, :SubscriptionShipping
+
+      # @!attribute subscription_id
+      #   @return [String] The ID of the subscription that is going to be changed.
+      define_attribute :subscription_id, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit amount
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.7.0"
+  VERSION = "3.8.0"
 end

data/openapi/api.yaml

@@ -12056,6 +12056,51 @@ paths:
           {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Removed Subscription
           Change: %v\", subscriptionChange)"
+  "/sites/{site_id}/subscriptions/{subscription_id}/change/preview":
+    post:
+      tags:
+      - subscription
+      - subscription_change
+      operationId: preview_subscription_change
+      summary: Preview a new subscription change
+      description: Calling this will not save the subscription change or overwrite
+        an existing change.
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/subscription_id"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/SubscriptionChangeCreate"
+        required: true
+      responses:
+        '200':
+          description: A subscription change.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/SubscriptionChangePreview"
+        '404':
+          description: Incorrect site ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: A validation error such as "Subscription hasn't been changed"
+            or error running the verification transaction.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ErrorMayHaveTransaction"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/sites/{site_id}/subscriptions/{subscription_id}/invoices":
     get:
       tags:
@@ -17894,6 +17939,15 @@ components:
           maxLength: 13
         add_on:
           "$ref": "#/components/schemas/AddOnMini"
+        add_on_source:
+          type: string
+          title: Add-on source
+          description: |
+            Used to determine where the associated add-on data is pulled from. If this value is set to
+            `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated
+            `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then
+            the associated add-on data will be pulled from the site's item catalog.
+          default: plan_add_on
         quantity:
           type: integer
           title: Add-on quantity
@@ -17947,6 +18001,15 @@ components:
           type: string
           title: Add-on code
           maxLength: 50
+        add_on_source:
+          type: string
+          title: Add-on source
+          description: |
+            Used to determine where the associated add-on data is pulled from. If this value is set to
+            `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated
+            `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then
+            the associated add-on data will be pulled from the site's item catalog.
+          default: plan_add_on
         quantity:
           type: integer
           title: Quantity
@@ -18245,6 +18308,13 @@ components:
             mail order and telephone transactions.
           enum:
           - moto
+    SubscriptionChangePreview:
+      allOf:
+      - "$ref": "#/components/schemas/SubscriptionChange"
+      type: object
+      properties:
+        invoice_collection:
+          "$ref": "#/components/schemas/InvoiceCollection"
     SubscriptionChangeShippingCreate:
       type: object
       title: Shipping details that will be changed on a subscription

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -249,6 +249,7 @@ files:
 - lib/recurly/resources/subscription_add_on.rb
 - lib/recurly/resources/subscription_add_on_tier.rb
 - lib/recurly/resources/subscription_change.rb
+- lib/recurly/resources/subscription_change_preview.rb
 - lib/recurly/resources/subscription_shipping.rb
 - lib/recurly/resources/tax_info.rb
 - lib/recurly/resources/tier.rb
@@ -283,7 +284,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/3.7.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.8.0
 post_install_message: 
 rdoc_options: []
 require_paths: