losant_rest 1.20.1 → 1.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d96f494f71f5645810bbebf4040de441d9067930582a5ec80fe5a52c1c3dfa68
-  data.tar.gz: 5c19f8747cc0dbcca7c3ce529815325fa80b690e25629e6ecd00c17d9462b9f2
+  metadata.gz: 4f41f3c00fb97dfa7f72f19f049104823c454a8f78226108b6b352d2fa5a605b
+  data.tar.gz: 85731f870544b1763845a867e2f7963ca234dfce7d7fc624e72a36ca16ee2d4c
 SHA512:
-  metadata.gz: 1d216781e43e33642741aeeede6274e107c9679568c9b88b54ce9ee0624006cc6dfd99c0724d955432cdf4e526720088b7193cf1171ed21e0c0cc3a521076bb0
-  data.tar.gz: 9f0b67e900f73ed4f25c39f4b072529aea73670319b37c457150447e905e19fcd8958480730ec7b744d63265d6b622ed0fc3b81d4671b4e6df2ddfe1b98f9011
+  metadata.gz: f97e1b47c3da23ebc2c60f910162cf82831bbf0b7e61f1d6b431768b9499e19296908d98dd02d471145a3e98523af2d13b5396bbd0550b5a8e1887342bcd478c
+  data.tar.gz: b7c69800da6e0cc7b93e8af8f46aab1b2180b26218cbd6513ce76b015f1e9bff64a821f75d7b3143f105cf0cbf9330ed103830d7c51a36d94822c291883670d2

data/README.md

@@ -1,10 +1,10 @@
 # Losant Ruby REST API Client
 
-![Build Status](https://github.com/Losant/losant-rest-js/actions/workflows/test.yml/badge.svg?branch=master)  [![Gem Version](https://badge.fury.io/rb/losant_rest.svg)](https://badge.fury.io/rb/losant_rest)
+![Build Status](https://github.com/Losant/losant-rest-ruby/actions/workflows/test.yml/badge.svg?branch=master)  [![Gem Version](https://badge.fury.io/rb/losant_rest.svg)](https://badge.fury.io/rb/losant_rest)
 
 The [Losant](https://www.losant.com) REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.
 
-This client works with Ruby 2.1 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
+This client works with Ruby 2.3 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
 
 <br/>
 
@@ -86,24 +86,60 @@ Each of the following is a method on the client object, and returns a wrapper fo
 * [application](docs/application.md)  
   Contains all of the actions that can be performed against a single [Application](https://docs.losant.com/applications/overview/), which include things like getting info on an application or modifying an application.
 
-* [applications](docs/applications.md)  
-  Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.
-
 * [application_api_token](docs/applicationApiToken.md)  
   Contains all the actions that can be performed against a single [Api Token](https://docs.losant.com/applications/application-tokens/) belonging to an application - for instance, getting info on a single token or revoking a token.
 
 * [application_api_tokens](docs/applicationApiTokens.md)  
   Contains all of the actions that can be performed against the collection of [Api Tokens](https://docs.losant.com/applications/application-tokens/) belonging to an Application - such as listing all tokens or creating a new token.
 
+* [application_certificate](docs/applicationCertificate.md)  
+  Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.
+
+* [application_certificate_authorities](docs/applicationCertificateAuthorities.md)  
+  Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.
+
+* [application_certificate_authority](docs/applicationCertificateAuthority.md)  
+  Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.
+
+* [application_certificates](docs/applicationCertificates.md)  
+  Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.
+
+* [application_cashboard](docs/applicationDashboard.md)  
+  Contains all the actions that can be performed against a single [Application Dashboard](https://docs.losant.com/dashboards/overview/) - for instance, things like getting info on a dashboard or modifying a dashboard.
+
+* [application_dashboards](docs/applicationDashboards.md)  
+  Contains all of the actions that can be performed against the collection of [Application Dashboards](https://docs.losant.com/dashboards/overview/) belonging to an Application - such as listing all dashboards or creating a new dashboard.
+
 * [application_key](docs/applicationKey.md)  
   Contains all the actions that can be performed against a single [Application Key](https://docs.losant.com/applications/access-keys/) - for instance, getting info on a single key or revoking a key.
 
 * [application_keys](docs/applicationKeys.md)  
   Contains all of the actions that can be performed against the collection of [Application Keys](https://docs.losant.com/applications/access-keys/) belonging to an Application - such as listing all keys or creating a new key.
 
+* [applications](docs/applications.md)  
+  Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.
+
+* [application_template](docs/applicationTemplate.md)  
+  Contains all the actions that can be performed against a single [Application Template](https://docs.losant.com/templates/overview/) - for instance, getting info on a single template.
+
+* [application_templates](docs/applicationTemplates.md)  
+  Contains all of the actions that can be performed against the collection of [Application Templates](https://docs.losant.com/templates/overview/) - such as listing all templates or categories.
+
+* [audit_log](docs/auditLog.md)  
+  Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/organizations/audit-logs/) that belongs to an organization - such as viewing a log.
+
+* [audit_logs](docs/auditLogs.md)  
+  Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/organizations/audit-logs/) that belong to an organization - such as listing the logs.
+
 * [auth](docs/auth.md)  
   Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.
 
+* [credential](docs/credential.md)  
+  Contains all the actions that can be performed against a single [Service Credential](https://docs.losant.com/applications/credentials/), such as updating a credential or removing a credential.
+
+* [credentials](docs/credentials.md)  
+  Contains all of the actions that can be performed against the set of [Service Credentials](https://docs.losant.com/applications/credentials/) that the currently authenticated user has access to - such as listing the credentials or creating a new credential.
+
 * [dashboard](docs/dashboard.md)  
   Contains all of the actions that can be performed against a single [Dashboard](https://docs.losant.com/dashboards/overview/), which include things like getting info on a dashboard or modifying a dashboard.
 
@@ -116,29 +152,38 @@ Each of the following is a method on the client object, and returns a wrapper fo
 * [data_table](docs/dataTable.md)  
   Contains all the actions that can be performed against a single [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting info on a single data table or modifying the columns of a data table.
 
-* [data_tables](docs/dataTables.md)  
-  Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.
-
 * [data_table_row](docs/dataTableRow.md)  
   Contains all the actions that can be performed against a single row inside of a [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting the contents of a row, or modifying a row.
 
 * [data_table_rows](docs/dataTableRows.md)  
   Contains all of the actions that can be performed against the collection of rows that make up a [Data Table](https://docs.losant.com/data-tables/overview/) - such as querying for rows in that table, or adding a new row to the table.
 
+* [data_tables](docs/dataTables.md)  
+  Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.
+
 * [device](docs/device.md)  
   Contains all the actions that can be performed against a single [Device](https://docs.losant.com/devices/overview/) - for instance, getting info on a single device or reporting the current state of a device.
 
-* [devices](docs/devices.md)  
-  Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.
-
 * [device_recipe](docs/deviceRecipe.md)  
   Contains all the actions that can be performed against a single [Device Recipe](https://docs.losant.com/devices/device-recipes/), which include things like removing a device recipe or creating a device from a device recipe.
 
 * [device_recipes](docs/deviceRecipes.md)  
   Contains all the actions that can be performed against the collection of [Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging to an Application - such as listing recipes or creating a new recipe.
 
+* [devices](docs/devices.md)  
+  Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.
+
+* [edge_deployment](docs/edgeDeployment.md)  
+  Contains all the actions that can be performed against a single [Edge Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.
+
 * [edge_deployments](docs/edgeDeployments.md)  
-  Contains all the actions that can be performed against the collection of [Edge Deployments](https://docs.losant.com/edge-compute/edge-deployments/) belonging to an Application - such as listing deployments or creating a new deployment.
+  Contains all the actions that can be performed against the collection of [Edge Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.
+
+* [embedded_deployment](docs/embeddedDeployment.md)  
+  Contains all the actions that can be performed against a single [Embedded Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.
+
+* [embedded_deployments](docs/embeddedDeployments.md)  
+  Contains all the actions that can be performed against the collection of [Embedded Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.
 
 * [event](docs/event.md)  
   Contains all the actions that can be performed against a single [Event](https://docs.losant.com/events/overview/), such as commenting on or changing the state of an event.
@@ -209,8 +254,65 @@ Each of the following is a method on the client object, and returns a wrapper fo
 * [flow_versions](docs/flowVersions.md)  
   Contains all the actions that can be performed against the collection of [Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging to a Workflow - such as listing the versions or creating a new version.
 
-* [me](docs/me.md)  
-  Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.
+* [instance](docs/instance.md)  
+  Contains all the actions that can be performed against a single [Instance](https://docs.losant.com/instance-manager/overview/), which include things such as updating report configuration or defaults.
+
+* [instance_api_token](docs/instanceApiToken.md)  
+  Contains all the actions that can be performed against a single [Instance API Token](https://docs.losant.com/instance-manager/instance-tokens/) - for instance, getting info on a single token or revoking a token.
+
+* [instance_api_tokens](docs/instanceApiTokens.md)  
+  Contains all the actions that can be performed against the collection of [Instance API Tokens](https://docs.losant.com/instance-manager/instance-tokens/) belonging to an Instance - such as listing tokens or creating a new token.
+
+* [instance_audit_log](docs/instanceAuditLog.md)  
+  Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as viewing a log.
+
+* [instance_audit_logs](docs/instanceAuditLogs.md)  
+  Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as listing the logs.
+
+* [instance_custom_node](docs/instanceCustomNode.md)  
+  Contains all the actions that can be performed against a single [Instance Custom Node](https://docs.losant.com/instance-manager/instance-custom-nodes/) - for instance, getting info on a single custom node or modifying a custom node.
+
+* [instance_custom_nodes](docs/instanceCustomNodes.md)  
+  Contains all the actions that can be performed against the collection of [Instance Custom Nodes](https://docs.losant.com/instance-manager/instance-custom-nodes/) belonging to an Instance - such as listing custom nodes or creating a new custom node.
+
+* [instance_member](docs/instanceMember.md)  
+  Contains all the actions that can be performed against a single [Instance Member](https://docs.losant.com/instance-manager/overview/#managing-membership), which include things such as updating the role or removing the member.
+
+* [instance_members](docs/instanceMembers.md)  
+  Contains all the actions that can be performed against the collection of [Instance Members](https://docs.losant.com/instance-manager/overview/#managing-membership) belonging to an Instance - such as listing members or adding a new member.
+
+* [instance_notification_rule](docs/instanceNotificationRule.md)  
+  Contains all the actions that can be performed against a single [Instance Notification Rule](https://docs.losant.com/instance-manager/overview/#notifications), which include things such as updating the threshold or the targets.
+
+* [instance_notification_rules](docs/instanceNotificationRules.md)  
+  Contains all the actions that can be performed against the collection of [Instance Notification Rules](https://docs.losant.com/instance-manager/overview/#notifications) belonging to an Instance - such as listing rules or adding a new rule.
+
+* [instance_org_invite](docs/instanceOrgInvite.md)  
+  Contains all the actions that can be performed against a single [Instance Organization Invite](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations), which include things such as revoking the invite.
+
+* [instance_org_invites](docs/instanceOrgInvites.md)  
+  Contains all the actions that can be performed against the collection of [Instance Organization Invites](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations) belonging to an Organization in an Instance - such as listing invites or sending a new invitation.
+
+* [instance_org_member](docs/instanceOrgMember.md)  
+  Contains all the actions that can be performed against a single [Instance Organization Member](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership), which include things such as changing the role or removing the membership.
+
+* [instance_org_members](docs/instanceOrgMembers.md)  
+  Contains all the actions that can be performed against the collection of [Instance Organization Members](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership) belonging to an Organization in an Instance - such as listing members or adding new members.
+
+* [instance_org](docs/instanceOrganization.md)  
+  Contains all the actions that can be performed against a single [Instance Organization](https://docs.losant.com/instance-manager/managing-organizations/), which include things such as modifying limits.
+
+* [instance_orgs](docs/instanceOrgs.md)  
+  Contains all the actions that can be performed against the collection of [Instance Organizations](https://docs.losant.com/instance-manager/managing-organizations/) belonging to an Instance - such as listing organizations or adding a new organization.
+
+* [instance_sandbox](docs/instanceSandbox.md)  
+  Contains all the actions that can be performed against a single [Instance Sandbox](https://docs.losant.com/instance-manager/managing-sandbox-users/) - for instance, getting info on a single sandbox or deleting the sandbox.
+
+* [instance_sandboxes](docs/instanceSandboxes.md)  
+  Contains all the actions that can be performed against the collection of [Instance Sandboxes](https://docs.losant.com/instance-manager/managing-sandbox-users/) belonging to an Instance - such as listing sandboxes.
+
+* [instances](docs/instances.md)  
+  Contains all the actions that can be performed against the collection of [Instances](https://docs.losant.com/instance-manager/overview/) that the currently authenticated user has access to - such as listing instances.
 
 * [integration](docs/integration.md)  
   Contains all the actions that can be performed against a single [Integration](https://docs.losant.com/applications/integrations/), which include things like removing an integration or updating integration configuration.
@@ -218,12 +320,36 @@ Each of the following is a method on the client object, and returns a wrapper fo
 * [integrations](docs/integrations.md)  
   Contains all the actions that can be performed against the collection of [Integrations](https://docs.losant.com/applications/integrations/) belonging to an Application - such as listing integrations or creating a new integration.
 
+* [me](docs/me.md)  
+  Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.
+
+* [notebook](docs/notebook.md)  
+  Contains all the actions that can be performed against a single [Notebook](https://docs.losant.com/notebooks/overview/), which include things like removing a notebook or executing a notebook.
+
+* [notebooks](docs/notebooks.md)  
+  Contains all the actions that can be performed against the collection of [Notebooks](https://docs.losant.com/notebooks/overview/) belonging to an Application - such as listing notebooks or creating a new notebook.
+
+* [org_invites](docs/orgInvites.md)  
+  Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.
+
 * [org](docs/org.md)  
   Contains all the actions that can be performed against a single [Organization](https://docs.losant.com/organizations/overview/), things like inviting a user to the organization, or modifying the organization.
 
 * [orgs](docs/orgs.md)  
   Contains all of the actions that can be performed against the set of [Organizations](https://docs.losant.com/organizations/overview/) that the currently authenticated user has access to - such as listing the organizations or creating a new organization.
 
+* [resource_job](docs/resourceJob.md)  
+  Contains all the actions that can be performed against a single [Resource Job](https://docs.losant.com/applications/resource-jobs/), such as executing the job.
+
+* [resource_jobs](docs/resourceJobs.md)  
+  Contains all the actions that can be performed against the collection of [Resource Jobs](https://docs.losant.com/applications/resource-jobs/) belonging to an Application - such as listing resource jobs or creating a new resource job.
+
+* [user_api_token](docs/userApiToken.md)  
+  Contains all the actions that can be performed against a single [User API Token](https://docs.losant.com/user-accounts/user-tokens/), such as revoking the token.
+
+* [user_api_tokens](docs/userApiTokens.md)  
+  Contains all the actions that can be performed against the collection of [User API Tokens](https://docs.losant.com/user-accounts/user-tokens/) belonging to the currently authenticated user - such as listing tokens or creating a new token.
+
 * [webhook](docs/webhook.md)  
   Contains all the actions that can be performed against a single [Webhook](https://docs.losant.com/applications/webhooks/), for instance modifying the verification settings or removing the webhook.