losant_rest 2.0.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.
- checksums.yaml +4 -4
- data/docs/_schemas.md +140925 -67028
- data/docs/application.md +27 -27
- 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 +5 -4
- data/docs/applicationDashboard.md +5 -5
- 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 +5 -5
- data/docs/auditLog.md +1 -1
- data/docs/auditLogs.md +1 -1
- data/docs/auth.md +1 -1
- data/docs/credential.md +4 -4
- data/docs/credentials.md +2 -2
- data/docs/dashboard.md +4 -4
- data/docs/dashboards.md +3 -2
- data/docs/data.md +3 -3
- data/docs/dataTable.md +5 -5
- data/docs/dataTableRow.md +4 -4
- data/docs/dataTableRows.md +9 -9
- data/docs/dataTables.md +2 -2
- data/docs/device.md +15 -15
- 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 +7 -7
- data/docs/embeddedDeployment.md +1 -1
- data/docs/embeddedDeployments.md +8 -8
- data/docs/event.md +3 -3
- data/docs/events.md +6 -6
- data/docs/experience.md +3 -3
- 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 +9 -9
- data/docs/files.md +3 -3
- data/docs/flow.md +11 -11
- data/docs/flowVersion.md +6 -6
- data/docs/flowVersions.md +4 -4
- data/docs/flows.md +5 -5
- data/docs/instance.md +8 -8
- data/docs/instanceApiToken.md +1 -1
- data/docs/instanceApiTokens.md +2 -2
- 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 +2 -2
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceNotificationRule.md +5 -5
- data/docs/instanceNotificationRules.md +2 -2
- data/docs/instanceOrg.md +8 -8
- data/docs/instanceOrgInvite.md +3 -3
- data/docs/instanceOrgInvites.md +2 -2
- data/docs/instanceOrgMember.md +1 -1
- data/docs/instanceOrgMembers.md +3 -2
- data/docs/instanceOrgs.md +3 -3
- 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 +21 -21
- data/docs/notebook.md +10 -10
- data/docs/notebooks.md +2 -2
- data/docs/org.md +14 -14
- data/docs/orgs.md +2 -2
- data/docs/privateFile.md +9 -9
- data/docs/privateFiles.md +3 -3
- data/docs/resourceJob.md +8 -8
- data/docs/resourceJobs.md +2 -2
- data/docs/userApiToken.md +3 -3
- data/docs/userApiTokens.md +4 -4
- 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 +21 -21
- 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 +7 -4
- data/lib/platform_rest/application_dashboard.rb +5 -5
- 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 +4 -4
- data/lib/platform_rest/dashboards.rb +3 -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 +4 -4
- data/lib/platform_rest/data_table_rows.rb +9 -9
- data/lib/platform_rest/data_tables.rb +2 -2
- data/lib/platform_rest/device.rb +15 -15
- 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 +7 -7
- data/lib/platform_rest/embedded_deployment.rb +1 -1
- data/lib/platform_rest/embedded_deployments.rb +8 -8
- data/lib/platform_rest/event.rb +3 -3
- data/lib/platform_rest/events.rb +6 -6
- data/lib/platform_rest/experience.rb +3 -3
- 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 +6 -6
- 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 +2 -2
- 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 +2 -2
- 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 +8 -8
- data/lib/platform_rest/instance_org_invite.rb +3 -3
- data/lib/platform_rest/instance_org_invites.rb +3 -3
- data/lib/platform_rest/instance_org_member.rb +1 -1
- data/lib/platform_rest/instance_org_members.rb +3 -2
- data/lib/platform_rest/instance_orgs.rb +3 -3
- 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 +21 -21
- data/lib/platform_rest/notebook.rb +9 -9
- data/lib/platform_rest/notebooks.rb +2 -2
- data/lib/platform_rest/org.rb +14 -14
- data/lib/platform_rest/orgs.rb +2 -2
- data/lib/platform_rest/private_file.rb +6 -6
- data/lib/platform_rest/private_files.rb +2 -2
- data/lib/platform_rest/resource_job.rb +8 -8
- 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 +4 -4
- 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/advancedApplicationCertQuery.json +1885 -0
- data/schemas/advancedApplicationKeyQuery.json +763 -763
- data/schemas/apiToken.json +110 -1
- data/schemas/apiTokenPatch.json +100 -0
- data/schemas/apiTokenPost.json +118 -0
- data/schemas/apiTokens.json +120 -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 +183 -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 +203 -128
- data/schemas/dashboardBlockSuggestCodePost.json +19 -0
- data/schemas/dashboardPatch.json +183 -128
- data/schemas/dashboardPost.json +183 -128
- data/schemas/dashboardUpdateEventsResult.json +266 -0
- data/schemas/dashboards.json +203 -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/githubLogin.json +18 -0
- 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/instanceOrgMemberPatch.json +2 -2
- data/schemas/instanceOrgMemberPost.json +4 -4
- data/schemas/instanceOrgMembers.json +105 -1
- data/schemas/instanceOrgPost.json +5 -5
- 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/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 +16 -3
- data/schemas/orgInvite.json +2 -2
- data/schemas/orgInviteCollection.json +2 -2
- data/schemas/orgInvitePost.json +2 -2
- data/schemas/orgInvites.json +77 -82
- data/schemas/orgInvitesUser.json +44 -47
- data/schemas/orgMemberPatch.json +2 -2
- data/schemas/orgRoleInfo.json +2 -2
- data/schemas/orgs.json +16 -3
- 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/samlResponse.json +18 -0
- data/schemas/tagValuesResponse.json +1 -2
- data/schemas/templateKeywords.json +1 -0
- data/schemas/timeSeriesData.json +36 -4
- data/schemas/userCredentials.json +18 -0
- data/schemas/userOauthToken.json +210 -0
- data/schemas/userOauthTokenPatch.json +123 -0
- data/schemas/userOauthTokenPost.json +197 -0
- data/schemas/userOauthTokens.json +251 -0
- data/schemas/userPost.json +18 -0
- data/schemas/validateContextError.json +71 -24
- data/schemas/validateContextSuccess.json +71 -24
- metadata +22 -1
data/docs/instanceMembers.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceMembers.*, or instanceMembers.get.
|
|
27
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceMembers.*, or instanceMembers.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -29,7 +29,7 @@ puts result
|
|
|
29
29
|
#### Authentication
|
|
30
30
|
The client must be configured with a valid api access token to call this
|
|
31
31
|
action. The token must include at least one of the following scopes:
|
|
32
|
-
all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.delete.
|
|
32
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.delete.
|
|
33
33
|
|
|
34
34
|
#### Available Parameters
|
|
35
35
|
|
|
@@ -70,7 +70,7 @@ puts result
|
|
|
70
70
|
#### Authentication
|
|
71
71
|
The client must be configured with a valid api access token to call this
|
|
72
72
|
action. The token must include at least one of the following scopes:
|
|
73
|
-
all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.evaluate.
|
|
73
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.evaluate.
|
|
74
74
|
|
|
75
75
|
#### Available Parameters
|
|
76
76
|
|
|
@@ -111,7 +111,7 @@ puts result
|
|
|
111
111
|
#### Authentication
|
|
112
112
|
The client must be configured with a valid api access token to call this
|
|
113
113
|
action. The token must include at least one of the following scopes:
|
|
114
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRule.*, or instanceNotificationRule.get.
|
|
114
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceNotificationRule.*, or instanceNotificationRule.get.
|
|
115
115
|
|
|
116
116
|
#### Available Parameters
|
|
117
117
|
|
|
@@ -151,7 +151,7 @@ puts result
|
|
|
151
151
|
#### Authentication
|
|
152
152
|
The client must be configured with a valid api access token to call this
|
|
153
153
|
action. The token must include at least one of the following scopes:
|
|
154
|
-
all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.logs.
|
|
154
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.logs.
|
|
155
155
|
|
|
156
156
|
#### Available Parameters
|
|
157
157
|
|
|
@@ -194,7 +194,7 @@ puts result
|
|
|
194
194
|
#### Authentication
|
|
195
195
|
The client must be configured with a valid api access token to call this
|
|
196
196
|
action. The token must include at least one of the following scopes:
|
|
197
|
-
all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.patch.
|
|
197
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceNotificationRule.*, or instanceNotificationRule.patch.
|
|
198
198
|
|
|
199
199
|
#### Available Parameters
|
|
200
200
|
|
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRules.*, or instanceNotificationRules.get.
|
|
27
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceNotificationRules.*, or instanceNotificationRules.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.Instance, all.User, instanceNotificationRules.*, or instanceNotificationRules.post.
|
|
71
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceNotificationRules.*, or instanceNotificationRules.post.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
data/docs/instanceOrg.md
CHANGED
|
@@ -31,7 +31,7 @@ puts result
|
|
|
31
31
|
#### Authentication
|
|
32
32
|
The client must be configured with a valid api access token to call this
|
|
33
33
|
action. The token must include at least one of the following scopes:
|
|
34
|
-
all.Instance, all.User, instanceOrg.*, or instanceOrg.delete.
|
|
34
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceOrg.*, or instanceOrg.delete.
|
|
35
35
|
|
|
36
36
|
#### Available Parameters
|
|
37
37
|
|
|
@@ -71,7 +71,7 @@ puts result
|
|
|
71
71
|
#### Authentication
|
|
72
72
|
The client must be configured with a valid api access token to call this
|
|
73
73
|
action. The token must include at least one of the following scopes:
|
|
74
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
|
|
74
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
|
|
75
75
|
|
|
76
76
|
#### Available Parameters
|
|
77
77
|
|
|
@@ -113,7 +113,7 @@ puts result
|
|
|
113
113
|
#### Authentication
|
|
114
114
|
The client must be configured with a valid api access token to call this
|
|
115
115
|
action. The token must include at least one of the following scopes:
|
|
116
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.
|
|
116
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrg.*, or instanceOrg.get.
|
|
117
117
|
|
|
118
118
|
#### Available Parameters
|
|
119
119
|
|
|
@@ -154,7 +154,7 @@ puts result
|
|
|
154
154
|
#### Authentication
|
|
155
155
|
The client must be configured with a valid api access token to call this
|
|
156
156
|
action. The token must include at least one of the following scopes:
|
|
157
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
|
|
157
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
|
|
158
158
|
|
|
159
159
|
#### Available Parameters
|
|
160
160
|
|
|
@@ -197,7 +197,7 @@ puts result
|
|
|
197
197
|
#### Authentication
|
|
198
198
|
The client must be configured with a valid api access token to call this
|
|
199
199
|
action. The token must include at least one of the following scopes:
|
|
200
|
-
all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
|
|
200
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceOrg.*, or instanceOrg.patch.
|
|
201
201
|
|
|
202
202
|
#### Available Parameters
|
|
203
203
|
|
|
@@ -239,7 +239,7 @@ puts result
|
|
|
239
239
|
#### Authentication
|
|
240
240
|
The client must be configured with a valid api access token to call this
|
|
241
241
|
action. The token must include at least one of the following scopes:
|
|
242
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.payloadCounts.
|
|
242
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrg.*, or instanceOrg.payloadCounts.
|
|
243
243
|
|
|
244
244
|
#### Available Parameters
|
|
245
245
|
|
|
@@ -269,7 +269,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or inst
|
|
|
269
269
|
|
|
270
270
|
## Payload Counts Breakdown
|
|
271
271
|
|
|
272
|
-
Returns payload counts per resolution in the time range specified for all
|
|
272
|
+
Returns payload counts per resolution in the time range specified for all applications this organization owns
|
|
273
273
|
|
|
274
274
|
```ruby
|
|
275
275
|
result = client.instance_org.payload_counts_breakdown(
|
|
@@ -282,7 +282,7 @@ puts result
|
|
|
282
282
|
#### Authentication
|
|
283
283
|
The client must be configured with a valid api access token to call this
|
|
284
284
|
action. The token must include at least one of the following scopes:
|
|
285
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.
|
|
285
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.
|
|
286
286
|
|
|
287
287
|
#### Available Parameters
|
|
288
288
|
|
data/docs/instanceOrgInvite.md
CHANGED
|
@@ -70,7 +70,7 @@ puts result
|
|
|
70
70
|
#### Authentication
|
|
71
71
|
The client must be configured with a valid api access token to call this
|
|
72
72
|
action. The token must include at least one of the following scopes:
|
|
73
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
|
|
73
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.
|
|
74
74
|
|
|
75
75
|
#### Available Parameters
|
|
76
76
|
|
|
@@ -85,7 +85,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, o
|
|
|
85
85
|
|
|
86
86
|
| Code | Type | Description |
|
|
87
87
|
| ---- | ---- | ----------- |
|
|
88
|
-
| 200 | [Organization Invitation](_schemas.md#organization-invitation) | A single organization invite |
|
|
88
|
+
| 200 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | A single organization invite |
|
|
89
89
|
|
|
90
90
|
#### Error Responses
|
|
91
91
|
|
|
@@ -129,7 +129,7 @@ all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
|
|
|
129
129
|
|
|
130
130
|
| Code | Type | Description |
|
|
131
131
|
| ---- | ---- | ----------- |
|
|
132
|
-
| 201 | [Organization Invitation](_schemas.md#organization-invitation) | The new org invite |
|
|
132
|
+
| 201 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | The new org invite |
|
|
133
133
|
|
|
134
134
|
#### Error Responses
|
|
135
135
|
|
data/docs/instanceOrgInvites.md
CHANGED
|
@@ -26,7 +26,7 @@ puts result
|
|
|
26
26
|
#### Authentication
|
|
27
27
|
The client must be configured with a valid api access token to call this
|
|
28
28
|
action. The token must include at least one of the following scopes:
|
|
29
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.
|
|
29
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.
|
|
30
30
|
|
|
31
31
|
#### Available Parameters
|
|
32
32
|
|
|
@@ -86,7 +86,7 @@ all.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.
|
|
|
86
86
|
|
|
87
87
|
| Code | Type | Description |
|
|
88
88
|
| ---- | ---- | ----------- |
|
|
89
|
-
| 201 | [Instance Organization
|
|
89
|
+
| 201 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | The new organization invite |
|
|
90
90
|
|
|
91
91
|
#### Error Responses
|
|
92
92
|
|
data/docs/instanceOrgMember.md
CHANGED
|
@@ -70,7 +70,7 @@ puts result
|
|
|
70
70
|
#### Authentication
|
|
71
71
|
The client must be configured with a valid api access token to call this
|
|
72
72
|
action. The token must include at least one of the following scopes:
|
|
73
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMember.*, or instanceOrgMember.get.
|
|
73
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgMember.*, or instanceOrgMember.get.
|
|
74
74
|
|
|
75
75
|
#### Available Parameters
|
|
76
76
|
|
data/docs/instanceOrgMembers.md
CHANGED
|
@@ -26,7 +26,7 @@ puts result
|
|
|
26
26
|
#### Authentication
|
|
27
27
|
The client must be configured with a valid api access token to call this
|
|
28
28
|
action. The token must include at least one of the following scopes:
|
|
29
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMembers.*, or instanceOrgMembers.get.
|
|
29
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgMembers.*, or instanceOrgMembers.get.
|
|
30
30
|
|
|
31
31
|
#### Available Parameters
|
|
32
32
|
|
|
@@ -86,7 +86,8 @@ all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
|
|
|
86
86
|
|
|
87
87
|
| Code | Type | Description |
|
|
88
88
|
| ---- | ---- | ----------- |
|
|
89
|
-
|
|
|
89
|
+
| 201 | [Instance Org Member](_schemas.md#instance-org-member) | The newly added instance org member |
|
|
90
|
+
| 202 | [Instance Organization Invite Sent](_schemas.md#instance-organization-invite-sent) | An invite was sent to the new member's email address |
|
|
90
91
|
|
|
91
92
|
#### Error Responses
|
|
92
93
|
|
data/docs/instanceOrgs.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or instanceOrgs.get.
|
|
27
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgs.*, or instanceOrgs.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.
|
|
71
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceOrgs.*, or instanceOrgs.post.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
|
@@ -83,7 +83,7 @@ all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.
|
|
|
83
83
|
|
|
84
84
|
| Code | Type | Description |
|
|
85
85
|
| ---- | ---- | ----------- |
|
|
86
|
-
|
|
|
86
|
+
| 201 | [Instance Organization](_schemas.md#instance-organization) | The newly created organization |
|
|
87
87
|
|
|
88
88
|
#### Error Responses
|
|
89
89
|
|
data/docs/instanceSandbox.md
CHANGED
|
@@ -31,7 +31,7 @@ puts result
|
|
|
31
31
|
#### Authentication
|
|
32
32
|
The client must be configured with a valid api access token to call this
|
|
33
33
|
action. The token must include at least one of the following scopes:
|
|
34
|
-
all.Instance, all.User, instanceSandbox.*, or instanceSandbox.delete.
|
|
34
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceSandbox.*, or instanceSandbox.delete.
|
|
35
35
|
|
|
36
36
|
#### Available Parameters
|
|
37
37
|
|
|
@@ -71,7 +71,7 @@ puts result
|
|
|
71
71
|
#### Authentication
|
|
72
72
|
The client must be configured with a valid api access token to call this
|
|
73
73
|
action. The token must include at least one of the following scopes:
|
|
74
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.deviceCounts.
|
|
74
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandbox.*, or instanceSandbox.deviceCounts.
|
|
75
75
|
|
|
76
76
|
#### Available Parameters
|
|
77
77
|
|
|
@@ -113,7 +113,7 @@ puts result
|
|
|
113
113
|
#### Authentication
|
|
114
114
|
The client must be configured with a valid api access token to call this
|
|
115
115
|
action. The token must include at least one of the following scopes:
|
|
116
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.get.
|
|
116
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandbox.*, or instanceSandbox.get.
|
|
117
117
|
|
|
118
118
|
#### Available Parameters
|
|
119
119
|
|
|
@@ -155,7 +155,7 @@ puts result
|
|
|
155
155
|
#### Authentication
|
|
156
156
|
The client must be configured with a valid api access token to call this
|
|
157
157
|
action. The token must include at least one of the following scopes:
|
|
158
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.notebookMinuteCounts.
|
|
158
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandbox.*, or instanceSandbox.notebookMinuteCounts.
|
|
159
159
|
|
|
160
160
|
#### Available Parameters
|
|
161
161
|
|
|
@@ -197,7 +197,7 @@ puts result
|
|
|
197
197
|
#### Authentication
|
|
198
198
|
The client must be configured with a valid api access token to call this
|
|
199
199
|
action. The token must include at least one of the following scopes:
|
|
200
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCounts.
|
|
200
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCounts.
|
|
201
201
|
|
|
202
202
|
#### Available Parameters
|
|
203
203
|
|
|
@@ -240,7 +240,7 @@ puts result
|
|
|
240
240
|
#### Authentication
|
|
241
241
|
The client must be configured with a valid api access token to call this
|
|
242
242
|
action. The token must include at least one of the following scopes:
|
|
243
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCountsBreakdown.
|
|
243
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCountsBreakdown.
|
|
244
244
|
|
|
245
245
|
#### Available Parameters
|
|
246
246
|
|
|
@@ -285,7 +285,7 @@ puts result
|
|
|
285
285
|
#### Authentication
|
|
286
286
|
The client must be configured with a valid api access token to call this
|
|
287
287
|
action. The token must include at least one of the following scopes:
|
|
288
|
-
all.Instance, all.User, instanceSandbox.*, or instanceSandbox.undelete.
|
|
288
|
+
all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceSandbox.*, or instanceSandbox.undelete.
|
|
289
289
|
|
|
290
290
|
#### Available Parameters
|
|
291
291
|
|
data/docs/instanceSandboxes.md
CHANGED
|
@@ -23,7 +23,7 @@ puts result
|
|
|
23
23
|
#### Authentication
|
|
24
24
|
The client must be configured with a valid api access token to call this
|
|
25
25
|
action. The token must include at least one of the following scopes:
|
|
26
|
-
all.Instance, all.Instance.read, all.User, all.User.read, instanceSandboxes.*, or instanceSandboxes.get.
|
|
26
|
+
all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceSandboxes.*, or instanceSandboxes.get.
|
|
27
27
|
|
|
28
28
|
#### Available Parameters
|
|
29
29
|
|
data/docs/instances.md
CHANGED
|
@@ -23,7 +23,7 @@ puts result
|
|
|
23
23
|
#### Authentication
|
|
24
24
|
The client must be configured with a valid api access token to call this
|
|
25
25
|
action. The token must include at least one of the following scopes:
|
|
26
|
-
all.User, all.User.read, instances.*,
|
|
26
|
+
all.User, all.User.bounded, all.User.read, instances.*, instances.get, only.User, only.User.bounded, or only.User.read.
|
|
27
27
|
|
|
28
28
|
#### Available Parameters
|
|
29
29
|
|
data/docs/integration.md
CHANGED
|
@@ -27,7 +27,7 @@ puts result
|
|
|
27
27
|
#### Authentication
|
|
28
28
|
The client must be configured with a valid api access token to call this
|
|
29
29
|
action. The token must include at least one of the following scopes:
|
|
30
|
-
all.Application, all.Organization, all.User, integration.*, or integration.delete.
|
|
30
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, integration.*, or integration.delete.
|
|
31
31
|
|
|
32
32
|
#### Available Parameters
|
|
33
33
|
|
|
@@ -68,7 +68,7 @@ puts result
|
|
|
68
68
|
#### Authentication
|
|
69
69
|
The client must be configured with a valid api access token to call this
|
|
70
70
|
action. The token must include at least one of the following scopes:
|
|
71
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, integration.*, or integration.get.
|
|
71
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, integration.*, or integration.get.
|
|
72
72
|
|
|
73
73
|
#### Available Parameters
|
|
74
74
|
|
|
@@ -109,7 +109,7 @@ puts result
|
|
|
109
109
|
#### Authentication
|
|
110
110
|
The client must be configured with a valid api access token to call this
|
|
111
111
|
action. The token must include at least one of the following scopes:
|
|
112
|
-
all.Application, all.Organization, all.User, integration.*, or integration.patch.
|
|
112
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, integration.*, or integration.patch.
|
|
113
113
|
|
|
114
114
|
#### Available Parameters
|
|
115
115
|
|
data/docs/integrations.md
CHANGED
|
@@ -24,7 +24,7 @@ puts result
|
|
|
24
24
|
#### Authentication
|
|
25
25
|
The client must be configured with a valid api access token to call this
|
|
26
26
|
action. The token must include at least one of the following scopes:
|
|
27
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, integrations.*, or integrations.get.
|
|
27
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, integrations.*, or integrations.get.
|
|
28
28
|
|
|
29
29
|
#### Available Parameters
|
|
30
30
|
|
|
@@ -69,7 +69,7 @@ puts result
|
|
|
69
69
|
#### Authentication
|
|
70
70
|
The client must be configured with a valid api access token to call this
|
|
71
71
|
action. The token must include at least one of the following scopes:
|
|
72
|
-
all.Application, all.Organization, all.User, integrations.*, or integrations.post.
|
|
72
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, integrations.*, or integrations.post.
|
|
73
73
|
|
|
74
74
|
#### Available Parameters
|
|
75
75
|
|
data/docs/me.md
CHANGED
|
@@ -42,7 +42,7 @@ puts result
|
|
|
42
42
|
#### Authentication
|
|
43
43
|
The client must be configured with a valid api access token to call this
|
|
44
44
|
action. The token must include at least one of the following scopes:
|
|
45
|
-
all.User, me.*,
|
|
45
|
+
all.User, all.User.bounded, me.*, me.addRecentItem, only.User, or only.User.bounded.
|
|
46
46
|
|
|
47
47
|
#### Available Parameters
|
|
48
48
|
|
|
@@ -78,7 +78,7 @@ puts result
|
|
|
78
78
|
#### Authentication
|
|
79
79
|
The client must be configured with a valid api access token to call this
|
|
80
80
|
action. The token must include at least one of the following scopes:
|
|
81
|
-
all.User, me.*,
|
|
81
|
+
all.User, me.*, me.changePassword, or only.User.
|
|
82
82
|
|
|
83
83
|
#### Available Parameters
|
|
84
84
|
|
|
@@ -114,7 +114,7 @@ puts result
|
|
|
114
114
|
#### Authentication
|
|
115
115
|
The client must be configured with a valid api access token to call this
|
|
116
116
|
action. The token must include at least one of the following scopes:
|
|
117
|
-
all.User, me.*,
|
|
117
|
+
all.User, me.*, me.delete, or only.User.
|
|
118
118
|
|
|
119
119
|
#### Available Parameters
|
|
120
120
|
|
|
@@ -150,7 +150,7 @@ puts result
|
|
|
150
150
|
#### Authentication
|
|
151
151
|
The client must be configured with a valid api access token to call this
|
|
152
152
|
action. The token must include at least one of the following scopes:
|
|
153
|
-
all.User, all.User.read, me.*,
|
|
153
|
+
all.User, all.User.bounded, all.User.read, me.*, me.deviceCounts, only.User, only.User.bounded, or only.User.read.
|
|
154
154
|
|
|
155
155
|
#### Available Parameters
|
|
156
156
|
|
|
@@ -187,7 +187,7 @@ puts result
|
|
|
187
187
|
#### Authentication
|
|
188
188
|
The client must be configured with a valid api access token to call this
|
|
189
189
|
action. The token must include at least one of the following scopes:
|
|
190
|
-
all.User, me.*,
|
|
190
|
+
all.User, me.*, me.disableTwoFactorAuth, or only.User.
|
|
191
191
|
|
|
192
192
|
#### Available Parameters
|
|
193
193
|
|
|
@@ -215,7 +215,7 @@ all.User, me.*, or me.disableTwoFactorAuth.
|
|
|
215
215
|
|
|
216
216
|
## Disconnect Github
|
|
217
217
|
|
|
218
|
-
Disconnects the user from
|
|
218
|
+
Disconnects the user from GitHub
|
|
219
219
|
|
|
220
220
|
```ruby
|
|
221
221
|
result = client.me.disconnect_github(optional_params)
|
|
@@ -226,7 +226,7 @@ puts result
|
|
|
226
226
|
#### Authentication
|
|
227
227
|
The client must be configured with a valid api access token to call this
|
|
228
228
|
action. The token must include at least one of the following scopes:
|
|
229
|
-
all.User, me.*,
|
|
229
|
+
all.User, me.*, me.disconnectGithub, or only.User.
|
|
230
230
|
|
|
231
231
|
#### Available Parameters
|
|
232
232
|
|
|
@@ -264,7 +264,7 @@ puts result
|
|
|
264
264
|
#### Authentication
|
|
265
265
|
The client must be configured with a valid api access token to call this
|
|
266
266
|
action. The token must include at least one of the following scopes:
|
|
267
|
-
all.User, me.*,
|
|
267
|
+
all.User, me.*, me.enableTwoFactorAuth, or only.User.
|
|
268
268
|
|
|
269
269
|
#### Available Parameters
|
|
270
270
|
|
|
@@ -303,7 +303,7 @@ puts result
|
|
|
303
303
|
#### Authentication
|
|
304
304
|
The client must be configured with a valid api access token to call this
|
|
305
305
|
action. The token must include at least one of the following scopes:
|
|
306
|
-
all.User, all.User.read, me.*,
|
|
306
|
+
all.User, all.User.bounded, all.User.read, me.*, me.fetchRecentItems, only.User, only.User.bounded, or only.User.read.
|
|
307
307
|
|
|
308
308
|
#### Available Parameters
|
|
309
309
|
|
|
@@ -340,7 +340,7 @@ puts result
|
|
|
340
340
|
#### Authentication
|
|
341
341
|
The client must be configured with a valid api access token to call this
|
|
342
342
|
action. The token must include at least one of the following scopes:
|
|
343
|
-
all.User, me.*,
|
|
343
|
+
all.User, me.*, me.generateTwoFactorAuth, or only.User.
|
|
344
344
|
|
|
345
345
|
#### Available Parameters
|
|
346
346
|
|
|
@@ -375,7 +375,7 @@ puts result
|
|
|
375
375
|
#### Authentication
|
|
376
376
|
The client must be configured with a valid api access token to call this
|
|
377
377
|
action. The token must include at least one of the following scopes:
|
|
378
|
-
all.User, all.User.read, me.*,
|
|
378
|
+
all.User, all.User.bounded, all.User.read, me.*, me.get, only.User, only.User.bounded, or only.User.read.
|
|
379
379
|
|
|
380
380
|
#### Available Parameters
|
|
381
381
|
|
|
@@ -412,7 +412,7 @@ puts result
|
|
|
412
412
|
#### Authentication
|
|
413
413
|
The client must be configured with a valid api access token to call this
|
|
414
414
|
action. The token must include at least one of the following scopes:
|
|
415
|
-
all.User, all.User.read, me.*,
|
|
415
|
+
all.User, all.User.bounded, all.User.read, me.*, me.invite, only.User, only.User.bounded, or only.User.read.
|
|
416
416
|
|
|
417
417
|
#### Available Parameters
|
|
418
418
|
|
|
@@ -449,7 +449,7 @@ puts result
|
|
|
449
449
|
#### Authentication
|
|
450
450
|
The client must be configured with a valid api access token to call this
|
|
451
451
|
action. The token must include at least one of the following scopes:
|
|
452
|
-
all.User, all.User.read, me.*,
|
|
452
|
+
all.User, all.User.bounded, all.User.read, me.*, me.invites, only.User, only.User.bounded, or only.User.read.
|
|
453
453
|
|
|
454
454
|
#### Available Parameters
|
|
455
455
|
|
|
@@ -484,7 +484,7 @@ puts result
|
|
|
484
484
|
#### Authentication
|
|
485
485
|
The client must be configured with a valid api access token to call this
|
|
486
486
|
action. The token must include at least one of the following scopes:
|
|
487
|
-
all.User, all.User.read, me.*,
|
|
487
|
+
all.User, all.User.bounded, all.User.read, me.*, me.notebookMinuteCounts, only.User, only.User.bounded, or only.User.read.
|
|
488
488
|
|
|
489
489
|
#### Available Parameters
|
|
490
490
|
|
|
@@ -521,7 +521,7 @@ puts result
|
|
|
521
521
|
#### Authentication
|
|
522
522
|
The client must be configured with a valid api access token to call this
|
|
523
523
|
action. The token must include at least one of the following scopes:
|
|
524
|
-
all.User, me.*,
|
|
524
|
+
all.User, me.*, me.patch, or only.User.
|
|
525
525
|
|
|
526
526
|
#### Available Parameters
|
|
527
527
|
|
|
@@ -560,7 +560,7 @@ puts result
|
|
|
560
560
|
#### Authentication
|
|
561
561
|
The client must be configured with a valid api access token to call this
|
|
562
562
|
action. The token must include at least one of the following scopes:
|
|
563
|
-
all.User, all.User.read, me.*,
|
|
563
|
+
all.User, all.User.bounded, all.User.read, me.*, me.payloadCounts, only.User, only.User.bounded, or only.User.read.
|
|
564
564
|
|
|
565
565
|
#### Available Parameters
|
|
566
566
|
|
|
@@ -598,7 +598,7 @@ puts result
|
|
|
598
598
|
#### Authentication
|
|
599
599
|
The client must be configured with a valid api access token to call this
|
|
600
600
|
action. The token must include at least one of the following scopes:
|
|
601
|
-
all.User, all.User.read, me.*,
|
|
601
|
+
all.User, all.User.bounded, all.User.read, me.*, me.payloadCountsBreakdown, only.User, only.User.bounded, or only.User.read.
|
|
602
602
|
|
|
603
603
|
#### Available Parameters
|
|
604
604
|
|
|
@@ -638,7 +638,7 @@ puts result
|
|
|
638
638
|
#### Authentication
|
|
639
639
|
The client must be configured with a valid api access token to call this
|
|
640
640
|
action. The token must include at least one of the following scopes:
|
|
641
|
-
all.User, or
|
|
641
|
+
all.User, me.*, me.refreshToken, or only.User.
|
|
642
642
|
|
|
643
643
|
#### Available Parameters
|
|
644
644
|
|
|
@@ -676,7 +676,7 @@ puts result
|
|
|
676
676
|
#### Authentication
|
|
677
677
|
The client must be configured with a valid api access token to call this
|
|
678
678
|
action. The token must include at least one of the following scopes:
|
|
679
|
-
all.User, me.*,
|
|
679
|
+
all.User, me.*, me.respondToInvite, or only.User.
|
|
680
680
|
|
|
681
681
|
#### Available Parameters
|
|
682
682
|
|
|
@@ -715,7 +715,7 @@ puts result
|
|
|
715
715
|
#### Authentication
|
|
716
716
|
The client must be configured with a valid api access token to call this
|
|
717
717
|
action. The token must include at least one of the following scopes:
|
|
718
|
-
all.User, me.*,
|
|
718
|
+
all.User, me.*, me.transferResources, or only.User.
|
|
719
719
|
|
|
720
720
|
#### Available Parameters
|
|
721
721
|
|
|
@@ -751,7 +751,7 @@ puts result
|
|
|
751
751
|
#### Authentication
|
|
752
752
|
The client must be configured with a valid api access token to call this
|
|
753
753
|
action. The token must include at least one of the following scopes:
|
|
754
|
-
all.User, me.*,
|
|
754
|
+
all.User, me.*, me.verifyEmail, or only.User.
|
|
755
755
|
|
|
756
756
|
#### Available Parameters
|
|
757
757
|
|
data/docs/notebook.md
CHANGED
|
@@ -34,7 +34,7 @@ puts result
|
|
|
34
34
|
#### Authentication
|
|
35
35
|
The client must be configured with a valid api access token to call this
|
|
36
36
|
action. The token must include at least one of the following scopes:
|
|
37
|
-
all.Application, all.Organization, all.User, notebook.*, or notebook.execute.
|
|
37
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebook.*, or notebook.execute.
|
|
38
38
|
|
|
39
39
|
#### Available Parameters
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ all.Application, all.Organization, all.User, notebook.*, or notebook.execute.
|
|
|
42
42
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
|
43
43
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
|
44
44
|
| notebookId | string | Y | ID associated with the notebook | | 575ed78e7ae143cd83dc4aab |
|
|
45
|
-
| executionId |
|
|
45
|
+
| executionId | string | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
|
|
46
46
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
|
47
47
|
|
|
48
48
|
#### Successful Responses
|
|
@@ -75,7 +75,7 @@ puts result
|
|
|
75
75
|
#### Authentication
|
|
76
76
|
The client must be configured with a valid api access token to call this
|
|
77
77
|
action. The token must include at least one of the following scopes:
|
|
78
|
-
all.Application, all.Organization, all.User, notebook.*, or notebook.delete.
|
|
78
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebook.*, or notebook.delete.
|
|
79
79
|
|
|
80
80
|
#### Available Parameters
|
|
81
81
|
|
|
@@ -116,7 +116,7 @@ puts result
|
|
|
116
116
|
#### Authentication
|
|
117
117
|
The client must be configured with a valid api access token to call this
|
|
118
118
|
action. The token must include at least one of the following scopes:
|
|
119
|
-
all.Application, all.Organization, all.User, notebook.*, or notebook.execute.
|
|
119
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebook.*, or notebook.execute.
|
|
120
120
|
|
|
121
121
|
#### Available Parameters
|
|
122
122
|
|
|
@@ -157,7 +157,7 @@ puts result
|
|
|
157
157
|
#### Authentication
|
|
158
158
|
The client must be configured with a valid api access token to call this
|
|
159
159
|
action. The token must include at least one of the following scopes:
|
|
160
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.get.
|
|
160
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, notebook.*, or notebook.get.
|
|
161
161
|
|
|
162
162
|
#### Available Parameters
|
|
163
163
|
|
|
@@ -197,7 +197,7 @@ puts result
|
|
|
197
197
|
#### Authentication
|
|
198
198
|
The client must be configured with a valid api access token to call this
|
|
199
199
|
action. The token must include at least one of the following scopes:
|
|
200
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.logs.
|
|
200
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, notebook.*, or notebook.logs.
|
|
201
201
|
|
|
202
202
|
#### Available Parameters
|
|
203
203
|
|
|
@@ -239,7 +239,7 @@ puts result
|
|
|
239
239
|
#### Authentication
|
|
240
240
|
The client must be configured with a valid api access token to call this
|
|
241
241
|
action. The token must include at least one of the following scopes:
|
|
242
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.notebookMinuteCounts.
|
|
242
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, notebook.*, or notebook.notebookMinuteCounts.
|
|
243
243
|
|
|
244
244
|
#### Available Parameters
|
|
245
245
|
|
|
@@ -282,7 +282,7 @@ puts result
|
|
|
282
282
|
#### Authentication
|
|
283
283
|
The client must be configured with a valid api access token to call this
|
|
284
284
|
action. The token must include at least one of the following scopes:
|
|
285
|
-
all.Application, all.Organization, all.User, notebook.*, or notebook.patch.
|
|
285
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebook.*, or notebook.patch.
|
|
286
286
|
|
|
287
287
|
#### Available Parameters
|
|
288
288
|
|
|
@@ -324,7 +324,7 @@ puts result
|
|
|
324
324
|
#### Authentication
|
|
325
325
|
The client must be configured with a valid api access token to call this
|
|
326
326
|
action. The token must include at least one of the following scopes:
|
|
327
|
-
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, notebook.*, or notebook.requestInputDataExport.
|
|
327
|
+
all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, notebook.*, or notebook.requestInputDataExport.
|
|
328
328
|
|
|
329
329
|
#### Available Parameters
|
|
330
330
|
|
|
@@ -366,7 +366,7 @@ puts result
|
|
|
366
366
|
#### Authentication
|
|
367
367
|
The client must be configured with a valid api access token to call this
|
|
368
368
|
action. The token must include at least one of the following scopes:
|
|
369
|
-
all.Application, all.Organization, all.User, notebook.*, or notebook.upload.
|
|
369
|
+
all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, notebook.*, or notebook.upload.
|
|
370
370
|
|
|
371
371
|
#### Available Parameters
|
|
372
372
|
|