Skip to content

Commit

Permalink
Update Swagger Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Samsara CI committed Jun 14, 2021
1 parent 606abe6 commit 6fbb8fc
Show file tree
Hide file tree
Showing 10 changed files with 149 additions and 423 deletions.
26 changes: 26 additions & 0 deletions changelog.json
Original file line number Diff line number Diff line change
Expand Up @@ -1585,6 +1585,19 @@
"IsDocumentationOnly": false
}
},
{
"Route": "gateways",
"Method": "GET",
"Changelog": {
"Index": 0,
"VersionDate": "2021.06.09",
"Description": "Update returned gateway accessory devices and gateway model types.",
"Details": "The previous version returned accessory devices with name, serial, firmware, and last connected time. This version returns the connected camera and/or sensors and their respective serials and model names.",
"IsBreakingChange": true,
"IsInitialRelease": false,
"IsDocumentationOnly": false
}
},
{
"Route": "gateways",
"Method": "POST",
Expand All @@ -1598,6 +1611,19 @@
"IsDocumentationOnly": false
}
},
{
"Route": "gateways",
"Method": "POST",
"Changelog": {
"Index": 0,
"VersionDate": "2021.06.09",
"Description": "Update returned gateway accessory devices and gateway model types.",
"Details": "The previous version returned accessory devices with name, serial, firmware, and last connected time. This version returns the connected camera and/or sensors and their respective serials and model names.",
"IsBreakingChange": true,
"IsInitialRelease": false,
"IsDocumentationOnly": false
}
},
{
"Route": "gateways/.id",
"Method": "DELETE",
Expand Down
2 changes: 1 addition & 1 deletion markdown/createtrailer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;installedGateway**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
| **&nbsp;&nbsp;&nbsp;&nbsp;licensePlate**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time. |
| **&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. |
Expand Down
8 changes: 3 additions & 5 deletions markdown/getgateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
| :------------ | :---------- |
| **data**<br/>_object array_ | Activated gateways |
| **&nbsp;&nbsp;&nbsp;&nbsp;accessoryDevices**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object array_ | Accessory devices on gateway |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;firmware**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The firmware version number of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lastConnectedTime**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The last time the accessory device was connected in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | Name of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | Product model name of the device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the accessory device. |
| **&nbsp;&nbsp;&nbsp;&nbsp;asset**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | An object containing information about the asset the gateway is installed on |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the asset where the gateway is installed. This is automatically generated when the asset is created and cannot be changed. Use this ID on PATCH vehicle, equipment, or trailer endpoints to update the asset |
Expand All @@ -16,7 +14,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;dataUsageLast30Days**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | An object containing information about the gateway data usage in mb for the last 30 days. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cellularDataUsageBytes**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Celluar data usage in bytes. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hotspotUsageBytes**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Wifi hotspot data usage in bytes. |
| **&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
| **pagination**<br/>_object_ | Pagination parameters. |
| **&nbsp;&nbsp;&nbsp;&nbsp;endCursor**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view. |
Expand Down
2 changes: 1 addition & 1 deletion markdown/gettrailer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;installedGateway**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
| **&nbsp;&nbsp;&nbsp;&nbsp;licensePlate**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time. |
| **&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. |
Expand Down
2 changes: 1 addition & 1 deletion markdown/listtrailers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;installedGateway**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
| **&nbsp;&nbsp;&nbsp;&nbsp;licensePlate**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time. |
| **&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. |
Expand Down
2 changes: 1 addition & 1 deletion markdown/patchequipment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. |
| **&nbsp;&nbsp;&nbsp;&nbsp;installedGateway**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | A minified gateway object |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
| **&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. |
| **&nbsp;&nbsp;&nbsp;&nbsp;notes**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time. |
Expand Down
8 changes: 3 additions & 5 deletions markdown/postgateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
| :------------ | :---------- |
| **data**<br/>_object_ | |
| **&nbsp;&nbsp;&nbsp;&nbsp;accessoryDevices**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object array_ | Accessory devices on gateway |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;firmware**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The firmware version number of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lastConnectedTime**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The last time the accessory device was connected in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | Name of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the accessory device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | Product model name of the device |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the accessory device. |
| **&nbsp;&nbsp;&nbsp;&nbsp;asset**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | An object containing information about the asset the gateway is installed on |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;externalIds**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;object_ | A map of external ids |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The unique Samsara ID of the asset where the gateway is installed. This is automatically generated when the asset is created and cannot be changed. Use this ID on PATCH vehicle, equipment, or trailer endpoints to update the asset |
Expand All @@ -16,5 +14,5 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;dataUsageLast30Days**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | An object containing information about the gateway data usage in mb for the last 30 days. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cellularDataUsageBytes**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Celluar data usage in bytes. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hotspotUsageBytes**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Wifi hotspot data usage in bytes. |
| **&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `none`, `AG45`, `AG41`, `AG46EU`, `IG41`, `VG34`, `IG15`, `EM22`, `PM7`, `VG54NA`, `OEMP`, `ACCCRGO`, `EM01`, `Baxter`, `IGMAO`, `EKM`, `DM1`, `VG54EU`, `IG11`, `CM12`, `AG41EU`, `IM32`, `AG46P`, `EM12`, `EM21`, `CM31`, `AG46`, `IG61`, `OEMV`, `Trailer`, `IM31`, `VG33`, `AG24`, `HM21`, `EM23`, `VG34EU`, `AG26EU`, `IG20`, `HM11`, `NVR10`, `VG34FN`, `IG21`, `IGMAI`, `AG15`, `OEM`, `AG26`, `SG1`, `VS25C`, `PM20`, `ACCBDH`, `AG24EU`, `CMVR`, `ACCHMI10`, `OEMR`, `VG32`, `PM10`, `VS2C`, `EM02`, `EM11`, `IM33`, `ACCDM11`, `CM52`, `CM11`, `GW22`, `VS25`, `CM22`, `CM32`, `PM8`, `WM11`, `AG45EU`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;model**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG54EU`, `VG54NA`. |
| **&nbsp;&nbsp;&nbsp;&nbsp;serial**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;string_ | The serial number of the gateway installed on the asset. |
Loading

0 comments on commit 6fbb8fc

Please sign in to comment.