diff --git a/changelog.json b/changelog.json index 2a0c789..9d2c6f9 100644 --- a/changelog.json +++ b/changelog.json @@ -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", @@ -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", diff --git a/markdown/createtrailer.md b/markdown/createtrailer.md index 2da5d8a..90449ca 100644 --- a/markdown/createtrailer.md +++ b/markdown/createtrailer.md @@ -11,7 +11,7 @@ | **    externalIds**
_    object_ | A map of external ids | | **    id**
_    string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. | | **    installedGateway**
_    object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. | -| **        model**
_        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`. | +| **        model**
_        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`. | | **        serial**
_        string_ | The serial number of the gateway installed on the asset. | | **    licensePlate**
_    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. | | **    name**
_    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. | diff --git a/markdown/getgateways.md b/markdown/getgateways.md index f581920..85ca029 100644 --- a/markdown/getgateways.md +++ b/markdown/getgateways.md @@ -3,10 +3,8 @@ | :------------ | :---------- | | **data**
_object array_ | Activated gateways | | **    accessoryDevices**
_    object array_ | Accessory devices on gateway | -| **        firmware**
_        string_ | The firmware version number of the accessory device | -| **        lastConnectedTime**
_        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). | -| **        name**
_        string_ | Name of the accessory device | -| **        serial**
_        string_ | The serial number of the accessory device | +| **        model**
_        string_ | Product model name of the device | +| **        serial**
_        string_ | The serial number of the accessory device. | | **    asset**
_    object_ | An object containing information about the asset the gateway is installed on | | **        externalIds**
_        object_ | A map of external ids | | **        id**
_        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 | @@ -16,7 +14,7 @@ | **    dataUsageLast30Days**
_    object_ | An object containing information about the gateway data usage in mb for the last 30 days. | | **        cellularDataUsageBytes**
_        integer_ | Celluar data usage in bytes. | | **        hotspotUsageBytes**
_        integer_ | Wifi hotspot data usage in bytes. | -| **    model**
_    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`. | +| **    model**
_    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`. | | **    serial**
_    string_ | The serial number of the gateway installed on the asset. | | **pagination**
_object_ | Pagination parameters. | | **    endCursor**
_    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. | diff --git a/markdown/gettrailer.md b/markdown/gettrailer.md index 2da5d8a..90449ca 100644 --- a/markdown/gettrailer.md +++ b/markdown/gettrailer.md @@ -11,7 +11,7 @@ | **    externalIds**
_    object_ | A map of external ids | | **    id**
_    string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. | | **    installedGateway**
_    object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. | -| **        model**
_        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`. | +| **        model**
_        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`. | | **        serial**
_        string_ | The serial number of the gateway installed on the asset. | | **    licensePlate**
_    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. | | **    name**
_    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. | diff --git a/markdown/listtrailers.md b/markdown/listtrailers.md index cf6e821..2f8656d 100644 --- a/markdown/listtrailers.md +++ b/markdown/listtrailers.md @@ -6,7 +6,7 @@ | **    externalIds**
_    object_ | A map of external ids | | **    id**
_    string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. | | **    installedGateway**
_    object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. | -| **        model**
_        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`. | +| **        model**
_        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`. | | **        serial**
_        string_ | The serial number of the gateway installed on the asset. | | **    licensePlate**
_    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. | | **    name**
_    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. | diff --git a/markdown/patchequipment.md b/markdown/patchequipment.md index d329719..e2c8e81 100644 --- a/markdown/patchequipment.md +++ b/markdown/patchequipment.md @@ -11,7 +11,7 @@ | **    externalIds**
_    object_ | A map of external ids | | **    id**
_    string_ | The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed. | | **    installedGateway**
_    object_ | A minified gateway object | -| **        model**
_        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`. | +| **        model**
_        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`. | | **        serial**
_        string_ | The serial number of the gateway installed on the asset. | | **    name**
_    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. | | **    notes**
_    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. | diff --git a/markdown/postgateway.md b/markdown/postgateway.md index be280fd..e2c1be9 100644 --- a/markdown/postgateway.md +++ b/markdown/postgateway.md @@ -3,10 +3,8 @@ | :------------ | :---------- | | **data**
_object_ | | | **    accessoryDevices**
_    object array_ | Accessory devices on gateway | -| **        firmware**
_        string_ | The firmware version number of the accessory device | -| **        lastConnectedTime**
_        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). | -| **        name**
_        string_ | Name of the accessory device | -| **        serial**
_        string_ | The serial number of the accessory device | +| **        model**
_        string_ | Product model name of the device | +| **        serial**
_        string_ | The serial number of the accessory device. | | **    asset**
_    object_ | An object containing information about the asset the gateway is installed on | | **        externalIds**
_        object_ | A map of external ids | | **        id**
_        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 | @@ -16,5 +14,5 @@ | **    dataUsageLast30Days**
_    object_ | An object containing information about the gateway data usage in mb for the last 30 days. | | **        cellularDataUsageBytes**
_        integer_ | Celluar data usage in bytes. | | **        hotspotUsageBytes**
_        integer_ | Wifi hotspot data usage in bytes. | -| **    model**
_    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`. | +| **    model**
_    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`. | | **    serial**
_    string_ | The serial number of the gateway installed on the asset. | diff --git a/markdown/updatetrailer.md b/markdown/updatetrailer.md index 2da5d8a..90449ca 100644 --- a/markdown/updatetrailer.md +++ b/markdown/updatetrailer.md @@ -11,7 +11,7 @@ | **    externalIds**
_    object_ | A map of external ids | | **    id**
_    string_ | The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed. | | **    installedGateway**
_    object_ | A minified gateway object. This field will be omitted if the trailer does not have a gateway installed. | -| **        model**
_        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`. | +| **        model**
_        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`. | | **        serial**
_        string_ | The serial number of the gateway installed on the asset. | | **    licensePlate**
_    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. | | **    name**
_    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. | diff --git a/swagger-readme.json b/swagger-readme.json index 1d2dd98..8a8abed 100644 --- a/swagger-readme.json +++ b/swagger-readme.json @@ -696,23 +696,13 @@ "AccessoryResponseObjectResponseBody": { "description": "An object containing information about an accessory connected to the VG.", "properties": { - "firmware": { - "description": "The firmware version number of the accessory device", - "example": "ag-stable-10", - "type": "string" - }, - "lastConnectedTime": { - "description": "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).", - "example": "2019-06-13T19:08:25Z", - "type": "string" - }, - "name": { - "description": "Name of the accessory device", - "example": "Gateway 100", + "model": { + "description": "Product model name of the device", + "example": "EM11", "type": "string" }, "serial": { - "description": "The serial number of the accessory device", + "description": "The serial number of the accessory device.", "example": "ABCD-123-EFG", "type": "string" } @@ -7509,76 +7499,30 @@ "model": { "description": "The model of the gateway installed on the asset.", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34", "type": "string" @@ -8470,76 +8414,30 @@ "model": { "description": "The model of the gateway installed on the asset.", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34", "type": "string" @@ -15067,76 +14965,30 @@ "model": { "description": "The model of the gateway installed on the asset.", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34", "type": "string" @@ -28572,7 +28424,7 @@ "info": { "description": "\u003cstyle type=\"text/css\"\u003e\nn {\n padding: 1em;\n width: 100%;\n display: block;\n margin: 28px 0;\n}\nn.info {\n background-color: rgba(0, 51, 160, 0.1);\n}\nn.warning {\n background-color: #fdf6e3;\n}\ni:before {\n margin-right: 6px;\n}\nnh {\n font-size: 1.5rem;\n font-weight: 700;\n line-height: 1.1;\n display: block;\n}\nnb {\n margin-top: 10px;\n padding-left: 22px;\n display: block;\n}\n\u003c/style\u003e\n\n# Overview\n\n\u003cn class=\"info\"\u003e\n\u003cnh\u003e\n\u003ci class=\"fa fa-info-circle\"\u003e\u003c/i\u003e\nSomething new!\n\u003c/nh\u003e\n\u003cnb\u003e\nWelcome Samsara's new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what's changed and learn how to get started.\u003cbr\u003e\n\u003cbr\u003e\nWant to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).\u003cbr\u003e\n\u003cbr\u003e\n*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can't find an API that you're looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*\u003cbr\u003e\n\u003cbr\u003e\nSubmit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)!\n\u003c/nb\u003e\n\u003c/n\u003e\n\nSamsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets.\n\nThe Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you're familiar with what you can build with a REST API, then this will be your go-to API reference.\n\nVisit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview.\n\nIf you have any questions, please visit https://samsara.com/help.\n\n## Endpoints\n\nAll our APIs can be accessed through HTTP requests to URLs like:\n\n```\nhttps://api.samsara.com/\u003cendpoint\u003e\n```\n\nFor EU customers, this URL will be:\n\n```\nhttps://api.eu.samsara.com/\u003cendpoint\u003e\n```\n\n\u003cn class=\"warning\"\u003e\n\u003cnh\u003e\n\u003ci class=\"fa fa-exclamation-circle\"\u003e\u003c/i\u003e\nNote\n\u003c/nh\u003e\n\u003cnb\u003e\nLegacy endpoints will have the URL: `https://api.samsara.com/v1/\u003cendpoint\u003e` or `https://api.eu.samsara.com/v1/\u003cendpoint\u003e`\n\u003c/nb\u003e\n\u003c/n\u003e\n\n## Authentication\n\nTo authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings-\u003eOrganization-\u003eAPI Tokens`.\n\nYour API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on.\n\nAuthentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password:\n\n```curl\nAuthorization: Bearer {access_token}\n```\n\nAll API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail.\n\n### OAuth2\nIf building an application for our marketplace, our API is accessible via. OAuth2 as well.\n\n| Type | Value |\n| ------------- |:-------------:|\n| Security scheme | OAuth2 |\n| OAuth2 Flow | accessCode |\n| Authorization URL | https://api.samsara.com/oauth2/authorize |\n| Token URL | https://api.samsara.com/oauth2/token |\n\n\n\n## Common Patterns\n\nYou can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).\n", "title": "Samsara API", - "version": "2020-06-15" + "version": "2021-06-09" }, "openapi": "3.0.1", "paths": { diff --git a/swagger.json b/swagger.json index a06feb5..cbd1f19 100644 --- a/swagger.json +++ b/swagger.json @@ -12,7 +12,7 @@ "info": { "description": "\u003cstyle type=\"text/css\"\u003e\nn {\n padding: 1em;\n width: 100%;\n display: block;\n margin: 28px 0;\n}\nn.info {\n background-color: rgba(0, 51, 160, 0.1);\n}\nn.warning {\n background-color: #fdf6e3;\n}\ni:before {\n margin-right: 6px;\n}\nnh {\n font-size: 1.5rem;\n font-weight: 700;\n line-height: 1.1;\n display: block;\n}\nnb {\n margin-top: 10px;\n padding-left: 22px;\n display: block;\n}\n\u003c/style\u003e\n\n# Overview\n\n\u003cn class=\"info\"\u003e\n\u003cnh\u003e\n\u003ci class=\"fa fa-info-circle\"\u003e\u003c/i\u003e\nSomething new!\n\u003c/nh\u003e\n\u003cnb\u003e\nWelcome Samsara's new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what's changed and learn how to get started.\u003cbr\u003e\n\u003cbr\u003e\nWant to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).\u003cbr\u003e\n\u003cbr\u003e\n*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can't find an API that you're looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*\u003cbr\u003e\n\u003cbr\u003e\nSubmit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)!\n\u003c/nb\u003e\n\u003c/n\u003e\n\nSamsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets.\n\nThe Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you're familiar with what you can build with a REST API, then this will be your go-to API reference.\n\nVisit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview.\n\nIf you have any questions, please visit https://samsara.com/help.\n\n## Endpoints\n\nAll our APIs can be accessed through HTTP requests to URLs like:\n\n```\nhttps://api.samsara.com/\u003cendpoint\u003e\n```\n\nFor EU customers, this URL will be:\n\n```\nhttps://api.eu.samsara.com/\u003cendpoint\u003e\n```\n\n\u003cn class=\"warning\"\u003e\n\u003cnh\u003e\n\u003ci class=\"fa fa-exclamation-circle\"\u003e\u003c/i\u003e\nNote\n\u003c/nh\u003e\n\u003cnb\u003e\nLegacy endpoints will have the URL: `https://api.samsara.com/v1/\u003cendpoint\u003e` or `https://api.eu.samsara.com/v1/\u003cendpoint\u003e`\n\u003c/nb\u003e\n\u003c/n\u003e\n\n## Authentication\n\nTo authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings-\u003eOrganization-\u003eAPI Tokens`.\n\nYour API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on.\n\nAuthentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password:\n\n```curl\nAuthorization: Bearer {access_token}\n```\n\nAll API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail.\n\n### OAuth2\nIf building an application for our marketplace, our API is accessible via. OAuth2 as well.\n\n| Type | Value |\n| ------------- |:-------------:|\n| Security scheme | OAuth2 |\n| OAuth2 Flow | accessCode |\n| Authorization URL | https://api.samsara.com/oauth2/authorize |\n| Token URL | https://api.samsara.com/oauth2/token |\n\n\n\n## Common Patterns\n\nYou can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).\n", "title": "Samsara API", - "version": "2020-06-15" + "version": "2021-06-09" }, "host": "api.samsara.com", "paths": { @@ -9860,23 +9860,13 @@ "description": "An object containing information about an accessory connected to the VG.", "type": "object", "properties": { - "firmware": { - "description": "The firmware version number of the accessory device", - "type": "string", - "example": "ag-stable-10" - }, - "lastConnectedTime": { - "description": "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).", - "type": "string", - "example": "2019-06-13T19:08:25Z" - }, - "name": { - "description": "Name of the accessory device", + "model": { + "description": "Product model name of the device", "type": "string", - "example": "Gateway 100" + "example": "EM11" }, "serial": { - "description": "The serial number of the accessory device", + "description": "The serial number of the accessory device.", "type": "string", "example": "ABCD-123-EFG" } @@ -16671,76 +16661,30 @@ "description": "The model of the gateway installed on the asset.", "type": "string", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34" }, @@ -17632,76 +17576,30 @@ "description": "The model of the gateway installed on the asset.", "type": "string", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34" }, @@ -24216,76 +24114,30 @@ "description": "The model of the gateway installed on the asset.", "type": "string", "enum": [ - "none", - "AG45", + "AG15", + "AG24", + "AG24EU", + "AG26", + "AG26EU", "AG41", - "AG46EU", - "IG41", - "VG34", - "IG15", - "EM22", - "PM7", - "VG54NA", - "OEMP", - "ACCCRGO", - "EM01", - "Baxter", - "IGMAO", - "EKM", - "DM1", - "VG54EU", - "IG11", - "CM12", "AG41EU", - "IM32", - "AG46P", - "EM12", - "EM21", - "CM31", + "AG45", + "AG45EU", "AG46", + "AG46EU", + "AG46P", + "IG15", + "IG21", + "IG41", "IG61", - "OEMV", - "Trailer", - "IM31", + "SG1", + "VG32", "VG33", - "AG24", - "HM21", - "EM23", + "VG34", "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" + "VG54EU", + "VG54NA" ], "example": "VG34" },