recurly 4.23.0 → 4.25.0

data/openapi/api.yaml

@@ -57,7 +57,7 @@ info:
 
     We encourage you to update to the latest version of the API and corresponding client library,
     as most recent versions are more performant than their predecessors. See the
-    [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
+    [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
     introduced in the latest API version.
 
     ### Default Versions
@@ -114,7 +114,7 @@ info:
     Please consider changing these messages in the target system to be better
     suited to the audience of the system.
 
-    Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+    Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
 
     ## Pagination
     ### Response Schema
@@ -181,7 +181,7 @@ info:
 
     ## Change Log
 
-    A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version).
+    A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2021-02-25---current-ga-version).
   version: v2021-02-25
 security:
 - api_key: []
@@ -199,6 +199,8 @@ x-tagGroups:
   - purchase
   - usage
   - automated_exports
+  - external_subscriptions
+  - external_products
 - name: Products and Promotions
   tags:
   - item
@@ -338,6 +340,16 @@ tags:
 - name: dunning_campaigns
   x-displayName: Dunning Campaigns
   description: Settings used when attempting to dun customers whose payments are declined.
+- name: external_subscriptions
+  x-displayName: External Subscription
+  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 Store
+    and Google Play.
+- name: external_products
+  x-displayName: External Product
+  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 Store and
+    Google Play.
 paths:
   "/sites":
     get:
@@ -2694,7 +2706,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
-      summary: Show the coupon redemptions for an account
+      summary: List the coupon redemptions for an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -2791,7 +2803,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_active_coupon_redemptions
-      summary: Show the coupon redemptions that are active on an account
+      summary: List the coupon redemptions that are active on an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -3944,7 +3956,7 @@ paths:
       tags:
       - note
       operationId: list_account_notes
-      summary: Fetch a list of an account's notes
+      summary: List an account's notes
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -7442,6 +7454,129 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/external_products":
+    get:
+      tags:
+      - external_products
+      operationId: list_external_products
+      summary: List a site's external products
+      description: See the [Pagination Guide](/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_products on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductList"
+        '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}":
+    parameters:
+    - "$ref": "#/components/parameters/external_product_id"
+    get:
+      tags:
+      - external_products
+      operationId: get_external_product
+      summary: Fetch an external product
+      responses:
+        '200':
+          description: Settings for an external product.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProduct"
+        '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: []
+  "/external_subscriptions":
+    get:
+      tags:
+      - external_subscriptions
+      operationId: list_external_subscriptions
+      summary: List a site's external subscriptions
+      description: See the [Pagination Guide](/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_subscriptions on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscriptionList"
+        '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_subscriptions/{external_subscription_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_subscription_id"
+    get:
+      tags:
+      - external_subscriptions
+      operationId: get_external_subscription
+      summary: Fetch an external subscription
+      responses:
+        '200':
+          description: Settings for an external subscription.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscription"
+        '404':
+          description: Incorrect site or external subscription ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Validation error with external resource connection or feature
+            flag.
+          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:
@@ -8742,7 +8877,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
-      summary: Show the coupon redemptions applied to an invoice
+      summary: List the coupon redemptions applied to an invoice
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -13327,7 +13462,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
-      summary: Show the coupon redemptions for a subscription
+      summary: List the coupon redemptions for a subscription
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14907,7 +15042,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: list_dunning_campaigns
-      summary: Show the dunning campaigns for a site
+      summary: List the dunning campaigns for a site
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14939,7 +15074,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: get_dunning_campaign
-      summary: Show the settings for a dunning campaign
+      summary: Fetch a dunning campaign
       responses:
         '200':
           description: Settings for a dunning campaign.
@@ -15042,7 +15177,7 @@ paths:
       tags:
       - invoice_templates
       operationId: get_invoice_template
-      summary: Show the settings for an invoice template
+      summary: Fetch an invoice template
       responses:
         '200':
           description: Settings for an invoice template.
@@ -15077,7 +15212,7 @@ paths:
       tags:
       - account
       operationId: list_entitlements
-      summary: Show all entitlements granted to an account
+      summary: List entitlements granted to an account
       responses:
         '200':
           description: A list of the entitlements granted to an account.
@@ -15098,6 +15233,38 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/accounts/{account_id}/external_subscriptions":
+    parameters:
+    - "$ref": "#/components/parameters/account_id"
+    get:
+      tags:
+      - account
+      operationId: list_account_external_subscriptions
+      summary: List an account's external subscriptions
+      description: See the [Pagination Guide](/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_subscriptions on an account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscriptionList"
+        '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: []
 servers:
 - url: https://v3.recurly.com
 - url: https://v3.eu.recurly.com
@@ -15165,6 +15332,20 @@ components:
       required: true
       schema:
         type: string
+    external_product_id:
+      name: external_product_id
+      in: path
+      description: External product id
+      required: true
+      schema:
+        type: string
+    external_subscription_id:
+      name: external_subscription_id
+      in: path
+      description: External subscription id
+      required: true
+      schema:
+        type: string
     invoice_template_id:
       name: invoice_template_id
       in: path
@@ -16369,6 +16550,8 @@ components:
           "$ref": "#/components/schemas/AddOnTypeEnum"
         usage_type:
           "$ref": "#/components/schemas/UsageTypeEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_percentage:
           type: number
           format: float
@@ -16522,6 +16705,8 @@ components:
           "$ref": "#/components/schemas/AddOnTypeCreateEnum"
         usage_type:
           "$ref": "#/components/schemas/UsageTypeCreateEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_percentage:
           type: number
           format: float
@@ -16682,6 +16867,8 @@ components:
             This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
             if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage.
             Must be omitted otherwise.
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         measured_unit_id:
           type: string
           title: Measured Unit ID
@@ -16882,7 +17069,7 @@ components:
         token_id:
           type: string
           title: Token ID
-          description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+          description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
           maxLength: 22
         first_name:
           type: string
@@ -19090,6 +19277,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19260,6 +19449,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19474,6 +19665,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -20401,6 +20594,8 @@ components:
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
         tier_type:
           "$ref": "#/components/schemas/TierTypeEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_timeframe:
           "$ref": "#/components/schemas/UsageTimeframeEnum"
         tiers:
@@ -20491,7 +20686,7 @@ components:
             If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
             must include one to many tiers with `ending_quantity` and `unit_amount`.
             There must be one tier without an `ending_quantity` value which represents the final tier.
-            See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+            See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
         percentage_tiers:
           type: array
@@ -20512,7 +20707,7 @@ components:
           description: The percentage taken of the monetary amount of usage tracked.
             This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
             if `add_on_type` is usage and `usage_type` is percentage. Must be omitted
-            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
+            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
             for an overview of how to configure usage add-ons.
         revenue_schedule_type:
           title: Revenue schedule type
@@ -22175,6 +22370,184 @@ components:
           type: string
           format: date-time
           description: Time the object was last updated
+    ExternalProduct:
+      type: object
+      description: Product from an external resource such as Apple App or Google Play.
+      properties:
+        id:
+          type: string
+          title: External product ID.
+          description: System-generated unique identifier for an external product
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        name:
+          type: string
+          title: Name
+          description: Name to identify the external product in Recurly.
+        plan:
+          "$ref": "#/components/schemas/PlanMini"
+        created_at:
+          type: string
+          format: date-time
+          description: When the external product was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the external product was updated in Recurly.
+        external_product_references:
+          type: array
+          title: External Product References
+          description: List of external product references of the external product.
+          items:
+            "$ref": "#/components/schemas/ExternalProductReferenceMini"
+    ExternalProductList:
+      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/ExternalProduct"
+    ExternalProductReferenceMini:
+      type: object
+      title: External Product Reference details
+      description: External Product Reference details
+      properties:
+        id:
+          type: string
+          title: External Product ID
+          description: System-generated unique identifier for an external product
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: object
+        reference_code:
+          type: string
+          title: reference_code
+          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.
+        external_connection_type:
+          type: string
+          title: external_connection_type
+          description: Source connection platform.
+        created_at:
+          type: string
+          format: date-time
+          description: When the external product was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the external product was updated in Recurly.
+    ExternalSubscription:
+      type: object
+      description: Subscription from an external resource such as Apple App or Google
+        Play.
+      properties:
+        id:
+          type: string
+          title: External subscription ID
+          description: System-generated unique identifier for an external subscription
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        account:
+          "$ref": "#/components/schemas/AccountMini"
+        external_resource:
+          "$ref": "#/components/schemas/ExternalResourceMini"
+        external_product_reference:
+          "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        last_purchased:
+          type: string
+          format: date-time
+          title: Last purchased
+          description: When a new billing event occurred on the external subscription
+            in conjunction with a recent billing period, reactivation or upgrade/downgrade.
+        auto_renew:
+          type: boolean
+          title: Auto-renew
+          description: An indication of whether or not the external subscription will
+            auto-renew at the expiration date.
+          default: false
+        app_identifier:
+          type: string
+          title: App identifier
+          description: Identifier of the app that generated the external subscription.
+        quantity:
+          type: integer
+          title: Quantity
+          description: An indication of the quantity of a subscribed item's quantity.
+          default: 1
+          minimum: 0
+        activated_at:
+          type: string
+          format: date-time
+          title: Activated at
+          description: When the external subscription was activated in the external
+            platform.
+        expires_at:
+          type: string
+          format: date-time
+          title: Expires at
+          description: When the external subscription expires in the external platform.
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          description: When the external subscription was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          title: Updated at
+          description: When the external subscription was updated in Recurly.
+    ExternalSubscriptionList:
+      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/ExternalSubscription"
+    ExternalResourceMini:
+      type: object
+      title: External Resource mini details
+      properties:
+        id:
+          type: string
+          title: External resource ID
+          description: System-generated unique identifier for an external resource
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        external_object_reference:
+          type: string
+          title: External Object Reference
+          description: Identifier or URL reference where the resource is canonically
+            available in the external platform.
+          maxLength: 255
+          readOnly: true
     CustomerPermission:
       type: object
       properties:
@@ -22367,6 +22740,7 @@ components:
       enum:
       - account
       - item
+      - plan
       - subscription
     RefundTypeEnum:
       type: string
@@ -22392,6 +22766,15 @@ components:
       - percentage
       title: Usage Type
       description: Type of usage, returns usage type if `add_on_type` is `usage`.
+    UsageCalculationTypeEnum:
+      type: string
+      description: The type of calculation to be employed for an add-on.  Cumulative
+        billing will sum all usage records created in the current billing cycle.  Last-in-period
+        billing will apply only the most recent usage record in the billing period.  If
+        no value is specified, cumulative billing will be used.
+      enum:
+      - cumulative
+      - last_in_period
     BillingStatusEnum:
       type: string
       default: unbilled
@@ -22596,7 +22979,7 @@ components:
       title: Usage Type
       description: |
         Type of usage, required if `add_on_type` is `usage`. See our
-        [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an
+        [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an
         overview of how to configure usage add-ons.
     TierTypeEnum:
       type: string
@@ -22604,7 +22987,7 @@ components:
       description: |
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
       default: flat
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.23.0
+  version: 4.25.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - lib/recurly/errors.rb
 - lib/recurly/errors/api_errors.rb
 - lib/recurly/errors/network_errors.rb
+- lib/recurly/errors/webhooks_errors.rb
 - lib/recurly/http.rb
 - lib/recurly/pager.rb
 - lib/recurly/request.rb
@@ -251,6 +252,10 @@ files:
 - lib/recurly/resources/export_dates.rb
 - lib/recurly/resources/export_file.rb
 - lib/recurly/resources/export_files.rb
+- lib/recurly/resources/external_product.rb
+- lib/recurly/resources/external_product_reference_mini.rb
+- lib/recurly/resources/external_resource_mini.rb
+- lib/recurly/resources/external_subscription.rb
 - lib/recurly/resources/fraud_info.rb
 - lib/recurly/resources/granted_by.rb
 - lib/recurly/resources/invoice.rb
@@ -304,6 +309,7 @@ files:
 - lib/recurly/schema/schema_factory.rb
 - lib/recurly/schema/schema_validator.rb
 - lib/recurly/version.rb
+- lib/recurly/webhooks.rb
 - openapi/api.yaml
 - recurly.gemspec
 - scripts/build
@@ -320,7 +326,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.23.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.25.0
 post_install_message: 
 rdoc_options: []
 require_paths: