losant_rest 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9f63e144f5c8d3f2b77eef7a561a7df05c96a60
-  data.tar.gz: f00576df31b359a9ff094e903b9479cc8e9cd6f6
+  metadata.gz: c11a85f0b5a6200a2ea9aa541eb96aee3ba5a376
+  data.tar.gz: d3f145e28a8e00dc74d2745881c51201c8569a9b
 SHA512:
-  metadata.gz: 436d742c5224a575abe2e1cd16f394ed12e9111b6fabcb7b0980e12900aa2cbf5a23d68ba0f320bea96f977087b5968ce24fe3a45d9ba517bdc7380320f0327b
-  data.tar.gz: 7ee47ea16f3c96b0fcd659245cc05ca7ea989294b774b151bcd1339284c61b54d778d6a0574a0749f56572b2f241ca7b29908dd099e1500e2640e2db721dfc0a
+  metadata.gz: cac9c0ec1272db66322919234c75292d3bb9e5dd0eeee4846d5fb298f434eeabee9ff2ef467719d8ccc9d5350f92f91b011c047c378ef43021fa2e65de66e0b4
+  data.tar.gz: 2e6d8b88d29de4d78dc8dd088f83d171aa196d9d5e8ad4348c7bbf45a766d0c38e811943da3cbf220f1f750fd0628e9eabe6572f1d5703c8b665322a1c86ab82

data/docs/_schemas.md

@@ -15,6 +15,7 @@
 *   [Authenticated Device](#authenticated-device)
 *   [Authenticated Solution User](#authenticated-solution-user)
 *   [Authenticated User](#authenticated-user)
+*   [Composite Device State](#composite-device-state)
 *   [Dashboard](#dashboard)
 *   [Dashboard Patch](#dashboard-patch)
 *   [Dashboard Post](#dashboard-post)
@@ -66,6 +67,7 @@
 *   [Payload Counts](#payload-counts)
 *   [Recent Item](#recent-item)
 *   [Recent Item List](#recent-item-list)
+*   [Resource Transfer](#resource-transfer)
 *   [Solution](#solution)
 *   [Solution Patch](#solution-patch)
 *   [Solution Post](#solution-post)
@@ -1141,6 +1143,75 @@ Schema for the sucessful response when authenticating a User
 
 <br/>
 
+## Composite Device State
+
+Schema for a composite Device state
+
+### <a name="composite-device-state-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "patternProperties": {
+    "^[0-9a-zA-Z_-]{1,255}$": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": [
+            "number",
+            "string",
+            "boolean"
+          ]
+        },
+        "time": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$date": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "$date"
+              ]
+            }
+          ]
+        },
+        "relayId": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "additionalProperties": false
+}
+```
+### <a name="composite-device-state-example"></a> Example
+
+```json
+{
+  "voltage": {
+    "time": "2016-06-13T04:00:00.000Z",
+    "value": 22.4
+  },
+  "loaded": {
+    "time": "2016-06-13T03:00:00.000Z",
+    "value": false
+  }
+}
+```
+
+<br/>
+
 ## Dashboard
 
 Schema for a single Dashboard
@@ -5030,6 +5101,9 @@ Schema for information about the currently authenticated user
       },
       "dataTTL": {
         "type": "number"
+      },
+      "payload": {
+        "type": "number"
       }
     },
     "recentDashboards": {
@@ -5043,7 +5117,8 @@ Schema for information about the currently authenticated user
             "application",
             "device",
             "flow",
-            "dashboard"
+            "dashboard",
+            "organization"
           ]
         },
         "parentId": {
@@ -5080,7 +5155,46 @@ Schema for information about the currently authenticated user
             "application",
             "device",
             "flow",
-            "dashboard"
+            "dashboard",
+            "organization"
+          ]
+        },
+        "parentId": {
+          "type": "string",
+          "pattern": "^[A-Fa-f\\d]{24}$"
+        },
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "pattern": "^[A-Fa-f\\d]{24}$"
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              }
+            }
+          }
+        }
+      }
+    },
+    "recentOrganizations": {
+      "title": "Recent Item List",
+      "description": "Schema for an array of recent items",
+      "type": "object",
+      "properties": {
+        "itemType": {
+          "type": "string",
+          "enum": [
+            "application",
+            "device",
+            "flow",
+            "dashboard",
+            "organization"
           ]
         },
         "parentId": {
@@ -5130,13 +5244,105 @@ Schema for information about the currently authenticated user
         "keyCount": {
           "type": "number"
         },
-        "eventCount": {
-          "type": "number"
-        },
         "deviceRecipeCount": {
           "type": "number"
+        },
+        "payloadCount": {
+          "title": "Payload Counts",
+          "description": "Schema the result of a payload count request",
+          "type": "object",
+          "properties": {
+            "mqttOut": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "mqttIn": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceState": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceCommand": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "webhook": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "timer": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "event": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "virtualButton": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceConnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceDisconnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            }
+          }
         }
       }
+    },
+    "currentPeriodStart": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "currentPeriodEnd": {
+      "type": "string",
+      "format": "date-time"
     }
   }
 }
@@ -5439,6 +5645,12 @@ Schema for a single Organization
       },
       "dataTTL": {
         "type": "number"
+      },
+      "member": {
+        "type": "number"
+      },
+      "payload": {
+        "type": "number"
       }
     },
     "summary": {
@@ -5465,13 +5677,136 @@ Schema for a single Organization
         "keyCount": {
           "type": "number"
         },
-        "eventCount": {
+        "deviceRecipeCount": {
           "type": "number"
         },
-        "deviceRecipeCount": {
+        "payloadCount": {
+          "title": "Payload Counts",
+          "description": "Schema the result of a payload count request",
+          "type": "object",
+          "properties": {
+            "mqttOut": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "mqttIn": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceState": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceCommand": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "webhook": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "timer": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "event": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "virtualButton": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceConnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceDisconnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            }
+          }
+        },
+        "pendingInviteCount": {
+          "type": "number"
+        },
+        "memberCount": {
           "type": "number"
         }
       }
+    },
+    "planId": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "billingEmail": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "subscriptionStatus": {
+      "type": "string",
+      "enum": [
+        "trialing",
+        "active",
+        "past_due",
+        "canceled",
+        "unpaid"
+      ]
+    },
+    "currentPeriodStart": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "currentPeriodEnd": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "isEnterprise": {
+      "type": "boolean"
+    },
+    "iconColor": {
+      "type": "string"
     }
   }
 }
@@ -5682,6 +6017,22 @@ Schema for the body of an Organization modification request
     "description": {
       "type": "string",
       "maxLength": 32767
+    },
+    "planId": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "billingEmail": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "cardToken": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "iconColor": {
+      "type": "string"
     }
   },
   "additionalProperties": false
@@ -5717,6 +6068,22 @@ Schema for the body of an Organization creation request
     "description": {
       "type": "string",
       "maxLength": 32767
+    },
+    "planId": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "billingEmail": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "cardToken": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "iconColor": {
+      "type": "string"
     }
   },
   "additionalProperties": false,
@@ -5848,6 +6215,12 @@ Schema for a collection of Organizations
             },
             "dataTTL": {
               "type": "number"
+            },
+            "member": {
+              "type": "number"
+            },
+            "payload": {
+              "type": "number"
             }
           },
           "summary": {
@@ -5874,13 +6247,136 @@ Schema for a collection of Organizations
               "keyCount": {
                 "type": "number"
               },
-              "eventCount": {
+              "deviceRecipeCount": {
                 "type": "number"
               },
-              "deviceRecipeCount": {
+              "payloadCount": {
+                "title": "Payload Counts",
+                "description": "Schema the result of a payload count request",
+                "type": "object",
+                "properties": {
+                  "mqttOut": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "mqttIn": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "deviceState": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "deviceCommand": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "webhook": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "timer": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "event": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "virtualButton": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "deviceConnect": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  },
+                  "deviceDisconnect": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "type": "number"
+                      }
+                    }
+                  }
+                }
+              },
+              "pendingInviteCount": {
+                "type": "number"
+              },
+              "memberCount": {
                 "type": "number"
               }
             }
+          },
+          "planId": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "billingEmail": {
+            "type": "string",
+            "format": "email",
+            "maxLength": 1024
+          },
+          "subscriptionStatus": {
+            "type": "string",
+            "enum": [
+              "trialing",
+              "active",
+              "past_due",
+              "canceled",
+              "unpaid"
+            ]
+          },
+          "currentPeriodStart": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "currentPeriodEnd": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "isEnterprise": {
+            "type": "boolean"
+          },
+          "iconColor": {
+            "type": "string"
           }
         }
       }
@@ -6106,7 +6602,8 @@ Schema for the body of a request to add a recent item
         "application",
         "device",
         "flow",
-        "dashboard"
+        "dashboard",
+        "organization"
       ]
     },
     "parentId": {
@@ -6153,7 +6650,8 @@ Schema for an array of recent items
         "application",
         "device",
         "flow",
-        "dashboard"
+        "dashboard",
+        "organization"
       ]
     },
     "parentId": {
@@ -6200,6 +6698,74 @@ Schema for an array of recent items
 
 <br/>
 
+## Resource Transfer
+
+Schema for the body of a resource transfer request
+
+### <a name="resource-transfer-schema"></a> Schema
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "destinationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "destinationType": {
+      "type": "string",
+      "enum": [
+        "user",
+        "organization"
+      ]
+    },
+    "applicationIds": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      }
+    },
+    "dashboardIds": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      }
+    },
+    "solutionIds": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      }
+    },
+    "strict": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "destinationId",
+    "destinationType"
+  ]
+}
+```
+### <a name="resource-transfer-example"></a> Example
+
+```json
+{
+  "destinationId": "575ed6e87ae143cd83dc4aa8",
+  "destinationType": "organization",
+  "applicationIds": [
+    "575ec8687ae143cd83dc4a97"
+  ]
+}
+```
+
+<br/>
+
 ## Solution
 
 Schema for a single Solution
@@ -7392,6 +7958,9 @@ Schema for the body of a time series query request
         "type": "string",
         "pattern": "^[A-Fa-f\\d]{24}$"
       }
+    },
+    "limit": {
+      "type": "number"
     }
   },
   "additionalProperties": false