Merge pull request #36 from tago-io/feat/methods-device/SDKPY-115

feat/methods-device/SDKPY-115

Author: felipefdl

.flake8

@@ -17,7 +17,9 @@ extend-ignore =
     ANN101,
     # ANN102: Missing type annotation for cls in classmethod
     ANN102,
-    E722
+    E722,
+    BLK100,
+    # BLK100: Missing type annotation for public function
 per-file-ignores =
     # F401: Module imported by unused (non-implicit modules)
     # TC002: Move third-party import '...' into a type-checking block

README.md

@@ -20,32 +20,29 @@ If you have any questions, feel free to check our [Help Center](https://help.tag
 ### Insert Device Data
 
 ```python
-from tagoio_sdk import Device
+from tagoio_sdk import Resources
 
-myDevice = Device({ "token": "my_device_token" })
-result = myDevice.sendData({
+resources = Resources()
+resource.devices.sendDeviceData("myDeviceID", {
     "variable": "temperature",
     "unit": "F",
     "value": 55,
     "time": "2015-11-03 13:44:33",
-    "location": { "lat": 42.2974279, "lng": -85.628292 },
+    "location": {"lat": 42.2974279, "lng": -85.628292},
 })
 ```
 
 ### Edit Device Data
 
 ```python
-from tagoio_sdk import Device
-
-myDevice = Device({"token": "my_device_token"})
-result = myDevice.editData(
-    {
-        "id": "id_of_the_data_item",
-        "value": "123",
-        "time": "2022-04-01 12:34:56",
-        "location": {"lat": 42.2974279, "lng": -85.628292},
-    }
-)
+from tagoio_sdk import Resources
+
+resources = Resource()
+resource.devices.editDeviceData("myDeviceID", {
+    "id": "idOfTheRecord",
+    "value": "new value",
+    "unit": "new unit"
+})
 ```
 
 ## Development Commands

docs/source/Resources/Dashboards/Dashboard_Type.rst

@@ -24,10 +24,13 @@ DashboardCreateInfo
 
     **Attributes:**
 
-        | **label**: str
-        | **arrangement**: list[Arrangement]
-        | **tags**: list[TagsObj]
-        | **visible**: bool
+        **label**: str
+
+        **arrangement**: list[Arrangement]
+
+        **tags**: list[:ref:`TagsObj`]
+
+        **visible**: bool
 
 .. _icon:
 
@@ -137,7 +140,7 @@ WidgetResource
 
     **Attributes:**
 
-        | **filter**: list[TagsObj]
+        filter: list[:ref:`TagsObj`]
 
 .. _DeviceResourceView:
 

docs/source/Resources/Devices/Devices_Type.rst

@@ -205,7 +205,7 @@ DeviceCreateInfoBasic
         | **configuration_params**: Optional[list[ConfigurationParams]]
         | [Optional] An array of configuration params
 
-        | **tags**: Optional[list[TagsObj]]
+        | **tags**: Optional[list[:ref:`TagsObj`]]
         | [Optional] An array of tags
 
         | **serie_number**: Optional[str]

docs/source/Resources/Devices/index.rst

@@ -206,3 +206,77 @@ Retrieves a list of all tokens
             "amount": 20,
             "orderBy": "created_at,desc",
         }
+
+==========
+sendDeviceData
+==========
+
+Send data to a device.
+
+    **Parameters:**
+
+        | **deviceID**: GenericID: str
+        | Device ID
+
+        | **data**: Union[:ref:`DataCreate`, list[:ref:`DataCreate`]]
+        | An array or one object with data to be send to TagoIO.
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        resource.devices.sendDeviceData("myDeviceID", {
+            "variable": "temperature",
+            "unit": "F",
+            "value": 55,
+            "time": "2015-11-03 13:44:33",
+            "location": { "lat": 42.2974279, "lng": -85.628292 },
+        })
+
+==========
+editDeviceData
+==========
+
+Edit data in a device.
+
+    **Parameters:**
+
+        | **deviceID**: GenericID: str
+        | Device ID
+
+        | **updatedData**: Union[:ref:`DataEdit`, list[:ref:`DataEdit`]]
+        | An array or one object with data to be send to TagoIO.
+
+.. code-block::
+    :caption: **Example:**
+
+    resources = Resource()
+    resource.devices.editDeviceData("myDeviceID", {
+        "id": "idOfTheRecord",
+        "value": "new value",
+        "unit": "new unit"
+    })
+
+==========
+deleteDeviceData
+==========
+
+Delete data from a device.
+
+    **Parameters:**
+
+        | **deviceID**: GenericID: str
+        | Device ID
+
+        | *Optional* **queryParams**: :ref:`DataQuery`
+        | Query parameters to filter the results.
+
+.. code-block::
+    :caption: **Example:**
+
+    resources = Resource()
+    resource.devices.deleteDeviceData("myDeviceID", {
+        "ids": ["recordIdToDelete", "anotherRecordIdToDelete" ]
+    })

docs/source/Resources/Run/Run_Types.rst

@@ -266,7 +266,7 @@ UserCreateInfo
         | **company**: Optional[str]
         | **phone**: Optional[str]
         | **language**: Optional[str]
-        | **tags**: Optional[list[TagsObj]]
+        | **tags**: Optional[list[:ref:`TagsObj`]]
         | **active**: Optional[bool]
 
 .. _UserInfo:
@@ -282,7 +282,7 @@ UserInfo
         | **company**: Optional[str]
         | **phone**: Optional[str]
         | **language**: Optional[str]
-        | **tags**: Optional[list[TagsObj]]
+        | **tags**: Optional[list[:ref:`TagsObj`]]
         | **active**: Optional[bool]
         | **id**: GenericID
         | **profile**: GenericID
@@ -292,7 +292,7 @@ UserInfo
         | **created_at**: datetime
         | **updated_at**: datetime
         | **options**: object
-        | **tags**: list[TagsObj]
+        | **tags**: list[:ref:`TagsObj`]
 
 .. _LoginResponse: