losant_rest 1.7.2 → 1.8.0

data/lib/losant_rest/flows.rb

@@ -45,7 +45,7 @@ module LosantRest
     # *  {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} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode
+    # *  {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -91,6 +91,71 @@ module LosantRest
         body: body)
     end
 
+    # Returns the flows by version for an application
+    #
+    # 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, flows.*, or flows.getByVersion.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {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} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
+    # *  {string} version - Return the workflow versions for the given version.
+    # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
+    # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
+    # *  {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 flow versions (https://api.losant.com/#/definitions/flowVersions)
+    #
+    # 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 get_by_version(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("version is required") unless params.has_key?(:version)
+
+      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)
+      query_params[:flowClass] = params[:flowClass] if params.has_key?(:flowClass)
+      query_params[:version] = params[:version] if params.has_key?(:version)
+      query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter)
+      query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
+      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]}/flows/version"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Import a set of flows and flow versions
     #
     # Authentication:

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.7.2"
+  VERSION = "1.8.0"
 end

data/lib/losant_rest.rb

@@ -53,8 +53,12 @@ require_relative "losant_rest/experience_endpoint"
 require_relative "losant_rest/experience_endpoints"
 require_relative "losant_rest/experience_group"
 require_relative "losant_rest/experience_groups"
+require_relative "losant_rest/experience_slug"
+require_relative "losant_rest/experience_slugs"
 require_relative "losant_rest/experience_user"
 require_relative "losant_rest/experience_users"
+require_relative "losant_rest/experience_version"
+require_relative "losant_rest/experience_versions"
 require_relative "losant_rest/experience_view"
 require_relative "losant_rest/experience_views"
 require_relative "losant_rest/file"

data/schemas/apiTokens.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "API Token",
+        "description": "Schema for a single API Token",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "apiTokenId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "ownerId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "ownerType": {
+            "type": "string",
+            "enum": [
+              "application"
+            ]
+          },
+          "creatorId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creatorType": {
+            "type": "string",
+            "enum": [
+              "apiToken",
+              "user",
+              "flow"
+            ]
+          },
+          "creatorName": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "lastUpdated": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "expirationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "scope": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1024
+            }
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "inactive"
+            ]
+          },
+          "token": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      }
+    },
+    "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"
+      ]
+    },
+    "ownerId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "ownerType": {
+      "type": "string",
+      "enum": [
+        "application"
+      ]
+    }
+  }
+}

data/schemas/application.json

@@ -108,9 +108,15 @@
         "experienceGroupCount": {
           "type": "number"
         },
+        "experienceSlugCount": {
+          "type": "number"
+        },
         "experienceUserCount": {
           "type": "number"
         },
+        "experienceVersionCount": {
+          "type": "number"
+        },
         "experienceViewCount": {
           "type": "number"
         },

data/schemas/applicationApiTokenPost.json

@@ -49,8 +49,12 @@
           "experienceEndpoints.*",
           "experienceGroup.*",
           "experienceGroups.*",
+          "experienceSlug.*",
+          "experienceSlugs.*",
           "experienceUser.*",
           "experienceUsers.*",
+          "experienceVersion.*",
+          "experienceVersions.*",
           "experienceView.*",
           "experienceViews.*",
           "integration.*",
@@ -68,6 +72,8 @@
           "application.debug",
           "application.delete",
           "application.get",
+          "application.mqttPublishMessage",
+          "application.mqttSubscriptionStream",
           "application.patch",
           "application.payloadCounts",
           "applicationApiToken.delete",
@@ -136,6 +142,7 @@
           "events.patch",
           "events.post",
           "experience.delete",
+          "experience.bootstrap",
           "experienceDomain.delete",
           "experienceDomain.get",
           "experienceDomain.patch",
@@ -153,12 +160,22 @@
           "experienceGroups.detailedSummary",
           "experienceGroups.get",
           "experienceGroups.post",
+          "experienceSlug.delete",
+          "experienceSlug.get",
+          "experienceSlug.patch",
+          "experienceSlugs.get",
+          "experienceSlugs.post",
           "experienceUser.delete",
           "experienceUser.get",
           "experienceUser.patch",
           "experienceUsers.detailedSummary",
           "experienceUsers.get",
           "experienceUsers.post",
+          "experienceVersion.delete",
+          "experienceVersion.get",
+          "experienceVersion.patch",
+          "experienceVersions.get",
+          "experienceVersions.post",
           "experienceView.debug",
           "experienceView.delete",
           "experienceView.get",
@@ -183,6 +200,7 @@
           "flow.pressVirtualButton",
           "flow.setStorageEntry",
           "flows.get",
+          "flows.getByVersion",
           "flows.import",
           "flows.post",
           "flowVersion.delete",

data/schemas/applications.json

@@ -115,9 +115,15 @@
               "experienceGroupCount": {
                 "type": "number"
               },
+              "experienceSlugCount": {
+                "type": "number"
+              },
               "experienceUserCount": {
                 "type": "number"
               },
+              "experienceVersionCount": {
+                "type": "number"
+              },
               "experienceViewCount": {
                 "type": "number"
               },

data/schemas/dataTableRowInMultiple.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "array",
+  "items": {
+    "title": "Data Table Row Insert/Update",
+    "description": "Schema for inserting or updating a data table row",
+    "type": "object",
+    "patternProperties": {
+      "^[0-9a-zA-Z_-]{1,255}$": {
+        "type": [
+          "string",
+          "number",
+          "boolean",
+          "null"
+        ]
+      }
+    },
+    "additionalProperties": false
+  }
+}

data/schemas/dataTableRowInsert.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "oneOf": [
+    {
+      "title": "Data Table Row Insert/Update",
+      "description": "Schema for inserting or updating a data table row",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9a-zA-Z_-]{1,255}$": {
+          "type": [
+            "string",
+            "number",
+            "boolean",
+            "null"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "title": "Data Table Row Insert Multiple",
+      "description": "Schema for inserting data table rows",
+      "type": "array",
+      "items": {
+        "title": "Data Table Row Insert/Update",
+        "description": "Schema for inserting or updating a data table row",
+        "type": "object",
+        "patternProperties": {
+          "^[0-9a-zA-Z_-]{1,255}$": {
+            "type": [
+              "string",
+              "number",
+              "boolean",
+              "null"
+            ]
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  ]
+}

data/schemas/dataTableRowInsertResult.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "oneOf": [
+    {
+      "title": "Data Table Row",
+      "description": "Schema for a single Data Table Row",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Fa-f\\d]{24}$"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "patternProperties": {
+        "^[0-9a-zA-Z_-]{1,255}$": {
+          "type": [
+            "string",
+            "number",
+            "boolean",
+            "null"
+          ]
+        }
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "count": {
+          "type": "number"
+        },
+        "rowIds": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "maxItems": 1000
+        }
+      }
+    }
+  ]
+}

data/schemas/edgeDeployment.json

@@ -0,0 +1,119 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "edgeDeploymentId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "deviceId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "deviceName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "flowId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "flowName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "creationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "currentVersion": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "desiredVersion": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "logs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "sourceType": {
+            "type": "string",
+            "enum": [
+              "flow",
+              "user",
+              "device",
+              "apiToken"
+            ]
+          },
+          "sourceId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "date": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "changeType": {
+            "type": "string",
+            "enum": [
+              "current",
+              "desired"
+            ]
+          },
+          "newValue": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "previousValue": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "attemptedValue": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "error": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

data/schemas/emailVerificationVerify.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "token": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "email",
+    "token"
+  ],
+  "additionalProperties": false
+}

data/schemas/experienceBootstrapOptions.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "replaceExisting": {
+      "type": "boolean",
+      "default": false
+    },
+    "createUsers": {
+      "type": "boolean",
+      "default": true
+    },
+    "createGroups": {
+      "type": "boolean",
+      "default": true
+    },
+    "slug": {
+      "type": "string",
+      "minLength": 4,
+      "maxLength": 63,
+      "pattern": "^[0-9a-z-]*$"
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/experienceBootstrapResult.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "resourceSuffix": {
+      "type": "string"
+    },
+    "password": {
+      "type": "string"
+    },
+    "email": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/experienceDomain.json

@@ -36,6 +36,11 @@
       "type": "string",
       "maxLength": 1024,
       "minLength": 3
+    },
+    "version": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
     }
   }
 }

data/schemas/experienceDomainPatch.json

@@ -38,6 +38,18 @@
         }
       ]
     },
+    "version": {
+      "$oneOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255
+        },
+        {
+          "type": null
+        }
+      ]
+    },
     "domainName": {
       "type": "string",
       "maxLength": 1024,

data/schemas/experienceDomainPost.json

@@ -21,6 +21,18 @@
       "type": "string",
       "maxLength": 1024,
       "minLength": 3
+    },
+    "version": {
+      "$oneOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255
+        },
+        {
+          "type": null
+        }
+      ]
     }
   },
   "additionalProperties": false,