losant_rest 1.0.0

data/docs/org.md

@@ -0,0 +1,279 @@
+# Org Actions
+
+Details on the various actions that can be performed on the
+Org resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Invite Member](#invite-member)
+*   [Modify Member](#modify-member)
+*   [Patch](#patch)
+*   [Pending Invites](#pending-invites)
+*   [Remove Member](#remove-member)
+*   [Revoke Invite](#revoke-invite)
+
+<br/>
+
+## Delete
+
+Deletes an organization
+
+```ruby
+result = client.org.delete(orgId: my_org_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If organization was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an organization
+
+```ruby
+result = client.org.get(orgId: my_org_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization](_schemas.md#organization) | Organization information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Invite Member
+
+Invites a person to an organization
+
+```ruby
+result = client.org.invite_member(
+  orgId: my_org_id,
+  invite: my_invite)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| invite | [Organization Invitation Post](_schemas.md#organization-invitation-post) | Y | Object containing new invite info |  | [Organization Invitation Post Example](_schemas.md#organization-invitation-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitations](_schemas.md#organization-invitations) | Invitation information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Modify Member
+
+Modifies a current org member&#x27;s role
+
+```ruby
+result = client.org.modify_member(
+  orgId: my_org_id,
+  member: my_member)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| member | [Organization Member Patch](_schemas.md#organization-member-patch) | Y | Object containing new member pair |  | [Organization Member Patch Example](_schemas.md#organization-member-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization](_schemas.md#organization) | Updated organization information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Patch
+
+Updates information about an organization
+
+```ruby
+result = client.org.patch(
+  orgId: my_org_id,
+  organization: my_organization)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| organization | [Organization Patch](_schemas.md#organization-patch) | Y | Object containing new organization properties |  | [Organization Patch Example](_schemas.md#organization-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization](_schemas.md#organization) | Updated organization information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |
+
+<br/>
+
+## Pending Invites
+
+Gets the current pending invites
+
+```ruby
+result = client.org.pending_invites(orgId: my_org_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitations](_schemas.md#organization-invitations) | Invitation information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Remove Member
+
+Modifies a current org member&#x27;s role
+
+```ruby
+result = client.org.remove_member(
+  orgId: my_org_id,
+  userId: my_user_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| userId | string | Y | Id of user to remove |  | 575ed70c7ae143cd83dc4aa9 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization](_schemas.md#organization) | Updated organization information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Revoke Invite
+
+Revokes an existing invite
+
+```ruby
+result = client.org.revoke_invite(
+  orgId: my_org_id,
+  inviteId: my_invite_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| inviteId | string | Y | Id of invite to revoke |  | 575ed71e7ae143cd83dc4aaa |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitations](_schemas.md#organization-invitations) | Invitation information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization not found |

data/docs/orgs.md

@@ -0,0 +1,75 @@
+# Orgs Actions
+
+Details on the various actions that can be performed on the
+Orgs resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the organizations associated with the current user
+
+```ruby
+result = client.orgs.get(optional_params)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 1000 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*org |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organizations](_schemas.md#organizations) | Collection of organizations |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new organization
+
+```ruby
+result = client.orgs.post(organization: my_organization)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| organization | [Organization Post](_schemas.md#organization-post) | Y | New organization information |  | [Organization Post Example](_schemas.md#organization-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Organization](_schemas.md#organization) | Successfully created organization |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/webhook.md

@@ -0,0 +1,115 @@
+# Webhook Actions
+
+Details on the various actions that can be performed on the
+Webhook resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes a webhook
+
+```ruby
+result = client.webhook.delete(
+  applicationId: my_application_id,
+  webhookId: my_webhook_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| webhookId | string | Y | ID associated with the webhook |  | 575ed78e7ae143cd83dc4aab |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If webhook was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if webhook was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on a webhook
+
+```ruby
+result = client.webhook.get(
+  applicationId: my_application_id,
+  webhookId: my_webhook_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| webhookId | string | Y | ID associated with the webhook |  | 575ed78e7ae143cd83dc4aab |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Webhook](_schemas.md#webhook) | Webhook information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if webhook was not found |
+
+<br/>
+
+## Patch
+
+Updates information about a webhook
+
+```ruby
+result = client.webhook.patch(
+  applicationId: my_application_id,
+  webhookId: my_webhook_id,
+  webhook: my_webhook)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| webhookId | string | Y | ID associated with the webhook |  | 575ed78e7ae143cd83dc4aab |
+| webhook | [Webhook Patch](_schemas.md#webhook-patch) | Y | Object containing new properties of the webhook |  | [Webhook Patch Example](_schemas.md#webhook-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Webhook](_schemas.md#webhook) | Updated webhook information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if webhook was not found |

data/docs/webhooks.md

@@ -0,0 +1,81 @@
+# Webhooks Actions
+
+Details on the various actions that can be performed on the
+Webhooks resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the webhooks for an application
+
+```ruby
+result = client.webhooks.get(applicationId: my_application_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 1000 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*webhook |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Webhooks](_schemas.md#webhooks) | Collection of webhooks |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Post
+
+Create a new webhook for an application
+
+```ruby
+result = client.webhooks.post(
+  applicationId: my_application_id,
+  webhook: my_webhook)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| webhook | [Webhook Post](_schemas.md#webhook-post) | Y | New webhook information |  | [Webhook Post Example](_schemas.md#webhook-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Webhook](_schemas.md#webhook) | Successfully created webhook |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |

data/examples/auth.rb

@@ -0,0 +1,32 @@
+require "losant_rest"
+
+client = LosantRest::Client.new
+
+user_response = client.auth.authenticate_user(credentials: {
+  email: "example@losant.com",
+  password: "your_password"
+})
+
+puts user_response
+# Example user result
+# {
+#   "token"  => "an auth token string",
+#   "userId" => "theUserId"
+# }
+
+
+device_response = client.auth.authenticate_device(credentials: {
+  deviceId: "myDeviceId",
+  key: "my_app_access_key",
+  secret: "my_app_access_secret"
+})
+
+puts device_response
+# Example device result
+# {
+#   "applicationId" => "myAppId",
+#   "token"         => "an auth token string",
+#   "restricted"    => false,
+#   "deviceId"      => "myDeviceId",
+#   "deviceClass"   => "standalone"
+# }

data/examples/list_devices.rb

@@ -0,0 +1,45 @@
+require "losant_rest"
+
+client = LosantRest::Client.new(auth_token: "my_token")
+result = client.devices.get(applicationId: "myAppId")
+
+puts result
+# Example result
+# {
+#   "count" => 1,
+#   "items" => [ {
+#     "deviceClass" => "standalone",
+#     "connectionInfo" => { "connected" => 0, "time" => "2016-06-01T17:16:02.324Z" },
+#     "name" => "Ruby Client Testing",
+#     "creationDate" => "2016-01-31T17:58:57.541Z",
+#     "lastUpdated" => "2016-05-31T14:47:32.288Z",
+#     "id" => "myDevId",
+#     "attributes" => [
+#       { "name" => "string", "dataType" => "string" },
+#       { "name" => "number", "dataType" => "number" },
+#       { "name" => "boolean", "dataType" => "boolean" }
+#     ],
+#     "description" => "",
+#     "_etag" => "\"174-u7/3je4oFyaKGePPbcHLqw\"",
+#     "deviceId" => "myDevId",
+#     "tags" => [],
+#     "applicationId" => "myAppId",
+#     "_type" => "device",
+#     "_links" => {
+#       "application" => { "href" => "/applications/myAppId" },
+#       "devices" => { "href" => "/applications/myAppId/devices" },
+#       "self" => { "href" => "/applications/myAppId/devices/myDevId" }
+#      }
+#   } ],
+#   "applicationId" => "myAppId",
+#   "perPage" => 100,
+#   "page" => 0,
+#   "sortField" => "name",
+#   "sortDirection" => "asc",
+#   "totalCount" => 1,
+#   "_type" => "devices",
+#   "_links" => {
+#     "application" => { "href" => "/applications/myAppId" },
+#     "self" => { "href" => "/applications/myAppId/devices" }
+#   }
+# }