losant_rest 1.8.2 → 1.8.3

data/docs/application.md

@@ -13,6 +13,7 @@ parameters and the potential responses.
 *   [Mqtt Publish Message](#mqtt-publish-message)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
+*   [Search](#search)
 
 <br/>
 
@@ -283,3 +284,43 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Search
+
+Search across an application&#x27;s resources by target identifier
+
+```ruby
+result = client.application.search(
+  applicationId: my_application_id,
+  filter: my_filter)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.search.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| filter | string | Y | The partial resource name being searched for |  | my dev |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Search Result](_schemas.md#application-search-result) | An array of resource ids, names, descriptions, and types matching the search query |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application is not found |

data/docs/dashboards.md

@@ -30,12 +30,13 @@ all.Organization, all.Organization.read, all.SolutionUser, all.SolutionUser.read
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId | name | name |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, applicationId | name | name |
 | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
 | page | string | N | Which page of results to return | 0 | 0 |
 | perPage | string | N | How many items to return per page | 1000 | 10 |
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * dashboard |
+| applicationId | string | N | If not provided, return all dashboards. If provided but blank, only return dashboards that are not linked to applications. If provided and an id, only return dashboards linked to the given application id. |  | 575ec8687ae143cd83dc4a97 |
 | orgId | string | N | If not provided, return all dashboards. If provided but blank, only return dashboards belonging to the current user. If provided and an id, only return dashboards belonging to the given organization id. |  | 575ece7e7ae143cd83dc4a9c |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 

data/docs/dataTableRows.md

@@ -64,7 +64,8 @@ Request an export of the data table's data
 ```ruby
 result = client.data_table_rows.export(
   applicationId: my_application_id,
-  dataTableId: my_data_table_id)
+  dataTableId: my_data_table_id,
+  exportData: my_export_data)
 
 puts result
 ```
@@ -80,7 +81,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | dataTableId | string | Y | ID associated with the data table |  | 575ed78e7ae143cd83dc4aab |
-| exportData | [Data Table Export](_schemas.md#data-table-export) | N | Object containing export specifications |  | [Data Table Export Example](_schemas.md#data-table-export-example) |
+| exportData | [Data Table Export](_schemas.md#data-table-export) | Y | Object containing export specifications |  | [Data Table Export Example](_schemas.md#data-table-export-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/lib/losant_rest/application.rb

@@ -350,5 +350,52 @@ module LosantRest
         body: body)
     end
 
+    # Search across an application's resources by target identifier
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.search.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated application
+    # *  {string} filter - The partial resource name being searched for
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - An array of resource ids, names, descriptions, and types matching the search query (https://api.losant.com/#/definitions/applicationSearchResult)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application is not found (https://api.losant.com/#/definitions/error)
+    def search(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("filter is required") unless params.has_key?(:filter)
+
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/search"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.13.2
+  # Built For Version 1.13.3
   class Client
     attr_accessor :auth_token, :url
 
@@ -266,7 +266,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.13.2"
+      headers["Accept-Version"] = "^1.13.3"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/dashboards.rb

@@ -38,12 +38,13 @@ module LosantRest
     # all.Organization, all.Organization.read, all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, dashboards.*, or dashboards.get.
     #
     # Parameters:
-    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, applicationId
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
     # *  {string} page - Which page of results to return
     # *  {string} perPage - How many items to return per page
     # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {string} applicationId - If not provided, return all dashboards. If provided but blank, only return dashboards that are not linked to applications. If provided and an id, only return dashboards linked to the given application id.
     # *  {string} orgId - If not provided, return all dashboards. If provided but blank, only return dashboards belonging to the current user. If provided and an id, only return dashboards belonging to the given organization id.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
@@ -68,6 +69,7 @@ module LosantRest
       query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      query_params[:applicationId] = params[:applicationId] if params.has_key?(:applicationId)
       query_params[:orgId] = params[:orgId] if params.has_key?(:orgId)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
       query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)

data/lib/losant_rest/data_table_rows.rb

@@ -110,6 +110,7 @@ module LosantRest
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
       raise ArgumentError.new("dataTableId is required") unless params.has_key?(:dataTableId)
+      raise ArgumentError.new("exportData is required") unless params.has_key?(:exportData)
 
       body = params[:exportData] if params.has_key?(:exportData)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.8.2"
+  VERSION = "1.8.3"
 end

data/schemas/application.json

@@ -29,6 +29,14 @@
         "organization"
       ]
     },
+    "organizationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "organizationIconColor": {
+      "type": "string"
+    },
     "name": {
       "type": "string",
       "minLength": 1,

data/schemas/applicationApiTokenPost.json

@@ -76,6 +76,7 @@
           "application.mqttSubscriptionStream",
           "application.patch",
           "application.payloadCounts",
+          "application.search",
           "applicationApiToken.delete",
           "applicationApiToken.get",
           "applicationApiToken.patch",

data/schemas/applicationSearchResult.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "id": {
+        "type": "string",
+        "pattern": "^[A-Fa-f\\d]{24}$"
+      },
+      "name": {
+        "type": "string"
+      },
+      "metadata": {
+        "type": "object"
+      },
+      "viewType": {
+        "type": "string"
+      },
+      "version": {
+        "type": "string"
+      },
+      "_type": {
+        "type": "string",
+        "enum": [
+          "applicationKey",
+          "dashboard",
+          "dataTable",
+          "deviceRecipe",
+          "device",
+          "domain",
+          "event",
+          "experienceEndpoint",
+          "experienceGroup",
+          "experienceSlug",
+          "experienceUser",
+          "experienceVersion",
+          "experienceView",
+          "file",
+          "flow",
+          "integration",
+          "webhook"
+        ]
+      }
+    },
+    "required": [
+      "id",
+      "name",
+      "_type"
+    ]
+  }
+}

data/schemas/applications.json

@@ -36,6 +36,14 @@
               "organization"
             ]
           },
+          "organizationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "organizationIconColor": {
+            "type": "string"
+          },
           "name": {
             "type": "string",
             "minLength": 1,

data/schemas/dashboard.json

@@ -29,6 +29,23 @@
         "organization"
       ]
     },
+    "organizationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "organizationIconColor": {
+      "type": "string"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
     "name": {
       "type": "string",
       "minLength": 1,

data/schemas/dashboardPost.json

@@ -6,6 +6,10 @@
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
     "name": {
       "type": "string",
       "minLength": 1,

data/schemas/dashboards.json

@@ -36,6 +36,23 @@
               "organization"
             ]
           },
+          "organizationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "organizationIconColor": {
+            "type": "string"
+          },
+          "applicationId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "applicationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
           "name": {
             "type": "string",
             "minLength": 1,
@@ -331,6 +348,14 @@
         "asc",
         "desc"
       ]
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
     }
   }
 }

data/schemas/flow.json

@@ -68,6 +68,7 @@
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -83,8 +84,8 @@
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",

data/schemas/flowPatch.json

@@ -49,6 +49,7 @@
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -64,8 +65,8 @@
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",

data/schemas/flowPost.json

@@ -38,6 +38,7 @@
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -53,8 +54,8 @@
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",

data/schemas/flowVersion.json

@@ -53,6 +53,7 @@
               "type": {
                 "type": "string",
                 "enum": [
+                  "customNodeStart",
                   "dataTable",
                   "deviceCommand",
                   "deviceId",
@@ -68,8 +69,8 @@
                   "fileWatch",
                   "integration",
                   "mqttTopic",
+                  "redis",
                   "request",
-                  "customNodeStart",
                   "timer",
                   "udp",
                   "virtualButton",
@@ -581,6 +582,7 @@
               "type": {
                 "type": "string",
                 "enum": [
+                  "customNodeStart",
                   "dataTable",
                   "deviceCommand",
                   "deviceId",
@@ -596,8 +598,8 @@
                   "fileWatch",
                   "integration",
                   "mqttTopic",
+                  "redis",
                   "request",
-                  "customNodeStart",
                   "timer",
                   "udp",
                   "virtualButton",