recurly 4.30.0 → 4.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 390709441aca5c09d9488d70631d5ff3a14d9df4e6d56d8604f615f421331e85
-  data.tar.gz: c9a9c5d0b0c8b697f0a2261c431f7018e87eed5246c06ade654f7987a8bfde81
+  metadata.gz: 84747761025eb90c7de66e7da62fe6cce9fd058e278adf1d6038eb6fc492b5f3
+  data.tar.gz: 441ffabcdcf6ae892d45d5074a44b56661a583701e543226bf8c2a70ccfce467
 SHA512:
-  metadata.gz: e9d31be321f4acaf50a1fcabddd241b37228a11685e547ebbd9549474a2488ccb6e83e552e78cfad1b2fd9a543c697b0bd9d73507f7ec536a65ed2022ab1c758
-  data.tar.gz: e767216dc486c50859f051d5788fd1b28a86950d1f178bad2ee4c9baf18ff4d20d7cf58be6bd25f2f7433257997c352c09587951109d0de4a615203d4f27638a
+  metadata.gz: 4910840cf085df49e2209b71dfd623296a824dff3069711eccd8b2ccb50576d821b637fa4d6fd50341361a92d5d3d9a03af6d914b2dcd33266ccea38cb19a9cd
+  data.tar.gz: bb57c2e12770d33591b37589d89f26bf75f56c89ee005f28a4c05bb5535d0a48b7d6b767c99fb2929a2b696ed9b14a5343177f3d08642f92d4fd37b8b8d9c240

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [4.31.0](https://github.com/recurly/recurly-client-ruby/tree/4.31.0) (2023-03-29)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.30.0...4.31.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (External Invoices) [#831](https://github.com/recurly/recurly-client-ruby/pull/831) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.30.0](https://github.com/recurly/recurly-client-ruby/tree/4.30.0) (2023-02-22)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.29.0...4.30.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.30'
+gem 'recurly', '~> 4.31'
 ```
 
 > *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

@@ -750,6 +750,26 @@ module Recurly
       pager(path, **options)
     end
 
+    # List the external invoices on an account
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_invoices list_account_external_invoices api documentation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @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.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #
+    # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on an account.
+    #
+    def list_account_external_invoices(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/external_invoices", account_id: account_id)
+      pager(path, **options)
+    end
+
     # List an account's invoices
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documentation}
@@ -2109,6 +2129,26 @@ module Recurly
       get(path, **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}
+    #
+    # @param external_subscription_id [String] External subscription 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.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #
+    # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on a site.
+    #
+    def list_external_subscription_external_invoices(external_subscription_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_invoices", external_subscription_id: external_subscription_id)
+      pager(path, **options)
+    end
+
     # List a site's invoices
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
@@ -4179,6 +4219,39 @@ module Recurly
       get(path, **options)
     end
 
+    # List the external invoices on a site
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_invoices list_external_invoices api documentation}
+    #
+    # @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.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #
+    # @return [Pager<Resources::ExternalInvoice>] A list of the the external_invoices on a site.
+    #
+    def list_external_invoices(**options)
+      path = "/external_invoices"
+      pager(path, **options)
+    end
+
+    # Fetch an external invoice
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/show_external_invoice show_external_invoice api documentation}
+    #
+    # @param external_invoice_id [String] External invoice ID, e.g. +e28zov4fw0v2+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalInvoice] Returns the external invoice
+    #
+    def show_external_invoice(external_invoice_id:, **options)
+      path = interpolate_path("/external_invoices/{external_invoice_id}", external_invoice_id: external_invoice_id)
+      get(path, **options)
+    end
+
     # List entitlements granted to an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}

data/lib/recurly/resources/external_charge.rb

@@ -0,0 +1,50 @@
+# 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 ExternalCharge < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external charge was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String]
+      define_attribute :description, String
+
+      # @!attribute external_product_reference
+      #   @return [ExternalProductReferenceMini] External Product Reference details
+      define_attribute :external_product_reference, :ExternalProductReferenceMini
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external charge ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute quantity
+      #   @return [Integer]
+      define_attribute :quantity, Integer
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit Amount
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external charge was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/external_invoice.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 Resources
+    class ExternalInvoice < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external invoice was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute external_id
+      #   @return [String] An identifier which associates the external invoice to a corresponding object in an external platform.
+      define_attribute :external_id, String
+
+      # @!attribute external_subscription
+      #   @return [ExternalSubscription] Subscription from an external resource such as Apple App Store or Google Play Store.
+      define_attribute :external_subscription, :ExternalSubscription
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external invoice ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute line_items
+      #   @return [Array[ExternalCharge]]
+      define_attribute :line_items, Array, { :item_type => :ExternalCharge }
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute purchased_at
+      #   @return [DateTime] When the invoice was created in the external platform.
+      define_attribute :purchased_at, DateTime
+
+      # @!attribute state
+      #   @return [String]
+      define_attribute :state, String
+
+      # @!attribute total
+      #   @return [Float] Total
+      define_attribute :total, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external invoice was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.30.0"
+  VERSION = "4.31.0"
 end

data/openapi/api.yaml

@@ -200,6 +200,7 @@ x-tagGroups:
   - usage
   - automated_exports
   - external_subscriptions
+  - external_invoices
   - external_products
   - gift_cards
 - name: Products and Promotions
@@ -346,6 +347,11 @@ tags:
   description: A subscription 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_invoices
+  x-displayName: External Invoices
+  description: An invoice 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_products
   x-displayName: External Product
   description: A product from an external resource that is not managed by the Recurly
@@ -3244,6 +3250,40 @@ paths:
           := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next
           page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, creditPayment := range creditPayments.Data()
           {\n\t\tfmt.Printf(\"Account Credit Payment %3d: %s\\n\",\n\t\t\ti,\n\t\t\tcreditPayment.Id,\n\t\t)\n\t}\n}"
+  "/accounts/{account_id}/external_invoices":
+    parameters:
+    - "$ref": "#/components/parameters/account_id"
+    get:
+      tags:
+      - account
+      operationId: list_account_external_invoices
+      summary: List the external invoices on an account
+      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"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      responses:
+        '200':
+          description: A list of the the external_invoices on an account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalInvoiceList"
+        '404':
+          description: Incorrect account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/accounts/{account_id}/invoices":
     get:
       tags:
@@ -7588,6 +7628,40 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/external_subscriptions/{external_subscription_id}/external_invoices":
+    parameters:
+    - "$ref": "#/components/parameters/external_subscription_id"
+    get:
+      tags:
+      - external_subscriptions
+      operationId: list_external_subscription_external_invoices
+      summary: List the external invoices on an external subscription
+      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"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      responses:
+        '200':
+          description: A list of the the external_invoices on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalInvoiceList"
+        '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: []
   "/invoices":
     get:
       tags:
@@ -15346,6 +15420,72 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/external_invoices":
+    get:
+      tags:
+      - external_invoices
+      operationId: list_external_invoices
+      summary: List the external invoices on a site
+      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"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      responses:
+        '200':
+          description: A list of the the external_invoices on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalInvoiceList"
+        '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_invoices/{external_invoice_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_invoice_id"
+    get:
+      tags:
+      - external_invoices
+      operationId: show_external_invoice
+      summary: Fetch an external invoice
+      responses:
+        '201':
+          description: Returns the external invoice
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalInvoice"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: External invoice cannot be found 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: []
   "/accounts/{account_id}/entitlements":
     parameters:
     - "$ref": "#/components/parameters/account_id"
@@ -15643,6 +15783,13 @@ components:
       required: true
       schema:
         type: string
+    external_invoice_id:
+      name: external_invoice_id
+      in: path
+      description: External invoice ID, e.g. `e28zov4fw0v2`.
+      required: true
+      schema:
+        type: string
     external_product_id:
       name: external_product_id
       in: path
@@ -22918,6 +23065,110 @@ components:
           type: array
           items:
             "$ref": "#/components/schemas/ExternalSubscription"
+    ExternalInvoice:
+      type: object
+      description: Invoice from an external resource such as Apple App Store or Google
+        Play Store.
+      properties:
+        id:
+          type: string
+          title: External invoice ID
+          description: System-generated unique identifier for an external invoice
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        account:
+          "$ref": "#/components/schemas/AccountMini"
+        external_subscription:
+          "$ref": "#/components/schemas/ExternalSubscription"
+        external_id:
+          type: string
+          description: An identifier which associates the external invoice to a corresponding
+            object in an external platform.
+        state:
+          "$ref": "#/components/schemas/ExternalInvoiceStateEnum"
+        total:
+          type: number
+          format: float
+          title: Total
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+        line_items:
+          type: array
+          items:
+            "$ref": "#/components/schemas/ExternalCharge"
+        purchased_at:
+          type: string
+          format: date-time
+          description: When the invoice was created in the external platform.
+        created_at:
+          type: string
+          format: date-time
+          description: When the external invoice was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          title: Updated at
+          description: When the external invoice was updated in Recurly.
+    ExternalInvoiceList:
+      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/ExternalInvoice"
+    ExternalCharge:
+      type: object
+      description: Charge from an external resource such as Apple App Store or Google
+        Play Store.
+      properties:
+        id:
+          type: string
+          title: External invoice ID
+          description: System-generated unique identifier for an external charge ID,
+            e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        account:
+          "$ref": "#/components/schemas/AccountMini"
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+        unit_amount:
+          type: number
+          format: float
+          title: Unit Amount
+        quantity:
+          type: integer
+        description:
+          type: string
+        external_product_reference:
+          "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          description: When the external charge was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          title: Updated at
+          description: When the external charge was updated in Recurly.
     CustomerPermission:
       type: object
       properties:
@@ -24276,3 +24527,7 @@ components:
       enum:
       - ideal
       - sofort
+    ExternalInvoiceStateEnum:
+      type: string
+      enum:
+      - paid

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.30.0
+  version: 4.31.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -256,6 +256,8 @@ files:
 - lib/recurly/resources/export_dates.rb
 - lib/recurly/resources/export_file.rb
 - lib/recurly/resources/export_files.rb
+- lib/recurly/resources/external_charge.rb
+- lib/recurly/resources/external_invoice.rb
 - lib/recurly/resources/external_product.rb
 - lib/recurly/resources/external_product_reference_mini.rb
 - lib/recurly/resources/external_subscription.rb
@@ -331,7 +333,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.30.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.31.0
 post_install_message: 
 rdoc_options: []
 require_paths: