Generated Latest Changes for v2021-02-25

lib/recurly.d.ts

@@ -2257,7 +2257,7 @@ export declare class CustomFieldDefinition {
    */
   name?: string | null;
   /**
-   * The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. 
+   * The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console. 
    */
   userAccess?: string | null;
   /**
@@ -2488,14 +2488,14 @@ export declare class ExternalSubscription {
    * Account mini details
    */
   account?: AccountMini | null;
-  /**
-   * External Resource mini details
-   */
-  externalResource?: ExternalResourceMini | null;
   /**
    * External Product Reference details
    */
   externalProductReference?: ExternalProductReferenceMini | null;
+  /**
+   * The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
+   */
+  externalId?: string | null;
   /**
    * When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
    */
@@ -2512,6 +2512,10 @@ export declare class ExternalSubscription {
    * An indication of the quantity of a subscribed item's quantity.
    */
   quantity?: number | null;
+  /**
+   * External subscriptions can be active, canceled, expired, or future.
+   */
+  state?: string | null;
   /**
    * When the external subscription was activated in the external platform.
    */
@@ -2531,22 +2535,6 @@ export declare class ExternalSubscription {
 
 }
 
-export declare class ExternalResourceMini {
-  /**
-   * System-generated unique identifier for an external resource ID, e.g. `e28zov4fw0v2`.
-   */
-  id?: string | null;
-  /**
-   * Object type
-   */
-  object?: string | null;
-  /**
-   * Identifier or URL reference where the resource is canonically available in the external platform.
-   */
-  externalObjectReference?: string | null;
-
-}
-
 export declare class BinaryFile {
   data?: string | null;
 

lib/recurly/resources/CustomFieldDefinition.js

@@ -21,7 +21,7 @@ const Resource = require('../Resource')
  * @prop {string} relatedType - Related Recurly object type
  * @prop {string} tooltip - Displayed as a tooltip when editing the field in the Recurly admin UI.
  * @prop {Date} updatedAt - Last updated at
- * @prop {string} userAccess - The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+ * @prop {string} userAccess - The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
  */
 class CustomFieldDefinition extends Resource {
   static getSchema () {

lib/recurly/resources/ExternalSubscription.js

@@ -18,12 +18,13 @@ const Resource = require('../Resource')
  * @prop {boolean} autoRenew - An indication of whether or not the external subscription will auto-renew at the expiration date.
  * @prop {Date} createdAt - When the external subscription was created in Recurly.
  * @prop {Date} expiresAt - When the external subscription expires in the external platform.
+ * @prop {string} externalId - The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
  * @prop {ExternalProductReferenceMini} externalProductReference - External Product Reference details
- * @prop {ExternalResourceMini} externalResource - External Resource mini details
  * @prop {string} id - System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
  * @prop {Date} lastPurchased - When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
  * @prop {string} object - Object type
  * @prop {number} quantity - An indication of the quantity of a subscribed item's quantity.
+ * @prop {string} state - External subscriptions can be active, canceled, expired, or future.
  * @prop {Date} updatedAt - When the external subscription was updated in Recurly.
  */
 class ExternalSubscription extends Resource {
@@ -35,12 +36,13 @@ class ExternalSubscription extends Resource {
       autoRenew: Boolean,
       createdAt: Date,
       expiresAt: Date,
+      externalId: String,
       externalProductReference: 'ExternalProductReferenceMini',
-      externalResource: 'ExternalResourceMini',
       id: String,
       lastPurchased: Date,
       object: String,
       quantity: Number,
+      state: String,
       updatedAt: Date
     }
   }

lib/recurly/resources/index.js

@@ -66,7 +66,6 @@ module.exports.MeasuredUnit = require('./MeasuredUnit')
 module.exports.ExternalProduct = require('./ExternalProduct')
 module.exports.ExternalProductReferenceMini = require('./ExternalProductReferenceMini')
 module.exports.ExternalSubscription = require('./ExternalSubscription')
-module.exports.ExternalResourceMini = require('./ExternalResourceMini')
 module.exports.BinaryFile = require('./BinaryFile')
 module.exports.Plan = require('./Plan')
 module.exports.PlanRampInterval = require('./PlanRampInterval')

openapi/api.yaml

@@ -228,8 +228,8 @@ tags:
   x-displayName: Site
 - name: custom_field_definition
   x-displayName: Custom Field Definition
-  description: Describes the fields that can use used as custom fields on accounts
-    or subscriptions.
+  description: Describes the fields that can be used as custom fields on accounts,
+    items, line-items (one time charges), plans, or subscriptions.
 - name: item
   x-displayName: Item
   description: |-
@@ -18211,6 +18211,7 @@ components:
             - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but
               editing will only be available via the API.
             - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+            - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
           "$ref": "#/components/schemas/UserAccessEnum"
         display_name:
           type: string
@@ -22846,10 +22847,13 @@ components:
           title: Object type
         account:
           "$ref": "#/components/schemas/AccountMini"
-        external_resource:
-          "$ref": "#/components/schemas/ExternalResourceMini"
         external_product_reference:
           "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        external_id:
+          type: string
+          title: External Id
+          description: The id of the subscription in the external systems., I.e. Apple
+            App Store or Google Play Store.
         last_purchased:
           type: string
           format: date-time
@@ -22872,6 +22876,10 @@ components:
           description: An indication of the quantity of a subscribed item's quantity.
           default: 1
           minimum: 0
+        state:
+          type: string
+          description: External subscriptions can be active, canceled, expired, or
+            future.
         activated_at:
           type: string
           format: date-time
@@ -22910,25 +22918,6 @@ components:
           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:
@@ -23673,6 +23662,7 @@ components:
       - api_only
       - read_only
       - write
+      - set_only
     PricingModelTypeEnum:
       type: string
       enum: