RubyGems - losant_rest - Versions diffs - 1.9.2 → 1.10.3 - Mend

losant_rest 1.9.2 → 1.10.3

Files changed (100) hide show

checksums.yaml +4 -4
data/docs/_schemas.md +38445 -24043
data/docs/application.md +124 -2
data/docs/applicationTemplates.md +50 -0
data/docs/auth.md +72 -0
data/docs/device.md +1 -0
data/docs/devices.md +92 -3
data/docs/experienceEndpoints.md +1 -0
data/docs/file.md +4 -4
data/docs/flow.md +94 -1
data/docs/flowVersion.md +96 -1
data/lib/losant_rest.rb +1 -0
data/lib/losant_rest/application.rb +93 -2
data/lib/losant_rest/application_templates.rb +88 -0
data/lib/losant_rest/auth.rb +84 -0
data/lib/losant_rest/client.rb +6 -2
data/lib/losant_rest/device.rb +2 -0
data/lib/losant_rest/devices.rb +105 -2
data/lib/losant_rest/experience_endpoints.rb +2 -0
data/lib/losant_rest/file.rb +3 -3
data/lib/losant_rest/flow.rb +115 -1
data/lib/losant_rest/flow_version.rb +115 -1
data/lib/losant_rest/version.rb +2 -2
data/schemas/advancedDeviceQuery.json +1018 -0
data/schemas/advancedEventQuery.json +382 -13
data/schemas/advancedQuery.json +37 -3
data/schemas/application.json +7 -2
data/schemas/applicationApiTokenPost.json +8 -1
data/schemas/applicationCreationByTemplateResult.json +7 -2
data/schemas/applicationPatch.json +7 -2
data/schemas/applicationPost.json +11 -2
data/schemas/applicationReadme.json +29 -0
data/schemas/applicationReadmePatch.json +11 -0
data/schemas/applicationTemplate.json +99 -0
data/schemas/applicationTemplates.json +140 -0
data/schemas/applications.json +7 -2
data/schemas/dashboard.json +1168 -144
data/schemas/dashboardPatch.json +1168 -144
data/schemas/dashboardPost.json +1168 -144
data/schemas/dashboards.json +1168 -144
data/schemas/dataExport.json +11 -0
data/schemas/dataTableRows.json +3 -0
data/schemas/dataTableRowsExport.json +37 -3
data/schemas/device.json +16 -3
data/schemas/devicePatch.json +16 -3
data/schemas/devicePost.json +16 -3
data/schemas/deviceRecipe.json +16 -3
data/schemas/deviceRecipePatch.json +16 -3
data/schemas/deviceRecipePost.json +16 -3
data/schemas/deviceRecipes.json +16 -3
data/schemas/devices.json +19 -3
data/schemas/devicesDataRemoved.json +12 -0
data/schemas/devicesDeletePost.json +1034 -0
data/schemas/devicesDeleted.json +12 -0
data/schemas/devicesExportPost.json +1035 -0
data/schemas/devicesPatch.json +1773 -7
data/schemas/devicesRemoveDataPost.json +1056 -0
data/schemas/devicesUpdated.json +18 -0
data/schemas/eventPost.json +22 -0
data/schemas/events.json +1 -816
data/schemas/eventsExport.json +382 -13
data/schemas/experienceDomain.json +1 -1
data/schemas/experienceDomainPatch.json +1 -1
data/schemas/experienceDomainPost.json +1 -1
data/schemas/experienceDomains.json +1 -1
data/schemas/experienceGroup.json +7 -0
data/schemas/experienceGroupPatch.json +7 -0
data/schemas/experienceGroupPost.json +7 -0
data/schemas/experienceGroups.json +7 -0
data/schemas/experienceLinkedResources.json +309 -3
data/schemas/experienceVersion.json +1 -1
data/schemas/experienceVersions.json +1 -1
data/schemas/flow.json +103 -1
data/schemas/flowErrors.json +87 -0
data/schemas/flowPatch.json +103 -1
data/schemas/flowPost.json +103 -1
data/schemas/flowStats.json +54 -0
data/schemas/flowVersion.json +206 -2
data/schemas/flowVersionPost.json +103 -1
data/schemas/flowVersions.json +206 -2
data/schemas/flows.json +103 -1
data/schemas/flowsImportPost.json +206 -2
data/schemas/flowsImportResult.json +309 -3
data/schemas/githubLogin.json +10 -1
data/schemas/me.json +3 -0
data/schemas/multiDeviceCommand.json +1019 -0
data/schemas/notebook.json +99 -2
data/schemas/notebookPatch.json +99 -2
data/schemas/notebookPost.json +99 -2
data/schemas/notebooks.json +99 -2
data/schemas/org.json +8 -0
data/schemas/orgPatch.json +9 -0
data/schemas/orgs.json +8 -0
data/schemas/samlResponse.json +21 -0
data/schemas/ssoRequest.json +20 -0
data/schemas/timeSeriesData.json +91 -12
data/schemas/timeSeriesQuery.json +21 -12
data/schemas/userCredentials.json +10 -1
data/schemas/userPost.json +10 -1
metadata +20 -4

@@ -6,17 +6,26 @@
       "type": "array",
       "items": {
         "$ref": "#/definitions/advancedQuery"
-      }
+      },
+      "maxItems": 100
     },
     "$or": {
       "type": "array",
       "items": {
         "$ref": "#/definitions/advancedQuery"
-      }
+      },
+      "maxItems": 100
+    },
+    "$nor": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/advancedQuery"
+      },
+      "maxItems": 100
     }
   },
   "patternProperties": {
-    "^[0-9a-zA-Z_-]{1,255}": {
+    "^[0-9a-zA-Z_-]{1,255}$": {
       "oneOf": [
         {
           "type": [
@@ -88,6 +97,31 @@
             "$contains": {
               "type": "string",
               "minLength": 1
+            },
+            "$ci": {
+              "type": "boolean"
+            },
+            "$in": {
+              "type": "array",
+              "maxItems": 100,
+              "items": {
+                "type": [
+                  "string",
+                  "number",
+                  "boolean"
+                ]
+              }
+            },
+            "$nin": {
+              "type": "array",
+              "maxItems": 100,
+              "items": {
+                "type": [
+                  "string",
+                  "number",
+                  "boolean"
+                ]
+              }
             }
           },
           "additionalProperties": false

data/schemas/application.json CHANGED

@@ -45,7 +45,7 @@
     },
     "description": {
       "type": "string",
-      "maxLength": 32767
+      "maxLength": 1024
     },
     "endpointSlug": {
       "type": "string",
@@ -81,7 +81,7 @@
           },
           "description": {
             "type": "string",
-            "maxLength": 32767
+            "maxLength": 1024
           }
         },
         "additionalProperties": false,
@@ -91,6 +91,11 @@
         ]
       }
     },
+    "blobUrlTTL": {
+      "type": "number",
+      "minimum": 3600,
+      "maximum": 604800
+    },
     "summary": {
       "type": "object",
       "properties": {

data/schemas/applicationApiTokenPost.json CHANGED

@@ -77,6 +77,7 @@
           "application.backfillArchiveData",
           "application.clone",
           "application.export",
+          "application.import",
           "application.fullEventsArchive",
           "application.fullDataTablesArchive",
           "application.debug",
@@ -148,6 +149,8 @@
           "deviceRecipes.get",
           "deviceRecipes.post",
           "devices.patch",
+          "devices.delete",
+          "devices.removeData",
           "devices.detailedSummary",
           "devices.export",
           "devices.get",
@@ -218,23 +221,27 @@
           "file.upload",
           "files.get",
           "files.post",
+          "flow.clearStorageEntries",
           "flow.debug",
           "flow.delete",
-          "flow.clearStorageEntries",
+          "flow.errors",
           "flow.get",
           "flow.getStorageEntries",
           "flow.log",
           "flow.patch",
           "flow.pressVirtualButton",
           "flow.setStorageEntry",
+          "flow.stats",
           "flows.get",
           "flows.getByVersion",
           "flows.import",
           "flows.post",
           "flowVersion.delete",
+          "flowVersion.errors",
           "flowVersion.get",
           "flowVersion.log",
           "flowVersion.patch",
+          "flowVersion.stats",
           "flowVersions.get",
           "flowVersions.post",
           "integration.delete",

data/schemas/applicationCreationByTemplateResult.json CHANGED

@@ -50,7 +50,7 @@
         },
         "description": {
           "type": "string",
-          "maxLength": 32767
+          "maxLength": 1024
         },
         "endpointSlug": {
           "type": "string",
@@ -86,7 +86,7 @@
               },
               "description": {
                 "type": "string",
-                "maxLength": 32767
+                "maxLength": 1024
               }
             },
             "additionalProperties": false,
@@ -96,6 +96,11 @@
             ]
           }
         },
+        "blobUrlTTL": {
+          "type": "number",
+          "minimum": 3600,
+          "maximum": 604800
+        },
         "summary": {
           "type": "object",
           "properties": {

data/schemas/applicationPatch.json CHANGED

@@ -9,7 +9,7 @@
     },
     "description": {
       "type": "string",
-      "maxLength": 32767
+      "maxLength": 1024
     },
     "endpointSlug": {
       "type": "string",
@@ -45,7 +45,7 @@
           },
           "description": {
             "type": "string",
-            "maxLength": 32767
+            "maxLength": 1024
           }
         },
         "additionalProperties": false,
@@ -236,6 +236,11 @@
         }
       },
       "additionalProperties": false
+    },
+    "blobUrlTTL": {
+      "type": "number",
+      "minimum": 3600,
+      "maximum": 604800
     }
   },
   "additionalProperties": false

data/schemas/applicationPost.json CHANGED

@@ -6,6 +6,10 @@
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "applicationTemplateId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
     "name": {
       "type": "string",
       "minLength": 1,
@@ -13,7 +17,7 @@
     },
     "description": {
       "type": "string",
-      "maxLength": 32767
+      "maxLength": 1024
     },
     "endpointSlug": {
       "type": "string",
@@ -49,7 +53,7 @@
           },
           "description": {
             "type": "string",
-            "maxLength": 32767
+            "maxLength": 1024
           }
         },
         "additionalProperties": false,
@@ -211,6 +215,11 @@
         }
       },
       "additionalProperties": false
+    },
+    "blobUrlTTL": {
+      "type": "number",
+      "minimum": 3600,
+      "maximum": 604800
     }
   },
   "additionalProperties": false,

data/schemas/applicationReadme.json ADDED

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdatedById": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "lastUpdatedByType": {
+      "type": "string",
+      "enum": [
+        "flow",
+        "user",
+        "apiToken"
+      ]
+    },
+    "content": {
+      "type": "string"
+    }
+  }
+}

data/schemas/applicationReadmePatch.json ADDED

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string",
+      "maxLength": 131072
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/applicationTemplate.json ADDED

@@ -0,0 +1,99 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "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": 1024
+    },
+    "public": {
+      "type": "boolean"
+    },
+    "authorName": {
+      "type": "string",
+      "maxLength": 255
+    },
+    "imageUrl": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "authorUrl": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "templateUrl": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "applicationCertificateAuthorityCount": {
+          "type": "number"
+        },
+        "dashboardCount": {
+          "type": "number"
+        },
+        "deviceCount": {
+          "type": "number"
+        },
+        "deviceRecipeCount": {
+          "type": "number"
+        },
+        "dataTableCount": {
+          "type": "number"
+        },
+        "experienceGroupCount": {
+          "type": "number"
+        },
+        "experienceUserCount": {
+          "type": "number"
+        },
+        "experienceVersionCount": {
+          "type": "number"
+        },
+        "experienceViewCount": {
+          "type": "number"
+        },
+        "experienceEndpointCount": {
+          "type": "number"
+        },
+        "fileCount": {
+          "type": "number"
+        },
+        "flowCount": {
+          "type": "number"
+        },
+        "integrationCount": {
+          "type": "number"
+        },
+        "notebookCount": {
+          "type": "number"
+        },
+        "dataTableCsvSize": {
+          "type": "number"
+        },
+        "webhookCount": {
+          "type": "number"
+        }
+      }
+    }
+  }
+}

data/schemas/applicationTemplates.json ADDED

@@ -0,0 +1,140 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "Application Template",
+        "description": "Schema for a single Application Template",
+        "type": "object",
+        "properties": {
+          "id": {
+            "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": 1024
+          },
+          "public": {
+            "type": "boolean"
+          },
+          "authorName": {
+            "type": "string",
+            "maxLength": 255
+          },
+          "imageUrl": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "authorUrl": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "templateUrl": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "summary": {
+            "type": "object",
+            "properties": {
+              "applicationCertificateAuthorityCount": {
+                "type": "number"
+              },
+              "dashboardCount": {
+                "type": "number"
+              },
+              "deviceCount": {
+                "type": "number"
+              },
+              "deviceRecipeCount": {
+                "type": "number"
+              },
+              "dataTableCount": {
+                "type": "number"
+              },
+              "experienceGroupCount": {
+                "type": "number"
+              },
+              "experienceUserCount": {
+                "type": "number"
+              },
+              "experienceVersionCount": {
+                "type": "number"
+              },
+              "experienceViewCount": {
+                "type": "number"
+              },
+              "experienceEndpointCount": {
+                "type": "number"
+              },
+              "fileCount": {
+                "type": "number"
+              },
+              "flowCount": {
+                "type": "number"
+              },
+              "integrationCount": {
+                "type": "number"
+              },
+              "notebookCount": {
+                "type": "number"
+              },
+              "dataTableCsvSize": {
+                "type": "number"
+              },
+              "webhookCount": {
+                "type": "number"
+              }
+            }
+          }
+        }
+      }
+    },
+    "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",
+        "ASC",
+        "DESC",
+        ""
+      ]
+    }
+  }
+}