RubyGems - losant_rest - Versions diffs - 2.1.0 → 2.1.1 - Mend

losant_rest 2.1.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (191) hide show

checksums.yaml +4 -4
data/docs/_schemas.md +139101 -66992
data/docs/application.md +6 -6
data/docs/applicationCertificates.md +3 -2
data/docs/applicationDashboard.md +1 -1
data/docs/applications.md +1 -1
data/docs/auth.md +1 -1
data/docs/dashboard.md +1 -1
data/docs/dashboards.md +1 -0
data/docs/dataTableRow.md +1 -1
data/docs/dataTableRows.md +3 -3
data/docs/device.md +1 -1
data/docs/edgeDeployments.md +3 -3
data/docs/embeddedDeployments.md +3 -3
data/docs/experience.md +1 -1
data/docs/file.md +4 -4
data/docs/files.md +1 -1
data/docs/flowVersions.md +1 -1
data/docs/instanceApiTokens.md +1 -1
data/docs/instanceMember.md +1 -1
data/docs/instanceOrg.md +1 -1
data/docs/instanceOrgInvite.md +2 -2
data/docs/instanceOrgInvites.md +1 -1
data/docs/instanceOrgMembers.md +2 -1
data/docs/instanceOrgs.md +1 -1
data/docs/me.md +1 -1
data/docs/notebook.md +1 -1
data/docs/org.md +1 -1
data/docs/privateFile.md +4 -4
data/docs/privateFiles.md +1 -1
data/docs/resourceJob.md +2 -2
data/docs/userApiTokens.md +2 -2
data/lib/platform_rest/application.rb +1 -1
data/lib/platform_rest/application_certificates.rb +5 -2
data/lib/platform_rest/application_dashboard.rb +1 -1
data/lib/platform_rest/client.rb +2 -2
data/lib/platform_rest/dashboard.rb +1 -1
data/lib/platform_rest/dashboards.rb +1 -0
data/lib/platform_rest/data_table_row.rb +1 -1
data/lib/platform_rest/data_table_rows.rb +3 -3
data/lib/platform_rest/device.rb +1 -1
data/lib/platform_rest/edge_deployments.rb +3 -3
data/lib/platform_rest/embedded_deployments.rb +3 -3
data/lib/platform_rest/experience.rb +1 -1
data/lib/platform_rest/file.rb +2 -2
data/lib/platform_rest/instance_api_tokens.rb +1 -1
data/lib/platform_rest/instance_member.rb +1 -1
data/lib/platform_rest/instance_org.rb +1 -1
data/lib/platform_rest/instance_org_invite.rb +2 -2
data/lib/platform_rest/instance_org_invites.rb +2 -2
data/lib/platform_rest/instance_org_members.rb +2 -1
data/lib/platform_rest/instance_orgs.rb +1 -1
data/lib/platform_rest/me.rb +1 -1
data/lib/platform_rest/notebook.rb +1 -1
data/lib/platform_rest/org.rb +1 -1
data/lib/platform_rest/private_file.rb +2 -2
data/lib/platform_rest/resource_job.rb +2 -2
data/lib/platform_rest/user_api_tokens.rb +2 -2
data/lib/platform_rest/version.rb +1 -1
data/schemas/advancedApplicationCertQuery.json +1885 -0
data/schemas/advancedApplicationKeyQuery.json +763 -763
data/schemas/apiToken.json +10 -1
data/schemas/apiTokens.json +20 -2
data/schemas/application.json +15 -2
data/schemas/applicationCertificate.json +90 -58
data/schemas/applicationCertificateAuthorities.json +24 -0
data/schemas/applicationCertificateAuthority.json +24 -0
data/schemas/applicationCertificatePatch.json +32 -4
data/schemas/applicationCertificatePost.json +28 -30
data/schemas/applicationCertificates.json +90 -58
data/schemas/applicationCreationByTemplateResult.json +15 -2
data/schemas/applicationDashboardPost.json +179 -128
data/schemas/applicationImportExecutions.json +3 -5
data/schemas/applicationImportResult.json +674 -0
data/schemas/applicationJobLog.json +129 -123
data/schemas/applicationJobLogs.json +129 -123
data/schemas/applicationKey.json +41 -41
data/schemas/applicationKeyPatch.json +4 -4
data/schemas/applicationKeyPost.json +36 -29
data/schemas/applicationKeys.json +41 -41
data/schemas/applicationSearchResult.json +10 -10
data/schemas/applicationTemplates.json +9 -2
data/schemas/applications.json +15 -2
data/schemas/auditLog.json +2 -6
data/schemas/auditLogs.json +2 -6
data/schemas/authedDevice.json +3 -0
data/schemas/credential.json +7 -0
data/schemas/credentialLinkedResources.json +19724 -344
data/schemas/credentialPatch.json +3 -0
data/schemas/credentialPost.json +3 -0
data/schemas/credentials.json +7 -0
data/schemas/dashboard.json +199 -128
data/schemas/dashboardBlockSuggestCodePost.json +19 -0
data/schemas/dashboardPatch.json +179 -128
data/schemas/dashboardPost.json +179 -128
data/schemas/dashboardUpdateEventsResult.json +266 -0
data/schemas/dashboards.json +199 -128
data/schemas/dataTable.json +11 -0
data/schemas/dataTableRowPatch.json +16 -0
data/schemas/dataTableRowPost.json +39 -0
data/schemas/dataTableRowPostResult.json +54 -0
data/schemas/dataTables.json +11 -0
data/schemas/device.json +259 -107
data/schemas/deviceConnectionStatus.json +4 -0
data/schemas/deviceLog.json +3 -0
data/schemas/deviceRecipe.json +259 -108
data/schemas/deviceRecipes.json +259 -108
data/schemas/devices.json +287 -116
data/schemas/edgeDeploymentRelease.json +4252 -39
data/schemas/edgeDeployments.json +28 -0
data/schemas/embeddedDeploymentRelease.json +2073 -0
data/schemas/embeddedDeployments.json +25 -0
data/schemas/error.json +14 -0
data/schemas/event.json +4 -1
data/schemas/eventPlusNewCount.json +4 -1
data/schemas/events.json +4 -1
data/schemas/experienceDomains.json +19 -0
data/schemas/experienceEndpoint.json +19 -0
data/schemas/experienceEndpoints.json +24 -0
data/schemas/experienceLinkedResources.json +19728 -313
data/schemas/experienceSlugs.json +19 -0
data/schemas/experienceUsers.json +16 -2
data/schemas/experienceVersions.json +25 -0
data/schemas/experienceView.json +5 -0
data/schemas/experienceViews.json +10 -0
data/schemas/fileUploadPostResponse.json +92 -103
data/schemas/files.json +5 -1
data/schemas/flow.json +211 -46
data/schemas/flowPatch.json +199 -46
data/schemas/flowPost.json +199 -46
data/schemas/flowStorageMetadata.json +2 -2
data/schemas/flowVersion.json +450 -101
data/schemas/flowVersionPost.json +199 -46
data/schemas/flowVersions.json +9903 -113
data/schemas/flows.json +9637 -46
data/schemas/flowsImportPost.json +398 -92
data/schemas/flowsImportResult.json +661 -147
data/schemas/historicalSummaries.json +3 -2
data/schemas/historicalSummary.json +3 -2
data/schemas/instanceAuditLog.json +2 -6
data/schemas/instanceAuditLogs.json +90 -1
data/schemas/instanceCustomNode.json +41 -2
data/schemas/instanceCustomNodePatch.json +59 -6
data/schemas/instanceCustomNodePost.json +59 -6
data/schemas/instanceCustomNodes.json +41 -2
data/schemas/instanceOrg.json +4 -1
data/schemas/instanceOrgInvite.json +102 -0
data/schemas/instanceOrgInviteSent.json +12 -0
data/schemas/instanceOrgInvites.json +145 -0
data/schemas/instanceOrgMember.json +52 -0
data/schemas/instanceOrgMembers.json +105 -1
data/schemas/instanceOrgPost.json +1 -1
data/schemas/instanceOrgs.json +5 -2
data/schemas/instanceSandbox.json +5 -1
data/schemas/instanceSandboxes.json +9 -1
data/schemas/integration.json +38 -39
data/schemas/integrationPatch.json +8 -8
data/schemas/integrationPost.json +8 -8
data/schemas/integrations.json +38 -39
data/schemas/jobEnqueuedResult.json +1 -1
data/schemas/me.json +685 -88
data/schemas/notebook.json +33 -21
data/schemas/notebookExecutionLogs.json +20 -0
data/schemas/notebookMinuteCounts.json +1 -1
data/schemas/notebookPatch.json +29 -21
data/schemas/notebookPost.json +29 -21
data/schemas/notebooks.json +33 -21
data/schemas/notificationRule.json +4 -0
data/schemas/notificationRules.json +8 -0
data/schemas/org.json +14 -1
data/schemas/orgInvites.json +77 -82
data/schemas/orgInvitesUser.json +44 -47
data/schemas/orgs.json +14 -1
data/schemas/paletteResponse.json +372 -364
data/schemas/periodSummaries.json +1 -1
data/schemas/recentItemList.json +226 -27
data/schemas/resourceJob.json +33 -9
data/schemas/resourceJobExecutionLogs.json +34 -20
data/schemas/resourceJobExecutionOptions.json +1 -1
data/schemas/resourceJobPatch.json +9 -9
data/schemas/resourceJobPost.json +9 -9
data/schemas/resourceJobs.json +33 -9
data/schemas/tagValuesResponse.json +1 -2
data/schemas/templateKeywords.json +1 -0
data/schemas/timeSeriesData.json +36 -4
data/schemas/userOauthToken.json +4 -1
data/schemas/userOauthTokenPost.json +1 -1
data/schemas/userOauthTokens.json +4 -1
data/schemas/validateContextError.json +71 -24
data/schemas/validateContextSuccess.json +71 -24
metadata +10 -1

data/schemas/historicalSummaries.json CHANGED Viewed

@@ -14,7 +14,7 @@
             "enum": [
               "application",
               "organization",
-              "whitelabel"
+              "sandbox"
             ]
           },
           "resourceId": {
@@ -33,7 +33,8 @@
             "type": "string",
             "enum": [
               "organization",
-              "user"
+              "user",
+              "sandbox"
             ]
           },
           "ownerId": {

data/schemas/historicalSummary.json CHANGED Viewed

@@ -7,7 +7,7 @@
       "enum": [
         "application",
         "organization",
-        "whitelabel"
+        "sandbox"
       ]
     },
     "resourceId": {
@@ -26,7 +26,8 @@
       "type": "string",
       "enum": [
         "organization",
-        "user"
+        "user",
+        "sandbox"
       ]
     },
     "ownerId": {

data/schemas/instanceAuditLog.json CHANGED Viewed

@@ -77,15 +77,11 @@
     "requestQueryParams": {
       "type": "object"
     },
-    "requestBody": {
-      "type": "object"
-    },
+    "requestBody": {},
     "requestPathParams": {
       "type": "object"
     },
-    "responseBody": {
-      "type": "object"
-    },
+    "responseBody": {},
     "responseStatus": {
       "type": "integer",
       "minimum": 100,

data/schemas/instanceAuditLogs.json CHANGED Viewed

@@ -5,7 +5,96 @@
     "items": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/instanceAuditLogs"
+        "title": "Instance Audit Log",
+        "description": "Schema for a single Instance Audit Log entry",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "instanceAuditLogId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "instanceId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "primaryTargetId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "primaryTargetType": {
+            "type": "string",
+            "enum": [
+              "Organization",
+              "ApiToken",
+              "User",
+              "InstanceCustomNode",
+              "NotificationRule"
+            ]
+          },
+          "primaryTargetName": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "secondaryTargetId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "secondaryTargetType": {
+            "type": "string",
+            "enum": [
+              "OrgInvite",
+              "ApiToken"
+            ]
+          },
+          "secondaryTargetName": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "actorId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "actorType": {
+            "type": "string",
+            "enum": [
+              "User",
+              "ApiToken"
+            ]
+          },
+          "actorName": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "requestResource": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "requestAction": {
+            "type": "string",
+            "maxLength": 1024
+          },
+          "requestQueryParams": {
+            "type": "object"
+          },
+          "requestBody": {},
+          "requestPathParams": {
+            "type": "object"
+          },
+          "responseBody": {},
+          "responseStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          }
+        }
       }
     },
     "count": {

data/schemas/instanceCustomNode.json CHANGED Viewed

@@ -175,7 +175,41 @@
             "type": "object"
           },
           "meta": {
-            "type": "object"
+            "type": "object",
+            "properties": {
+              "category": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              },
+              "description": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "x": {
+                "type": "number"
+              },
+              "y": {
+                "type": "number"
+              },
+              "groupId": {
+                "type": "string",
+                "maxLength": 1024
+              }
+            },
+            "required": [
+              "name"
+            ]
           },
           "outputIds": {
             "type": "array",
@@ -193,7 +227,8 @@
         },
         "additionalProperties": false,
         "required": [
-          "type"
+          "type",
+          "meta"
         ]
       }
     },
@@ -223,6 +258,10 @@
           "type": "array",
           "maxItems": 100,
           "items": {
+            "type": "object",
+            "discriminator": {
+              "propertyName": "type"
+            },
             "oneOf": [
               {
                 "type": "object",

data/schemas/instanceCustomNodePatch.json CHANGED Viewed

@@ -49,6 +49,10 @@
     "triggers": {
       "type": "array",
       "items": {
+        "type": "object",
+        "discriminator": {
+          "propertyName": "type"
+        },
         "oneOf": [
           {
             "type": "object",
@@ -156,7 +160,11 @@
                     "maxLength": 48
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "required": [
+                  "category",
+                  "name"
+                ]
               },
               "outputIds": {
                 "type": "array",
@@ -173,7 +181,8 @@
               }
             },
             "required": [
-              "type"
+              "type",
+              "meta"
             ],
             "additionalProperties": false
           },
@@ -272,7 +281,11 @@
                     ]
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "required": [
+                  "category",
+                  "name"
+                ]
               },
               "outputIds": {
                 "type": "array",
@@ -289,7 +302,8 @@
               }
             },
             "required": [
-              "type"
+              "type",
+              "meta"
             ],
             "additionalProperties": false
           }
@@ -314,7 +328,41 @@
             "type": "object"
           },
           "meta": {
-            "type": "object"
+            "type": "object",
+            "properties": {
+              "category": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              },
+              "description": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "x": {
+                "type": "number"
+              },
+              "y": {
+                "type": "number"
+              },
+              "groupId": {
+                "type": "string",
+                "maxLength": 1024
+              }
+            },
+            "required": [
+              "name"
+            ]
           },
           "outputIds": {
             "type": "array",
@@ -332,7 +380,8 @@
         },
         "additionalProperties": false,
         "required": [
-          "type"
+          "type",
+          "meta"
         ]
       }
     },
@@ -362,6 +411,10 @@
           "type": "array",
           "maxItems": 100,
           "items": {
+            "type": "object",
+            "discriminator": {
+              "propertyName": "type"
+            },
             "oneOf": [
               {
                 "type": "object",

data/schemas/instanceCustomNodePost.json CHANGED Viewed

@@ -49,6 +49,10 @@
     "triggers": {
       "type": "array",
       "items": {
+        "type": "object",
+        "discriminator": {
+          "propertyName": "type"
+        },
         "oneOf": [
           {
             "type": "object",
@@ -156,7 +160,11 @@
                     "maxLength": 48
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "required": [
+                  "category",
+                  "name"
+                ]
               },
               "outputIds": {
                 "type": "array",
@@ -173,7 +181,8 @@
               }
             },
             "required": [
-              "type"
+              "type",
+              "meta"
             ],
             "additionalProperties": false
           },
@@ -272,7 +281,11 @@
                     ]
                   }
                 },
-                "additionalProperties": false
+                "additionalProperties": false,
+                "required": [
+                  "category",
+                  "name"
+                ]
               },
               "outputIds": {
                 "type": "array",
@@ -289,7 +302,8 @@
               }
             },
             "required": [
-              "type"
+              "type",
+              "meta"
             ],
             "additionalProperties": false
           }
@@ -314,7 +328,41 @@
             "type": "object"
           },
           "meta": {
-            "type": "object"
+            "type": "object",
+            "properties": {
+              "category": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              },
+              "description": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "x": {
+                "type": "number"
+              },
+              "y": {
+                "type": "number"
+              },
+              "groupId": {
+                "type": "string",
+                "maxLength": 1024
+              }
+            },
+            "required": [
+              "name"
+            ]
           },
           "outputIds": {
             "type": "array",
@@ -332,7 +380,8 @@
         },
         "additionalProperties": false,
         "required": [
-          "type"
+          "type",
+          "meta"
         ]
       }
     },
@@ -362,6 +411,10 @@
           "type": "array",
           "maxItems": 100,
           "items": {
+            "type": "object",
+            "discriminator": {
+              "propertyName": "type"
+            },
             "oneOf": [
               {
                 "type": "object",

data/schemas/instanceCustomNodes.json CHANGED Viewed

@@ -182,7 +182,41 @@
                   "type": "object"
                 },
                 "meta": {
-                  "type": "object"
+                  "type": "object",
+                  "properties": {
+                    "category": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 1024
+                    },
+                    "name": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 1024
+                    },
+                    "label": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 255
+                    },
+                    "description": {
+                      "type": "string",
+                      "maxLength": 32767
+                    },
+                    "x": {
+                      "type": "number"
+                    },
+                    "y": {
+                      "type": "number"
+                    },
+                    "groupId": {
+                      "type": "string",
+                      "maxLength": 1024
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ]
                 },
                 "outputIds": {
                   "type": "array",
@@ -200,7 +234,8 @@
               },
               "additionalProperties": false,
               "required": [
-                "type"
+                "type",
+                "meta"
               ]
             }
           },
@@ -230,6 +265,10 @@
                 "type": "array",
                 "maxItems": 100,
                 "items": {
+                  "type": "object",
+                  "discriminator": {
+                    "propertyName": "type"
+                  },
                   "oneOf": [
                     {
                       "type": "object",

data/schemas/instanceOrg.json CHANGED Viewed

@@ -439,12 +439,15 @@
               "type": "integer"
             },
             "minutesThisPeriod": {
-              "type": "integer"
+              "type": "number"
             },
             "runsThisPeriod": {
               "type": "integer"
             }
           }
+        },
+        "deviceDataSize": {
+          "type": "number"
         }
       }
     },

data/schemas/instanceOrgInvite.json ADDED Viewed

@@ -0,0 +1,102 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 1024
+    },
+    "role": {
+      "type": "string",
+      "enum": [
+        "admin",
+        "edit",
+        "collaborate",
+        "view",
+        "none"
+      ]
+    },
+    "applicationRoles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "resourceId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "role": {
+            "type": "string",
+            "enum": [
+              "collaborate",
+              "view",
+              "none"
+            ]
+          }
+        },
+        "required": [
+          "resourceId",
+          "role"
+        ],
+        "additionalProperties": false
+      },
+      "maxItems": 100
+    },
+    "dashboardRoles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "resourceId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "role": {
+            "type": "string",
+            "enum": [
+              "collaborate",
+              "view",
+              "none"
+            ]
+          }
+        },
+        "required": [
+          "resourceId",
+          "role"
+        ],
+        "additionalProperties": false
+      },
+      "maxItems": 100
+    },
+    "inviteDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "ttl": {
+      "type": "number"
+    },
+    "hasExpired": {
+      "type": "boolean"
+    },
+    "disallowTransfer": {
+      "type": "boolean"
+    },
+    "inviteId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "instanceId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    }
+  }
+}

data/schemas/instanceOrgInviteSent.json ADDED Viewed

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "inviteSent": {
+      "type": "boolean",
+      "enum": [
+        true
+      ]
+    }
+  }
+}