@deeptrekker/api-domain 0.43.2 → 0.44.0

package/dist/types/devices/vehicles/revolution/index.d.ts

@@ -30,7 +30,7 @@ export type Revolution = {
      *
      * - Arbitrary value
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json}
      */
     ip?: string;
     /**
@@ -45,19 +45,19 @@ export type Revolution = {
      *
      * - Light On (mid)
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMidIntensitySample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMidIntensitySample.json}
      *
      * - Light Off
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json}
      *
      * - Light On (max)
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMaxIntensitySample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMaxIntensitySample.json}
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json}
      */
     auxLight?: Light;
     /** Grabber
@@ -68,27 +68,27 @@ export type Revolution = {
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRandomSample.json}
      *
      * - Resting
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRestingSample.json}
      *
      * - Open
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberOpenClawSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberOpenClawSample.json}
      *
      * - Close
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberCloseClawSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberCloseClawSample.json}
      *
      * - Rotate Left
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateLeftSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateLeftSample.json}
      *
      * - Rotate Right
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json}
      */
     grabber?: Grabber;
     /** Rov Drive object
@@ -100,7 +100,7 @@ export type Revolution = {
      * ### Example Payloads
      * #### SET Requests
      * - Random drive request
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json}
      */
     drive?: RovDrive;
     /**
@@ -150,12 +150,12 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRandomSample.json}
      *
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRestingSample.json}
      */
     frontLeftMotorDiagnostics?: MotorDiagnostics;
     /** Front Right Motor Diagnostics
@@ -166,11 +166,11 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRandomSample.json}
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRestingSample.json}
      */
     frontRightMotorDiagnostics?: MotorDiagnostics;
     /** Rear Left Motor Diagnostics
@@ -182,11 +182,11 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRandomSample.json}
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRestingSample.json}
      */
     rearLeftMotorDiagnostics?: MotorDiagnostics;
     /** Rear Right Motor Diagnostics
@@ -198,11 +198,11 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRandomSample.json}
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRestingSample.json}
      */
     rearRightMotorDiagnostics?: MotorDiagnostics;
     /** Vertical Left Motor Diagnostics
@@ -214,11 +214,11 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRandomSample.json}
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRestingSample.json}
      */
     verticalLeftMotorDiagnostics?: MotorDiagnostics;
     /** Vertical Right Motor Diagnostics
@@ -230,11 +230,11 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRandomSample.json}
      *
      * - Resting values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRestingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRestingSample.json}
      */
     verticalRightMotorDiagnostics?: MotorDiagnostics;
     /** Main ROV Batteries */
@@ -246,31 +246,31 @@ export type Revolution = {
      *
      * - All arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryRandomSample.json}
      *
      * - Left battery warning
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryWarningSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryWarningSample.json}
      *
      * - Left battery shutdown
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryShutdownSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryShutdownSample.json}
      *
      * - Left battery charging
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsChargingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsChargingSample.json}
      *
      * - left battery not charging
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsNotChargingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsNotChargingSample.json}
      *
      * - left battery has leak
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasLeakSample.json}
      *
      * - left batter has no leak
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasNoLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasNoLeakSample.json}
      */
     leftBattery?: Battery;
     /**
@@ -281,31 +281,31 @@ export type Revolution = {
      *
      * - All Arbitrary values
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryRandomSample.json}
      *
      * - Right battery warning
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryWarningSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryWarningSample.json}
      *
      * - Right battery shutdown
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryShutdownSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryShutdownSample.json}
      *
      * - Right battery charging
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsChargingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsChargingSample.json}
      *
      * - Right battery not charging
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsNotChargingSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsNotChargingSample.json}
      *
      * - right battery has leak
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasLeakSample.json}
      *
      * - right battery has no leak
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasNoLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasNoLeakSample.json}
      *
      *
      */
@@ -317,11 +317,11 @@ export type Revolution = {
      *
      * - Arbitrary total seconds
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/usageTime/revolutionRandomTotalSecondsUsageSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionRandomTotalSecondsUsageSample.json}
      *
      * - Arbitrary current seconds
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/usageTime/revolutionRandomCurrentSecondsUsageSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionRandomCurrentSecondsUsageSample.json}
      */
     usageTime?: UsageTime;
     /** CPU temperature sensors in degrees celsius
@@ -331,22 +331,22 @@ export type Revolution = {
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cpuTemp/revolutionCpuTempRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/cpuTemp/revolutionCpuTempRandomSample.json}
      *
      */
     cpuTemp?: number;
     /**
      * - Arbitrary temp
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/waterTemp/revolutionRandomWaterTempSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionRandomWaterTempSample.json}
      *
      * - Max water temp
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/waterTemp/revolutionMaxWaterTempSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMaxWaterTempSample.json}
      *
      * - Min water temp
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/waterTemp/revolutionMinWaterTempSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMinWaterTempSample.json}
      */
     waterTemp?: number;
     /** Body Leak Fault
@@ -356,15 +356,15 @@ export type Revolution = {
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json}
      *
      * - Has no body leak fault
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json}
      *
      * - Has body leak fault
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json}
      */
     bodyLeak?: boolean;
     /** Sensor Pod Leak Fault
@@ -374,15 +374,15 @@ export type Revolution = {
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/sensorPodLeak/revolutionSensorPodLeakRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionSensorPodLeakRandomSample.json}
      *
      * - Has no sensor pod leak fault
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasNoSensorPodLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasNoSensorPodLeakSample.json}
      *
      * - has sensor pod leak fault
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasSensorPodLeakSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/sensorPodLeak/revolutionHasSensorPodLeakSample.json}
      */
     sensorPodLeak?: boolean;
     /** Revolution Version
@@ -394,19 +394,19 @@ export type Revolution = {
      *
      * - Arbitrary
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/version/revolutionVersionRandomSample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersionRandomSample.json}
      *
      * - Version 1
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/version/revolutionVersion1Sample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion1Sample.json}
      *
      * - Version 2
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/version/revolutionVersion2Sample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion2Sample.json}
      *
      * - Version 3
      *
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/version/revolutionVersion3Sample.json}
+     * {@codeblock ~~/dist/samples/json/requests/devices/vehicles/revolution/version/revolutionVersion3Sample.json}
      */
     version?: DeviceVersion;
     /**

package/dist/types/server/index.d.ts

@@ -155,7 +155,7 @@ export type IceCandidateMessage = {
  * @protocol *wss* | *https*
  * @endpoint `/ice_candidate`
  *
- * {@codeblock ~~/dist/samples/generated/server/iceCandidate.json}
+ * {@codeblock ~~/dist/samples/json/server/iceCandidate.json}
  */
 export type IceCandidate = {
     target: string;

package/dist/types/server/index.js

@@ -15,7 +15,7 @@ exports.SdpMessageType = void 0;
  * @protocol *wss* | *https*
  * @endpoint  `/register_session`
  *
- * {@codeblock ~~/dist/samples/generated/server/registerSession.json}
+ * {@codeblock ~~/dist/samples/json/server/registerSession.json}
  */
 var IRegisterSession = "";
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.43.2",
+    "version": "0.44.0",
     "description": "A business domain of types and schemas that the DeepTrekker topside communicates with via an API.",
     "main": "dist/index.js",
     "files": [
@@ -44,6 +44,7 @@
     },
     "dependencies": {
         "@js-temporal/polyfill": "^0.4.4",
+        "dotenv": "^16.3.1",
         "lodash": "^4.17.21",
         "mkdirp": "^1.0.4"
     }

package/readme.md

@@ -477,7 +477,7 @@ There are 5 different types of transferred payloads:
 
 Sample GET request:
 
-{@codeblock ~~/dist/samples/generated/requests/transferGetRequest.json}
+{@codeblock ~~/dist/samples/json/requests/transferGetRequest.json}
 
 Errors are a type of response that gets returned, either as a result of a bad
 payload request sent or for reasons unprovoked depending on the error code
@@ -565,13 +565,13 @@ DeepTrekker systems.
 The following examples show a snapshot of vehicle states that could
 hypothetically exist in memory at some point during the operation of a vehicle:
 
-{@codeblock ~~/dist/samples/generated/states/a200RandomState.json}
+{@codeblock ~~/dist/samples/json/states/a200RandomState.json}
 
-{@codeblock ~~/dist/samples/generated/states/a150RandomState.json}
+{@codeblock ~~/dist/samples/json/states/a150RandomState.json}
 
-{@codeblock ~~/dist/samples/generated/states/revolutionRandomState.json}
+{@codeblock ~~/dist/samples/json/states/revolutionRandomState.json}
 
-{@codeblock ~~/dist/samples/generated/states/pivotRandomState.json}
+{@codeblock ~~/dist/samples/json/states/pivotRandomState.json}
 
 ## Integration
 
@@ -599,9 +599,9 @@ client-side solution for communicating with DeepTrekker related hardware.
     -   [Version](dist/versions)
     -   [API Schema](dist/schemas/schema.json)
     -   [Samples](dist/samples)
-    -   [Generated Samples](dist/samples/generated/)
-        -   [Requests](dist/samples/generated/requests/)
-        -   [States](dist/samples/generated/state/)
+    -   [Generated Samples](dist/samples/json/)
+        -   [Requests](dist/samples/json/requests/)
+        -   [States](dist/samples/json/state/)
 
     #### Set up
 

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeGreenwichSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T17:57:15.533230635+00:00[UTC]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLocaleSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T17:57:15.541235533+00:00[UTC]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLondonSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T18:57:15.543235541+01:00[Europe/London]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLosAngelesSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T10:57:15.545235543-07:00[America/Los_Angeles]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncDisabledSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "networkTimeSync": false
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncEnabledSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "networkTimeSync": true
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNewYorkSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T13:57:15.548235545-04:00[America/New_York]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTokyoSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-26T02:57:15.550235548+09:00[Asia/Tokyo]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTorontoSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T13:57:15.55223555-04:00[America/Toronto]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeUTCSample.json

@@ -1,11 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "dateTime": {
-                "timestamp": "2023-08-25T17:57:15.553235552+00:00[UTC]"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementImperialSample.json

@@ -1,9 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "systemOfMeasurement": "IMPERIAL"
-        }
-    }
-}

package/dist/samples/generated/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementMetricSample.json

@@ -1,9 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "systemSettings": {
-            "systemOfMeasurement": "METRIC"
-        }
-    }
-}

package/dist/samples/generated/requests/clients/bridgeboxNetworkDiagnosticsSample.json

@@ -1,41 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "UPDATE",
-    "payload": {
-        "networkDiagnostics": {
-            "01AB23CD4567": {
-                "interfaceName": "ETH0",
-                "physicalLocation": "LOC",
-                "networkRole": "CCO",
-                "terminalEndpointIdentifier": "001",
-                "bridgedDestinationAddress": "1234567890AB",
-                "outboundRate": "120",
-                "inboundRate": "130",
-                "chipset": "Broadcom BCM56850",
-                "firmwareVersion": "3.5.1"
-            },
-            "89EF12AB3456": {
-                "interfaceName": "ETH1",
-                "physicalLocation": "REM",
-                "networkRole": "STA",
-                "terminalEndpointIdentifier": "002",
-                "bridgedDestinationAddress": "ABCDEF123456",
-                "outboundRate": "125",
-                "inboundRate": "115",
-                "chipset": "Intel I350",
-                "firmwareVersion": "2.1.0"
-            },
-            "23CD45EF6789": {
-                "interfaceName": "ETH2",
-                "physicalLocation": "LOC",
-                "networkRole": "STA",
-                "terminalEndpointIdentifier": "003",
-                "bridgedDestinationAddress": "DEADBEEF1234",
-                "outboundRate": "130",
-                "inboundRate": "120",
-                "chipset": "Broadcom BCM56840",
-                "firmwareVersion": "4.2.2"
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/devices/reels/manualReels/calibration/manualReelCalibratorCalibrateSample.json

@@ -1,12 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "devices": {
-            "6805E3135C4D": {
-                "model": 107,
-                "calibrator": false
-            }
-        }
-    }
-}

package/dist/samples/generated/requests/devices/reels/manualReels/calibration/manualReelCalibratorCancelSample.json

@@ -1,12 +0,0 @@
-{
-    "apiVersion": "0.43.2",
-    "method": "SET",
-    "payload": {
-        "devices": {
-            "B4ED0D786E39": {
-                "model": 107,
-                "calibrator": false
-            }
-        }
-    }
-}