RubyGems - losant_rest - Versions diffs - 1.0.0 - Mend

losant_rest 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (139) hide show

checksums.yaml +7 -0
data/.gitignore +23 -0
data/.rbenv-version +1 -0
data/.travis.yml +5 -0
data/Gemfile +2 -0
data/LICENSE +21 -0
data/README.md +237 -0
data/Rakefile +12 -0
data/docs/_schemas.md +6348 -0
data/docs/accessToken.md +107 -0
data/docs/accessTokens.md +68 -0
data/docs/application.md +107 -0
data/docs/applicationKey.md +115 -0
data/docs/applicationKeys.md +81 -0
data/docs/applications.md +76 -0
data/docs/auth.md +104 -0
data/docs/dashboard.md +107 -0
data/docs/dashboards.md +76 -0
data/docs/data.md +78 -0
data/docs/device.md +300 -0
data/docs/deviceRecipe.md +152 -0
data/docs/deviceRecipes.md +81 -0
data/docs/devices.md +117 -0
data/docs/event.md +115 -0
data/docs/events.md +153 -0
data/docs/flow.md +261 -0
data/docs/flows.md +81 -0
data/docs/me.md +312 -0
data/docs/org.md +279 -0
data/docs/orgs.md +75 -0
data/docs/webhook.md +115 -0
data/docs/webhooks.md +81 -0
data/examples/auth.rb +32 -0
data/examples/list_devices.rb +45 -0
data/lib/losant_rest/access_token.rb +122 -0
data/lib/losant_rest/access_tokens.rb +80 -0
data/lib/losant_rest/application.rb +122 -0
data/lib/losant_rest/application_key.rb +128 -0
data/lib/losant_rest/application_keys.rb +98 -0
data/lib/losant_rest/applications.rb +94 -0
data/lib/losant_rest/auth.rb +122 -0
data/lib/losant_rest/client.rb +132 -0
data/lib/losant_rest/dashboard.rb +122 -0
data/lib/losant_rest/dashboards.rb +94 -0
data/lib/losant_rest/data.rb +89 -0
data/lib/losant_rest/device.rb +336 -0
data/lib/losant_rest/device_recipe.rb +169 -0
data/lib/losant_rest/device_recipes.rb +98 -0
data/lib/losant_rest/devices.rb +139 -0
data/lib/losant_rest/error.rb +12 -0
data/lib/losant_rest/event.rb +128 -0
data/lib/losant_rest/events.rb +183 -0
data/lib/losant_rest/flow.rb +290 -0
data/lib/losant_rest/flows.rb +98 -0
data/lib/losant_rest/me.rb +362 -0
data/lib/losant_rest/org.rb +314 -0
data/lib/losant_rest/orgs.rb +92 -0
data/lib/losant_rest/utils.rb +22 -0
data/lib/losant_rest/version.rb +3 -0
data/lib/losant_rest/webhook.rb +128 -0
data/lib/losant_rest/webhooks.rb +98 -0
data/lib/losant_rest.rb +43 -0
data/losant_rest.gemspec +25 -0
data/schemas/accessToken.json +52 -0
data/schemas/accessTokenPatch.json +19 -0
data/schemas/accessTokenPost.json +32 -0
data/schemas/accessTokens.json +65 -0
data/schemas/application.json +65 -0
data/schemas/applicationKey.json +68 -0
data/schemas/applicationKeyPatch.json +18 -0
data/schemas/applicationKeyPost.json +36 -0
data/schemas/applicationKeys.json +110 -0
data/schemas/applicationPatch.json +16 -0
data/schemas/applicationPost.json +23 -0
data/schemas/applications.json +103 -0
data/schemas/authedDevice.json +34 -0
data/schemas/authedUser.json +18 -0
data/schemas/dashboard.json +95 -0
data/schemas/dashboardPatch.json +69 -0
data/schemas/dashboardPost.json +76 -0
data/schemas/dashboards.json +133 -0
data/schemas/device.json +113 -0
data/schemas/deviceCommand.json +20 -0
data/schemas/deviceCommands.json +25 -0
data/schemas/deviceCredentials.json +22 -0
data/schemas/deviceLog.json +28 -0
data/schemas/devicePatch.json +78 -0
data/schemas/devicePost.json +81 -0
data/schemas/deviceRecipe.json +106 -0
data/schemas/deviceRecipeBulkCreate.json +15 -0
data/schemas/deviceRecipeBulkCreatePost.json +19 -0
data/schemas/deviceRecipePatch.json +87 -0
data/schemas/deviceRecipePost.json +90 -0
data/schemas/deviceRecipes.json +148 -0
data/schemas/deviceState.json +30 -0
data/schemas/deviceStates.json +35 -0
data/schemas/deviceTagFilter.json +19 -0
data/schemas/devices.json +155 -0
data/schemas/disableTwoFactorAuth.json +20 -0
data/schemas/enableTwoFactorAuth.json +21 -0
data/schemas/error.json +12 -0
data/schemas/event.json +115 -0
data/schemas/eventPatch.json +20 -0
data/schemas/eventPost.json +39 -0
data/schemas/events.json +165 -0
data/schemas/flow.json +137 -0
data/schemas/flowLog.json +46 -0
data/schemas/flowPatch.json +107 -0
data/schemas/flowPost.json +110 -0
data/schemas/flowStorageEntries.json +7 -0
data/schemas/flowStorageEntry.json +16 -0
data/schemas/flows.json +179 -0
data/schemas/githubLogin.json +14 -0
data/schemas/lastValueData.json +34 -0
data/schemas/lastValueQuery.json +36 -0
data/schemas/me.json +173 -0
data/schemas/mePatch.json +43 -0
data/schemas/multiDeviceCommand.json +45 -0
data/schemas/org.json +81 -0
data/schemas/orgInvitePost.json +24 -0
data/schemas/orgInvites.json +36 -0
data/schemas/orgMemberPatch.json +23 -0
data/schemas/orgPatch.json +16 -0
data/schemas/orgPost.json +19 -0
data/schemas/orgs.json +119 -0
data/schemas/recentItem.json +27 -0
data/schemas/recentItemList.json +36 -0
data/schemas/success.json +12 -0
data/schemas/timeSeriesData.json +89 -0
data/schemas/timeSeriesQuery.json +64 -0
data/schemas/userCredentials.json +25 -0
data/schemas/virtualButtonPress.json +14 -0
data/schemas/webhook.json +52 -0
data/schemas/webhookPatch.json +29 -0
data/schemas/webhookPost.json +32 -0
data/schemas/webhooks.json +94 -0
data/test/basic_test.rb +67 -0
data/test/test_helper.rb +14 -0
metadata +239 -0

data/schemas/dashboards.json ADDED Viewed

@@ -0,0 +1,133 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Dashboard",
+        "description": "Schema for a single Dashboard",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "dashboardId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "ownerId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "ownerType": {
+            "type": "string",
+            "enum": [
+              "user",
+              "organization"
+            ]
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
+          "refreshRate": {
+            "type": "number",
+            "minimum": 5,
+            "maximum": 600
+          },
+          "public": {
+            "type": "boolean"
+          },
+          "blocks": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "blockType": {
+                  "type": "string"
+                },
+                "title": {
+                  "type": "string",
+                  "maxLength": 255
+                },
+                "applicationId": {
+                  "type": "string",
+                  "pattern": "^[A-Fa-f\\d]{24}$"
+                },
+                "startX": {
+                  "type": "integer"
+                },
+                "startY": {
+                  "type": "integer"
+                },
+                "width": {
+                  "type": "integer"
+                },
+                "height": {
+                  "type": "integer"
+                },
+                "config": {
+                  "type": "object"
+                }
+              },
+              "required": [
+                "id",
+                "blockType",
+                "startX",
+                "startY",
+                "width",
+                "height"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "filter": {
+      "type": "string"
+    },
+    "filterField": {
+      "type": "string"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc"
+      ]
+    }
+  }
+}

data/schemas/device.json ADDED Viewed

@@ -0,0 +1,113 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "deviceId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          }
+        },
+        "required": [
+          "key",
+          "value"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "attributes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "dataType": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "gps",
+              "boolean"
+            ]
+          }
+        },
+        "required": [
+          "name",
+          "dataType"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "deviceClass": {
+      "type": "string",
+      "enum": [
+        "standalone",
+        "master",
+        "owned",
+        "floating",
+        "virtual"
+      ]
+    },
+    "masterId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "connectionInfo": {
+      "type": "object",
+      "properties": {
+        "time": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "connected": {
+          "enum": [
+            1,
+            0,
+            null
+          ]
+        }
+      }
+    }
+  }
+}

data/schemas/deviceCommand.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "payload": {}
+  },
+  "required": [
+    "name"
+  ],
+  "additionalProperties": false
+}

data/schemas/deviceCommands.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "array",
+  "items": {
+    "title": "Device Command",
+    "description": "Schema for a command for a single Device",
+    "type": "object",
+    "properties": {
+      "time": {
+        "type": "string",
+        "format": "date-time"
+      },
+      "name": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 255
+      },
+      "payload": {}
+    },
+    "required": [
+      "name"
+    ],
+    "additionalProperties": false
+  }
+}

data/schemas/deviceCredentials.json ADDED Viewed

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "deviceId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "key": {
+      "type": "string"
+    },
+    "secret": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "deviceId",
+    "key",
+    "secret"
+  ],
+  "additionalProperties": false
+}

data/schemas/deviceLog.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "connected": {
+        "enum": [
+          1,
+          0
+        ]
+      },
+      "time": {
+        "type": "string",
+        "format": "date-time"
+      },
+      "disconnectReason": {
+        "type": "string"
+      },
+      "messagesFromClient": {
+        "type": "number"
+      },
+      "messagesToClient": {
+        "type": "number"
+      }
+    }
+  }
+}

data/schemas/devicePatch.json ADDED Viewed

@@ -0,0 +1,78 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          }
+        },
+        "required": [
+          "key",
+          "value"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "attributes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "dataType": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "gps",
+              "boolean"
+            ]
+          }
+        },
+        "required": [
+          "name",
+          "dataType"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "deviceClass": {
+      "type": "string",
+      "enum": [
+        "standalone",
+        "master",
+        "owned",
+        "floating",
+        "virtual"
+      ]
+    },
+    "masterId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/devicePost.json ADDED Viewed

@@ -0,0 +1,81 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          }
+        },
+        "required": [
+          "key",
+          "value"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "attributes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "dataType": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "gps",
+              "boolean"
+            ]
+          }
+        },
+        "required": [
+          "name",
+          "dataType"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "deviceClass": {
+      "type": "string",
+      "enum": [
+        "standalone",
+        "master",
+        "owned",
+        "floating",
+        "virtual"
+      ]
+    },
+    "masterId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name"
+  ]
+}

data/schemas/deviceRecipe.json ADDED Viewed

@@ -0,0 +1,106 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "deviceRecipeId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "deviceName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "deviceDescription": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "value": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          }
+        },
+        "required": [
+          "key",
+          "value"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "attributes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+          },
+          "dataType": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "gps",
+              "boolean"
+            ]
+          }
+        },
+        "required": [
+          "name",
+          "dataType"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "deviceClass": {
+      "type": "string",
+      "enum": [
+        "standalone",
+        "master",
+        "owned",
+        "floating",
+        "virtual"
+      ]
+    },
+    "masterId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}

data/schemas/deviceRecipeBulkCreate.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "created": {
+      "type": "number"
+    },
+    "failed": {
+      "type": "number"
+    },
+    "csvResult": {
+      "type": "string"
+    }
+  }
+}

data/schemas/deviceRecipeBulkCreatePost.json ADDED Viewed

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "nameColumn": {
+      "type": "string"
+    },
+    "descriptionColumn": {
+      "type": "string"
+    },
+    "csv": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "csv"
+  ]
+}