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

losant_rest 2.0.0 → 2.1.0

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 (232) hide show

checksums.yaml +4 -4
data/docs/_schemas.md +2454 -666
data/docs/application.md +21 -21
data/docs/applicationApiToken.md +1 -1
data/docs/applicationApiTokens.md +1 -1
data/docs/applicationCertificate.md +3 -3
data/docs/applicationCertificateAuthorities.md +2 -2
data/docs/applicationCertificateAuthority.md +3 -3
data/docs/applicationCertificates.md +2 -2
data/docs/applicationDashboard.md +4 -4
data/docs/applicationDashboards.md +2 -2
data/docs/applicationJobLog.md +1 -1
data/docs/applicationJobLogs.md +1 -1
data/docs/applicationKey.md +3 -3
data/docs/applicationKeys.md +2 -2
data/docs/applicationTemplate.md +1 -1
data/docs/applicationTemplates.md +3 -3
data/docs/applications.md +4 -4
data/docs/auditLog.md +1 -1
data/docs/auditLogs.md +1 -1
data/docs/credential.md +4 -4
data/docs/credentials.md +2 -2
data/docs/dashboard.md +3 -3
data/docs/dashboards.md +2 -2
data/docs/data.md +3 -3
data/docs/dataTable.md +5 -5
data/docs/dataTableRow.md +3 -3
data/docs/dataTableRows.md +6 -6
data/docs/dataTables.md +2 -2
data/docs/device.md +14 -14
data/docs/deviceAttribute.md +3 -3
data/docs/deviceAttributes.md +2 -2
data/docs/deviceRecipe.md +4 -4
data/docs/deviceRecipes.md +2 -2
data/docs/devices.md +14 -14
data/docs/edgeDeployment.md +1 -1
data/docs/edgeDeployments.md +4 -4
data/docs/embeddedDeployment.md +1 -1
data/docs/embeddedDeployments.md +5 -5
data/docs/event.md +3 -3
data/docs/events.md +6 -6
data/docs/experience.md +2 -2
data/docs/experienceDomain.md +3 -3
data/docs/experienceDomains.md +2 -2
data/docs/experienceEndpoint.md +4 -4
data/docs/experienceEndpoints.md +3 -3
data/docs/experienceGroup.md +3 -3
data/docs/experienceGroups.md +2 -2
data/docs/experienceSlug.md +3 -3
data/docs/experienceSlugs.md +2 -2
data/docs/experienceUser.md +3 -3
data/docs/experienceUsers.md +2 -2
data/docs/experienceVersion.md +3 -3
data/docs/experienceVersions.md +2 -2
data/docs/experienceView.md +4 -4
data/docs/experienceViews.md +2 -2
data/docs/file.md +5 -5
data/docs/files.md +2 -2
data/docs/flow.md +11 -11
data/docs/flowVersion.md +6 -6
data/docs/flowVersions.md +3 -3
data/docs/flows.md +5 -5
data/docs/instance.md +8 -8
data/docs/instanceApiToken.md +1 -1
data/docs/instanceApiTokens.md +1 -1
data/docs/instanceAuditLog.md +1 -1
data/docs/instanceAuditLogs.md +1 -1
data/docs/instanceCustomNode.md +5 -5
data/docs/instanceCustomNodes.md +2 -2
data/docs/instanceMember.md +1 -1
data/docs/instanceMembers.md +1 -1
data/docs/instanceNotificationRule.md +5 -5
data/docs/instanceNotificationRules.md +2 -2
data/docs/instanceOrg.md +7 -7
data/docs/instanceOrgInvite.md +1 -1
data/docs/instanceOrgInvites.md +1 -1
data/docs/instanceOrgMember.md +1 -1
data/docs/instanceOrgMembers.md +1 -1
data/docs/instanceOrgs.md +2 -2
data/docs/instanceSandbox.md +7 -7
data/docs/instanceSandboxes.md +1 -1
data/docs/instances.md +1 -1
data/docs/integration.md +3 -3
data/docs/integrations.md +2 -2
data/docs/me.md +20 -20
data/docs/notebook.md +9 -9
data/docs/notebooks.md +2 -2
data/docs/org.md +13 -13
data/docs/orgs.md +2 -2
data/docs/privateFile.md +5 -5
data/docs/privateFiles.md +2 -2
data/docs/resourceJob.md +6 -6
data/docs/resourceJobs.md +2 -2
data/docs/userApiToken.md +3 -3
data/docs/userApiTokens.md +2 -2
data/docs/userOauthToken.md +125 -0
data/docs/userOauthTokens.md +87 -0
data/docs/webhook.md +3 -3
data/docs/webhooks.md +2 -2
data/lib/platform_rest/application.rb +20 -20
data/lib/platform_rest/application_api_token.rb +1 -1
data/lib/platform_rest/application_api_tokens.rb +1 -1
data/lib/platform_rest/application_certificate.rb +3 -3
data/lib/platform_rest/application_certificate_authorities.rb +2 -2
data/lib/platform_rest/application_certificate_authority.rb +3 -3
data/lib/platform_rest/application_certificates.rb +2 -2
data/lib/platform_rest/application_dashboard.rb +4 -4
data/lib/platform_rest/application_dashboards.rb +2 -2
data/lib/platform_rest/application_job_log.rb +1 -1
data/lib/platform_rest/application_job_logs.rb +1 -1
data/lib/platform_rest/application_key.rb +3 -3
data/lib/platform_rest/application_keys.rb +2 -2
data/lib/platform_rest/application_template.rb +1 -1
data/lib/platform_rest/application_templates.rb +3 -3
data/lib/platform_rest/applications.rb +3 -3
data/lib/platform_rest/audit_log.rb +1 -1
data/lib/platform_rest/audit_logs.rb +1 -1
data/lib/platform_rest/client.rb +10 -2
data/lib/platform_rest/credential.rb +4 -4
data/lib/platform_rest/credentials.rb +2 -2
data/lib/platform_rest/dashboard.rb +3 -3
data/lib/platform_rest/dashboards.rb +2 -2
data/lib/platform_rest/data.rb +3 -3
data/lib/platform_rest/data_table.rb +5 -5
data/lib/platform_rest/data_table_row.rb +3 -3
data/lib/platform_rest/data_table_rows.rb +6 -6
data/lib/platform_rest/data_tables.rb +2 -2
data/lib/platform_rest/device.rb +14 -14
data/lib/platform_rest/device_attribute.rb +3 -3
data/lib/platform_rest/device_attributes.rb +2 -2
data/lib/platform_rest/device_recipe.rb +4 -4
data/lib/platform_rest/device_recipes.rb +2 -2
data/lib/platform_rest/devices.rb +14 -14
data/lib/platform_rest/edge_deployment.rb +1 -1
data/lib/platform_rest/edge_deployments.rb +4 -4
data/lib/platform_rest/embedded_deployment.rb +1 -1
data/lib/platform_rest/embedded_deployments.rb +5 -5
data/lib/platform_rest/event.rb +3 -3
data/lib/platform_rest/events.rb +6 -6
data/lib/platform_rest/experience.rb +2 -2
data/lib/platform_rest/experience_domain.rb +3 -3
data/lib/platform_rest/experience_domains.rb +2 -2
data/lib/platform_rest/experience_endpoint.rb +4 -4
data/lib/platform_rest/experience_endpoints.rb +3 -3
data/lib/platform_rest/experience_group.rb +3 -3
data/lib/platform_rest/experience_groups.rb +2 -2
data/lib/platform_rest/experience_slug.rb +3 -3
data/lib/platform_rest/experience_slugs.rb +2 -2
data/lib/platform_rest/experience_user.rb +3 -3
data/lib/platform_rest/experience_users.rb +2 -2
data/lib/platform_rest/experience_version.rb +3 -3
data/lib/platform_rest/experience_versions.rb +2 -2
data/lib/platform_rest/experience_view.rb +4 -4
data/lib/platform_rest/experience_views.rb +2 -2
data/lib/platform_rest/file.rb +4 -4
data/lib/platform_rest/files.rb +2 -2
data/lib/platform_rest/flow.rb +11 -11
data/lib/platform_rest/flow_version.rb +6 -6
data/lib/platform_rest/flow_versions.rb +3 -3
data/lib/platform_rest/flows.rb +5 -5
data/lib/platform_rest/instance.rb +8 -8
data/lib/platform_rest/instance_api_token.rb +1 -1
data/lib/platform_rest/instance_api_tokens.rb +1 -1
data/lib/platform_rest/instance_audit_log.rb +1 -1
data/lib/platform_rest/instance_audit_logs.rb +1 -1
data/lib/platform_rest/instance_custom_node.rb +5 -5
data/lib/platform_rest/instance_custom_nodes.rb +2 -2
data/lib/platform_rest/instance_member.rb +1 -1
data/lib/platform_rest/instance_members.rb +1 -1
data/lib/platform_rest/instance_notification_rule.rb +5 -5
data/lib/platform_rest/instance_notification_rules.rb +2 -2
data/lib/platform_rest/instance_org.rb +7 -7
data/lib/platform_rest/instance_org_invite.rb +1 -1
data/lib/platform_rest/instance_org_invites.rb +1 -1
data/lib/platform_rest/instance_org_member.rb +1 -1
data/lib/platform_rest/instance_org_members.rb +1 -1
data/lib/platform_rest/instance_orgs.rb +2 -2
data/lib/platform_rest/instance_sandbox.rb +7 -7
data/lib/platform_rest/instance_sandboxes.rb +1 -1
data/lib/platform_rest/instances.rb +1 -1
data/lib/platform_rest/integration.rb +3 -3
data/lib/platform_rest/integrations.rb +2 -2
data/lib/platform_rest/me.rb +20 -20
data/lib/platform_rest/notebook.rb +8 -8
data/lib/platform_rest/notebooks.rb +2 -2
data/lib/platform_rest/org.rb +13 -13
data/lib/platform_rest/orgs.rb +2 -2
data/lib/platform_rest/private_file.rb +4 -4
data/lib/platform_rest/private_files.rb +2 -2
data/lib/platform_rest/resource_job.rb +6 -6
data/lib/platform_rest/resource_jobs.rb +2 -2
data/lib/platform_rest/user_api_token.rb +3 -3
data/lib/platform_rest/user_api_tokens.rb +2 -2
data/lib/platform_rest/user_oauth_token.rb +170 -0
data/lib/platform_rest/user_oauth_tokens.rb +132 -0
data/lib/platform_rest/version.rb +1 -1
data/lib/platform_rest/webhook.rb +3 -3
data/lib/platform_rest/webhooks.rb +2 -2
data/lib/platform_rest.rb +2 -0
data/schemas/apiToken.json +100 -0
data/schemas/apiTokenPatch.json +100 -0
data/schemas/apiTokenPost.json +118 -0
data/schemas/apiTokens.json +100 -0
data/schemas/applicationDashboardPost.json +4 -0
data/schemas/dashboard.json +4 -0
data/schemas/dashboardPatch.json +4 -0
data/schemas/dashboardPost.json +4 -0
data/schemas/dashboards.json +4 -0
data/schemas/githubLogin.json +18 -0
data/schemas/instanceOrgMemberPatch.json +2 -2
data/schemas/instanceOrgMemberPost.json +4 -4
data/schemas/instanceOrgPost.json +4 -4
data/schemas/oauthClient.json +107 -0
data/schemas/oauthClientPost.json +89 -0
data/schemas/oauthDcrError.json +23 -0
data/schemas/oauthError.json +31 -0
data/schemas/org.json +2 -2
data/schemas/orgInvite.json +2 -2
data/schemas/orgInviteCollection.json +2 -2
data/schemas/orgInvitePost.json +2 -2
data/schemas/orgInvites.json +2 -2
data/schemas/orgMemberPatch.json +2 -2
data/schemas/orgRoleInfo.json +2 -2
data/schemas/orgs.json +2 -2
data/schemas/samlResponse.json +18 -0
data/schemas/userCredentials.json +18 -0
data/schemas/userOauthToken.json +207 -0
data/schemas/userOauthTokenPatch.json +123 -0
data/schemas/userOauthTokenPost.json +197 -0
data/schemas/userOauthTokens.json +248 -0
data/schemas/userPost.json +18 -0
metadata +13 -1

data/schemas/userOauthTokens.json ADDED Viewed

@@ -0,0 +1,248 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "title": "User OAuth Token",
+        "description": "Schema for a single OAuth Token",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "oauthTokenId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "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"
+          },
+          "defaultRole": {
+            "type": "string",
+            "enum": [
+              "admin",
+              "edit",
+              "collaborate",
+              "view",
+              "none"
+            ]
+          },
+          "orgRoles": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "orgId": {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "pattern": "^[A-Fa-f\\d]{24}$"
+                    },
+                    {
+                      "type": "string",
+                      "enum": [
+                        "sandbox"
+                      ]
+                    }
+                  ]
+                },
+                "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
+                }
+              },
+              "required": [
+                "orgId",
+                "role"
+              ],
+              "additionalProperties": false
+            },
+            "maxItems": 25
+          },
+          "scope": {
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+              "type": "string",
+              "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
+              "enum": [
+                "all.Application.read",
+                "all.Application.bounded",
+                "only.Organization.read",
+                "only.Organization.bounded",
+                "all.Organization.read",
+                "all.Organization.bounded",
+                "only.User.read"
+              ]
+            },
+            "description": "API scopes for this OAuth client"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "inactive"
+            ]
+          },
+          "oauth": {
+            "type": "object",
+            "properties": {
+              "client_id": {
+                "type": "string",
+                "minLength": 24,
+                "maxLength": 1024,
+                "description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
+              },
+              "client_name": {
+                "type": "string",
+                "maxLength": 255,
+                "description": "Human-readable name of the OAuth client (from client registration)"
+              },
+              "client_uri": {
+                "type": "string",
+                "maxLength": 1024,
+                "description": "Informational URL for the OAuth client's homepage (from client registration)"
+              },
+              "logo_uri": {
+                "type": "string",
+                "maxLength": 32768,
+                "description": "Logo URL for the OAuth client (http(s) URL or data: URI, from client registration)"
+              },
+              "redirect_uri": {
+                "type": "string",
+                "format": "uri",
+                "maxLength": 1024
+              },
+              "resource": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uri",
+                  "maxLength": 1024
+                },
+                "description": "Resource indicator(s) per RFC 8707 — audience(s) this token is bound to"
+              },
+              "authorizationStatus": {
+                "type": "string",
+                "enum": [
+                  "pending",
+                  "authorized"
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "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",
+        "ASC",
+        "DESC",
+        ""
+      ]
+    }
+  }
+}

data/schemas/userPost.json CHANGED Viewed

@@ -85,6 +85,7 @@
                 "type": "string",
                 "enum": [
                   "all.Application",
+                  "all.Application.bounded",
                   "all.Application.read",
                   "all.Application.cli",
                   "all.Device",
@@ -411,7 +412,11 @@
                 "type": "string",
                 "enum": [
                   "all.Organization",
+                  "all.Organization.bounded",
                   "all.Organization.read",
+                  "only.Organization",
+                  "only.Organization.bounded",
+                  "only.Organization.read",
                   "applications.*",
                   "auditLog.*",
                   "auditLogs.*",
@@ -454,6 +459,7 @@
             "type": "string",
             "enum": [
               "all.Instance",
+              "all.Instance.bounded",
               "all.Instance.read",
               "instance.*",
               "instance.get",
@@ -542,8 +548,12 @@
             "type": "string",
             "enum": [
               "all.User",
+              "all.User.bounded",
               "all.User.read",
               "all.User.cli",
+              "only.User",
+              "only.User.bounded",
+              "only.User.read",
               "userApiToken.*",
               "userApiToken.get",
               "userApiToken.patch",
@@ -551,6 +561,13 @@
               "userApiTokens.*",
               "userApiTokens.get",
               "userApiTokens.post",
+              "userOauthToken.*",
+              "userOauthToken.get",
+              "userOauthToken.patch",
+              "userOauthToken.delete",
+              "userOauthTokens.*",
+              "userOauthTokens.get",
+              "userOauthTokens.post",
               "applicationTemplate.*",
               "applicationTemplate.get",
               "applicationTemplates.*",
@@ -580,6 +597,7 @@
               "me.invite",
               "me.invites",
               "me.respondToInvite",
+              "me.refreshToken",
               "orgs.*",
               "orgs.get",
               "orgs.post"

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: losant_rest
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Kuehl
@@ -190,6 +190,8 @@ files:
 - docs/resourceJobs.md
 - docs/userApiToken.md
 - docs/userApiTokens.md
+- docs/userOauthToken.md
+- docs/userOauthTokens.md
 - docs/webhook.md
 - docs/webhooks.md
 - examples/auth.rb
@@ -292,6 +294,8 @@ files:
 - lib/platform_rest/resource_jobs.rb
 - lib/platform_rest/user_api_token.rb
 - lib/platform_rest/user_api_tokens.rb
+- lib/platform_rest/user_oauth_token.rb
+- lib/platform_rest/user_oauth_tokens.rb
 - lib/platform_rest/utils.rb
 - lib/platform_rest/version.rb
 - lib/platform_rest/webhook.rb
@@ -567,6 +571,10 @@ files:
 - schemas/notificationRulePatch.json
 - schemas/notificationRulePost.json
 - schemas/notificationRules.json
+- schemas/oauthClient.json
+- schemas/oauthClientPost.json
+- schemas/oauthDcrError.json
+- schemas/oauthError.json
 - schemas/org.json
 - schemas/orgInvite.json
 - schemas/orgInviteAction.json
@@ -615,6 +623,10 @@ files:
 - schemas/timeSeriesQuery.json
 - schemas/twoFactorAuthInfo.json
 - schemas/userCredentials.json
+- schemas/userOauthToken.json
+- schemas/userOauthTokenPatch.json
+- schemas/userOauthTokenPost.json
+- schemas/userOauthTokens.json
 - schemas/userPost.json
 - schemas/validateContextError.json
 - schemas/validateContextSuccess.json