losant_rest 1.19.1 → 1.19.3

data/docs/application.md

@@ -18,6 +18,7 @@ parameters and the potential responses.
 *   [Get](#get)
 *   [Globals](#globals)
 *   [Import](#import)
+*   [Import Logs](#import-logs)
 *   [Mqtt Publish Message](#mqtt-publish-message)
 *   [Notebook Minute Counts](#notebook-minute-counts)
 *   [Patch](#patch)
@@ -499,6 +500,45 @@ all.Application, all.Organization, all.User, application.*, or application.impor
 
 <br/>
 
+## Import Logs
+
+Retrieves information on application import logs
+
+```ruby
+result = client.application.import_logs(applicationId: my_application_id)
+
+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.importLogs.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
+| since | string | N | Look for log entries since this time (ms since epoch) |  | 1465790400000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Import Executions](_schemas.md#application-import-executions) | Application log objects |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
 ## Mqtt Publish Message
 
 Publishes the given message to the given MQTT topic

data/docs/me.md

@@ -176,7 +176,7 @@ all.User, all.User.read, me.*, or me.deviceCounts.
 
 ## Disable Two Factor Auth
 
-Disables two factor auth for the current user
+Disables multi-factor authentication for the current user
 
 ```ruby
 result = client.me.disable_two_factor_auth(data: my_data)
@@ -193,7 +193,7 @@ all.User, me.*, or me.disableTwoFactorAuth.
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| data | [Disable Two Factor Auth](_schemas.md#disable-two-factor-auth) | Y | Object containing two factor auth properties |  | [Disable Two Factor Auth Example](_schemas.md#disable-two-factor-auth-example) |
+| data | [Disable Multi-Factor Authentication](_schemas.md#disable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties |  | [Disable Multi-Factor Authentication Example](_schemas.md#disable-multi-factor-authentication-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -247,7 +247,7 @@ all.User, me.*, or me.disconnectGithub.
 
 ## Enable Two Factor Auth
 
-Enables two factor auth for the current user
+Enables multi-factor authentication for the current user
 
 ```ruby
 result = client.me.enable_two_factor_auth(data: my_data)
@@ -264,7 +264,7 @@ all.User, me.*, or me.enableTwoFactorAuth.
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| data | [Enable Two Factor Auth](_schemas.md#enable-two-factor-auth) | Y | Object containing two factor auth properties |  | [Enable Two Factor Auth Example](_schemas.md#enable-two-factor-auth-example) |
+| data | [Enable Multi-Factor Authentication](_schemas.md#enable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties |  | [Enable Multi-Factor Authentication Example](_schemas.md#enable-multi-factor-authentication-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -320,7 +320,7 @@ all.User, all.User.read, me.*, or me.fetchRecentItems.
 
 ## Generate Two Factor Auth
 
-Returns the two factor auth key for a user
+Returns the multi-factor authentication key for the current user
 
 ```ruby
 result = client.me.generate_two_factor_auth(optional_params)
@@ -343,7 +343,7 @@ all.User, me.*, or me.generateTwoFactorAuth.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Two Factor Auth Info](_schemas.md#two-factor-auth-info) | Updated user information |
+| 200 | [Multi-Factor Authentication Info](_schemas.md#multi-factor-authentication-info) | Multi-factor authentication info |
 
 #### Error Responses
 

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.19.1"
+  VERSION = "1.19.3"
 end

data/lib/platform_rest/application.rb

@@ -542,6 +542,54 @@ module PlatformRest
         body: body)
     end
 
+    # Retrieves information on application import logs
+    #
+    # 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.importLogs.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated application
+    # *  {string} limit - Max log entries to return (ordered by time descending)
+    # *  {string} since - Look for log entries since this time (ms since epoch)
+    # *  {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 - Application log objects (https://api.losant.com/#/definitions/applicationImportExecutions)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def import_logs(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)
+
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:since] = params[:since] if params.has_key?(:since)
+      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]}/importLogs"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Publishes the given message to the given MQTT topic
     #
     # Authentication:

data/lib/platform_rest/client.rb

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

data/lib/platform_rest/me.rb

@@ -208,7 +208,7 @@ module PlatformRest
         body: body)
     end
 
-    # Disables two factor auth for the current user
+    # Disables multi-factor authentication for the current user
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -217,7 +217,7 @@ module PlatformRest
     # all.User, me.*, or me.disableTwoFactorAuth.
     #
     # Parameters:
-    # *  {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/disableTwoFactorAuth)
+    # *  {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthDisable)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -293,7 +293,7 @@ module PlatformRest
         body: body)
     end
 
-    # Enables two factor auth for the current user
+    # Enables multi-factor authentication for the current user
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -302,7 +302,7 @@ module PlatformRest
     # all.User, me.*, or me.enableTwoFactorAuth.
     #
     # Parameters:
-    # *  {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/enableTwoFactorAuth)
+    # *  {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthEnable)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -383,7 +383,7 @@ module PlatformRest
         body: body)
     end
 
-    # Returns the two factor auth key for a user
+    # Returns the multi-factor authentication key for the current user
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -398,7 +398,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Updated user information (https://api.losant.com/#/definitions/twoFactorAuthInfo)
+    # *  200 - Multi-factor authentication info (https://api.losant.com/#/definitions/multiFactorAuthInfo)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/schemas/apiTokenPost.json

@@ -106,6 +106,7 @@
                   "application.deviceCounts",
                   "application.notebookMinuteCounts",
                   "application.search",
+                  "application.importLogs",
                   "applicationApiToken.delete",
                   "applicationApiToken.get",
                   "applicationApiToken.patch",

data/schemas/application.json

@@ -110,9 +110,18 @@
         "apiTokenCount": {
           "type": "integer"
         },
+        "certificateCount": {
+          "type": "integer"
+        },
+        "certificateAuthorityCount": {
+          "type": "integer"
+        },
         "credentialCount": {
           "type": "integer"
         },
+        "dashCount": {
+          "type": "integer"
+        },
         "dataTableCount": {
           "type": "integer"
         },
@@ -158,6 +167,150 @@
         "keyCount": {
           "type": "integer"
         },
+        "notebookCount": {
+          "type": "integer"
+        },
+        "resourceJobCount": {
+          "type": "integer"
+        },
+        "webhookCount": {
+          "type": "integer"
+        },
+        "payloadCount": {
+          "title": "Payload Stats",
+          "description": "Schema for the result of a payload stats request",
+          "type": "object",
+          "properties": {
+            "dataTable": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceCommand": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceConnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceDisconnect": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "deviceState": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "endpoint": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "event": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "flowError": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "integration": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "mqttIn": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "mqttOut": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "notebook": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "timer": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "virtualButton": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "webhook": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            },
+            "resourceJob": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "number"
+                }
+              }
+            }
+          }
+        },
         "storageStats": {
           "type": "object",
           "properties": {
@@ -169,8 +322,19 @@
             }
           }
         },
-        "webhookCount": {
-          "type": "integer"
+        "notebookStats": {
+          "type": "object",
+          "properties": {
+            "awaitingCompletion": {
+              "type": "integer"
+            },
+            "minutesThisPeriod": {
+              "type": "integer"
+            },
+            "runsThisPeriod": {
+              "type": "integer"
+            }
+          }
         }
       }
     },

data/schemas/applicationCreationByTemplateResult.json

@@ -115,9 +115,18 @@
             "apiTokenCount": {
               "type": "integer"
             },
+            "certificateCount": {
+              "type": "integer"
+            },
+            "certificateAuthorityCount": {
+              "type": "integer"
+            },
             "credentialCount": {
               "type": "integer"
             },
+            "dashCount": {
+              "type": "integer"
+            },
             "dataTableCount": {
               "type": "integer"
             },
@@ -163,6 +172,150 @@
             "keyCount": {
               "type": "integer"
             },
+            "notebookCount": {
+              "type": "integer"
+            },
+            "resourceJobCount": {
+              "type": "integer"
+            },
+            "webhookCount": {
+              "type": "integer"
+            },
+            "payloadCount": {
+              "title": "Payload Stats",
+              "description": "Schema for the result of a payload stats request",
+              "type": "object",
+              "properties": {
+                "dataTable": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "deviceCommand": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "deviceConnect": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "deviceDisconnect": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "deviceState": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "endpoint": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "event": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "flowError": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "integration": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "mqttIn": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "mqttOut": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "notebook": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "timer": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "virtualButton": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "webhook": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "resourceJob": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            },
             "storageStats": {
               "type": "object",
               "properties": {
@@ -174,8 +327,19 @@
                 }
               }
             },
-            "webhookCount": {
-              "type": "integer"
+            "notebookStats": {
+              "type": "object",
+              "properties": {
+                "awaitingCompletion": {
+                  "type": "integer"
+                },
+                "minutesThisPeriod": {
+                  "type": "integer"
+                },
+                "runsThisPeriod": {
+                  "type": "integer"
+                }
+              }
             }
           }
         },

data/schemas/applicationDashboardPost.json

@@ -880,6 +880,9 @@
                       "vega4",
                       "vega5"
                     ]
+                  },
+                  "tooltipEventSubscribe": {
+                    "type": "boolean"
                   }
                 },
                 "additionalProperties": false
@@ -2176,6 +2179,9 @@
                   "realTime": {
                     "type": "boolean"
                   },
+                  "hideLegend": {
+                    "type": "boolean"
+                  },
                   "disallowUserSelectedDuration": {
                     "type": "boolean"
                   },