losant_rest 1.18.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10369 -390
  3. data/docs/applications.md +49 -0
  4. data/docs/credential.md +175 -0
  5. data/docs/credentials.md +93 -0
  6. data/docs/device.md +12 -3
  7. data/docs/me.md +116 -0
  8. data/lib/losant_rest/client.rb +10 -2
  9. data/lib/losant_rest/credential.rb +224 -0
  10. data/lib/losant_rest/credentials.rb +138 -0
  11. data/lib/losant_rest/version.rb +1 -1
  12. data/lib/losant_rest.rb +2 -0
  13. data/lib/platform_rest/application.rb +932 -0
  14. data/lib/platform_rest/application_api_token.rb +176 -0
  15. data/lib/platform_rest/application_api_tokens.rb +136 -0
  16. data/lib/platform_rest/application_certificate.rb +176 -0
  17. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  18. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  19. data/lib/platform_rest/application_certificates.rb +138 -0
  20. data/lib/platform_rest/application_dashboard.rb +225 -0
  21. data/lib/platform_rest/application_dashboards.rb +138 -0
  22. data/lib/platform_rest/application_key.rb +176 -0
  23. data/lib/platform_rest/application_keys.rb +141 -0
  24. data/lib/platform_rest/application_template.rb +79 -0
  25. data/lib/platform_rest/application_templates.rb +176 -0
  26. data/lib/platform_rest/applications.rb +209 -0
  27. data/lib/platform_rest/audit_log.rb +81 -0
  28. data/lib/platform_rest/audit_logs.rb +93 -0
  29. data/lib/platform_rest/auth.rb +245 -0
  30. data/lib/platform_rest/client.rb +410 -0
  31. data/lib/platform_rest/credential.rb +224 -0
  32. data/lib/platform_rest/credentials.rb +138 -0
  33. data/lib/platform_rest/dashboard.rb +268 -0
  34. data/lib/platform_rest/dashboards.rb +136 -0
  35. data/lib/platform_rest/data.rb +176 -0
  36. data/lib/platform_rest/data_table.rb +274 -0
  37. data/lib/platform_rest/data_table_row.rb +182 -0
  38. data/lib/platform_rest/data_table_rows.rb +343 -0
  39. data/lib/platform_rest/data_tables.rb +138 -0
  40. data/lib/platform_rest/device.rb +767 -0
  41. data/lib/platform_rest/device_recipe.rb +234 -0
  42. data/lib/platform_rest/device_recipes.rb +146 -0
  43. data/lib/platform_rest/devices.rb +707 -0
  44. data/lib/platform_rest/edge_deployment.rb +81 -0
  45. data/lib/platform_rest/edge_deployments.rb +236 -0
  46. data/lib/platform_rest/embedded_deployment.rb +81 -0
  47. data/lib/platform_rest/embedded_deployments.rb +280 -0
  48. data/lib/platform_rest/error.rb +34 -0
  49. data/lib/platform_rest/event.rb +176 -0
  50. data/lib/platform_rest/events.rb +341 -0
  51. data/lib/platform_rest/experience.rb +142 -0
  52. data/lib/platform_rest/experience_domain.rb +176 -0
  53. data/lib/platform_rest/experience_domains.rb +126 -0
  54. data/lib/platform_rest/experience_endpoint.rb +230 -0
  55. data/lib/platform_rest/experience_endpoints.rb +200 -0
  56. data/lib/platform_rest/experience_group.rb +180 -0
  57. data/lib/platform_rest/experience_groups.rb +141 -0
  58. data/lib/platform_rest/experience_slug.rb +176 -0
  59. data/lib/platform_rest/experience_slugs.rb +126 -0
  60. data/lib/platform_rest/experience_user.rb +176 -0
  61. data/lib/platform_rest/experience_users.rb +142 -0
  62. data/lib/platform_rest/experience_version.rb +176 -0
  63. data/lib/platform_rest/experience_versions.rb +138 -0
  64. data/lib/platform_rest/experience_view.rb +228 -0
  65. data/lib/platform_rest/experience_views.rb +142 -0
  66. data/lib/platform_rest/file.rb +226 -0
  67. data/lib/platform_rest/files.rb +144 -0
  68. data/lib/platform_rest/flow.rb +580 -0
  69. data/lib/platform_rest/flow_version.rb +352 -0
  70. data/lib/platform_rest/flow_versions.rb +201 -0
  71. data/lib/platform_rest/flows.rb +310 -0
  72. data/lib/platform_rest/instance.rb +377 -0
  73. data/lib/platform_rest/instance_api_token.rb +176 -0
  74. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  75. data/lib/platform_rest/instance_custom_node.rb +282 -0
  76. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  77. data/lib/platform_rest/instance_member.rb +176 -0
  78. data/lib/platform_rest/instance_members.rb +134 -0
  79. data/lib/platform_rest/instance_org.rb +336 -0
  80. data/lib/platform_rest/instance_org_invite.rb +182 -0
  81. data/lib/platform_rest/instance_org_invites.rb +138 -0
  82. data/lib/platform_rest/instance_org_member.rb +182 -0
  83. data/lib/platform_rest/instance_org_members.rb +138 -0
  84. data/lib/platform_rest/instance_orgs.rb +139 -0
  85. data/lib/platform_rest/instance_sandbox.rb +181 -0
  86. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  87. data/lib/platform_rest/instances.rb +88 -0
  88. data/lib/platform_rest/integration.rb +178 -0
  89. data/lib/platform_rest/integrations.rb +138 -0
  90. data/lib/platform_rest/me.rb +923 -0
  91. data/lib/platform_rest/notebook.rb +423 -0
  92. data/lib/platform_rest/notebooks.rb +138 -0
  93. data/lib/platform_rest/org.rb +663 -0
  94. data/lib/platform_rest/org_invites.rb +124 -0
  95. data/lib/platform_rest/orgs.rb +140 -0
  96. data/lib/platform_rest/resource_job.rb +326 -0
  97. data/lib/platform_rest/resource_jobs.rb +138 -0
  98. data/lib/platform_rest/user_api_token.rb +170 -0
  99. data/lib/platform_rest/user_api_tokens.rb +132 -0
  100. data/lib/platform_rest/utils.rb +44 -0
  101. data/lib/platform_rest/webhook.rb +178 -0
  102. data/lib/platform_rest/webhooks.rb +138 -0
  103. data/lib/platform_rest.rb +129 -0
  104. data/schemas/apiTokenPost.json +12 -0
  105. data/schemas/application.json +9 -8
  106. data/schemas/applicationCreationByTemplateResult.json +9 -8
  107. data/schemas/applicationDashboardPost.json +66 -0
  108. data/schemas/applicationPatch.json +6 -8
  109. data/schemas/applicationPost.json +6 -8
  110. data/schemas/applications.json +9 -8
  111. data/schemas/credential.json +115 -0
  112. data/schemas/credentialLinkedResources.json +8254 -0
  113. data/schemas/credentialPatch.json +66 -0
  114. data/schemas/credentialPost.json +89 -0
  115. data/schemas/credentials.json +160 -0
  116. data/schemas/dashboard.json +66 -0
  117. data/schemas/dashboardPatch.json +76 -3
  118. data/schemas/dashboardPost.json +76 -3
  119. data/schemas/dashboards.json +66 -0
  120. data/schemas/device.json +8 -0
  121. data/schemas/deviceConnectionStatus.json +10 -0
  122. data/schemas/deviceLog.json +3 -0
  123. data/schemas/devices.json +8 -0
  124. data/schemas/event.json +8 -0
  125. data/schemas/eventPlusNewCount.json +8 -0
  126. data/schemas/events.json +8 -0
  127. data/schemas/experienceGroup.json +8 -0
  128. data/schemas/experienceGroups.json +8 -0
  129. data/schemas/experienceLinkedResources.json +6 -3
  130. data/schemas/flow.json +2 -1
  131. data/schemas/flowPatch.json +2 -1
  132. data/schemas/flowPost.json +2 -1
  133. data/schemas/flowVersion.json +4 -2
  134. data/schemas/flowVersionPost.json +2 -1
  135. data/schemas/flowVersions.json +4 -2
  136. data/schemas/flows.json +2 -1
  137. data/schemas/flowsImportPost.json +4 -2
  138. data/schemas/flowsImportResult.json +6 -3
  139. data/schemas/githubLogin.json +12 -0
  140. data/schemas/historicalSummaries.json +4 -0
  141. data/schemas/historicalSummary.json +4 -0
  142. data/schemas/instance.json +7 -0
  143. data/schemas/instanceOrg.json +4 -0
  144. data/schemas/instanceOrgPatch.json +4 -0
  145. data/schemas/instanceOrgPost.json +4 -0
  146. data/schemas/instanceOrgs.json +4 -0
  147. data/schemas/instancePatch.json +4 -0
  148. data/schemas/instanceSandbox.json +6 -0
  149. data/schemas/instanceSandboxes.json +6 -0
  150. data/schemas/instances.json +7 -0
  151. data/schemas/integration.json +26 -12
  152. data/schemas/integrationPatch.json +33 -22
  153. data/schemas/integrationPost.json +26 -12
  154. data/schemas/integrations.json +26 -12
  155. data/schemas/me.json +6 -0
  156. data/schemas/org.json +7 -0
  157. data/schemas/orgInviteActionUser.json +18 -0
  158. data/schemas/orgInviteResultUser.json +18 -0
  159. data/schemas/orgInviteUser.json +51 -0
  160. data/schemas/orgInvitesUser.json +59 -0
  161. data/schemas/orgs.json +7 -0
  162. data/schemas/payloadCountsBreakdown.json +1 -25
  163. data/schemas/periodSummaries.json +172 -0
  164. data/schemas/samlResponse.json +12 -0
  165. data/schemas/userCredentials.json +12 -0
  166. data/schemas/userPost.json +12 -0
  167. metadata +107 -2
@@ -0,0 +1,34 @@
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
+ module PlatformRest
24
+ class ResponseError < StandardError
25
+ attr_reader :code
26
+ attr_reader :type
27
+
28
+ def initialize(code, result)
29
+ @code = code
30
+ @type = result["type"]
31
+ super(result["message"])
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,176 @@
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 PlatformRest
26
+
27
+ # Class containing all the actions for the Event Resource
28
+ class Event
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes an event
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, event.*, or event.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} eventId - ID associated with the event
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 event 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 event 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("eventId is required") unless params.has_key?(:eventId)
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]}/events/#{params[:eventId]}"
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 event
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, event.*, or event.get.
87
+ #
88
+ # Parameters:
89
+ # * {string} applicationId - ID associated with the application
90
+ # * {string} eventId - ID associated with the event
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 - Event information (https://api.losant.com/#/definitions/event)
98
+ #
99
+ # Errors:
100
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
101
+ # * 404 - Error if event 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("eventId is required") unless params.has_key?(:eventId)
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]}/events/#{params[:eventId]}"
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 event
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, event.*, or event.patch.
133
+ #
134
+ # Parameters:
135
+ # * {string} applicationId - ID associated with the application
136
+ # * {string} eventId - ID associated with the event
137
+ # * {hash} event - Object containing new properties of the event (https://api.losant.com/#/definitions/eventPatch)
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 event information (https://api.losant.com/#/definitions/event)
145
+ #
146
+ # Errors:
147
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
148
+ # * 404 - Error if event is 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("eventId is required") unless params.has_key?(:eventId)
157
+ raise ArgumentError.new("event is required") unless params.has_key?(:event)
158
+
159
+ body = params[:event] if params.has_key?(:event)
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]}/events/#{params[:eventId]}"
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
@@ -0,0 +1,341 @@
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 PlatformRest
26
+
27
+ # Class containing all the actions for the Events Resource
28
+ class Events
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Delete events
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.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {hash} query - Query to apply to filter the events (https://api.losant.com/#/definitions/advancedEventQuery)
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 request successfully deletes a set of Events (https://api.losant.com/#/definitions/eventsDeleted)
52
+ #
53
+ # Errors:
54
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
55
+ # * 404 - Error if events were 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
+
64
+ body = params[:query] if params.has_key?(:query)
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]}/events/delete"
71
+
72
+ @client.request(
73
+ method: :post,
74
+ path: path,
75
+ query: query_params,
76
+ headers: headers,
77
+ body: body)
78
+ end
79
+
80
+ # Request an export of an application's event data
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, events.*, or events.export.
87
+ #
88
+ # Parameters:
89
+ # * {string} applicationId - ID associated with the application
90
+ # * {hash} exportData - Export options for events (https://api.losant.com/#/definitions/eventsExport)
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
+ # * 202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
98
+ #
99
+ # Errors:
100
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
101
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
102
+ def export(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
+
110
+ body = params[:exportData] if params.has_key?(:exportData)
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]}/events/export"
117
+
118
+ @client.request(
119
+ method: :post,
120
+ path: path,
121
+ query: query_params,
122
+ headers: headers,
123
+ body: body)
124
+ end
125
+
126
+ # Returns the events for an application
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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.get.
133
+ #
134
+ # Parameters:
135
+ # * {string} applicationId - ID associated with the application
136
+ # * {string} sortField - Field to sort the results by. Accepted values are: subject, id, creationDate, lastUpdated, level, state, deviceId
137
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
138
+ # * {string} page - Which page of results to return
139
+ # * {string} perPage - How many items to return per page
140
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: subject
141
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
142
+ # * {string} state - If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved
143
+ # * {hash} query - Event filter JSON object which overrides the filterField, filter, and state parameters. (https://api.losant.com/#/definitions/advancedEventQuery)
144
+ # * {string} losantdomain - Domain scope of request (rarely needed)
145
+ # * {boolean} _actions - Return resource actions in response
146
+ # * {boolean} _links - Return resource link in response
147
+ # * {boolean} _embedded - Return embedded resources in response
148
+ #
149
+ # Responses:
150
+ # * 200 - Collection of events (https://api.losant.com/#/definitions/events)
151
+ #
152
+ # Errors:
153
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
154
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
155
+ def get(params = {})
156
+ params = Utils.symbolize_hash_keys(params)
157
+ query_params = { _actions: false, _links: true, _embedded: true }
158
+ headers = {}
159
+ body = nil
160
+
161
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
162
+
163
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
164
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
165
+ query_params[:page] = params[:page] if params.has_key?(:page)
166
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
167
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
168
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
169
+ query_params[:state] = params[:state] if params.has_key?(:state)
170
+ query_params[:query] = params[:query] if params.has_key?(:query)
171
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
172
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
173
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
174
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
175
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
176
+
177
+ path = "/applications/#{params[:applicationId]}/events"
178
+
179
+ @client.request(
180
+ method: :get,
181
+ path: path,
182
+ query: query_params,
183
+ headers: headers,
184
+ body: body)
185
+ end
186
+
187
+ # Returns the first new event ordered by severity and then creation
188
+ #
189
+ # Authentication:
190
+ # The client must be configured with a valid api
191
+ # access token to call this action. The token
192
+ # must include at least one of the following scopes:
193
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.mostRecentBySeverity.
194
+ #
195
+ # Parameters:
196
+ # * {string} applicationId - ID associated with the application
197
+ # * {string} filter - Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering.
198
+ # * {hash} query - Event filter JSON object which overrides the filter parameter. (https://api.losant.com/#/definitions/advancedEventQuery)
199
+ # * {string} losantdomain - Domain scope of request (rarely needed)
200
+ # * {boolean} _actions - Return resource actions in response
201
+ # * {boolean} _links - Return resource link in response
202
+ # * {boolean} _embedded - Return embedded resources in response
203
+ #
204
+ # Responses:
205
+ # * 200 - The event, plus count of currently new events (https://api.losant.com/#/definitions/eventPlusNewCount)
206
+ #
207
+ # Errors:
208
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
209
+ def most_recent_by_severity(params = {})
210
+ params = Utils.symbolize_hash_keys(params)
211
+ query_params = { _actions: false, _links: true, _embedded: true }
212
+ headers = {}
213
+ body = nil
214
+
215
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
216
+
217
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
218
+ query_params[:query] = params[:query] if params.has_key?(:query)
219
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
220
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
221
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
222
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
223
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
224
+
225
+ path = "/applications/#{params[:applicationId]}/events/mostRecentBySeverity"
226
+
227
+ @client.request(
228
+ method: :get,
229
+ path: path,
230
+ query: query_params,
231
+ headers: headers,
232
+ body: body)
233
+ end
234
+
235
+ # Asynchronously updates information for matching events by subject and/or current state
236
+ #
237
+ # Authentication:
238
+ # The client must be configured with a valid api
239
+ # access token to call this action. The token
240
+ # must include at least one of the following scopes:
241
+ # all.Application, all.Organization, all.User, events.*, or events.patch.
242
+ #
243
+ # Parameters:
244
+ # * {string} applicationId - ID associated with the application
245
+ # * {string} filterField - Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject
246
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
247
+ # * {string} state - If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved
248
+ # * {hash} query - Event filter JSON object which overrides the filterField, filter, and state parameters. (https://api.losant.com/#/definitions/advancedEventQuery)
249
+ # * {hash} updates - Object containing updated information for the events (https://api.losant.com/#/definitions/eventPatch)
250
+ # * {string} losantdomain - Domain scope of request (rarely needed)
251
+ # * {boolean} _actions - Return resource actions in response
252
+ # * {boolean} _links - Return resource link in response
253
+ # * {boolean} _embedded - Return embedded resources in response
254
+ #
255
+ # Responses:
256
+ # * 200 - If the bulk update has been completed (https://api.losant.com/#/definitions/success)
257
+ # * 202 - If a bulk update job has been enqueued (https://api.losant.com/#/definitions/jobEnqueuedResult)
258
+ #
259
+ # Errors:
260
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
261
+ # * 404 - Error if application is not found (https://api.losant.com/#/definitions/error)
262
+ def patch(params = {})
263
+ params = Utils.symbolize_hash_keys(params)
264
+ query_params = { _actions: false, _links: true, _embedded: true }
265
+ headers = {}
266
+ body = nil
267
+
268
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
269
+ raise ArgumentError.new("updates is required") unless params.has_key?(:updates)
270
+
271
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
272
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
273
+ query_params[:state] = params[:state] if params.has_key?(:state)
274
+ query_params[:query] = params[:query] if params.has_key?(:query)
275
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
276
+ body = params[:updates] if params.has_key?(:updates)
277
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
278
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
279
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
280
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
281
+
282
+ path = "/applications/#{params[:applicationId]}/events"
283
+
284
+ @client.request(
285
+ method: :patch,
286
+ path: path,
287
+ query: query_params,
288
+ headers: headers,
289
+ body: body)
290
+ end
291
+
292
+ # Create a new event for an application
293
+ #
294
+ # Authentication:
295
+ # The client must be configured with a valid api
296
+ # access token to call this action. The token
297
+ # must include at least one of the following scopes:
298
+ # all.Application, all.Organization, all.User, events.*, or events.post.
299
+ #
300
+ # Parameters:
301
+ # * {string} applicationId - ID associated with the application
302
+ # * {hash} event - New event information (https://api.losant.com/#/definitions/eventPost)
303
+ # * {string} losantdomain - Domain scope of request (rarely needed)
304
+ # * {boolean} _actions - Return resource actions in response
305
+ # * {boolean} _links - Return resource link in response
306
+ # * {boolean} _embedded - Return embedded resources in response
307
+ #
308
+ # Responses:
309
+ # * 201 - Successfully created event (https://api.losant.com/#/definitions/event)
310
+ #
311
+ # Errors:
312
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
313
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
314
+ # * 429 - Error if event creation rate limit exceeded (https://api.losant.com/#/definitions/error)
315
+ def post(params = {})
316
+ params = Utils.symbolize_hash_keys(params)
317
+ query_params = { _actions: false, _links: true, _embedded: true }
318
+ headers = {}
319
+ body = nil
320
+
321
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
322
+ raise ArgumentError.new("event is required") unless params.has_key?(:event)
323
+
324
+ body = params[:event] if params.has_key?(:event)
325
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
326
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
327
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
328
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
329
+
330
+ path = "/applications/#{params[:applicationId]}/events"
331
+
332
+ @client.request(
333
+ method: :post,
334
+ path: path,
335
+ query: query_params,
336
+ headers: headers,
337
+ body: body)
338
+ end
339
+
340
+ end
341
+ end