RubyGems - losant_rest - Versions diffs - 1.8.7 → 1.8.9 - Mend

losant_rest 1.8.7 → 1.8.9

Files changed (167) hide show

checksums.yaml +4 -4
data/docs/_schemas.md +38618 -21196
data/docs/application.md +76 -0
data/docs/auth.md +0 -36
data/docs/dashboards.md +1 -1
data/docs/dataTableRows.md +2 -2
data/docs/device.md +1 -0
data/docs/events.md +81 -0
data/docs/file.md +43 -0
data/docs/me.md +50 -13
data/lib/losant_rest.rb +0 -4
data/lib/losant_rest/application.rb +90 -0
data/lib/losant_rest/application_api_token.rb +2 -0
data/lib/losant_rest/application_api_tokens.rb +2 -0
data/lib/losant_rest/application_certificate.rb +2 -0
data/lib/losant_rest/application_certificate_authorities.rb +2 -0
data/lib/losant_rest/application_certificate_authority.rb +2 -0
data/lib/losant_rest/application_certificates.rb +2 -0
data/lib/losant_rest/application_key.rb +2 -0
data/lib/losant_rest/application_keys.rb +2 -0
data/lib/losant_rest/applications.rb +2 -0
data/lib/losant_rest/audit_log.rb +2 -0
data/lib/losant_rest/audit_logs.rb +2 -0
data/lib/losant_rest/auth.rb +2 -42
data/lib/losant_rest/client.rb +2 -18
data/lib/losant_rest/dashboard.rb +2 -0
data/lib/losant_rest/dashboards.rb +3 -1
data/lib/losant_rest/data.rb +2 -0
data/lib/losant_rest/data_table.rb +2 -0
data/lib/losant_rest/data_table_row.rb +2 -0
data/lib/losant_rest/data_table_rows.rb +4 -2
data/lib/losant_rest/data_tables.rb +2 -0
data/lib/losant_rest/device.rb +4 -0
data/lib/losant_rest/device_recipe.rb +2 -0
data/lib/losant_rest/device_recipes.rb +2 -0
data/lib/losant_rest/devices.rb +2 -0
data/lib/losant_rest/edge_deployments.rb +2 -0
data/lib/losant_rest/event.rb +2 -0
data/lib/losant_rest/events.rb +103 -0
data/lib/losant_rest/experience.rb +2 -0
data/lib/losant_rest/experience_domain.rb +2 -0
data/lib/losant_rest/experience_domains.rb +2 -0
data/lib/losant_rest/experience_endpoint.rb +2 -0
data/lib/losant_rest/experience_endpoints.rb +2 -0
data/lib/losant_rest/experience_group.rb +2 -0
data/lib/losant_rest/experience_groups.rb +2 -0
data/lib/losant_rest/experience_slug.rb +2 -0
data/lib/losant_rest/experience_slugs.rb +2 -0
data/lib/losant_rest/experience_user.rb +2 -0
data/lib/losant_rest/experience_users.rb +2 -0
data/lib/losant_rest/experience_version.rb +2 -0
data/lib/losant_rest/experience_versions.rb +2 -0
data/lib/losant_rest/experience_view.rb +2 -0
data/lib/losant_rest/experience_views.rb +2 -0
data/lib/losant_rest/file.rb +2 -0
data/lib/losant_rest/files.rb +2 -0
data/lib/losant_rest/flow.rb +2 -0
data/lib/losant_rest/flow_version.rb +2 -0
data/lib/losant_rest/flow_versions.rb +2 -0
data/lib/losant_rest/flows.rb +2 -0
data/lib/losant_rest/integration.rb +2 -0
data/lib/losant_rest/integrations.rb +2 -0
data/lib/losant_rest/me.rb +57 -13
data/lib/losant_rest/notebook.rb +2 -0
data/lib/losant_rest/notebooks.rb +2 -0
data/lib/losant_rest/org.rb +2 -0
data/lib/losant_rest/org_invites.rb +2 -0
data/lib/losant_rest/orgs.rb +2 -0
data/lib/losant_rest/version.rb +1 -1
data/lib/losant_rest/webhook.rb +2 -0
data/lib/losant_rest/webhooks.rb +2 -0
data/schemas/advancedEventQuery.json +817 -0
data/schemas/{dataTableQuery.json → advancedQuery.json} +5 -4
data/schemas/apiTokens.json +4 -1
data/schemas/application.json +30 -1
data/schemas/applicationApiTokenPost.json +5 -0
data/schemas/applicationCertificate.json +29 -1
data/schemas/applicationCertificateAuthorities.json +36 -3
data/schemas/applicationCertificateAuthority.json +32 -2
data/schemas/applicationCertificateAuthorityPatch.json +3 -1
data/schemas/applicationCertificateAuthorityPost.json +3 -1
data/schemas/applicationCertificatePatch.json +3 -1
data/schemas/applicationCertificatePost.json +3 -1
data/schemas/applicationCertificates.json +33 -2
data/schemas/applicationKeys.json +4 -1
data/schemas/applicationPatch.json +28 -0
data/schemas/applicationPost.json +28 -0
data/schemas/applications.json +34 -2
data/schemas/auditLog.json +0 -3
data/schemas/auditLogFilter.json +0 -3
data/schemas/auditLogs.json +4 -4
data/schemas/authedDevice.json +7 -0
data/schemas/dashboard.json +3970 -72
data/schemas/dashboardPatch.json +3969 -72
data/schemas/dashboardPost.json +3969 -72
data/schemas/dashboardSendReport.json +4 -0
data/schemas/dashboardUpdateEvents.json +46 -0
data/schemas/dashboards.json +3974 -73
data/schemas/dataTableRows.json +4 -1
data/schemas/dataTableRowsExport.json +11 -7
data/schemas/dataTables.json +4 -1
data/schemas/deviceRecipes.json +4 -1
data/schemas/devices.json +4 -1
data/schemas/event.json +19 -2
data/schemas/eventPost.json +0 -1
data/schemas/eventTagsSummary.json +28 -0
data/schemas/events.json +841 -3
data/schemas/eventsDeleted.json +9 -0
data/schemas/eventsExport.json +830 -0
data/schemas/experienceDomain.json +6 -2
data/schemas/experienceDomainPatch.json +14 -10
data/schemas/experienceDomainPost.json +8 -4
data/schemas/experienceDomains.json +6 -2
data/schemas/experienceEndpoints.json +4 -1
data/schemas/experienceGroup.json +2 -2
data/schemas/experienceGroupPatch.json +2 -2
data/schemas/experienceGroupPost.json +2 -2
data/schemas/experienceGroups.json +6 -3
data/schemas/experienceSlugPatch.json +2 -2
data/schemas/experienceSlugPost.json +2 -2
data/schemas/experienceUsers.json +4 -1
data/schemas/experienceViews.json +4 -1
data/schemas/files.json +4 -1
data/schemas/flow.json +4 -0
data/schemas/flowPatch.json +6 -2
data/schemas/flowPost.json +4 -0
data/schemas/flowVersion.json +8 -0
data/schemas/flowVersionPost.json +4 -0
data/schemas/flowVersions.json +12 -1
data/schemas/flows.json +8 -1
data/schemas/flowsImportPost.json +10 -2
data/schemas/flowsImportResult.json +12 -0
data/schemas/githubLogin.json +6 -15
data/schemas/integrations.json +4 -1
data/schemas/notebooks.json +4 -1
data/schemas/org.json +2 -4
data/schemas/orgPatch.json +2 -1
data/schemas/orgPost.json +2 -1
data/schemas/orgs.json +6 -5
data/schemas/passwordResetFinish.json +0 -4
data/schemas/passwordResetInput.json +0 -4
data/schemas/resourceTransfer.json +0 -8
data/schemas/userCredentials.json +6 -15
data/schemas/userPost.json +6 -15
data/schemas/webhooks.json +4 -1
data/test/basic_test.rb +15 -0
metadata +8 -23
data/docs/solution.md +0 -133
data/docs/solutionUser.md +0 -139
data/docs/solutionUsers.md +0 -96
data/docs/solutions.md +0 -91
data/lib/losant_rest/solution.rb +0 -174
data/lib/losant_rest/solution_user.rb +0 -180
data/lib/losant_rest/solution_users.rb +0 -138
data/lib/losant_rest/solutions.rb +0 -134
data/schemas/authedSolutionUser.json +0 -18
data/schemas/fileUploadPostResp.json +0 -109
data/schemas/solution.json +0 -76
data/schemas/solutionMe.json +0 -150
data/schemas/solutionPatch.json +0 -48
data/schemas/solutionPost.json +0 -52
data/schemas/solutionUser.json +0 -103
data/schemas/solutionUserCredentials.json +0 -34
data/schemas/solutionUserPatch.json +0 -74
data/schemas/solutionUserPost.json +0 -80
data/schemas/solutionUsers.json +0 -149
data/schemas/solutions.json +0 -118

data/lib/losant_rest/solutions.rb DELETED

@@ -1,134 +0,0 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2019 Losant IoT, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-module LosantRest
-  # Class containing all the actions for the Solutions Resource
-  class Solutions
-    def initialize(client)
-      @client = client
-    end
-    # Returns the solutions for the organization
-    #
-    # 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.Organization, all.Organization.read, all.User, all.User.read, solutions.*, or solutions.get.
-    #
-    # Parameters:
-    # *  {string} orgId - ID associated with the organization
-    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
-    # *  {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} 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 - Collection of solutions (https://api.losant.com/#/definitions/solutions)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    def get(params = {})
-      params = Utils.symbolize_hash_keys(params)
-      query_params = { _actions: false, _links: true, _embedded: true }
-      headers = {}
-      body = nil
-      raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
-      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
-      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
-      query_params[:page] = params[:page] if params.has_key?(:page)
-      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)
-      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 = "/orgs/#{params[:orgId]}/solutions"
-      @client.request(
-        method: :get,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-    # Create a new solution
-    #
-    # 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.Organization, all.User, solutions.*, or solutions.post.
-    #
-    # Parameters:
-    # *  {string} orgId - ID associated with the organization
-    # *  {hash} solution - New solution information (https://api.losant.com/#/definitions/solutionPost)
-    # *  {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:
-    # *  201 - Successfully created solution (https://api.losant.com/#/definitions/solution)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    def post(params = {})
-      params = Utils.symbolize_hash_keys(params)
-      query_params = { _actions: false, _links: true, _embedded: true }
-      headers = {}
-      body = nil
-      raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
-      raise ArgumentError.new("solution is required") unless params.has_key?(:solution)
-      body = params[:solution] if params.has_key?(:solution)
-      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 = "/orgs/#{params[:orgId]}/solutions"
-      @client.request(
-        method: :post,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-  end
-end

data/schemas/authedSolutionUser.json DELETED

@@ -1,18 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "solutionUserId": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "token": {
-      "type": "string",
-      "minLength": 1
-    }
-  },
-  "required": [
-    "solutionUserId",
-    "token"
-  ]
-}

data/schemas/fileUploadPostResp.json DELETED

@@ -1,109 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "id": {
-      "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"
-    },
-    "authorId": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "authorType": {
-      "type": "string",
-      "enum": [
-        "flow",
-        "user",
-        "device",
-        "apiToken"
-      ]
-    },
-    "status": {
-      "type": "string",
-      "enum": [
-        "pending",
-        "moving",
-        "deleting",
-        "completed"
-      ]
-    },
-    "name": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 1024
-    },
-    "parentDirectory": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "type": {
-      "type": "string",
-      "enum": [
-        "file",
-        "directory"
-      ]
-    },
-    "fileSize": {
-      "type": "number"
-    },
-    "contentType": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "fileDimensions": {
-      "type": "object",
-      "properties": {
-        "width": {
-          "type": "number"
-        },
-        "height": {
-          "type": "number"
-        }
-      }
-    },
-    "upload": {
-      "url": {
-        "type": "string"
-      },
-      "fields": {
-        "type": "object",
-        "properties": {
-          "key": {
-            "type": "string"
-          },
-          "bucket": {
-            "type": "string"
-          },
-          "X-Amz-Algorithm": {
-            "type": "string"
-          },
-          "X-Amz-Credential": {
-            "type": "string"
-          },
-          "X-Amz-Date": {
-            "type": "string"
-          },
-          "Policy": {
-            "type": "string"
-          },
-          "X-Amz-Signature": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  }
-}

data/schemas/solution.json DELETED

@@ -1,76 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "solutionId": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "orgId": {
-      "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
-    },
-    "slug": {
-      "type": "string",
-      "minLength": 4,
-      "maxLength": 63,
-      "pattern": "^[0-9a-z-]*$"
-    },
-    "allowSelfDeletion": {
-      "type": "boolean"
-    },
-    "allowSelfEmailChange": {
-      "type": "boolean"
-    },
-    "passwordReset": {
-      "type": "object",
-      "properties": {
-        "allowPasswordReset": {
-          "type": "boolean"
-        },
-        "emailSubject": {
-          "type": "string",
-          "maxLength": 255
-        },
-        "emailBody": {
-          "type": "string",
-          "maxLength": 32767
-        },
-        "emailFrom": {
-          "type": "string",
-          "format": "email",
-          "maxLength": 1024
-        }
-      }
-    },
-    "summary": {
-      "type": "object",
-      "properties": {
-        "solutionUserCount": {
-          "type": "number"
-        }
-      }
-    }
-  }
-}

data/schemas/solutionMe.json DELETED

@@ -1,150 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "solutionUserId": {
-      "type": "string",
-      "pattern": "^[A-Fa-f\\d]{24}$"
-    },
-    "creationDate": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "lastUpdated": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "passwordLastUpdated": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "lastLogin": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "email": {
-      "type": "string",
-      "format": "email",
-      "maxLength": 1024
-    },
-    "firstName": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 1024
-    },
-    "lastName": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 1024
-    },
-    "companyName": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "title": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "phoneNumber": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "location": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "url": {
-      "type": "string",
-      "maxLength": 1024
-    },
-    "forcePasswordResetOnNextLogin": {
-      "type": "boolean"
-    },
-    "fullName": {
-      "type": "string"
-    },
-    "twoFactorAuthEnabled": {
-      "type": "boolean"
-    },
-    "avatarUrl": {
-      "type": "string",
-      "format": "url"
-    },
-    "accessRestrictions": {
-      "type": "object",
-      "properties": {
-        "dashboardIds": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "maxItems": 1000
-        }
-      }
-    },
-    "recentDashboards": {
-      "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": {
-          "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
-              }
-            }
-          }
-        }
-      }
-    },
-    "solution": {
-      "id": {
-        "type": "string",
-        "pattern": "^[A-Fa-f\\d]{24}$"
-      },
-      "slug": {
-        "type": "string",
-        "pattern": "^[0-9a-z_-]{1,255}$"
-      },
-      "name": {
-        "type": "string",
-        "minLength": 1,
-        "maxLength": 255
-      },
-      "allowSelfDeletion": {
-        "type": "boolean"
-      },
-      "allowSelfEmailChange": {
-        "type": "boolean"
-      }
-    }
-  }
-}