recurly 4.36.0 → 4.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63627cfe02c6b1f623b0ec942fbdfefcc602baab2ba76c210b5b3946610c6010
-  data.tar.gz: eab3fc22497332fec976abbfb79cd9c4a33a54c0755d701d445b4a54ac0fb34f
+  metadata.gz: d9706f4db91fa66e91071dfd51171b9933576b04f081c161715bcee8a2457a95
+  data.tar.gz: 85ba2a6dcc9c774c64c51a9c4ca088d473da7c9d5dae0926fa52f7fcd10ec0a1
 SHA512:
-  metadata.gz: 20999a85623503c5af9e2e7bd2097dc900729a01b96e9c9e758f409594f6b2130627cef2c49a06a750227359679f8bbed5a4c9e727401c6de528ebf1f19634dd
-  data.tar.gz: c042cf9edadd7293aea0550297a720c5ff212402c765d7a86e3c8c545d7c9023e162b6a08d94abd4576c66156ab5cd4cca6105003d2489a3474a24ad69c4874b
+  metadata.gz: 8e609da5b5ae899f5bd0d2ac5b4651c4981d84b605b58dd1b9fab32223328d1a487c4583f2ca580806f345e269aaf5cb6a8235d7b4aa911254d321d8d34cc97a
+  data.tar.gz: 218ac1808c50575ec60157116ed1f12d51de64a3b1159a249399a85f34f9b5b1daa72dec3f37b54cc4f0401078169bfc855e4f28c5a02e9277a96f10f6d065d2

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [4.37.0](https://github.com/recurly/recurly-client-ruby/tree/4.37.0) (2023-05-24)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.36.0...4.37.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (External Products & References) [#848](https://github.com/recurly/recurly-client-ruby/pull/848) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.36.0](https://github.com/recurly/recurly-client-ruby/tree/4.36.0) (2023-05-23)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.35.0...4.36.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.36'
+gem 'recurly', '~> 4.37'
 ```
 
 > *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

@@ -2159,6 +2159,20 @@ module Recurly
       pager(path, **options)
     end
 
+    # Create an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_external_product create_external_product api documentation}
+    #
+    # @param body [Requests::ExternalProductCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalProductCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProduct] Returns the external product
+    #
+    def create_external_product(body:, **options)
+      path = "/external_products"
+      post(path, body, Requests::ExternalProductCreate, **options)
+    end
+
     # Fetch an external product
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_product get_external_product api documentation}
@@ -2173,6 +2187,98 @@ module Recurly
       get(path, **options)
     end
 
+    # Update an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/update_external_product update_external_product api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param body [Requests::ExternalProductUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalProductUpdate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProduct] Settings for an external product.
+    #
+    def update_external_product(external_product_id:, body:, **options)
+      path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id)
+      put(path, body, Requests::ExternalProductUpdate, **options)
+    end
+
+    # Deactivate an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_external_products deactivate_external_products api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProduct] Deactivated external product.
+    #
+    def deactivate_external_products(external_product_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id)
+      delete(path, **options)
+    end
+
+    # List the external product references for an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_product_external_product_references list_external_product_external_product_references api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #
+    # @return [Pager<Resources::ExternalProductReferenceCollection>] A list of the the external product references for an external product.
+    #
+    def list_external_product_external_product_references(external_product_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}/external_product_references", external_product_id: external_product_id)
+      pager(path, **options)
+    end
+
+    # Create an external product reference on an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_external_product_external_product_reference create_external_product_external_product_reference api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param body [Requests::ExternalProductReferenceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalProductReferenceCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProductReferenceMini] Details for the external product reference.
+    #
+    def create_external_product_external_product_reference(external_product_id:, body:, **options)
+      path = interpolate_path("/external_products/{external_product_id}/external_product_references", external_product_id: external_product_id)
+      post(path, body, Requests::ExternalProductReferenceCreate, **options)
+    end
+
+    # Fetch an external product reference
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_product_external_product_reference get_external_product_external_product_reference api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param external_product_reference_id [String] External product reference ID, e.g. +d39iun2fw1v4+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProductReferenceMini] Details for an external product reference.
+    #
+    def get_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}/external_product_references/{external_product_reference_id}", external_product_id: external_product_id, external_product_reference_id: external_product_reference_id)
+      get(path, **options)
+    end
+
+    # Deactivate an external product reference
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_external_product_external_product_reference deactivate_external_product_external_product_reference api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param external_product_reference_id [String] External product reference ID, e.g. +d39iun2fw1v4+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProductReferenceMini] Details for an external product reference.
+    #
+    def deactivate_external_product_external_product_reference(external_product_id:, external_product_reference_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}/external_product_references/{external_product_reference_id}", external_product_id: external_product_id, external_product_reference_id: external_product_reference_id)
+      delete(path, **options)
+    end
+
     # List a site's external subscriptions
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscriptions list_external_subscriptions api documentation}

data/lib/recurly/requests/external_product_create.rb

@@ -0,0 +1,22 @@
+# 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 ExternalProductCreate < Request
+
+      # @!attribute external_product_references
+      #   @return [Array[ExternalProductReferenceBase]] List of external product references of the external product.
+      define_attribute :external_product_references, Array, { :item_type => :ExternalProductReferenceBase }
+
+      # @!attribute name
+      #   @return [String] External product name.
+      define_attribute :name, String
+
+      # @!attribute plan_id
+      #   @return [String] Recurly plan UUID.
+      define_attribute :plan_id, String
+    end
+  end
+end

data/lib/recurly/requests/external_product_reference_base.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 ExternalProductReferenceBase < Request
+
+      # @!attribute external_connection_type
+      #   @return [String]
+      define_attribute :external_connection_type, String
+
+      # @!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_product_reference_create.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 ExternalProductReferenceCreate < Request
+
+      # @!attribute external_connection_type
+      #   @return [String]
+      define_attribute :external_connection_type, String
+
+      # @!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_product_update.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 ExternalProductUpdate < Request
+
+      # @!attribute plan_id
+      #   @return [String] Recurly plan UUID.
+      define_attribute :plan_id, String
+    end
+  end
+end

data/lib/recurly/resources/external_product_reference_collection.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 ExternalProductReferenceCollection < Resource
+
+      # @!attribute data
+      #   @return [Array[ExternalProductReferenceMini]]
+      define_attribute :data, Array, { :item_type => :ExternalProductReferenceMini }
+
+      # @!attribute has_more
+      #   @return [Boolean] Indicates there are more results on subsequent pages.
+      define_attribute :has_more, :Boolean
+
+      # @!attribute next
+      #   @return [String] Path to subsequent page of results.
+      define_attribute :next, String
+
+      # @!attribute object
+      #   @return [String] Will always be List.
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.36.0"
+  VERSION = "4.37.0"
 end

data/openapi/api.yaml

@@ -206,6 +206,7 @@ x-tagGroups:
   - external_invoices
   - external_products
   - external_accounts
+  - external_product_references
 - name: Products and Promotions
   tags:
   - item
@@ -360,6 +361,10 @@ tags:
   description: A product from an external resource that is not managed by the Recurly
     platform and instead is managed by third-party platforms like Apple App Store
     and Google Play Store.
+- name: external_product_references
+  x-displayName: External Product Reference
+  description: Associates an external product to a corresponding resource on an external
+    platform like the Apple App Store or Google Play Store.
 - name: gift_cards
   x-displayName: Gift Cards
   description: Add gift card purchases to your checkout and allow gift card recipients
@@ -7745,6 +7750,43 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+    post:
+      tags:
+      - external_products
+      operationId: create_external_product
+      summary: Create an external product
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/ExternalProductCreate"
+        required: true
+      responses:
+        '201':
+          description: Returns the external product
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProduct"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: External product cannot be created 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: []
   "/external_products/{external_product_id}":
     parameters:
     - "$ref": "#/components/parameters/external_product_id"
@@ -7773,6 +7815,181 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+    put:
+      tags:
+      - external_products
+      operationId: update_external_product
+      summary: Update an external product
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/ExternalProductUpdate"
+        required: true
+      responses:
+        '200':
+          description: Settings for an external product.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProduct"
+        '404':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    delete:
+      tags:
+      - external_products
+      operationId: deactivate_external_products
+      summary: Deactivate an external product
+      description: Deactivate an external product.
+      responses:
+        '200':
+          description: Deactivated external product.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProduct"
+        '404':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_products/{external_product_id}/external_product_references":
+    parameters:
+    - "$ref": "#/components/parameters/external_product_id"
+    get:
+      tags:
+      - external_product_references
+      operationId: list_external_product_external_product_references
+      summary: List the external product references for an external product
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      responses:
+        '200':
+          description: A list of the the external product references for an external
+            product.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductReferenceCollection"
+        '404':
+          description: Incorrect site or external product ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    post:
+      tags:
+      - external_product_references
+      operationId: create_external_product_external_product_reference
+      summary: Create an external product reference on an external product
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/ExternalProductReferenceCreate"
+        required: true
+      responses:
+        '201':
+          description: Details for the external product reference.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_products/{external_product_id}/external_product_references/{external_product_reference_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_product_id"
+    - "$ref": "#/components/parameters/external_product_reference_id"
+    get:
+      tags:
+      - external_product_references
+      operationId: get_external_product_external_product_reference
+      summary: Fetch an external product reference
+      responses:
+        '200':
+          description: Details for an external product reference.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        '404':
+          description: Incorrect site or external product ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+    delete:
+      tags:
+      - external_product_references
+      operationId: deactivate_external_product_external_product_reference
+      summary: Deactivate an external product reference
+      responses:
+        '200':
+          description: Details for an external product reference.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        '404':
+          description: Incorrect site or external product reference ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/external_subscriptions":
     get:
       tags:
@@ -16014,6 +16231,13 @@ components:
       required: true
       schema:
         type: string
+    external_product_reference_id:
+      name: external_product_reference_id
+      in: path
+      description: External product reference ID, e.g. `d39iun2fw1v4`.
+      required: true
+      schema:
+        type: string
     external_subscription_id:
       name: external_subscription_id
       in: path
@@ -23220,6 +23444,73 @@ components:
           type: array
           items:
             "$ref": "#/components/schemas/ExternalProduct"
+    ExternalProductCreate:
+      type: object
+      properties:
+        name:
+          type: string
+          description: External product name.
+        plan_id:
+          type: string
+          description: Recurly plan UUID.
+        external_product_references:
+          type: array
+          title: External Product References
+          description: List of external product references of the external product.
+          items:
+            "$ref": "#/components/schemas/ExternalProductReferenceBase"
+      required:
+      - name
+    ExternalProductUpdate:
+      type: object
+      properties:
+        plan_id:
+          type: string
+          description: Recurly plan UUID.
+      required:
+      - plan_id
+    ExternalProductReferenceBase:
+      type: object
+      properties:
+        reference_code:
+          type: string
+          description: 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.
+          maxLength: 255
+        external_connection_type:
+          "$ref": "#/components/schemas/ExternalProductReferenceConnectionTypeEnum"
+    ExternalProductReferenceCollection:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/ExternalProductReferenceMini"
+    ExternalProductReferenceCreate:
+      allOf:
+      - "$ref": "#/components/schemas/ExternalProductReferenceBase"
+      required:
+      - reference_code
+      - external_connection_type
+    ExternalProductReferenceUpdate:
+      allOf:
+      - "$ref": "#/components/schemas/ExternalProductReferenceBase"
+    ExternalProductReferenceConnectionTypeEnum:
+      type: string
+      enum:
+      - apple_app_store
+      - google_play_store
     ExternalAccountList:
       type: object
       properties:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.36.0
+  version: 4.37.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,10 @@ 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_product_create.rb
+- lib/recurly/requests/external_product_reference_base.rb
+- lib/recurly/requests/external_product_reference_create.rb
+- lib/recurly/requests/external_product_update.rb
 - lib/recurly/requests/external_refund.rb
 - lib/recurly/requests/external_transaction.rb
 - lib/recurly/requests/gateway_attributes.rb
@@ -263,6 +267,7 @@ files:
 - lib/recurly/resources/external_charge.rb
 - lib/recurly/resources/external_invoice.rb
 - lib/recurly/resources/external_product.rb
+- lib/recurly/resources/external_product_reference_collection.rb
 - lib/recurly/resources/external_product_reference_mini.rb
 - lib/recurly/resources/external_subscription.rb
 - lib/recurly/resources/fraud_info.rb
@@ -338,7 +343,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.36.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.37.0
 post_install_message: 
 rdoc_options: []
 require_paths: