losant_rest 1.19.4 → 1.19.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (249) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +9 -9
  4. data/docs/_schemas.md +7090 -2334
  5. data/docs/experienceUsers.md +1 -0
  6. data/docs/instanceAuditLog.md +49 -0
  7. data/docs/instanceAuditLogs.md +53 -0
  8. data/examples/auth.rb +1 -1
  9. data/examples/list_devices.rb +1 -1
  10. data/lib/platform_rest/application.rb +1 -1
  11. data/lib/platform_rest/application_api_token.rb +1 -1
  12. data/lib/platform_rest/application_api_tokens.rb +1 -1
  13. data/lib/platform_rest/application_certificate.rb +1 -1
  14. data/lib/platform_rest/application_certificate_authorities.rb +1 -1
  15. data/lib/platform_rest/application_certificate_authority.rb +1 -1
  16. data/lib/platform_rest/application_certificates.rb +1 -1
  17. data/lib/platform_rest/application_dashboard.rb +1 -1
  18. data/lib/platform_rest/application_dashboards.rb +1 -1
  19. data/lib/platform_rest/application_key.rb +1 -1
  20. data/lib/platform_rest/application_keys.rb +1 -1
  21. data/lib/platform_rest/application_template.rb +1 -1
  22. data/lib/platform_rest/application_templates.rb +1 -1
  23. data/lib/platform_rest/applications.rb +1 -1
  24. data/lib/platform_rest/audit_log.rb +1 -1
  25. data/lib/platform_rest/audit_logs.rb +1 -1
  26. data/lib/platform_rest/auth.rb +1 -1
  27. data/lib/platform_rest/client.rb +11 -3
  28. data/lib/platform_rest/credential.rb +1 -1
  29. data/lib/platform_rest/credentials.rb +1 -1
  30. data/lib/platform_rest/dashboard.rb +1 -1
  31. data/lib/platform_rest/dashboards.rb +1 -1
  32. data/lib/platform_rest/data.rb +1 -1
  33. data/lib/platform_rest/data_table.rb +1 -1
  34. data/lib/platform_rest/data_table_row.rb +1 -1
  35. data/lib/platform_rest/data_table_rows.rb +1 -1
  36. data/lib/platform_rest/data_tables.rb +1 -1
  37. data/lib/platform_rest/device.rb +1 -1
  38. data/lib/platform_rest/device_recipe.rb +1 -1
  39. data/lib/platform_rest/device_recipes.rb +1 -1
  40. data/lib/platform_rest/devices.rb +1 -1
  41. data/lib/platform_rest/edge_deployment.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +1 -1
  43. data/lib/platform_rest/embedded_deployment.rb +1 -1
  44. data/lib/platform_rest/embedded_deployments.rb +1 -1
  45. data/lib/platform_rest/error.rb +1 -1
  46. data/lib/platform_rest/event.rb +1 -1
  47. data/lib/platform_rest/events.rb +1 -1
  48. data/lib/platform_rest/experience.rb +1 -1
  49. data/lib/platform_rest/experience_domain.rb +1 -1
  50. data/lib/platform_rest/experience_domains.rb +1 -1
  51. data/lib/platform_rest/experience_endpoint.rb +1 -1
  52. data/lib/platform_rest/experience_endpoints.rb +1 -1
  53. data/lib/platform_rest/experience_group.rb +1 -1
  54. data/lib/platform_rest/experience_groups.rb +1 -1
  55. data/lib/platform_rest/experience_slug.rb +1 -1
  56. data/lib/platform_rest/experience_slugs.rb +1 -1
  57. data/lib/platform_rest/experience_user.rb +1 -1
  58. data/lib/platform_rest/experience_users.rb +4 -1
  59. data/lib/platform_rest/experience_version.rb +1 -1
  60. data/lib/platform_rest/experience_versions.rb +1 -1
  61. data/lib/platform_rest/experience_view.rb +1 -1
  62. data/lib/platform_rest/experience_views.rb +1 -1
  63. data/lib/platform_rest/file.rb +1 -1
  64. data/lib/platform_rest/files.rb +1 -1
  65. data/lib/platform_rest/flow.rb +1 -1
  66. data/lib/platform_rest/flow_version.rb +1 -1
  67. data/lib/platform_rest/flow_versions.rb +1 -1
  68. data/lib/platform_rest/flows.rb +1 -1
  69. data/lib/platform_rest/instance.rb +1 -1
  70. data/lib/platform_rest/instance_api_token.rb +1 -1
  71. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  72. data/lib/{losant_rest/application_template.rb → platform_rest/instance_audit_log.rb} +13 -11
  73. data/lib/{losant_rest/audit_logs.rb → platform_rest/instance_audit_logs.rb} +12 -12
  74. data/lib/platform_rest/instance_custom_node.rb +1 -1
  75. data/lib/platform_rest/instance_custom_nodes.rb +1 -1
  76. data/lib/platform_rest/instance_member.rb +1 -1
  77. data/lib/platform_rest/instance_members.rb +1 -1
  78. data/lib/platform_rest/instance_org.rb +1 -1
  79. data/lib/platform_rest/instance_org_invite.rb +1 -1
  80. data/lib/platform_rest/instance_org_invites.rb +1 -1
  81. data/lib/platform_rest/instance_org_member.rb +1 -1
  82. data/lib/platform_rest/instance_org_members.rb +1 -1
  83. data/lib/platform_rest/instance_orgs.rb +1 -1
  84. data/lib/platform_rest/instance_sandbox.rb +1 -1
  85. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  86. data/lib/platform_rest/instances.rb +1 -1
  87. data/lib/platform_rest/integration.rb +1 -1
  88. data/lib/platform_rest/integrations.rb +1 -1
  89. data/lib/platform_rest/me.rb +1 -1
  90. data/lib/platform_rest/notebook.rb +1 -1
  91. data/lib/platform_rest/notebooks.rb +1 -1
  92. data/lib/platform_rest/org.rb +1 -1
  93. data/lib/platform_rest/org_invites.rb +1 -1
  94. data/lib/platform_rest/orgs.rb +1 -1
  95. data/lib/platform_rest/resource_job.rb +1 -1
  96. data/lib/platform_rest/resource_jobs.rb +1 -1
  97. data/lib/platform_rest/user_api_token.rb +1 -1
  98. data/lib/platform_rest/user_api_tokens.rb +1 -1
  99. data/lib/platform_rest/utils.rb +1 -1
  100. data/lib/{losant_rest → platform_rest}/version.rb +3 -3
  101. data/lib/platform_rest/webhook.rb +1 -1
  102. data/lib/platform_rest/webhooks.rb +1 -1
  103. data/lib/platform_rest.rb +3 -1
  104. data/losant_rest.gemspec +2 -2
  105. data/schemas/advancedExperienceUserQuery.json +1068 -0
  106. data/schemas/apiTokenPost.json +9 -1
  107. data/schemas/auditLog.json +3 -2
  108. data/schemas/auditLogFilter.json +3 -2
  109. data/schemas/auditLogs.json +3 -2
  110. data/schemas/credential.json +95 -1
  111. data/schemas/credentialLinkedResources.json +417 -19
  112. data/schemas/credentialPatch.json +107 -0
  113. data/schemas/credentialPost.json +129 -1
  114. data/schemas/credentials.json +95 -1
  115. data/schemas/deviceConnectionStatus.json +6 -2
  116. data/schemas/devicesHistoricalImportPost.json +25 -0
  117. data/schemas/experienceLinkedResources.json +343 -20
  118. data/schemas/experienceVersion.json +64 -0
  119. data/schemas/experienceVersionPatch.json +64 -0
  120. data/schemas/experienceVersionPost.json +64 -0
  121. data/schemas/experienceVersions.json +64 -0
  122. data/schemas/experienceView.json +1 -2
  123. data/schemas/experienceViewPatch.json +1 -2
  124. data/schemas/experienceViewPost.json +2 -4
  125. data/schemas/experienceViews.json +1 -2
  126. data/schemas/flow.json +114 -6
  127. data/schemas/flowPatch.json +114 -6
  128. data/schemas/flowPost.json +114 -6
  129. data/schemas/flowVersion.json +228 -12
  130. data/schemas/flowVersionPost.json +114 -6
  131. data/schemas/flowVersions.json +228 -12
  132. data/schemas/flows.json +114 -6
  133. data/schemas/flowsImportPost.json +228 -12
  134. data/schemas/flowsImportResult.json +342 -18
  135. data/schemas/githubLogin.json +9 -1
  136. data/schemas/instance.json +1 -4
  137. data/schemas/instanceAuditLog.json +94 -0
  138. data/schemas/instanceAuditLogFilter.json +106 -0
  139. data/schemas/instanceAuditLogs.json +41 -0
  140. data/schemas/instanceCustomNode.json +2 -1
  141. data/schemas/instanceCustomNodePatch.json +2 -7
  142. data/schemas/instanceCustomNodePost.json +2 -7
  143. data/schemas/instanceCustomNodes.json +2 -1
  144. data/schemas/instanceOrgMember.json +4 -1
  145. data/schemas/instances.json +1 -4
  146. data/schemas/integration.json +75 -1
  147. data/schemas/integrationPatch.json +73 -0
  148. data/schemas/integrationPost.json +75 -1
  149. data/schemas/integrations.json +75 -1
  150. data/schemas/mePatch.json +18 -0
  151. data/schemas/resourceJob.json +2 -1
  152. data/schemas/resourceJobExecutionLogs.json +2 -1
  153. data/schemas/resourceJobPost.json +2 -1
  154. data/schemas/resourceJobs.json +2 -1
  155. data/schemas/samlResponse.json +9 -1
  156. data/schemas/userCredentials.json +9 -1
  157. data/schemas/userPost.json +9 -1
  158. data/test/basic_test.rb +6 -6
  159. data/test/test_helper.rb +1 -1
  160. metadata +12 -94
  161. data/lib/losant_rest/application.rb +0 -932
  162. data/lib/losant_rest/application_api_token.rb +0 -176
  163. data/lib/losant_rest/application_api_tokens.rb +0 -136
  164. data/lib/losant_rest/application_certificate.rb +0 -176
  165. data/lib/losant_rest/application_certificate_authorities.rb +0 -138
  166. data/lib/losant_rest/application_certificate_authority.rb +0 -176
  167. data/lib/losant_rest/application_certificates.rb +0 -138
  168. data/lib/losant_rest/application_dashboard.rb +0 -225
  169. data/lib/losant_rest/application_dashboards.rb +0 -138
  170. data/lib/losant_rest/application_key.rb +0 -176
  171. data/lib/losant_rest/application_keys.rb +0 -141
  172. data/lib/losant_rest/application_templates.rb +0 -176
  173. data/lib/losant_rest/applications.rb +0 -142
  174. data/lib/losant_rest/audit_log.rb +0 -81
  175. data/lib/losant_rest/auth.rb +0 -245
  176. data/lib/losant_rest/client.rb +0 -410
  177. data/lib/losant_rest/credential.rb +0 -224
  178. data/lib/losant_rest/credentials.rb +0 -138
  179. data/lib/losant_rest/dashboard.rb +0 -268
  180. data/lib/losant_rest/dashboards.rb +0 -136
  181. data/lib/losant_rest/data.rb +0 -176
  182. data/lib/losant_rest/data_table.rb +0 -274
  183. data/lib/losant_rest/data_table_row.rb +0 -182
  184. data/lib/losant_rest/data_table_rows.rb +0 -343
  185. data/lib/losant_rest/data_tables.rb +0 -138
  186. data/lib/losant_rest/device.rb +0 -749
  187. data/lib/losant_rest/device_recipe.rb +0 -234
  188. data/lib/losant_rest/device_recipes.rb +0 -146
  189. data/lib/losant_rest/devices.rb +0 -707
  190. data/lib/losant_rest/edge_deployment.rb +0 -81
  191. data/lib/losant_rest/edge_deployments.rb +0 -236
  192. data/lib/losant_rest/embedded_deployment.rb +0 -81
  193. data/lib/losant_rest/embedded_deployments.rb +0 -280
  194. data/lib/losant_rest/error.rb +0 -34
  195. data/lib/losant_rest/event.rb +0 -176
  196. data/lib/losant_rest/events.rb +0 -341
  197. data/lib/losant_rest/experience.rb +0 -142
  198. data/lib/losant_rest/experience_domain.rb +0 -176
  199. data/lib/losant_rest/experience_domains.rb +0 -126
  200. data/lib/losant_rest/experience_endpoint.rb +0 -230
  201. data/lib/losant_rest/experience_endpoints.rb +0 -200
  202. data/lib/losant_rest/experience_group.rb +0 -180
  203. data/lib/losant_rest/experience_groups.rb +0 -141
  204. data/lib/losant_rest/experience_slug.rb +0 -176
  205. data/lib/losant_rest/experience_slugs.rb +0 -126
  206. data/lib/losant_rest/experience_user.rb +0 -176
  207. data/lib/losant_rest/experience_users.rb +0 -142
  208. data/lib/losant_rest/experience_version.rb +0 -176
  209. data/lib/losant_rest/experience_versions.rb +0 -138
  210. data/lib/losant_rest/experience_view.rb +0 -228
  211. data/lib/losant_rest/experience_views.rb +0 -142
  212. data/lib/losant_rest/file.rb +0 -226
  213. data/lib/losant_rest/files.rb +0 -144
  214. data/lib/losant_rest/flow.rb +0 -580
  215. data/lib/losant_rest/flow_version.rb +0 -352
  216. data/lib/losant_rest/flow_versions.rb +0 -201
  217. data/lib/losant_rest/flows.rb +0 -310
  218. data/lib/losant_rest/instance.rb +0 -377
  219. data/lib/losant_rest/instance_api_token.rb +0 -176
  220. data/lib/losant_rest/instance_api_tokens.rb +0 -136
  221. data/lib/losant_rest/instance_custom_node.rb +0 -282
  222. data/lib/losant_rest/instance_custom_nodes.rb +0 -136
  223. data/lib/losant_rest/instance_member.rb +0 -176
  224. data/lib/losant_rest/instance_members.rb +0 -134
  225. data/lib/losant_rest/instance_org.rb +0 -336
  226. data/lib/losant_rest/instance_org_invite.rb +0 -182
  227. data/lib/losant_rest/instance_org_invites.rb +0 -138
  228. data/lib/losant_rest/instance_org_member.rb +0 -182
  229. data/lib/losant_rest/instance_org_members.rb +0 -138
  230. data/lib/losant_rest/instance_orgs.rb +0 -139
  231. data/lib/losant_rest/instance_sandbox.rb +0 -181
  232. data/lib/losant_rest/instance_sandboxes.rb +0 -98
  233. data/lib/losant_rest/instances.rb +0 -88
  234. data/lib/losant_rest/integration.rb +0 -178
  235. data/lib/losant_rest/integrations.rb +0 -138
  236. data/lib/losant_rest/me.rb +0 -790
  237. data/lib/losant_rest/notebook.rb +0 -423
  238. data/lib/losant_rest/notebooks.rb +0 -138
  239. data/lib/losant_rest/org.rb +0 -663
  240. data/lib/losant_rest/org_invites.rb +0 -124
  241. data/lib/losant_rest/orgs.rb +0 -140
  242. data/lib/losant_rest/resource_job.rb +0 -326
  243. data/lib/losant_rest/resource_jobs.rb +0 -138
  244. data/lib/losant_rest/user_api_token.rb +0 -170
  245. data/lib/losant_rest/user_api_tokens.rb +0 -132
  246. data/lib/losant_rest/utils.rb +0 -44
  247. data/lib/losant_rest/webhook.rb +0 -178
  248. data/lib/losant_rest/webhooks.rb +0 -138
  249. data/lib/losant_rest.rb +0 -129
@@ -1,142 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
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 LosantRest
26
-
27
- # Class containing all the actions for the Experience Resource
28
- class Experience
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Bootstraps the experience for this application with standard endpoints and views
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.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experience.*, or experience.bootstrap.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
44
- # * {hash} options - Bootstrap options (https://api.losant.com/#/definitions/experienceBootstrapOptions)
45
- # * {string} losantdomain - Domain scope of request (rarely needed)
46
- # * {boolean} _actions - Return resource actions in response
47
- # * {boolean} _links - Return resource link in response
48
- # * {boolean} _embedded - Return embedded resources in response
49
- #
50
- # Responses:
51
- # * 200 - If bootstrap was successful (https://api.losant.com/#/definitions/experienceBootstrapResult)
52
- #
53
- # Errors:
54
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
56
- def bootstrap(params = {})
57
- params = Utils.symbolize_hash_keys(params)
58
- query_params = { _actions: false, _links: true, _embedded: true }
59
- headers = {}
60
- body = nil
61
-
62
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
63
- raise ArgumentError.new("options is required") unless params.has_key?(:options)
64
-
65
- body = params[:options] if params.has_key?(:options)
66
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
67
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
68
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
69
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
70
-
71
- path = "/applications/#{params[:applicationId]}/experience/bootstrap"
72
-
73
- @client.request(
74
- method: :patch,
75
- path: path,
76
- query: query_params,
77
- headers: headers,
78
- body: body)
79
- end
80
-
81
- # Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows
82
- #
83
- # Authentication:
84
- # The client must be configured with a valid api
85
- # access token to call this action. The token
86
- # must include at least one of the following scopes:
87
- # all.Application, all.Organization, all.User, experience.*, or experience.delete.
88
- #
89
- # Parameters:
90
- # * {string} applicationId - ID associated with the application
91
- # * {string} keepUsers - If this is set, Experience Users will not be removed.
92
- # * {string} keepGroups - If this is set, Experience Groups will not be removed.
93
- # * {string} keepSlugs - If this is set, Experience Slugs will not be removed.
94
- # * {string} keepDomains - If this is set, Experience Domains will not be removed.
95
- # * {string} removeVersions - If this is set, all Experience Versions and their contents will be removed (except for develop).
96
- # * {string} keepViews - If this is set, Experience Views (in the develop version) will not be removed.
97
- # * {string} keepEndpoints - If this is set, Experience Endpoints (in the develop version) will not be removed.
98
- # * {string} removeWorkflows - If this is set, all Experience Workflows (in the develop version) will ve removed.
99
- # * {string} losantdomain - Domain scope of request (rarely needed)
100
- # * {boolean} _actions - Return resource actions in response
101
- # * {boolean} _links - Return resource link in response
102
- # * {boolean} _embedded - Return embedded resources in response
103
- #
104
- # Responses:
105
- # * 200 - If deletion was successful (https://api.losant.com/#/definitions/success)
106
- #
107
- # Errors:
108
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
109
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
110
- def delete(params = {})
111
- params = Utils.symbolize_hash_keys(params)
112
- query_params = { _actions: false, _links: true, _embedded: true }
113
- headers = {}
114
- body = nil
115
-
116
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
117
-
118
- query_params[:keepUsers] = params[:keepUsers] if params.has_key?(:keepUsers)
119
- query_params[:keepGroups] = params[:keepGroups] if params.has_key?(:keepGroups)
120
- query_params[:keepSlugs] = params[:keepSlugs] if params.has_key?(:keepSlugs)
121
- query_params[:keepDomains] = params[:keepDomains] if params.has_key?(:keepDomains)
122
- query_params[:removeVersions] = params[:removeVersions] if params.has_key?(:removeVersions)
123
- query_params[:keepViews] = params[:keepViews] if params.has_key?(:keepViews)
124
- query_params[:keepEndpoints] = params[:keepEndpoints] if params.has_key?(:keepEndpoints)
125
- query_params[:removeWorkflows] = params[:removeWorkflows] if params.has_key?(:removeWorkflows)
126
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
127
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
128
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
129
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
130
-
131
- path = "/applications/#{params[:applicationId]}/experience"
132
-
133
- @client.request(
134
- method: :delete,
135
- path: path,
136
- query: query_params,
137
- headers: headers,
138
- body: body)
139
- end
140
-
141
- end
142
- end
@@ -1,176 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
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 LosantRest
26
-
27
- # Class containing all the actions for the Experience Domain Resource
28
- class ExperienceDomain
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Deletes an experience domain
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.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.delete.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
44
- # * {string} experienceDomainId - ID associated with the experience domain
45
- # * {string} losantdomain - Domain scope of request (rarely needed)
46
- # * {boolean} _actions - Return resource actions in response
47
- # * {boolean} _links - Return resource link in response
48
- # * {boolean} _embedded - Return embedded resources in response
49
- #
50
- # Responses:
51
- # * 200 - If experience domain was successfully deleted (https://api.losant.com/#/definitions/success)
52
- #
53
- # Errors:
54
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
- # * 404 - Error if experience domain was not found (https://api.losant.com/#/definitions/error)
56
- def delete(params = {})
57
- params = Utils.symbolize_hash_keys(params)
58
- query_params = { _actions: false, _links: true, _embedded: true }
59
- headers = {}
60
- body = nil
61
-
62
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
63
- raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
64
-
65
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
66
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
67
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
68
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
69
-
70
- path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
71
-
72
- @client.request(
73
- method: :delete,
74
- path: path,
75
- query: query_params,
76
- headers: headers,
77
- body: body)
78
- end
79
-
80
- # Retrieves information on an experience domain
81
- #
82
- # Authentication:
83
- # The client must be configured with a valid api
84
- # access token to call this action. The token
85
- # must include at least one of the following scopes:
86
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomain.*, or experienceDomain.get.
87
- #
88
- # Parameters:
89
- # * {string} applicationId - ID associated with the application
90
- # * {string} experienceDomainId - ID associated with the experience domain
91
- # * {string} losantdomain - Domain scope of request (rarely needed)
92
- # * {boolean} _actions - Return resource actions in response
93
- # * {boolean} _links - Return resource link in response
94
- # * {boolean} _embedded - Return embedded resources in response
95
- #
96
- # Responses:
97
- # * 200 - Experience domain information (https://api.losant.com/#/definitions/experienceDomain)
98
- #
99
- # Errors:
100
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
101
- # * 404 - Error if experience domain was not found (https://api.losant.com/#/definitions/error)
102
- def get(params = {})
103
- params = Utils.symbolize_hash_keys(params)
104
- query_params = { _actions: false, _links: true, _embedded: true }
105
- headers = {}
106
- body = nil
107
-
108
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
109
- raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
110
-
111
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
112
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
113
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
114
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
115
-
116
- path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
117
-
118
- @client.request(
119
- method: :get,
120
- path: path,
121
- query: query_params,
122
- headers: headers,
123
- body: body)
124
- end
125
-
126
- # Updates information about an experience domain
127
- #
128
- # Authentication:
129
- # The client must be configured with a valid api
130
- # access token to call this action. The token
131
- # must include at least one of the following scopes:
132
- # all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.patch.
133
- #
134
- # Parameters:
135
- # * {string} applicationId - ID associated with the application
136
- # * {string} experienceDomainId - ID associated with the experience domain
137
- # * {hash} experienceDomain - Object containing new properties of the experience domain (https://api.losant.com/#/definitions/experienceDomainPatch)
138
- # * {string} losantdomain - Domain scope of request (rarely needed)
139
- # * {boolean} _actions - Return resource actions in response
140
- # * {boolean} _links - Return resource link in response
141
- # * {boolean} _embedded - Return embedded resources in response
142
- #
143
- # Responses:
144
- # * 200 - Updated experience domain information (https://api.losant.com/#/definitions/experienceDomain)
145
- #
146
- # Errors:
147
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
148
- # * 404 - Error if experience domain was not found (https://api.losant.com/#/definitions/error)
149
- def patch(params = {})
150
- params = Utils.symbolize_hash_keys(params)
151
- query_params = { _actions: false, _links: true, _embedded: true }
152
- headers = {}
153
- body = nil
154
-
155
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
156
- raise ArgumentError.new("experienceDomainId is required") unless params.has_key?(:experienceDomainId)
157
- raise ArgumentError.new("experienceDomain is required") unless params.has_key?(:experienceDomain)
158
-
159
- body = params[:experienceDomain] if params.has_key?(:experienceDomain)
160
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
161
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
162
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
163
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
164
-
165
- path = "/applications/#{params[:applicationId]}/experience/domains/#{params[:experienceDomainId]}"
166
-
167
- @client.request(
168
- method: :patch,
169
- path: path,
170
- query: query_params,
171
- headers: headers,
172
- body: body)
173
- end
174
-
175
- end
176
- end
@@ -1,126 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
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 LosantRest
26
-
27
- # Class containing all the actions for the Experience Domains Resource
28
- class ExperienceDomains
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Returns the experience domains for an application
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.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceDomains.*, or experienceDomains.get.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
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 - Collection of experience domains (https://api.losant.com/#/definitions/experienceDomains)
51
- #
52
- # Errors:
53
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
54
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
55
- def get(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("applicationId is required") unless params.has_key?(:applicationId)
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 = "/applications/#{params[:applicationId]}/experience/domains"
69
-
70
- @client.request(
71
- method: :get,
72
- path: path,
73
- query: query_params,
74
- headers: headers,
75
- body: body)
76
- end
77
-
78
- # Create a new experience domain for an application
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.Application, all.Organization, all.User, experienceDomains.*, or experienceDomains.post.
85
- #
86
- # Parameters:
87
- # * {string} applicationId - ID associated with the application
88
- # * {hash} experienceDomain - New experience domain information (https://api.losant.com/#/definitions/experienceDomainPost)
89
- # * {string} losantdomain - Domain scope of request (rarely needed)
90
- # * {boolean} _actions - Return resource actions in response
91
- # * {boolean} _links - Return resource link in response
92
- # * {boolean} _embedded - Return embedded resources in response
93
- #
94
- # Responses:
95
- # * 201 - Successfully created experience domain (https://api.losant.com/#/definitions/experienceDomain)
96
- #
97
- # Errors:
98
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
99
- # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
100
- def post(params = {})
101
- params = Utils.symbolize_hash_keys(params)
102
- query_params = { _actions: false, _links: true, _embedded: true }
103
- headers = {}
104
- body = nil
105
-
106
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
107
- raise ArgumentError.new("experienceDomain is required") unless params.has_key?(:experienceDomain)
108
-
109
- body = params[:experienceDomain] if params.has_key?(:experienceDomain)
110
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
111
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
112
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
113
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
114
-
115
- path = "/applications/#{params[:applicationId]}/experience/domains"
116
-
117
- @client.request(
118
- method: :post,
119
- path: path,
120
- query: query_params,
121
- headers: headers,
122
- body: body)
123
- end
124
-
125
- end
126
- end
@@ -1,230 +0,0 @@
1
- # The MIT License (MIT)
2
- #
3
- # Copyright (c) 2023 Losant IoT, Inc.
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 LosantRest
26
-
27
- # Class containing all the actions for the Experience Endpoint Resource
28
- class ExperienceEndpoint
29
-
30
- def initialize(client)
31
- @client = client
32
- end
33
-
34
- # Deletes an experience endpoint
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.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.delete.
41
- #
42
- # Parameters:
43
- # * {string} applicationId - ID associated with the application
44
- # * {string} experienceEndpointId - ID associated with the experience endpoint
45
- # * {string} includeWorkflows - If the workflows that utilize this experience endpoint should also be deleted.
46
- # * {string} losantdomain - Domain scope of request (rarely needed)
47
- # * {boolean} _actions - Return resource actions in response
48
- # * {boolean} _links - Return resource link in response
49
- # * {boolean} _embedded - Return embedded resources in response
50
- #
51
- # Responses:
52
- # * 200 - If experience endpoint was successfully deleted (https://api.losant.com/#/definitions/success)
53
- #
54
- # Errors:
55
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
56
- # * 404 - Error if experience endpoint was not found (https://api.losant.com/#/definitions/error)
57
- def delete(params = {})
58
- params = Utils.symbolize_hash_keys(params)
59
- query_params = { _actions: false, _links: true, _embedded: true }
60
- headers = {}
61
- body = nil
62
-
63
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
64
- raise ArgumentError.new("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
65
-
66
- query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
67
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
68
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
69
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
70
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
71
-
72
- path = "/applications/#{params[:applicationId]}/experience/endpoints/#{params[:experienceEndpointId]}"
73
-
74
- @client.request(
75
- method: :delete,
76
- path: path,
77
- query: query_params,
78
- headers: headers,
79
- body: body)
80
- end
81
-
82
- # Retrieves information on an experience endpoint
83
- #
84
- # Authentication:
85
- # The client must be configured with a valid api
86
- # access token to call this action. The token
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, experienceEndpoint.*, or experienceEndpoint.get.
89
- #
90
- # Parameters:
91
- # * {string} applicationId - ID associated with the application
92
- # * {string} experienceEndpointId - ID associated with the experience endpoint
93
- # * {string} version - Version of this experience endpoint to return
94
- # * {string} losantdomain - Domain scope of request (rarely needed)
95
- # * {boolean} _actions - Return resource actions in response
96
- # * {boolean} _links - Return resource link in response
97
- # * {boolean} _embedded - Return embedded resources in response
98
- #
99
- # Responses:
100
- # * 200 - Experience endpoint information (https://api.losant.com/#/definitions/experienceEndpoint)
101
- #
102
- # Errors:
103
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
104
- # * 404 - Error if experience endpoint was not found (https://api.losant.com/#/definitions/error)
105
- def get(params = {})
106
- params = Utils.symbolize_hash_keys(params)
107
- query_params = { _actions: false, _links: true, _embedded: true }
108
- headers = {}
109
- body = nil
110
-
111
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
112
- raise ArgumentError.new("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
113
-
114
- query_params[:version] = params[:version] if params.has_key?(:version)
115
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
116
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
117
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
118
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
119
-
120
- path = "/applications/#{params[:applicationId]}/experience/endpoints/#{params[:experienceEndpointId]}"
121
-
122
- @client.request(
123
- method: :get,
124
- path: path,
125
- query: query_params,
126
- headers: headers,
127
- body: body)
128
- end
129
-
130
- # Retrieves information on resources linked to an experience endpoint
131
- #
132
- # Authentication:
133
- # The client must be configured with a valid api
134
- # access token to call this action. The token
135
- # must include at least one of the following scopes:
136
- # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoint.*, or experienceEndpoint.linkedResources.
137
- #
138
- # Parameters:
139
- # * {string} applicationId - ID associated with the application
140
- # * {string} experienceEndpointId - ID associated with the experience endpoint
141
- # * {string} version - Version of this experience endpoint to query
142
- # * {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by returned workflows
143
- # * {string} losantdomain - Domain scope of request (rarely needed)
144
- # * {boolean} _actions - Return resource actions in response
145
- # * {boolean} _links - Return resource link in response
146
- # * {boolean} _embedded - Return embedded resources in response
147
- #
148
- # Responses:
149
- # * 200 - Linked resource information (https://api.losant.com/#/definitions/experienceLinkedResources)
150
- #
151
- # Errors:
152
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
- # * 404 - Error if experience endpoint was not found (https://api.losant.com/#/definitions/error)
154
- def linked_resources(params = {})
155
- params = Utils.symbolize_hash_keys(params)
156
- query_params = { _actions: false, _links: true, _embedded: true }
157
- headers = {}
158
- body = nil
159
-
160
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
161
- raise ArgumentError.new("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
162
-
163
- query_params[:version] = params[:version] if params.has_key?(:version)
164
- query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
165
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
166
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
167
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
168
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
169
-
170
- path = "/applications/#{params[:applicationId]}/experience/endpoints/#{params[:experienceEndpointId]}/linkedResources"
171
-
172
- @client.request(
173
- method: :get,
174
- path: path,
175
- query: query_params,
176
- headers: headers,
177
- body: body)
178
- end
179
-
180
- # Updates information about an experience endpoint
181
- #
182
- # Authentication:
183
- # The client must be configured with a valid api
184
- # access token to call this action. The token
185
- # must include at least one of the following scopes:
186
- # all.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.patch.
187
- #
188
- # Parameters:
189
- # * {string} applicationId - ID associated with the application
190
- # * {string} experienceEndpointId - ID associated with the experience endpoint
191
- # * {hash} experienceEndpoint - Object containing new properties of the experience endpoint (https://api.losant.com/#/definitions/experienceEndpointPatch)
192
- # * {string} losantdomain - Domain scope of request (rarely needed)
193
- # * {boolean} _actions - Return resource actions in response
194
- # * {boolean} _links - Return resource link in response
195
- # * {boolean} _embedded - Return embedded resources in response
196
- #
197
- # Responses:
198
- # * 200 - Updated experience endpoint information (https://api.losant.com/#/definitions/experienceEndpoint)
199
- #
200
- # Errors:
201
- # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
202
- # * 404 - Error if experience endpoint was not found (https://api.losant.com/#/definitions/error)
203
- def patch(params = {})
204
- params = Utils.symbolize_hash_keys(params)
205
- query_params = { _actions: false, _links: true, _embedded: true }
206
- headers = {}
207
- body = nil
208
-
209
- raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
210
- raise ArgumentError.new("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
211
- raise ArgumentError.new("experienceEndpoint is required") unless params.has_key?(:experienceEndpoint)
212
-
213
- body = params[:experienceEndpoint] if params.has_key?(:experienceEndpoint)
214
- headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
215
- query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
216
- query_params[:_links] = params[:_links] if params.has_key?(:_links)
217
- query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
218
-
219
- path = "/applications/#{params[:applicationId]}/experience/endpoints/#{params[:experienceEndpointId]}"
220
-
221
- @client.request(
222
- method: :patch,
223
- path: path,
224
- query: query_params,
225
- headers: headers,
226
- body: body)
227
- end
228
-
229
- end
230
- end