@ricado/api-client 2.7.8 → 2.7.9

package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js

@@ -274,6 +274,8 @@ var _default = RejectBinScaleController;
  * @property {?number} printerGroupId The FreshPack Printer Group ID to be used when Printing Multi-Grower Bin Cards for this Reject Bin Scale
  * @property {boolean} binCardPrintingEnabled Whether Bin Card Printing is Enabled
  * @property {boolean} [useWindowsDriverApi] Whether Bin Card Printing should use the Specialized FreshPack Windows Driver API
+ * @property {?boolean} [forceSingleClassType] Whether the Net Weight should be used as a single Forced Class Type when creating Multi-Grower Bins and Weights
+ * @property {?string} [forcedClassType] The Forced Class Type of Net Weights when Enabled
  * @memberof Controllers.Packhouse.Site
  */
 

package/lib/Controllers/UserAccountActionTokenController.js

@@ -433,6 +433,8 @@ var _default = UserAccountActionTokenController;
  * @property {?Date} [activityTimestamp] When the last API call using this Action Token was made
  * @property {?Date} [completedTimestamp] When the Action was Completed
  * @property {?Date} [emailTimestamp] When the Action Email was Sent
+ * @property {UserAccountActionTokenController.RequestMetadata} [issueMetadata] Metadata from the Request that generated this Action Token
+ * @property {UserAccountActionTokenController.RequestMetadata} [consumeMetadata] Metadata from the Request that consumed this Action Token
  * @memberof Controllers
  */
 
@@ -443,6 +445,19 @@ var _default = UserAccountActionTokenController;
  * @property {?Date} [activityTimestamp] When the last API call using this Action Token was made
  * @property {?Date} [completedTimestamp] When the Action was Completed
  * @property {?Date} [emailTimestamp] When the Action Email was Sent
+ * @property {UserAccountActionTokenController.RequestMetadata} [consumeMetadata] Metadata from the Request that consumed this Action Token
+ * @memberof Controllers
+ */
+
+/**
+ * A **RequestMetadata** Type
+ * 
+ * @typedef {Object} UserAccountActionTokenController.RequestMetadata
+ * @property {?string} ipAddress The IP Address of the Requester
+ * @property {?string} userAgent The User-Agent of the Requester
+ * @property {?string} cloudflareRayId The Cloudflare Ray ID from the Request
+ * @property {?string} host The Host header from the Request
+ * @property {?string} referrer The Referrer header from the Request
  * @memberof Controllers
  */
 

package/lib/Models/Packhouse/Site/RejectBinScaleModel.js

@@ -264,7 +264,7 @@ var RejectBinScaleModel = /*#__PURE__*/function (_BaseModel) {
     /**
      * The FreshPack Integration Configuration for this Reject Bin Scale
      * 
-     * @type {?{points: Object, enabled: boolean, materialGroupId: ?number, binTypeId: number, printerGroupId: ?number, binCardPrintingEnabled: boolean, useWindowsDriverApi: boolean}}
+     * @type {?{points: Object, enabled: boolean, materialGroupId: ?number, binTypeId: number, printerGroupId: ?number, binCardPrintingEnabled: boolean, useWindowsDriverApi: boolean, forceSingleClassType: ?boolean, forcedClassType: ?string}}
      * @public
      */
 
@@ -1226,6 +1226,38 @@ var RejectBinScaleModel = /*#__PURE__*/function (_BaseModel) {
             freshPackIntegrationObject.useWindowsDriverApi = false;
           }
 
+          if (_typeof(jsonObject['freshPackIntegration']) === 'object' && 'forceSingleClassType' in jsonObject['freshPackIntegration']) {
+            freshPackIntegrationObject.forceSingleClassType = function () {
+              if (jsonObject['freshPackIntegration'].forceSingleClassType === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['freshPackIntegration'].forceSingleClassType !== 'boolean') {
+                return Boolean(jsonObject['freshPackIntegration'].forceSingleClassType);
+              }
+
+              return jsonObject['freshPackIntegration'].forceSingleClassType;
+            }();
+          } else {
+            freshPackIntegrationObject.forceSingleClassType = null;
+          }
+
+          if (_typeof(jsonObject['freshPackIntegration']) === 'object' && 'forcedClassType' in jsonObject['freshPackIntegration']) {
+            freshPackIntegrationObject.forcedClassType = function () {
+              if (jsonObject['freshPackIntegration'].forcedClassType === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['freshPackIntegration'].forcedClassType !== 'string') {
+                return String(jsonObject['freshPackIntegration'].forcedClassType);
+              }
+
+              return jsonObject['freshPackIntegration'].forcedClassType;
+            }();
+          } else {
+            freshPackIntegrationObject.forcedClassType = null;
+          }
+
           return freshPackIntegrationObject;
         }();
       }

package/lib/Models/TokenModel.js

@@ -118,6 +118,22 @@ var TokenModel = /*#__PURE__*/function (_BaseModel) {
      */
 
     _this.lockTimestamp = null;
+    /**
+     * Metadata from the Request that generated this Token
+     * 
+     * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+     * @public
+     */
+
+    _this.issueMetadata = function () {
+      var issueMetadataDefaultValue = {};
+      issueMetadataDefaultValue.ipAddress = null;
+      issueMetadataDefaultValue.userAgent = null;
+      issueMetadataDefaultValue.cloudflareRayId = null;
+      issueMetadataDefaultValue.host = null;
+      issueMetadataDefaultValue.referrer = null;
+      return issueMetadataDefaultValue;
+    }();
     /**
      * Whether the Token has been deleted
      * 
@@ -125,6 +141,7 @@ var TokenModel = /*#__PURE__*/function (_BaseModel) {
      * @public
      */
 
+
     _this.deleted = false;
     /**
      * When the Token was last updated
@@ -256,6 +273,94 @@ var TokenModel = /*#__PURE__*/function (_BaseModel) {
         }();
       }
 
+      if ('issueMetadata' in jsonObject) {
+        model.issueMetadata = function () {
+          var issueMetadataObject = {};
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'ipAddress' in jsonObject['issueMetadata']) {
+            issueMetadataObject.ipAddress = function () {
+              if (jsonObject['issueMetadata'].ipAddress === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].ipAddress !== 'string') {
+                return String(jsonObject['issueMetadata'].ipAddress);
+              }
+
+              return jsonObject['issueMetadata'].ipAddress;
+            }();
+          } else {
+            issueMetadataObject.ipAddress = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'userAgent' in jsonObject['issueMetadata']) {
+            issueMetadataObject.userAgent = function () {
+              if (jsonObject['issueMetadata'].userAgent === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].userAgent !== 'string') {
+                return String(jsonObject['issueMetadata'].userAgent);
+              }
+
+              return jsonObject['issueMetadata'].userAgent;
+            }();
+          } else {
+            issueMetadataObject.userAgent = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'cloudflareRayId' in jsonObject['issueMetadata']) {
+            issueMetadataObject.cloudflareRayId = function () {
+              if (jsonObject['issueMetadata'].cloudflareRayId === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].cloudflareRayId !== 'string') {
+                return String(jsonObject['issueMetadata'].cloudflareRayId);
+              }
+
+              return jsonObject['issueMetadata'].cloudflareRayId;
+            }();
+          } else {
+            issueMetadataObject.cloudflareRayId = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'host' in jsonObject['issueMetadata']) {
+            issueMetadataObject.host = function () {
+              if (jsonObject['issueMetadata'].host === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].host !== 'string') {
+                return String(jsonObject['issueMetadata'].host);
+              }
+
+              return jsonObject['issueMetadata'].host;
+            }();
+          } else {
+            issueMetadataObject.host = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'referrer' in jsonObject['issueMetadata']) {
+            issueMetadataObject.referrer = function () {
+              if (jsonObject['issueMetadata'].referrer === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].referrer !== 'string') {
+                return String(jsonObject['issueMetadata'].referrer);
+              }
+
+              return jsonObject['issueMetadata'].referrer;
+            }();
+          } else {
+            issueMetadataObject.referrer = null;
+          }
+
+          return issueMetadataObject;
+        }();
+      }
+
       if ('deleted' in jsonObject) {
         model.deleted = function () {
           if (typeof jsonObject['deleted'] !== 'boolean') {

package/lib/Models/UserAccountActionTokenModel.js

@@ -126,6 +126,39 @@ var UserAccountActionTokenModel = /*#__PURE__*/function (_BaseModel) {
      */
 
     _this.emailTimestamp = null;
+    /**
+     * Metadata from the Request that generated this Action Token
+     * 
+     * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+     * @public
+     */
+
+    _this.issueMetadata = function () {
+      var issueMetadataDefaultValue = {};
+      issueMetadataDefaultValue.ipAddress = null;
+      issueMetadataDefaultValue.userAgent = null;
+      issueMetadataDefaultValue.cloudflareRayId = null;
+      issueMetadataDefaultValue.host = null;
+      issueMetadataDefaultValue.referrer = null;
+      return issueMetadataDefaultValue;
+    }();
+    /**
+     * Metadata from the Request that consumed this Action Token
+     * 
+     * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+     * @public
+     */
+
+
+    _this.consumeMetadata = function () {
+      var consumeMetadataDefaultValue = {};
+      consumeMetadataDefaultValue.ipAddress = null;
+      consumeMetadataDefaultValue.userAgent = null;
+      consumeMetadataDefaultValue.cloudflareRayId = null;
+      consumeMetadataDefaultValue.host = null;
+      consumeMetadataDefaultValue.referrer = null;
+      return consumeMetadataDefaultValue;
+    }();
     /**
      * Whether the User Account Action Token has been deleted
      * 
@@ -133,6 +166,7 @@ var UserAccountActionTokenModel = /*#__PURE__*/function (_BaseModel) {
      * @public
      */
 
+
     _this.deleted = false;
     /**
      * When the User Account Action Token was last updated
@@ -274,6 +308,182 @@ var UserAccountActionTokenModel = /*#__PURE__*/function (_BaseModel) {
         }();
       }
 
+      if ('issueMetadata' in jsonObject) {
+        model.issueMetadata = function () {
+          var issueMetadataObject = {};
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'ipAddress' in jsonObject['issueMetadata']) {
+            issueMetadataObject.ipAddress = function () {
+              if (jsonObject['issueMetadata'].ipAddress === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].ipAddress !== 'string') {
+                return String(jsonObject['issueMetadata'].ipAddress);
+              }
+
+              return jsonObject['issueMetadata'].ipAddress;
+            }();
+          } else {
+            issueMetadataObject.ipAddress = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'userAgent' in jsonObject['issueMetadata']) {
+            issueMetadataObject.userAgent = function () {
+              if (jsonObject['issueMetadata'].userAgent === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].userAgent !== 'string') {
+                return String(jsonObject['issueMetadata'].userAgent);
+              }
+
+              return jsonObject['issueMetadata'].userAgent;
+            }();
+          } else {
+            issueMetadataObject.userAgent = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'cloudflareRayId' in jsonObject['issueMetadata']) {
+            issueMetadataObject.cloudflareRayId = function () {
+              if (jsonObject['issueMetadata'].cloudflareRayId === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].cloudflareRayId !== 'string') {
+                return String(jsonObject['issueMetadata'].cloudflareRayId);
+              }
+
+              return jsonObject['issueMetadata'].cloudflareRayId;
+            }();
+          } else {
+            issueMetadataObject.cloudflareRayId = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'host' in jsonObject['issueMetadata']) {
+            issueMetadataObject.host = function () {
+              if (jsonObject['issueMetadata'].host === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].host !== 'string') {
+                return String(jsonObject['issueMetadata'].host);
+              }
+
+              return jsonObject['issueMetadata'].host;
+            }();
+          } else {
+            issueMetadataObject.host = null;
+          }
+
+          if (_typeof(jsonObject['issueMetadata']) === 'object' && 'referrer' in jsonObject['issueMetadata']) {
+            issueMetadataObject.referrer = function () {
+              if (jsonObject['issueMetadata'].referrer === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['issueMetadata'].referrer !== 'string') {
+                return String(jsonObject['issueMetadata'].referrer);
+              }
+
+              return jsonObject['issueMetadata'].referrer;
+            }();
+          } else {
+            issueMetadataObject.referrer = null;
+          }
+
+          return issueMetadataObject;
+        }();
+      }
+
+      if ('consumeMetadata' in jsonObject) {
+        model.consumeMetadata = function () {
+          var consumeMetadataObject = {};
+
+          if (_typeof(jsonObject['consumeMetadata']) === 'object' && 'ipAddress' in jsonObject['consumeMetadata']) {
+            consumeMetadataObject.ipAddress = function () {
+              if (jsonObject['consumeMetadata'].ipAddress === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['consumeMetadata'].ipAddress !== 'string') {
+                return String(jsonObject['consumeMetadata'].ipAddress);
+              }
+
+              return jsonObject['consumeMetadata'].ipAddress;
+            }();
+          } else {
+            consumeMetadataObject.ipAddress = null;
+          }
+
+          if (_typeof(jsonObject['consumeMetadata']) === 'object' && 'userAgent' in jsonObject['consumeMetadata']) {
+            consumeMetadataObject.userAgent = function () {
+              if (jsonObject['consumeMetadata'].userAgent === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['consumeMetadata'].userAgent !== 'string') {
+                return String(jsonObject['consumeMetadata'].userAgent);
+              }
+
+              return jsonObject['consumeMetadata'].userAgent;
+            }();
+          } else {
+            consumeMetadataObject.userAgent = null;
+          }
+
+          if (_typeof(jsonObject['consumeMetadata']) === 'object' && 'cloudflareRayId' in jsonObject['consumeMetadata']) {
+            consumeMetadataObject.cloudflareRayId = function () {
+              if (jsonObject['consumeMetadata'].cloudflareRayId === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['consumeMetadata'].cloudflareRayId !== 'string') {
+                return String(jsonObject['consumeMetadata'].cloudflareRayId);
+              }
+
+              return jsonObject['consumeMetadata'].cloudflareRayId;
+            }();
+          } else {
+            consumeMetadataObject.cloudflareRayId = null;
+          }
+
+          if (_typeof(jsonObject['consumeMetadata']) === 'object' && 'host' in jsonObject['consumeMetadata']) {
+            consumeMetadataObject.host = function () {
+              if (jsonObject['consumeMetadata'].host === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['consumeMetadata'].host !== 'string') {
+                return String(jsonObject['consumeMetadata'].host);
+              }
+
+              return jsonObject['consumeMetadata'].host;
+            }();
+          } else {
+            consumeMetadataObject.host = null;
+          }
+
+          if (_typeof(jsonObject['consumeMetadata']) === 'object' && 'referrer' in jsonObject['consumeMetadata']) {
+            consumeMetadataObject.referrer = function () {
+              if (jsonObject['consumeMetadata'].referrer === null) {
+                return null;
+              }
+
+              if (typeof jsonObject['consumeMetadata'].referrer !== 'string') {
+                return String(jsonObject['consumeMetadata'].referrer);
+              }
+
+              return jsonObject['consumeMetadata'].referrer;
+            }();
+          } else {
+            consumeMetadataObject.referrer = null;
+          }
+
+          return consumeMetadataObject;
+        }();
+      }
+
       if ('deleted' in jsonObject) {
         model.deleted = function () {
           if (typeof jsonObject['deleted'] !== 'boolean') {

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-var version = '2.7.8';
+var version = '2.7.9';
 exports.version = version;

package/lib/index.d.ts

@@ -1992,6 +1992,14 @@ declare module '@ricado/api-client/Controllers/UserAccountActionTokenController'
                         * When the Action Email was Sent
                         */
                     emailTimestamp?: Date | null | undefined;
+                    /**
+                        * Metadata from the Request that generated this Action Token
+                        */
+                    issueMetadata?: RequestMetadata | undefined;
+                    /**
+                        * Metadata from the Request that consumed this Action Token
+                        */
+                    consumeMetadata?: RequestMetadata | undefined;
             };
             /**
                 * The Update Data for a User Account Action Token
@@ -2009,6 +2017,35 @@ declare module '@ricado/api-client/Controllers/UserAccountActionTokenController'
                         * When the Action Email was Sent
                         */
                     emailTimestamp?: Date | null | undefined;
+                    /**
+                        * Metadata from the Request that consumed this Action Token
+                        */
+                    consumeMetadata?: RequestMetadata | undefined;
+            };
+            /**
+                * A **RequestMetadata** Type
+                */
+            type RequestMetadata = {
+                    /**
+                        * The IP Address of the Requester
+                        */
+                    ipAddress: string | null;
+                    /**
+                        * The User-Agent of the Requester
+                        */
+                    userAgent: string | null;
+                    /**
+                        * The Cloudflare Ray ID from the Request
+                        */
+                    cloudflareRayId: string | null;
+                    /**
+                        * The Host header from the Request
+                        */
+                    host: string | null;
+                    /**
+                        * The Referrer header from the Request
+                        */
+                    referrer: string | null;
             };
     }
     import UserAccountActionTokenModel from "@ricado/api-client/Models/UserAccountActionTokenModel";
@@ -2955,6 +2992,19 @@ declare module '@ricado/api-client/Models/TokenModel' {
                 * @public
                 */
             lockTimestamp: Date | null;
+            /**
+                * Metadata from the Request that generated this Token
+                *
+                * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+                * @public
+                */
+            issueMetadata: {
+                    ipAddress: string | null;
+                    userAgent: string | null;
+                    cloudflareRayId: string | null;
+                    host: string | null;
+                    referrer: string | null;
+            };
             /**
                 * Whether the Token has been deleted
                 *
@@ -3057,6 +3107,32 @@ declare module '@ricado/api-client/Models/UserAccountActionTokenModel' {
                 * @public
                 */
             emailTimestamp: Date | null;
+            /**
+                * Metadata from the Request that generated this Action Token
+                *
+                * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+                * @public
+                */
+            issueMetadata: {
+                    ipAddress: string | null;
+                    userAgent: string | null;
+                    cloudflareRayId: string | null;
+                    host: string | null;
+                    referrer: string | null;
+            };
+            /**
+                * Metadata from the Request that consumed this Action Token
+                *
+                * @type {{ipAddress: ?string, userAgent: ?string, cloudflareRayId: ?string, host: ?string, referrer: ?string}}
+                * @public
+                */
+            consumeMetadata: {
+                    ipAddress: string | null;
+                    userAgent: string | null;
+                    cloudflareRayId: string | null;
+                    host: string | null;
+                    referrer: string | null;
+            };
             /**
                 * Whether the User Account Action Token has been deleted
                 *
@@ -21028,6 +21104,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleCont
                         * Whether Bin Card Printing should use the Specialized FreshPack Windows Driver API
                         */
                     useWindowsDriverApi?: boolean | undefined;
+                    /**
+                        * Whether the Net Weight should be used as a single Forced Class Type when creating Multi-Grower Bins and Weights
+                        */
+                    forceSingleClassType?: boolean | null | undefined;
+                    /**
+                        * The Forced Class Type of Net Weights when Enabled
+                        */
+                    forcedClassType?: string | null | undefined;
             };
     }
     import RejectBinScaleModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel";
@@ -31596,7 +31680,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel' {
             /**
                 * The FreshPack Integration Configuration for this Reject Bin Scale
                 *
-                * @type {?{points: Object, enabled: boolean, materialGroupId: ?number, binTypeId: number, printerGroupId: ?number, binCardPrintingEnabled: boolean, useWindowsDriverApi: boolean}}
+                * @type {?{points: Object, enabled: boolean, materialGroupId: ?number, binTypeId: number, printerGroupId: ?number, binCardPrintingEnabled: boolean, useWindowsDriverApi: boolean, forceSingleClassType: ?boolean, forcedClassType: ?string}}
                 * @public
                 */
             freshPackIntegration: {
@@ -31607,6 +31691,8 @@ declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel' {
                     printerGroupId: number | null;
                     binCardPrintingEnabled: boolean;
                     useWindowsDriverApi: boolean;
+                    forceSingleClassType: boolean | null;
+                    forcedClassType: string | null;
             } | null;
             /**
                 * Whether the Reject Bin Scale has been deleted

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.7.8",
+    "version": "2.7.9",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

package/src/Controllers/Packhouse/Site/RejectBinScaleController.js

@@ -253,5 +253,7 @@ export default RejectBinScaleController;
  * @property {?number} printerGroupId The FreshPack Printer Group ID to be used when Printing Multi-Grower Bin Cards for this Reject Bin Scale
  * @property {boolean} binCardPrintingEnabled Whether Bin Card Printing is Enabled
  * @property {boolean} [useWindowsDriverApi] Whether Bin Card Printing should use the Specialized FreshPack Windows Driver API
+ * @property {?boolean} [forceSingleClassType] Whether the Net Weight should be used as a single Forced Class Type when creating Multi-Grower Bins and Weights
+ * @property {?string} [forcedClassType] The Forced Class Type of Net Weights when Enabled
  * @memberof Controllers.Packhouse.Site
  */

package/src/Controllers/UserAccountActionTokenController.js

@@ -407,6 +407,8 @@ export default UserAccountActionTokenController;
  * @property {?Date} [activityTimestamp] When the last API call using this Action Token was made
  * @property {?Date} [completedTimestamp] When the Action was Completed
  * @property {?Date} [emailTimestamp] When the Action Email was Sent
+ * @property {UserAccountActionTokenController.RequestMetadata} [issueMetadata] Metadata from the Request that generated this Action Token
+ * @property {UserAccountActionTokenController.RequestMetadata} [consumeMetadata] Metadata from the Request that consumed this Action Token
  * @memberof Controllers
  */
 
@@ -417,5 +419,18 @@ export default UserAccountActionTokenController;
  * @property {?Date} [activityTimestamp] When the last API call using this Action Token was made
  * @property {?Date} [completedTimestamp] When the Action was Completed
  * @property {?Date} [emailTimestamp] When the Action Email was Sent
+ * @property {UserAccountActionTokenController.RequestMetadata} [consumeMetadata] Metadata from the Request that consumed this Action Token
+ * @memberof Controllers
+ */
+
+/**
+ * A **RequestMetadata** Type
+ * 
+ * @typedef {Object} UserAccountActionTokenController.RequestMetadata
+ * @property {?string} ipAddress The IP Address of the Requester
+ * @property {?string} userAgent The User-Agent of the Requester
+ * @property {?string} cloudflareRayId The Cloudflare Ray ID from the Request
+ * @property {?string} host The Host header from the Request
+ * @property {?string} referrer The Referrer header from the Request
  * @memberof Controllers
  */