Merge pull request #30 from tago-io/beta

Beta
tago-io · Oct 4, 2023 · 1546e11 · 1546e11
2 parents 3af0fdf + b322172
commit 1546e11
Show file tree

Hide file tree

Showing 54 changed files with 320 additions and 254 deletions.
diff --git a/docs/source/Account/Account/index.rst b/docs/source/Account/Account/index.rst
diff --git a/docs/source/Account/Buckets/index.rst b/docs/source/Account/Buckets/index.rst
diff --git a/docs/source/Account/index.rst b/docs/source/Account/index.rst
diff --git a/docs/source/Account/Account/Account_type.rst → ...source/Resources/Account/Account_type.rst b/docs/source/Account/Account/Account_type.rst → ...source/Resources/Account/Account_type.rst
diff --git a/docs/source/Resources/Account/index.rst b/docs/source/Resources/Account/index.rst
@@ -0,0 +1,22 @@
+**Account**
+==========
+
+Manage Account.
+
+=========
+info
+=========
+
+Gets all account information.
+
+    **Return:**
+
+        | **AccountInfo**: :ref:`AccountInfo`
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.account.info()
diff --git a/docs/source/Account/Billing/Billing_Type.rst → ...source/Resources/Billing/Billing_Type.rst b/docs/source/Account/Billing/Billing_Type.rst → ...source/Resources/Billing/Billing_Type.rst
diff --git a/docs/source/Account/Billing/index.rst → docs/source/Resources/Billing/index.rst b/docs/source/Account/Billing/index.rst → docs/source/Resources/Billing/index.rst
@@ -1,7 +1,7 @@
 **Billing**
 ==========
 
-Manage Billing for the account. Be sure to use an account token with “write” permissions when using functions like create, edit and delete.
+Manage Billing for the account.
 
 =========
 getPrices
@@ -12,10 +12,10 @@ Get pricing for plans, services and add-ons.
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.billing.getPrices()
+        resources = Resources()
+        result = resources.billing.getPrices()
 
 ===============
 getSubscription
@@ -26,10 +26,10 @@ Get the account subscription information.
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.billing.getSubscription()
+        resources = Resources()
+        result = resources.billing.getSubscription()
 
 ================
 editSubscription

diff --git a/docs/source/Resources/Buckets/index.rst b/docs/source/Resources/Buckets/index.rst
@@ -0,0 +1,42 @@
+**Buckets**
+============
+
+Manage buckets in account.
+
+====
+info
+====
+
+Gets information about the bucket
+
+    **Parameters:**
+
+        | **bucketID**: GenericID: str
+        | Bucket ID
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.buckets.info("Bucket ID")
+
+======
+amount
+======
+
+Get Amount of data on the Bucket
+
+    **Parameters:**
+
+        | **bucketID**: GenericID: str
+        | Bucket ID
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.buckets.amount("Bucket ID")
diff --git a/...rce/Account/Dashboards/Dashboard_Type.rst → ...e/Resources/Dashboards/Dashboard_Type.rst b/...rce/Account/Dashboards/Dashboard_Type.rst → ...e/Resources/Dashboards/Dashboard_Type.rst
diff --git a/docs/source/Account/Dashboards/index.rst → docs/source/Resources/Dashboards/index.rst b/docs/source/Account/Dashboards/index.rst → docs/source/Resources/Dashboards/index.rst
@@ -1,7 +1,7 @@
 **Dashboards**
 ==============
 
-Manage dashboards in account Be sure to use an account token with “write” permissions when using functions like create, edit and delete.
+Manage dashboards in account.
 
 =======
 create

diff --git a/docs/source/Account/Devices/Devices_Type.rst → ...source/Resources/Devices/Devices_Type.rst b/docs/source/Account/Devices/Devices_Type.rst → ...source/Resources/Devices/Devices_Type.rst
diff --git a/docs/source/Account/Devices/index.rst → docs/source/Resources/Devices/index.rst b/docs/source/Account/Devices/index.rst → docs/source/Resources/Devices/index.rst
@@ -1,7 +1,7 @@
 **Devices**
 ============
 
-Manage devices in account Be sure to use an account token with “write” permissions when using functions like create, edit and delete.
+Manage devices in account.
 
 =======
 create
@@ -70,10 +70,10 @@ Get data from all variables in the device.
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myDevice = Account({ "token": "my_account_token" })
-        myDevice.devices.getVariablesData("myDeviceId");
+        resources = Resources()
+        resources.devices.getDeviceData("myDeviceId");
 
 =====
 info

diff --git a/...rationNetwork/IntegrationNetwork_Type.rst → ...rationNetwork/IntegrationNetwork_Type.rst b/...rationNetwork/IntegrationNetwork_Type.rst → ...rationNetwork/IntegrationNetwork_Type.rst
diff --git a/...urce/Account/IntegrationNetwork/index.rst → ...ce/Resources/IntegrationNetwork/index.rst b/...urce/Account/IntegrationNetwork/index.rst → ...ce/Resources/IntegrationNetwork/index.rst
diff --git a/docs/source/Account/Profile/index.rst → docs/source/Resources/Profile/index.rst b/docs/source/Account/Profile/index.rst → docs/source/Resources/Profile/index.rst
@@ -1,7 +1,7 @@
 **Profile**
 ============
 
-Manage profiles in account be sure to use an account token with “write” permissions when using functions like create, edit and delete.
+Manage profiles in account.
 
 ====
 info
@@ -17,10 +17,10 @@ Gets information about the bucket
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.profile.info("Profile ID")
+        resources = Resources()
+        result = resources.profile.info("Profile ID")
 
 ====
 list
@@ -31,10 +31,10 @@ Lists all the profiles in your account
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.profile.list()
+        resources = Resources()
+        result = resources.profile.list()
 
 
 ========
@@ -51,10 +51,10 @@ Gets profile summary
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.profile.summary("Profile ID")
+        resources = Resources()
+        result = resources.profile.summary("Profile ID")
 
 
 ========
@@ -73,7 +73,7 @@ Gets profile tokenList
 .. code-block::
     :caption: **Example:**
 
-        from tagoio_sdk import Account
+        from tagoio_sdk import Resources
 
-        myAccount = Account({ "token": "my_account_token" })
-        result = myAccount.profile.tokenList("Profile ID")
+        resources = Resources()
+        result = resources.profile.tokenList("Profile ID")
diff --git a/docs/source/Account/Run/Run_Types.rst → docs/source/Resources/Run/Run_Types.rst b/docs/source/Account/Run/Run_Types.rst → docs/source/Resources/Run/Run_Types.rst
diff --git a/docs/source/Account/Run/index.rst → docs/source/Resources/Run/index.rst b/docs/source/Account/Run/index.rst → docs/source/Resources/Run/index.rst
@@ -2,7 +2,7 @@
 **Run**
 ========
 
-Manage services in account, be sure to use an account token with “write” permissions when using functions like create, edit and delete.
+Manage services in account.
 
 
 ============

diff --git a/docs/source/Resources/index.rst b/docs/source/Resources/index.rst
@@ -0,0 +1,35 @@
+
+**Resources**
+==========
+
+To set up an resource object, you need to import the ``Resources`` class from the ``tagoio_sdk`` module.
+
+========
+Instance
+========
+
+    **Parameters:**
+
+        | *Optional* **token**: str
+        | Token is a optional parameter
+
+        | *Optional* **region**: str "usa-1" or "env"
+        | Region is a optional parameter
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+
+.. toctree::
+
+    Account/index
+    Billing/index
+    Buckets/index
+    Dashboards/index
+    Devices/index
+    IntegrationNetwork/index
+    Profile/index
+    Run/index