losant_rest 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2454 -666
  3. data/docs/application.md +21 -21
  4. data/docs/applicationApiToken.md +1 -1
  5. data/docs/applicationApiTokens.md +1 -1
  6. data/docs/applicationCertificate.md +3 -3
  7. data/docs/applicationCertificateAuthorities.md +2 -2
  8. data/docs/applicationCertificateAuthority.md +3 -3
  9. data/docs/applicationCertificates.md +2 -2
  10. data/docs/applicationDashboard.md +4 -4
  11. data/docs/applicationDashboards.md +2 -2
  12. data/docs/applicationJobLog.md +1 -1
  13. data/docs/applicationJobLogs.md +1 -1
  14. data/docs/applicationKey.md +3 -3
  15. data/docs/applicationKeys.md +2 -2
  16. data/docs/applicationTemplate.md +1 -1
  17. data/docs/applicationTemplates.md +3 -3
  18. data/docs/applications.md +4 -4
  19. data/docs/auditLog.md +1 -1
  20. data/docs/auditLogs.md +1 -1
  21. data/docs/credential.md +4 -4
  22. data/docs/credentials.md +2 -2
  23. data/docs/dashboard.md +3 -3
  24. data/docs/dashboards.md +2 -2
  25. data/docs/data.md +3 -3
  26. data/docs/dataTable.md +5 -5
  27. data/docs/dataTableRow.md +3 -3
  28. data/docs/dataTableRows.md +6 -6
  29. data/docs/dataTables.md +2 -2
  30. data/docs/device.md +14 -14
  31. data/docs/deviceAttribute.md +3 -3
  32. data/docs/deviceAttributes.md +2 -2
  33. data/docs/deviceRecipe.md +4 -4
  34. data/docs/deviceRecipes.md +2 -2
  35. data/docs/devices.md +14 -14
  36. data/docs/edgeDeployment.md +1 -1
  37. data/docs/edgeDeployments.md +4 -4
  38. data/docs/embeddedDeployment.md +1 -1
  39. data/docs/embeddedDeployments.md +5 -5
  40. data/docs/event.md +3 -3
  41. data/docs/events.md +6 -6
  42. data/docs/experience.md +2 -2
  43. data/docs/experienceDomain.md +3 -3
  44. data/docs/experienceDomains.md +2 -2
  45. data/docs/experienceEndpoint.md +4 -4
  46. data/docs/experienceEndpoints.md +3 -3
  47. data/docs/experienceGroup.md +3 -3
  48. data/docs/experienceGroups.md +2 -2
  49. data/docs/experienceSlug.md +3 -3
  50. data/docs/experienceSlugs.md +2 -2
  51. data/docs/experienceUser.md +3 -3
  52. data/docs/experienceUsers.md +2 -2
  53. data/docs/experienceVersion.md +3 -3
  54. data/docs/experienceVersions.md +2 -2
  55. data/docs/experienceView.md +4 -4
  56. data/docs/experienceViews.md +2 -2
  57. data/docs/file.md +5 -5
  58. data/docs/files.md +2 -2
  59. data/docs/flow.md +11 -11
  60. data/docs/flowVersion.md +6 -6
  61. data/docs/flowVersions.md +3 -3
  62. data/docs/flows.md +5 -5
  63. data/docs/instance.md +8 -8
  64. data/docs/instanceApiToken.md +1 -1
  65. data/docs/instanceApiTokens.md +1 -1
  66. data/docs/instanceAuditLog.md +1 -1
  67. data/docs/instanceAuditLogs.md +1 -1
  68. data/docs/instanceCustomNode.md +5 -5
  69. data/docs/instanceCustomNodes.md +2 -2
  70. data/docs/instanceMember.md +1 -1
  71. data/docs/instanceMembers.md +1 -1
  72. data/docs/instanceNotificationRule.md +5 -5
  73. data/docs/instanceNotificationRules.md +2 -2
  74. data/docs/instanceOrg.md +7 -7
  75. data/docs/instanceOrgInvite.md +1 -1
  76. data/docs/instanceOrgInvites.md +1 -1
  77. data/docs/instanceOrgMember.md +1 -1
  78. data/docs/instanceOrgMembers.md +1 -1
  79. data/docs/instanceOrgs.md +2 -2
  80. data/docs/instanceSandbox.md +7 -7
  81. data/docs/instanceSandboxes.md +1 -1
  82. data/docs/instances.md +1 -1
  83. data/docs/integration.md +3 -3
  84. data/docs/integrations.md +2 -2
  85. data/docs/me.md +20 -20
  86. data/docs/notebook.md +9 -9
  87. data/docs/notebooks.md +2 -2
  88. data/docs/org.md +13 -13
  89. data/docs/orgs.md +2 -2
  90. data/docs/privateFile.md +5 -5
  91. data/docs/privateFiles.md +2 -2
  92. data/docs/resourceJob.md +6 -6
  93. data/docs/resourceJobs.md +2 -2
  94. data/docs/userApiToken.md +3 -3
  95. data/docs/userApiTokens.md +2 -2
  96. data/docs/userOauthToken.md +125 -0
  97. data/docs/userOauthTokens.md +87 -0
  98. data/docs/webhook.md +3 -3
  99. data/docs/webhooks.md +2 -2
  100. data/lib/platform_rest/application.rb +20 -20
  101. data/lib/platform_rest/application_api_token.rb +1 -1
  102. data/lib/platform_rest/application_api_tokens.rb +1 -1
  103. data/lib/platform_rest/application_certificate.rb +3 -3
  104. data/lib/platform_rest/application_certificate_authorities.rb +2 -2
  105. data/lib/platform_rest/application_certificate_authority.rb +3 -3
  106. data/lib/platform_rest/application_certificates.rb +2 -2
  107. data/lib/platform_rest/application_dashboard.rb +4 -4
  108. data/lib/platform_rest/application_dashboards.rb +2 -2
  109. data/lib/platform_rest/application_job_log.rb +1 -1
  110. data/lib/platform_rest/application_job_logs.rb +1 -1
  111. data/lib/platform_rest/application_key.rb +3 -3
  112. data/lib/platform_rest/application_keys.rb +2 -2
  113. data/lib/platform_rest/application_template.rb +1 -1
  114. data/lib/platform_rest/application_templates.rb +3 -3
  115. data/lib/platform_rest/applications.rb +3 -3
  116. data/lib/platform_rest/audit_log.rb +1 -1
  117. data/lib/platform_rest/audit_logs.rb +1 -1
  118. data/lib/platform_rest/client.rb +10 -2
  119. data/lib/platform_rest/credential.rb +4 -4
  120. data/lib/platform_rest/credentials.rb +2 -2
  121. data/lib/platform_rest/dashboard.rb +3 -3
  122. data/lib/platform_rest/dashboards.rb +2 -2
  123. data/lib/platform_rest/data.rb +3 -3
  124. data/lib/platform_rest/data_table.rb +5 -5
  125. data/lib/platform_rest/data_table_row.rb +3 -3
  126. data/lib/platform_rest/data_table_rows.rb +6 -6
  127. data/lib/platform_rest/data_tables.rb +2 -2
  128. data/lib/platform_rest/device.rb +14 -14
  129. data/lib/platform_rest/device_attribute.rb +3 -3
  130. data/lib/platform_rest/device_attributes.rb +2 -2
  131. data/lib/platform_rest/device_recipe.rb +4 -4
  132. data/lib/platform_rest/device_recipes.rb +2 -2
  133. data/lib/platform_rest/devices.rb +14 -14
  134. data/lib/platform_rest/edge_deployment.rb +1 -1
  135. data/lib/platform_rest/edge_deployments.rb +4 -4
  136. data/lib/platform_rest/embedded_deployment.rb +1 -1
  137. data/lib/platform_rest/embedded_deployments.rb +5 -5
  138. data/lib/platform_rest/event.rb +3 -3
  139. data/lib/platform_rest/events.rb +6 -6
  140. data/lib/platform_rest/experience.rb +2 -2
  141. data/lib/platform_rest/experience_domain.rb +3 -3
  142. data/lib/platform_rest/experience_domains.rb +2 -2
  143. data/lib/platform_rest/experience_endpoint.rb +4 -4
  144. data/lib/platform_rest/experience_endpoints.rb +3 -3
  145. data/lib/platform_rest/experience_group.rb +3 -3
  146. data/lib/platform_rest/experience_groups.rb +2 -2
  147. data/lib/platform_rest/experience_slug.rb +3 -3
  148. data/lib/platform_rest/experience_slugs.rb +2 -2
  149. data/lib/platform_rest/experience_user.rb +3 -3
  150. data/lib/platform_rest/experience_users.rb +2 -2
  151. data/lib/platform_rest/experience_version.rb +3 -3
  152. data/lib/platform_rest/experience_versions.rb +2 -2
  153. data/lib/platform_rest/experience_view.rb +4 -4
  154. data/lib/platform_rest/experience_views.rb +2 -2
  155. data/lib/platform_rest/file.rb +4 -4
  156. data/lib/platform_rest/files.rb +2 -2
  157. data/lib/platform_rest/flow.rb +11 -11
  158. data/lib/platform_rest/flow_version.rb +6 -6
  159. data/lib/platform_rest/flow_versions.rb +3 -3
  160. data/lib/platform_rest/flows.rb +5 -5
  161. data/lib/platform_rest/instance.rb +8 -8
  162. data/lib/platform_rest/instance_api_token.rb +1 -1
  163. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  164. data/lib/platform_rest/instance_audit_log.rb +1 -1
  165. data/lib/platform_rest/instance_audit_logs.rb +1 -1
  166. data/lib/platform_rest/instance_custom_node.rb +5 -5
  167. data/lib/platform_rest/instance_custom_nodes.rb +2 -2
  168. data/lib/platform_rest/instance_member.rb +1 -1
  169. data/lib/platform_rest/instance_members.rb +1 -1
  170. data/lib/platform_rest/instance_notification_rule.rb +5 -5
  171. data/lib/platform_rest/instance_notification_rules.rb +2 -2
  172. data/lib/platform_rest/instance_org.rb +7 -7
  173. data/lib/platform_rest/instance_org_invite.rb +1 -1
  174. data/lib/platform_rest/instance_org_invites.rb +1 -1
  175. data/lib/platform_rest/instance_org_member.rb +1 -1
  176. data/lib/platform_rest/instance_org_members.rb +1 -1
  177. data/lib/platform_rest/instance_orgs.rb +2 -2
  178. data/lib/platform_rest/instance_sandbox.rb +7 -7
  179. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  180. data/lib/platform_rest/instances.rb +1 -1
  181. data/lib/platform_rest/integration.rb +3 -3
  182. data/lib/platform_rest/integrations.rb +2 -2
  183. data/lib/platform_rest/me.rb +20 -20
  184. data/lib/platform_rest/notebook.rb +8 -8
  185. data/lib/platform_rest/notebooks.rb +2 -2
  186. data/lib/platform_rest/org.rb +13 -13
  187. data/lib/platform_rest/orgs.rb +2 -2
  188. data/lib/platform_rest/private_file.rb +4 -4
  189. data/lib/platform_rest/private_files.rb +2 -2
  190. data/lib/platform_rest/resource_job.rb +6 -6
  191. data/lib/platform_rest/resource_jobs.rb +2 -2
  192. data/lib/platform_rest/user_api_token.rb +3 -3
  193. data/lib/platform_rest/user_api_tokens.rb +2 -2
  194. data/lib/platform_rest/user_oauth_token.rb +170 -0
  195. data/lib/platform_rest/user_oauth_tokens.rb +132 -0
  196. data/lib/platform_rest/version.rb +1 -1
  197. data/lib/platform_rest/webhook.rb +3 -3
  198. data/lib/platform_rest/webhooks.rb +2 -2
  199. data/lib/platform_rest.rb +2 -0
  200. data/schemas/apiToken.json +100 -0
  201. data/schemas/apiTokenPatch.json +100 -0
  202. data/schemas/apiTokenPost.json +118 -0
  203. data/schemas/apiTokens.json +100 -0
  204. data/schemas/applicationDashboardPost.json +4 -0
  205. data/schemas/dashboard.json +4 -0
  206. data/schemas/dashboardPatch.json +4 -0
  207. data/schemas/dashboardPost.json +4 -0
  208. data/schemas/dashboards.json +4 -0
  209. data/schemas/githubLogin.json +18 -0
  210. data/schemas/instanceOrgMemberPatch.json +2 -2
  211. data/schemas/instanceOrgMemberPost.json +4 -4
  212. data/schemas/instanceOrgPost.json +4 -4
  213. data/schemas/oauthClient.json +107 -0
  214. data/schemas/oauthClientPost.json +89 -0
  215. data/schemas/oauthDcrError.json +23 -0
  216. data/schemas/oauthError.json +31 -0
  217. data/schemas/org.json +2 -2
  218. data/schemas/orgInvite.json +2 -2
  219. data/schemas/orgInviteCollection.json +2 -2
  220. data/schemas/orgInvitePost.json +2 -2
  221. data/schemas/orgInvites.json +2 -2
  222. data/schemas/orgMemberPatch.json +2 -2
  223. data/schemas/orgRoleInfo.json +2 -2
  224. data/schemas/orgs.json +2 -2
  225. data/schemas/samlResponse.json +18 -0
  226. data/schemas/userCredentials.json +18 -0
  227. data/schemas/userOauthToken.json +207 -0
  228. data/schemas/userOauthTokenPatch.json +123 -0
  229. data/schemas/userOauthTokenPost.json +197 -0
  230. data/schemas/userOauthTokens.json +248 -0
  231. data/schemas/userPost.json +18 -0
  232. metadata +13 -1
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.delete.
40
+ # all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.delete.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -83,7 +83,7 @@ module PlatformRest
83
83
  # The client must be configured with a valid api
84
84
  # access token to call this action. The token
85
85
  # must include at least one of the following scopes:
86
- # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, privateFile.*, or privateFile.get.
86
+ # all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, privateFile.*, or privateFile.get.
87
87
  #
88
88
  # Parameters:
89
89
  # * {string} applicationId - ID associated with the application
@@ -131,7 +131,7 @@ module PlatformRest
131
131
  # The client must be configured with a valid api
132
132
  # access token to call this action. The token
133
133
  # must include at least one of the following scopes:
134
- # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.move.
134
+ # all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.move.
135
135
  #
136
136
  # Parameters:
137
137
  # * {string} applicationId - ID associated with the application
@@ -183,7 +183,7 @@ module PlatformRest
183
183
  # The client must be configured with a valid api
184
184
  # access token to call this action. The token
185
185
  # must include at least one of the following scopes:
186
- # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.patch.
186
+ # all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFile.*, or privateFile.patch.
187
187
  #
188
188
  # Parameters:
189
189
  # * {string} applicationId - ID associated with the application
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, privateFiles.*, or privateFiles.get.
40
+ # all.Application, all.Application.bounded, all.Application.cli, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.cli, all.User.read, privateFiles.*, or privateFiles.get.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -101,7 +101,7 @@ module PlatformRest
101
101
  # The client must be configured with a valid api
102
102
  # access token to call this action. The token
103
103
  # must include at least one of the following scopes:
104
- # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFiles.*, or privateFiles.post.
104
+ # all.Application, all.Application.bounded, all.Application.cli, all.Organization, all.Organization.bounded, all.User, all.User.bounded, all.User.cli, privateFiles.*, or privateFiles.post.
105
105
  #
106
106
  # Parameters:
107
107
  # * {string} applicationId - ID associated with the application
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.cancelExecution.
40
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.cancelExecution.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -86,7 +86,7 @@ module PlatformRest
86
86
  # The client must be configured with a valid api
87
87
  # access token to call this action. The token
88
88
  # must include at least one of the following scopes:
89
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.delete.
89
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.delete.
90
90
  #
91
91
  # Parameters:
92
92
  # * {string} applicationId - ID associated with the application
@@ -134,7 +134,7 @@ module PlatformRest
134
134
  # The client must be configured with a valid api
135
135
  # access token to call this action. The token
136
136
  # must include at least one of the following scopes:
137
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.execute.
137
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.execute.
138
138
  #
139
139
  # Parameters:
140
140
  # * {string} applicationId - ID associated with the application
@@ -183,7 +183,7 @@ module PlatformRest
183
183
  # The client must be configured with a valid api
184
184
  # access token to call this action. The token
185
185
  # must include at least one of the following scopes:
186
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.get.
186
+ # all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJob.*, or resourceJob.get.
187
187
  #
188
188
  # Parameters:
189
189
  # * {string} applicationId - ID associated with the application
@@ -229,7 +229,7 @@ module PlatformRest
229
229
  # The client must be configured with a valid api
230
230
  # access token to call this action. The token
231
231
  # must include at least one of the following scopes:
232
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJob.*, or resourceJob.logs.
232
+ # all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJob.*, or resourceJob.logs.
233
233
  #
234
234
  # Parameters:
235
235
  # * {string} applicationId - ID associated with the application
@@ -279,7 +279,7 @@ module PlatformRest
279
279
  # The client must be configured with a valid api
280
280
  # access token to call this action. The token
281
281
  # must include at least one of the following scopes:
282
- # all.Application, all.Organization, all.User, resourceJob.*, or resourceJob.patch.
282
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJob.*, or resourceJob.patch.
283
283
  #
284
284
  # Parameters:
285
285
  # * {string} applicationId - ID associated with the application
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, resourceJobs.*, or resourceJobs.get.
40
+ # all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, resourceJobs.*, or resourceJobs.get.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -93,7 +93,7 @@ module PlatformRest
93
93
  # The client must be configured with a valid api
94
94
  # access token to call this action. The token
95
95
  # must include at least one of the following scopes:
96
- # all.Application, all.Organization, all.User, resourceJobs.*, or resourceJobs.post.
96
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, resourceJobs.*, or resourceJobs.post.
97
97
  #
98
98
  # Parameters:
99
99
  # * {string} applicationId - ID associated with the application
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.User, userApiToken.*, or userApiToken.delete.
40
+ # all.User, only.User, userApiToken.*, or userApiToken.delete.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} apiTokenId - ID associated with the API token
@@ -81,7 +81,7 @@ module PlatformRest
81
81
  # The client must be configured with a valid api
82
82
  # access token to call this action. The token
83
83
  # must include at least one of the following scopes:
84
- # all.User, all.User.read, userApiToken.*, or userApiToken.get.
84
+ # all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userApiToken.*, or userApiToken.get.
85
85
  #
86
86
  # Parameters:
87
87
  # * {string} apiTokenId - ID associated with the API token
@@ -125,7 +125,7 @@ module PlatformRest
125
125
  # The client must be configured with a valid api
126
126
  # access token to call this action. The token
127
127
  # must include at least one of the following scopes:
128
- # all.User, userApiToken.*, or userApiToken.patch.
128
+ # all.User, only.User, userApiToken.*, or userApiToken.patch.
129
129
  #
130
130
  # Parameters:
131
131
  # * {string} apiTokenId - ID associated with the API token
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.User, all.User.read, userApiTokens.*, or userApiTokens.get.
40
+ # all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userApiTokens.*, or userApiTokens.get.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate
@@ -90,7 +90,7 @@ module PlatformRest
90
90
  # The client must be configured with a valid api
91
91
  # access token to call this action. The token
92
92
  # must include at least one of the following scopes:
93
- # all.User, userApiTokens.*, or userApiTokens.post.
93
+ # all.User, only.User, userApiTokens.*, or userApiTokens.post.
94
94
  #
95
95
  # Parameters:
96
96
  # * {hash} apiToken - API token information (https://api.losant.com/#/definitions/apiTokenPost)
@@ -0,0 +1,170 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2026 SUSE
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the User Oauth Token Resource
28
+ class UserOauthToken
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes an OAuth Token
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.User, only.User, userOauthToken.*, or userOauthToken.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} oauthTokenId - ID associated with the OAuth token
44
+ # * {string} losantdomain - Domain scope of request (rarely needed)
45
+ # * {boolean} _actions - Return resource actions in response
46
+ # * {boolean} _links - Return resource link in response
47
+ # * {boolean} _embedded - Return embedded resources in response
48
+ #
49
+ # Responses:
50
+ # * 200 - If OAuth token was successfully deleted (https://api.losant.com/#/definitions/success)
51
+ #
52
+ # Errors:
53
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
54
+ # * 404 - Error if OAuth token was not found (https://api.losant.com/#/definitions/error)
55
+ def delete(params = {})
56
+ params = Utils.symbolize_hash_keys(params)
57
+ query_params = { _actions: false, _links: true, _embedded: true }
58
+ headers = {}
59
+ body = nil
60
+
61
+ raise ArgumentError.new("oauthTokenId is required") unless params.has_key?(:oauthTokenId)
62
+
63
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
64
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
65
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
66
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
67
+
68
+ path = "/me/oauth-tokens/#{params[:oauthTokenId]}"
69
+
70
+ @client.request(
71
+ method: :delete,
72
+ path: path,
73
+ query: query_params,
74
+ headers: headers,
75
+ body: body)
76
+ end
77
+
78
+ # Retrieves information on an OAuth token
79
+ #
80
+ # Authentication:
81
+ # The client must be configured with a valid api
82
+ # access token to call this action. The token
83
+ # must include at least one of the following scopes:
84
+ # all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userOauthToken.*, or userOauthToken.get.
85
+ #
86
+ # Parameters:
87
+ # * {string} oauthTokenId - ID associated with the OAuth token
88
+ # * {string} losantdomain - Domain scope of request (rarely needed)
89
+ # * {boolean} _actions - Return resource actions in response
90
+ # * {boolean} _links - Return resource link in response
91
+ # * {boolean} _embedded - Return embedded resources in response
92
+ #
93
+ # Responses:
94
+ # * 200 - OAuth token information (https://api.losant.com/#/definitions/userOauthToken)
95
+ #
96
+ # Errors:
97
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
98
+ # * 404 - Error if OAuth token was not found (https://api.losant.com/#/definitions/error)
99
+ def get(params = {})
100
+ params = Utils.symbolize_hash_keys(params)
101
+ query_params = { _actions: false, _links: true, _embedded: true }
102
+ headers = {}
103
+ body = nil
104
+
105
+ raise ArgumentError.new("oauthTokenId is required") unless params.has_key?(:oauthTokenId)
106
+
107
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
108
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
109
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
110
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
111
+
112
+ path = "/me/oauth-tokens/#{params[:oauthTokenId]}"
113
+
114
+ @client.request(
115
+ method: :get,
116
+ path: path,
117
+ query: query_params,
118
+ headers: headers,
119
+ body: body)
120
+ end
121
+
122
+ # Updates information about an OAuth token
123
+ #
124
+ # Authentication:
125
+ # The client must be configured with a valid api
126
+ # access token to call this action. The token
127
+ # must include at least one of the following scopes:
128
+ # all.User, only.User, userOauthToken.*, or userOauthToken.patch.
129
+ #
130
+ # Parameters:
131
+ # * {string} oauthTokenId - ID associated with the OAuth token
132
+ # * {hash} oauthToken - Object containing new properties of the OAuth token (https://api.losant.com/#/definitions/userOauthTokenPatch)
133
+ # * {string} losantdomain - Domain scope of request (rarely needed)
134
+ # * {boolean} _actions - Return resource actions in response
135
+ # * {boolean} _links - Return resource link in response
136
+ # * {boolean} _embedded - Return embedded resources in response
137
+ #
138
+ # Responses:
139
+ # * 200 - Updated OAuth token information (https://api.losant.com/#/definitions/userOauthToken)
140
+ #
141
+ # Errors:
142
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
143
+ # * 404 - Error if OAuth token was not found (https://api.losant.com/#/definitions/error)
144
+ def patch(params = {})
145
+ params = Utils.symbolize_hash_keys(params)
146
+ query_params = { _actions: false, _links: true, _embedded: true }
147
+ headers = {}
148
+ body = nil
149
+
150
+ raise ArgumentError.new("oauthTokenId is required") unless params.has_key?(:oauthTokenId)
151
+ raise ArgumentError.new("oauthToken is required") unless params.has_key?(:oauthToken)
152
+
153
+ body = params[:oauthToken] if params.has_key?(:oauthToken)
154
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
155
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
156
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
157
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
158
+
159
+ path = "/me/oauth-tokens/#{params[:oauthTokenId]}"
160
+
161
+ @client.request(
162
+ method: :patch,
163
+ path: path,
164
+ query: query_params,
165
+ headers: headers,
166
+ body: body)
167
+ end
168
+
169
+ end
170
+ end
@@ -0,0 +1,132 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2026 SUSE
4
+ #
5
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ # of this software and associated documentation files (the "Software"), to deal
7
+ # in the Software without restriction, including without limitation the rights
8
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ # copies of the Software, and to permit persons to whom the Software is
10
+ # furnished to do so, subject to the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be included in all
13
+ # copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
22
+
23
+ require "json"
24
+
25
+ module PlatformRest
26
+
27
+ # Class containing all the actions for the User Oauth Tokens Resource
28
+ class UserOauthTokens
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the OAuth tokens for a user
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.User.read, userOauthTokens.*, or userOauthTokens.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated
44
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
45
+ # * {string} page - Which page of results to return
46
+ # * {string} perPage - How many items to return per page
47
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
48
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
+ # * {string} losantdomain - Domain scope of request (rarely needed)
50
+ # * {boolean} _actions - Return resource actions in response
51
+ # * {boolean} _links - Return resource link in response
52
+ # * {boolean} _embedded - Return embedded resources in response
53
+ #
54
+ # Responses:
55
+ # * 200 - Collection of OAuth tokens (https://api.losant.com/#/definitions/userOauthTokens)
56
+ #
57
+ # Errors:
58
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
59
+ def get(params = {})
60
+ params = Utils.symbolize_hash_keys(params)
61
+ query_params = { _actions: false, _links: true, _embedded: true }
62
+ headers = {}
63
+ body = nil
64
+
65
+
66
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
67
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
68
+ query_params[:page] = params[:page] if params.has_key?(:page)
69
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
70
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
71
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
72
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
73
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
74
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
75
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
76
+
77
+ path = "/me/oauth-tokens"
78
+
79
+ @client.request(
80
+ method: :get,
81
+ path: path,
82
+ query: query_params,
83
+ headers: headers,
84
+ body: body)
85
+ end
86
+
87
+ # Create a new OAuth token for a user
88
+ #
89
+ # Authentication:
90
+ # The client must be configured with a valid api
91
+ # access token to call this action. The token
92
+ # must include at least one of the following scopes:
93
+ # all.User, only.User, userOauthTokens.*, or userOauthTokens.post.
94
+ #
95
+ # Parameters:
96
+ # * {hash} oauthToken - OAuth token information (https://api.losant.com/#/definitions/userOauthTokenPost)
97
+ # * {string} losantdomain - Domain scope of request (rarely needed)
98
+ # * {boolean} _actions - Return resource actions in response
99
+ # * {boolean} _links - Return resource link in response
100
+ # * {boolean} _embedded - Return embedded resources in response
101
+ #
102
+ # Responses:
103
+ # * 201 - The successfully created OAuth token (https://api.losant.com/#/definitions/userOauthToken)
104
+ #
105
+ # Errors:
106
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
107
+ def post(params = {})
108
+ params = Utils.symbolize_hash_keys(params)
109
+ query_params = { _actions: false, _links: true, _embedded: true }
110
+ headers = {}
111
+ body = nil
112
+
113
+ raise ArgumentError.new("oauthToken is required") unless params.has_key?(:oauthToken)
114
+
115
+ body = params[:oauthToken] if params.has_key?(:oauthToken)
116
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
117
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
118
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
119
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
120
+
121
+ path = "/me/oauth-tokens"
122
+
123
+ @client.request(
124
+ method: :post,
125
+ path: path,
126
+ query: query_params,
127
+ headers: headers,
128
+ body: body)
129
+ end
130
+
131
+ end
132
+ end
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module PlatformRest
24
- VERSION = "2.0.0"
24
+ VERSION = "2.1.0"
25
25
  end
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Organization, all.User, webhook.*, or webhook.delete.
40
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.delete.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -85,7 +85,7 @@ module PlatformRest
85
85
  # The client must be configured with a valid api
86
86
  # access token to call this action. The token
87
87
  # must include at least one of the following scopes:
88
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.
88
+ # all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, webhook.*, or webhook.get.
89
89
  #
90
90
  # Parameters:
91
91
  # * {string} applicationId - ID associated with the application
@@ -131,7 +131,7 @@ module PlatformRest
131
131
  # The client must be configured with a valid api
132
132
  # access token to call this action. The token
133
133
  # must include at least one of the following scopes:
134
- # all.Application, all.Organization, all.User, webhook.*, or webhook.patch.
134
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhook.*, or webhook.patch.
135
135
  #
136
136
  # Parameters:
137
137
  # * {string} applicationId - ID associated with the application
@@ -37,7 +37,7 @@ module PlatformRest
37
37
  # The client must be configured with a valid api
38
38
  # access token to call this action. The token
39
39
  # must include at least one of the following scopes:
40
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhooks.*, or webhooks.get.
40
+ # all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, webhooks.*, or webhooks.get.
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
@@ -93,7 +93,7 @@ module PlatformRest
93
93
  # The client must be configured with a valid api
94
94
  # access token to call this action. The token
95
95
  # must include at least one of the following scopes:
96
- # all.Application, all.Organization, all.User, webhooks.*, or webhooks.post.
96
+ # all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, webhooks.*, or webhooks.post.
97
97
  #
98
98
  # Parameters:
99
99
  # * {string} applicationId - ID associated with the application
data/lib/platform_rest.rb CHANGED
@@ -118,6 +118,8 @@ require_relative "platform_rest/resource_job"
118
118
  require_relative "platform_rest/resource_jobs"
119
119
  require_relative "platform_rest/user_api_token"
120
120
  require_relative "platform_rest/user_api_tokens"
121
+ require_relative "platform_rest/user_oauth_token"
122
+ require_relative "platform_rest/user_oauth_tokens"
121
123
  require_relative "platform_rest/webhook"
122
124
  require_relative "platform_rest/webhooks"
123
125
  require_relative "platform_rest/client"
@@ -58,6 +58,106 @@
58
58
  "type": "string",
59
59
  "format": "date-time"
60
60
  },
61
+ "defaultRole": {
62
+ "type": "string",
63
+ "enum": [
64
+ "admin",
65
+ "edit",
66
+ "collaborate",
67
+ "view",
68
+ "none"
69
+ ]
70
+ },
71
+ "orgRoles": {
72
+ "type": "array",
73
+ "items": {
74
+ "type": "object",
75
+ "properties": {
76
+ "orgId": {
77
+ "oneOf": [
78
+ {
79
+ "type": "string",
80
+ "pattern": "^[A-Fa-f\\d]{24}$"
81
+ },
82
+ {
83
+ "type": "string",
84
+ "enum": [
85
+ "sandbox"
86
+ ]
87
+ }
88
+ ]
89
+ },
90
+ "role": {
91
+ "type": "string",
92
+ "enum": [
93
+ "admin",
94
+ "edit",
95
+ "collaborate",
96
+ "view",
97
+ "none"
98
+ ]
99
+ },
100
+ "applicationRoles": {
101
+ "type": "array",
102
+ "items": {
103
+ "type": "object",
104
+ "properties": {
105
+ "resourceId": {
106
+ "type": "string",
107
+ "pattern": "^[A-Fa-f\\d]{24}$"
108
+ },
109
+ "role": {
110
+ "type": "string",
111
+ "enum": [
112
+ "collaborate",
113
+ "view",
114
+ "none"
115
+ ]
116
+ }
117
+ },
118
+ "required": [
119
+ "resourceId",
120
+ "role"
121
+ ],
122
+ "additionalProperties": false
123
+ },
124
+ "maxItems": 100
125
+ },
126
+ "dashboardRoles": {
127
+ "type": "array",
128
+ "items": {
129
+ "type": "object",
130
+ "properties": {
131
+ "resourceId": {
132
+ "type": "string",
133
+ "pattern": "^[A-Fa-f\\d]{24}$"
134
+ },
135
+ "role": {
136
+ "type": "string",
137
+ "enum": [
138
+ "collaborate",
139
+ "view",
140
+ "none"
141
+ ]
142
+ }
143
+ },
144
+ "required": [
145
+ "resourceId",
146
+ "role"
147
+ ],
148
+ "additionalProperties": false
149
+ },
150
+ "maxItems": 100
151
+ }
152
+ },
153
+ "required": [
154
+ "orgId",
155
+ "role"
156
+ ],
157
+ "additionalProperties": false
158
+ },
159
+ "maxItems": 25
160
+ },
61
161
  "scope": {
62
162
  "type": "array",
63
163
  "items": {