losant_rest 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1002 -0
  3. data/docs/auth.md +32 -0
  4. data/docs/solution.md +115 -0
  5. data/docs/solutionUser.md +121 -0
  6. data/docs/solutionUsers.md +84 -0
  7. data/docs/solutions.md +79 -0
  8. data/lib/losant_rest/auth.rb +39 -0
  9. data/lib/losant_rest/client.rb +18 -2
  10. data/lib/losant_rest/solution.rb +134 -0
  11. data/lib/losant_rest/solution_user.rb +140 -0
  12. data/lib/losant_rest/solution_users.rb +104 -0
  13. data/lib/losant_rest/solutions.rb +100 -0
  14. data/lib/losant_rest/version.rb +1 -1
  15. data/lib/losant_rest.rb +4 -0
  16. data/schemas/authedSolutionUser.json +18 -0
  17. data/schemas/org.json +3 -0
  18. data/schemas/orgs.json +3 -0
  19. data/schemas/solution.json +74 -0
  20. data/schemas/solutionPatch.json +48 -0
  21. data/schemas/solutionPost.json +52 -0
  22. data/schemas/solutionUser.json +94 -0
  23. data/schemas/solutionUserCredentials.json +30 -0
  24. data/schemas/solutionUserPatch.json +64 -0
  25. data/schemas/solutionUserPost.json +70 -0
  26. data/schemas/solutionUsers.json +140 -0
  27. data/schemas/solutions.json +116 -0
  28. metadata +20 -2
data/docs/auth.md CHANGED
@@ -7,6 +7,7 @@ parameters and the potential responses.
7
7
  ##### Contents
8
8
 
9
9
  * [Authenticate Device](#authenticate-device)
10
+ * [Authenticate Solution User](#authenticate-solution-user)
10
11
  * [Authenticate User](#authenticate-user)
11
12
  * [Authenticate User Github](#authenticate-user-github)
12
13
 
@@ -43,6 +44,37 @@ puts result
43
44
 
44
45
  <br/>
45
46
 
47
+ ## Authenticate Solution User
48
+
49
+ Authenticates a solution user using the provided credentials
50
+
51
+ ```ruby
52
+ result = client.auth.authenticate_solution_user(credentials: my_credentials)
53
+
54
+ puts result
55
+ ```
56
+
57
+ #### Available Parameters
58
+
59
+ | Name | Type | Required | Description | Default | Example |
60
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
61
+ | credentials | [User Credentials](_schemas.md#user-credentials) | Y | Solution user authentication credentials | | [User Credentials Example](_schemas.md#user-credentials-example) |
62
+
63
+ #### Successful Responses
64
+
65
+ | Code | Type | Description |
66
+ | ---- | ---- | ----------- |
67
+ | 200 | [Authenticated Solution User](_schemas.md#authenticated-solution-user) | Successful authentication |
68
+
69
+ #### Error Responses
70
+
71
+ | Code | Type | Description |
72
+ | ---- | ---- | ----------- |
73
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
74
+ | 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
75
+
76
+ <br/>
77
+
46
78
  ## Authenticate User
47
79
 
48
80
  Authenticates a user using the provided credentials
data/docs/solution.md ADDED
@@ -0,0 +1,115 @@
1
+ # Solution Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Solution resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Delete](#delete)
10
+ * [Get](#get)
11
+ * [Patch](#patch)
12
+
13
+ <br/>
14
+
15
+ ## Delete
16
+
17
+ Deletes a solution
18
+
19
+ ```ruby
20
+ result = client.solution.delete(
21
+ orgId: my_org_id,
22
+ solutionId: my_solution_id)
23
+
24
+ puts result
25
+ ```
26
+
27
+ #### Available Parameters
28
+
29
+ | Name | Type | Required | Description | Default | Example |
30
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
31
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
32
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
33
+
34
+ #### Successful Responses
35
+
36
+ | Code | Type | Description |
37
+ | ---- | ---- | ----------- |
38
+ | 200 | [Success](_schemas.md#success) | If solution was successfully deleted |
39
+
40
+ #### Error Responses
41
+
42
+ | Code | Type | Description |
43
+ | ---- | ---- | ----------- |
44
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
45
+ | 404 | [Error](_schemas.md#error) | Error if solution was not found |
46
+
47
+ <br/>
48
+
49
+ ## Get
50
+
51
+ Retrieves information on a solution
52
+
53
+ ```ruby
54
+ result = client.solution.get(
55
+ orgId: my_org_id,
56
+ solutionId: my_solution_id)
57
+
58
+ puts result
59
+ ```
60
+
61
+ #### Available Parameters
62
+
63
+ | Name | Type | Required | Description | Default | Example |
64
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
65
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
66
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
67
+
68
+ #### Successful Responses
69
+
70
+ | Code | Type | Description |
71
+ | ---- | ---- | ----------- |
72
+ | 200 | [Solution](_schemas.md#solution) | Solution information |
73
+
74
+ #### Error Responses
75
+
76
+ | Code | Type | Description |
77
+ | ---- | ---- | ----------- |
78
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
79
+ | 404 | [Error](_schemas.md#error) | Error if solution was not found |
80
+
81
+ <br/>
82
+
83
+ ## Patch
84
+
85
+ Updates information about a solution
86
+
87
+ ```ruby
88
+ result = client.solution.patch(
89
+ orgId: my_org_id,
90
+ solutionId: my_solution_id,
91
+ solution: my_solution)
92
+
93
+ puts result
94
+ ```
95
+
96
+ #### Available Parameters
97
+
98
+ | Name | Type | Required | Description | Default | Example |
99
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
100
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
101
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
102
+ | solution | [Solution Patch](_schemas.md#solution-patch) | Y | Object containing new properties of the solution | | [Solution Patch Example](_schemas.md#solution-patch-example) |
103
+
104
+ #### Successful Responses
105
+
106
+ | Code | Type | Description |
107
+ | ---- | ---- | ----------- |
108
+ | 200 | [Solution](_schemas.md#solution) | Updated solution information |
109
+
110
+ #### Error Responses
111
+
112
+ | Code | Type | Description |
113
+ | ---- | ---- | ----------- |
114
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
115
+ | 404 | [Error](_schemas.md#error) | Error if solution was not found |
data/docs/solutionUser.md ADDED
@@ -0,0 +1,121 @@
1
+ # Solution User Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Solution User resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Delete](#delete)
10
+ * [Get](#get)
11
+ * [Patch](#patch)
12
+
13
+ <br/>
14
+
15
+ ## Delete
16
+
17
+ Deletes a solution user
18
+
19
+ ```ruby
20
+ result = client.solution_user.delete(
21
+ orgId: my_org_id,
22
+ solutionId: my_solution_id,
23
+ solutionUserId: my_solution_user_id)
24
+
25
+ puts result
26
+ ```
27
+
28
+ #### Available Parameters
29
+
30
+ | Name | Type | Required | Description | Default | Example |
31
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
32
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
33
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
34
+ | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
35
+
36
+ #### Successful Responses
37
+
38
+ | Code | Type | Description |
39
+ | ---- | ---- | ----------- |
40
+ | 200 | [Success](_schemas.md#success) | If solution user was successfully deleted |
41
+
42
+ #### Error Responses
43
+
44
+ | Code | Type | Description |
45
+ | ---- | ---- | ----------- |
46
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
47
+ | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
48
+
49
+ <br/>
50
+
51
+ ## Get
52
+
53
+ Retrieves information on a solution user
54
+
55
+ ```ruby
56
+ result = client.solution_user.get(
57
+ orgId: my_org_id,
58
+ solutionId: my_solution_id,
59
+ solutionUserId: my_solution_user_id)
60
+
61
+ puts result
62
+ ```
63
+
64
+ #### Available Parameters
65
+
66
+ | Name | Type | Required | Description | Default | Example |
67
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
68
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
69
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
70
+ | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
71
+
72
+ #### Successful Responses
73
+
74
+ | Code | Type | Description |
75
+ | ---- | ---- | ----------- |
76
+ | 200 | [Solution User](_schemas.md#solution-user) | Solution user information |
77
+
78
+ #### Error Responses
79
+
80
+ | Code | Type | Description |
81
+ | ---- | ---- | ----------- |
82
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
83
+ | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
84
+
85
+ <br/>
86
+
87
+ ## Patch
88
+
89
+ Updates information about a solution user
90
+
91
+ ```ruby
92
+ result = client.solution_user.patch(
93
+ orgId: my_org_id,
94
+ solutionId: my_solution_id,
95
+ solutionUserId: my_solution_user_id,
96
+ solutionUser: my_solution_user)
97
+
98
+ puts result
99
+ ```
100
+
101
+ #### Available Parameters
102
+
103
+ | Name | Type | Required | Description | Default | Example |
104
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
105
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
106
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
107
+ | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
108
+ | solutionUser | [Solution User Patch](_schemas.md#solution-user-patch) | Y | Object containing new properties of the solution user | | [Solution User Patch Example](_schemas.md#solution-user-patch-example) |
109
+
110
+ #### Successful Responses
111
+
112
+ | Code | Type | Description |
113
+ | ---- | ---- | ----------- |
114
+ | 200 | [Solution User](_schemas.md#solution-user) | Updated solution user information |
115
+
116
+ #### Error Responses
117
+
118
+ | Code | Type | Description |
119
+ | ---- | ---- | ----------- |
120
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
121
+ | 404 | [Error](_schemas.md#error) | Error if solution user was not found |
data/docs/solutionUsers.md ADDED
@@ -0,0 +1,84 @@
1
+ # Solution Users Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Solution Users resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Get](#get)
10
+ * [Post](#post)
11
+
12
+ <br/>
13
+
14
+ ## Get
15
+
16
+ Returns the users for the solution
17
+
18
+ ```ruby
19
+ result = client.solution_users.get(
20
+ orgId: my_org_id,
21
+ solutionId: my_solution_id)
22
+
23
+ puts result
24
+ ```
25
+
26
+ #### Available Parameters
27
+
28
+ | Name | Type | Required | Description | Default | Example |
29
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
30
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
31
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
32
+ | sortField | string | N | Field to sort the results by. Accepted values are: email, firstName, lastName, id, creationDate, lastLogin | email | email |
33
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
34
+ | page | string | N | Which page of results to return | 0 | 0 |
35
+ | perPage | string | N | How many items to return per page | 1000 | 10 |
36
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, firstName, lastName | | email |
37
+ | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | email*address |
38
+
39
+ #### Successful Responses
40
+
41
+ | Code | Type | Description |
42
+ | ---- | ---- | ----------- |
43
+ | 200 | [Solution Users](_schemas.md#solution-users) | Collection of solution users |
44
+
45
+ #### Error Responses
46
+
47
+ | Code | Type | Description |
48
+ | ---- | ---- | ----------- |
49
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
50
+
51
+ <br/>
52
+
53
+ ## Post
54
+
55
+ Create a new solution user
56
+
57
+ ```ruby
58
+ result = client.solution_users.post(
59
+ orgId: my_org_id,
60
+ solutionId: my_solution_id,
61
+ solutionUser: my_solution_user)
62
+
63
+ puts result
64
+ ```
65
+
66
+ #### Available Parameters
67
+
68
+ | Name | Type | Required | Description | Default | Example |
69
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
70
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
71
+ | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
72
+ | solutionUser | [Solution User Post](_schemas.md#solution-user-post) | Y | New solution user information | | [Solution User Post Example](_schemas.md#solution-user-post-example) |
73
+
74
+ #### Successful Responses
75
+
76
+ | Code | Type | Description |
77
+ | ---- | ---- | ----------- |
78
+ | 201 | [Solution User](_schemas.md#solution-user) | Successfully created solution user |
79
+
80
+ #### Error Responses
81
+
82
+ | Code | Type | Description |
83
+ | ---- | ---- | ----------- |
84
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
data/docs/solutions.md ADDED
@@ -0,0 +1,79 @@
1
+ # Solutions Actions
2
+
3
+ Details on the various actions that can be performed on the
4
+ Solutions resource, including the expected
5
+ parameters and the potential responses.
6
+
7
+ ##### Contents
8
+
9
+ * [Get](#get)
10
+ * [Post](#post)
11
+
12
+ <br/>
13
+
14
+ ## Get
15
+
16
+ Returns the solutions for the organization
17
+
18
+ ```ruby
19
+ result = client.solutions.get(orgId: my_org_id)
20
+
21
+ puts result
22
+ ```
23
+
24
+ #### Available Parameters
25
+
26
+ | Name | Type | Required | Description | Default | Example |
27
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
28
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
29
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate | name | name |
30
+ | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
31
+ | page | string | N | Which page of results to return | 0 | 0 |
32
+ | perPage | string | N | How many items to return per page | 1000 | 10 |
33
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
34
+ | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*solution |
35
+
36
+ #### Successful Responses
37
+
38
+ | Code | Type | Description |
39
+ | ---- | ---- | ----------- |
40
+ | 200 | [Solutions](_schemas.md#solutions) | Collection of solutions |
41
+
42
+ #### Error Responses
43
+
44
+ | Code | Type | Description |
45
+ | ---- | ---- | ----------- |
46
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |
47
+
48
+ <br/>
49
+
50
+ ## Post
51
+
52
+ Create a new solution
53
+
54
+ ```ruby
55
+ result = client.solutions.post(
56
+ orgId: my_org_id,
57
+ solution: my_solution)
58
+
59
+ puts result
60
+ ```
61
+
62
+ #### Available Parameters
63
+
64
+ | Name | Type | Required | Description | Default | Example |
65
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
66
+ | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
67
+ | solution | [Solution Post](_schemas.md#solution-post) | Y | New solution information | | [Solution Post Example](_schemas.md#solution-post-example) |
68
+
69
+ #### Successful Responses
70
+
71
+ | Code | Type | Description |
72
+ | ---- | ---- | ----------- |
73
+ | 201 | [Solution](_schemas.md#solution) | Successfully created solution |
74
+
75
+ #### Error Responses
76
+
77
+ | Code | Type | Description |
78
+ | ---- | ---- | ----------- |
79
+ | 400 | [Error](_schemas.md#error) | Error if malformed request |