losant_rest 1.19.0 → 1.19.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +872 -38
  3. data/docs/applications.md +49 -0
  4. data/docs/device.md +12 -3
  5. data/docs/me.md +116 -0
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/lib/platform_rest/application.rb +932 -0
  8. data/lib/platform_rest/application_api_token.rb +176 -0
  9. data/lib/platform_rest/application_api_tokens.rb +136 -0
  10. data/lib/platform_rest/application_certificate.rb +176 -0
  11. data/lib/platform_rest/application_certificate_authorities.rb +138 -0
  12. data/lib/platform_rest/application_certificate_authority.rb +176 -0
  13. data/lib/platform_rest/application_certificates.rb +138 -0
  14. data/lib/platform_rest/application_dashboard.rb +225 -0
  15. data/lib/platform_rest/application_dashboards.rb +138 -0
  16. data/lib/platform_rest/application_key.rb +176 -0
  17. data/lib/platform_rest/application_keys.rb +141 -0
  18. data/lib/platform_rest/application_template.rb +79 -0
  19. data/lib/platform_rest/application_templates.rb +176 -0
  20. data/lib/platform_rest/applications.rb +209 -0
  21. data/lib/platform_rest/audit_log.rb +81 -0
  22. data/lib/platform_rest/audit_logs.rb +93 -0
  23. data/lib/platform_rest/auth.rb +245 -0
  24. data/lib/platform_rest/client.rb +410 -0
  25. data/lib/platform_rest/credential.rb +224 -0
  26. data/lib/platform_rest/credentials.rb +138 -0
  27. data/lib/platform_rest/dashboard.rb +268 -0
  28. data/lib/platform_rest/dashboards.rb +136 -0
  29. data/lib/platform_rest/data.rb +176 -0
  30. data/lib/platform_rest/data_table.rb +274 -0
  31. data/lib/platform_rest/data_table_row.rb +182 -0
  32. data/lib/platform_rest/data_table_rows.rb +343 -0
  33. data/lib/platform_rest/data_tables.rb +138 -0
  34. data/lib/platform_rest/device.rb +767 -0
  35. data/lib/platform_rest/device_recipe.rb +234 -0
  36. data/lib/platform_rest/device_recipes.rb +146 -0
  37. data/lib/platform_rest/devices.rb +707 -0
  38. data/lib/platform_rest/edge_deployment.rb +81 -0
  39. data/lib/platform_rest/edge_deployments.rb +236 -0
  40. data/lib/platform_rest/embedded_deployment.rb +81 -0
  41. data/lib/platform_rest/embedded_deployments.rb +280 -0
  42. data/lib/platform_rest/error.rb +34 -0
  43. data/lib/platform_rest/event.rb +176 -0
  44. data/lib/platform_rest/events.rb +341 -0
  45. data/lib/platform_rest/experience.rb +142 -0
  46. data/lib/platform_rest/experience_domain.rb +176 -0
  47. data/lib/platform_rest/experience_domains.rb +126 -0
  48. data/lib/platform_rest/experience_endpoint.rb +230 -0
  49. data/lib/platform_rest/experience_endpoints.rb +200 -0
  50. data/lib/platform_rest/experience_group.rb +180 -0
  51. data/lib/platform_rest/experience_groups.rb +141 -0
  52. data/lib/platform_rest/experience_slug.rb +176 -0
  53. data/lib/platform_rest/experience_slugs.rb +126 -0
  54. data/lib/platform_rest/experience_user.rb +176 -0
  55. data/lib/platform_rest/experience_users.rb +142 -0
  56. data/lib/platform_rest/experience_version.rb +176 -0
  57. data/lib/platform_rest/experience_versions.rb +138 -0
  58. data/lib/platform_rest/experience_view.rb +228 -0
  59. data/lib/platform_rest/experience_views.rb +142 -0
  60. data/lib/platform_rest/file.rb +226 -0
  61. data/lib/platform_rest/files.rb +144 -0
  62. data/lib/platform_rest/flow.rb +580 -0
  63. data/lib/platform_rest/flow_version.rb +352 -0
  64. data/lib/platform_rest/flow_versions.rb +201 -0
  65. data/lib/platform_rest/flows.rb +310 -0
  66. data/lib/platform_rest/instance.rb +377 -0
  67. data/lib/platform_rest/instance_api_token.rb +176 -0
  68. data/lib/platform_rest/instance_api_tokens.rb +136 -0
  69. data/lib/platform_rest/instance_custom_node.rb +282 -0
  70. data/lib/platform_rest/instance_custom_nodes.rb +136 -0
  71. data/lib/platform_rest/instance_member.rb +176 -0
  72. data/lib/platform_rest/instance_members.rb +134 -0
  73. data/lib/platform_rest/instance_org.rb +336 -0
  74. data/lib/platform_rest/instance_org_invite.rb +182 -0
  75. data/lib/platform_rest/instance_org_invites.rb +138 -0
  76. data/lib/platform_rest/instance_org_member.rb +182 -0
  77. data/lib/platform_rest/instance_org_members.rb +138 -0
  78. data/lib/platform_rest/instance_orgs.rb +139 -0
  79. data/lib/platform_rest/instance_sandbox.rb +181 -0
  80. data/lib/platform_rest/instance_sandboxes.rb +98 -0
  81. data/lib/platform_rest/instances.rb +88 -0
  82. data/lib/platform_rest/integration.rb +178 -0
  83. data/lib/platform_rest/integrations.rb +138 -0
  84. data/lib/platform_rest/me.rb +923 -0
  85. data/lib/platform_rest/notebook.rb +423 -0
  86. data/lib/platform_rest/notebooks.rb +138 -0
  87. data/lib/platform_rest/org.rb +663 -0
  88. data/lib/platform_rest/org_invites.rb +124 -0
  89. data/lib/platform_rest/orgs.rb +140 -0
  90. data/lib/platform_rest/resource_job.rb +326 -0
  91. data/lib/platform_rest/resource_jobs.rb +138 -0
  92. data/lib/platform_rest/user_api_token.rb +170 -0
  93. data/lib/platform_rest/user_api_tokens.rb +132 -0
  94. data/lib/platform_rest/utils.rb +44 -0
  95. data/lib/platform_rest/webhook.rb +178 -0
  96. data/lib/platform_rest/webhooks.rb +138 -0
  97. data/lib/platform_rest.rb +129 -0
  98. data/schemas/apiTokenPost.json +4 -0
  99. data/schemas/applicationDashboardPost.json +66 -0
  100. data/schemas/dashboard.json +66 -0
  101. data/schemas/dashboardPatch.json +66 -0
  102. data/schemas/dashboardPost.json +66 -0
  103. data/schemas/dashboards.json +66 -0
  104. data/schemas/deviceConnectionStatus.json +10 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/event.json +8 -0
  107. data/schemas/eventPlusNewCount.json +8 -0
  108. data/schemas/events.json +8 -0
  109. data/schemas/githubLogin.json +4 -0
  110. data/schemas/integrationPatch.json +0 -10
  111. data/schemas/orgInviteActionUser.json +18 -0
  112. data/schemas/orgInviteResultUser.json +18 -0
  113. data/schemas/orgInviteUser.json +51 -0
  114. data/schemas/orgInvitesUser.json +59 -0
  115. data/schemas/payloadCountsBreakdown.json +1 -25
  116. data/schemas/periodSummaries.json +172 -0
  117. data/schemas/samlResponse.json +4 -0
  118. data/schemas/userCredentials.json +4 -0
  119. data/schemas/userPost.json +4 -0
  120. metadata +98 -2
@@ -0,0 +1,200 @@
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 Experience Endpoints Resource
28
+ class ExperienceEndpoints
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the experience endpoints 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.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoints.*, or experienceEndpoints.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount, lastUpdated
45
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: method, route
47
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
48
+ # * {string} experienceGroupId - Filter endpoints to those only in the specified group
49
+ # * {string} requestCountDuration - If set, a count of recent requests is included on each endpoint for the duration requested (milliseconds)
50
+ # * {string} version - Return the experience endpoints belonging to this version
51
+ # * {string} losantdomain - Domain scope of request (rarely needed)
52
+ # * {boolean} _actions - Return resource actions in response
53
+ # * {boolean} _links - Return resource link in response
54
+ # * {boolean} _embedded - Return embedded resources in response
55
+ #
56
+ # Responses:
57
+ # * 200 - Collection of experience endpoints (https://api.losant.com/#/definitions/experienceEndpoints)
58
+ #
59
+ # Errors:
60
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
61
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
62
+ def get(params = {})
63
+ params = Utils.symbolize_hash_keys(params)
64
+ query_params = { _actions: false, _links: true, _embedded: true }
65
+ headers = {}
66
+ body = nil
67
+
68
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
69
+
70
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
71
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
72
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
73
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
74
+ query_params[:experienceGroupId] = params[:experienceGroupId] if params.has_key?(:experienceGroupId)
75
+ query_params[:requestCountDuration] = params[:requestCountDuration] if params.has_key?(:requestCountDuration)
76
+ query_params[:version] = params[:version] if params.has_key?(:version)
77
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
78
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
79
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
80
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
81
+
82
+ path = "/applications/#{params[:applicationId]}/experience/endpoints"
83
+
84
+ @client.request(
85
+ method: :get,
86
+ path: path,
87
+ query: query_params,
88
+ headers: headers,
89
+ body: body)
90
+ end
91
+
92
+ # Create a new experience endpoint for an application
93
+ #
94
+ # Authentication:
95
+ # The client must be configured with a valid api
96
+ # access token to call this action. The token
97
+ # must include at least one of the following scopes:
98
+ # all.Application, all.Organization, all.User, experienceEndpoints.*, or experienceEndpoints.post.
99
+ #
100
+ # Parameters:
101
+ # * {string} applicationId - ID associated with the application
102
+ # * {hash} experienceEndpoint - New experience endpoint information (https://api.losant.com/#/definitions/experienceEndpointPost)
103
+ # * {string} losantdomain - Domain scope of request (rarely needed)
104
+ # * {boolean} _actions - Return resource actions in response
105
+ # * {boolean} _links - Return resource link in response
106
+ # * {boolean} _embedded - Return embedded resources in response
107
+ #
108
+ # Responses:
109
+ # * 201 - Successfully created experience endpoint (https://api.losant.com/#/definitions/experienceEndpoint)
110
+ #
111
+ # Errors:
112
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
113
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
114
+ def post(params = {})
115
+ params = Utils.symbolize_hash_keys(params)
116
+ query_params = { _actions: false, _links: true, _embedded: true }
117
+ headers = {}
118
+ body = nil
119
+
120
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
121
+ raise ArgumentError.new("experienceEndpoint is required") unless params.has_key?(:experienceEndpoint)
122
+
123
+ body = params[:experienceEndpoint] if params.has_key?(:experienceEndpoint)
124
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
125
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
126
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
127
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
128
+
129
+ path = "/applications/#{params[:applicationId]}/experience/endpoints"
130
+
131
+ @client.request(
132
+ method: :post,
133
+ path: path,
134
+ query: query_params,
135
+ headers: headers,
136
+ body: body)
137
+ end
138
+
139
+ # Get statistics about endpoint requests
140
+ #
141
+ # Authentication:
142
+ # The client must be configured with a valid api
143
+ # access token to call this action. The token
144
+ # must include at least one of the following scopes:
145
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoints.*, or experienceEndpoints.stats.
146
+ #
147
+ # Parameters:
148
+ # * {string} applicationId - ID associated with the application
149
+ # * {string} statGrouping - Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain
150
+ # * {string} duration - Duration in milliseconds
151
+ # * {string} end - End of time range in milliseconds since epoch
152
+ # * {string} resolution - Resolution in milliseconds
153
+ # * {string} versionFilter - Filters the stats to a particular experience version
154
+ # * {string} domainFilter - Filters the stats to a particular experience domain or slug
155
+ # * {string} statusCodeFilter - Filters the stats to a particular status code
156
+ # * {string} endpointIdFilter - Filters the stats to a particular endpoint
157
+ # * {string} losantdomain - Domain scope of request (rarely needed)
158
+ # * {boolean} _actions - Return resource actions in response
159
+ # * {boolean} _links - Return resource link in response
160
+ # * {boolean} _embedded - Return embedded resources in response
161
+ #
162
+ # Responses:
163
+ # * 200 - Statistics for endpoint requests (https://api.losant.com/#/definitions/experienceEndpointStats)
164
+ #
165
+ # Errors:
166
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
167
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
168
+ def stats(params = {})
169
+ params = Utils.symbolize_hash_keys(params)
170
+ query_params = { _actions: false, _links: true, _embedded: true }
171
+ headers = {}
172
+ body = nil
173
+
174
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
175
+
176
+ query_params[:statGrouping] = params[:statGrouping] if params.has_key?(:statGrouping)
177
+ query_params[:duration] = params[:duration] if params.has_key?(:duration)
178
+ query_params[:end] = params[:end] if params.has_key?(:end)
179
+ query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
180
+ query_params[:versionFilter] = params[:versionFilter] if params.has_key?(:versionFilter)
181
+ query_params[:domainFilter] = params[:domainFilter] if params.has_key?(:domainFilter)
182
+ query_params[:statusCodeFilter] = params[:statusCodeFilter] if params.has_key?(:statusCodeFilter)
183
+ query_params[:endpointIdFilter] = params[:endpointIdFilter] if params.has_key?(:endpointIdFilter)
184
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
185
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
186
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
187
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
188
+
189
+ path = "/applications/#{params[:applicationId]}/experience/endpoints/stats"
190
+
191
+ @client.request(
192
+ method: :get,
193
+ path: path,
194
+ query: query_params,
195
+ headers: headers,
196
+ body: body)
197
+ end
198
+
199
+ end
200
+ end
@@ -0,0 +1,180 @@
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 Experience Group Resource
28
+ class ExperienceGroup
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Deletes an experience group
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, experienceGroup.*, or experienceGroup.delete.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} experienceGroupId - ID associated with the experience group
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 group 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 group 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("experienceGroupId is required") unless params.has_key?(:experienceGroupId)
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/groups/#{params[:experienceGroupId]}"
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 group
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, experienceGroup.*, or experienceGroup.get.
87
+ #
88
+ # Parameters:
89
+ # * {string} applicationId - ID associated with the application
90
+ # * {string} experienceGroupId - ID associated with the experience group
91
+ # * {string} includeDirectDeviceCount - Whether or not to return count of devices associated directly with this group
92
+ # * {string} includeTotalDeviceCount - Whether or not to return count of devices associated with this group or any of its descendents
93
+ # * {string} losantdomain - Domain scope of request (rarely needed)
94
+ # * {boolean} _actions - Return resource actions in response
95
+ # * {boolean} _links - Return resource link in response
96
+ # * {boolean} _embedded - Return embedded resources in response
97
+ #
98
+ # Responses:
99
+ # * 200 - Experience group information (https://api.losant.com/#/definitions/experienceGroup)
100
+ #
101
+ # Errors:
102
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
103
+ # * 404 - Error if experience group was not found (https://api.losant.com/#/definitions/error)
104
+ def get(params = {})
105
+ params = Utils.symbolize_hash_keys(params)
106
+ query_params = { _actions: false, _links: true, _embedded: true }
107
+ headers = {}
108
+ body = nil
109
+
110
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
111
+ raise ArgumentError.new("experienceGroupId is required") unless params.has_key?(:experienceGroupId)
112
+
113
+ query_params[:includeDirectDeviceCount] = params[:includeDirectDeviceCount] if params.has_key?(:includeDirectDeviceCount)
114
+ query_params[:includeTotalDeviceCount] = params[:includeTotalDeviceCount] if params.has_key?(:includeTotalDeviceCount)
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/groups/#{params[:experienceGroupId]}"
121
+
122
+ @client.request(
123
+ method: :get,
124
+ path: path,
125
+ query: query_params,
126
+ headers: headers,
127
+ body: body)
128
+ end
129
+
130
+ # Updates information about an experience group
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.Organization, all.User, experienceGroup.*, or experienceGroup.patch.
137
+ #
138
+ # Parameters:
139
+ # * {string} applicationId - ID associated with the application
140
+ # * {string} experienceGroupId - ID associated with the experience group
141
+ # * {hash} experienceGroup - Object containing new properties of the experience group (https://api.losant.com/#/definitions/experienceGroupPatch)
142
+ # * {string} losantdomain - Domain scope of request (rarely needed)
143
+ # * {boolean} _actions - Return resource actions in response
144
+ # * {boolean} _links - Return resource link in response
145
+ # * {boolean} _embedded - Return embedded resources in response
146
+ #
147
+ # Responses:
148
+ # * 200 - Updated experience group information (https://api.losant.com/#/definitions/experienceGroup)
149
+ #
150
+ # Errors:
151
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
152
+ # * 404 - Error if experience group was not found (https://api.losant.com/#/definitions/error)
153
+ def patch(params = {})
154
+ params = Utils.symbolize_hash_keys(params)
155
+ query_params = { _actions: false, _links: true, _embedded: true }
156
+ headers = {}
157
+ body = nil
158
+
159
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
160
+ raise ArgumentError.new("experienceGroupId is required") unless params.has_key?(:experienceGroupId)
161
+ raise ArgumentError.new("experienceGroup is required") unless params.has_key?(:experienceGroup)
162
+
163
+ body = params[:experienceGroup] if params.has_key?(:experienceGroup)
164
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
165
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
166
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
167
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
168
+
169
+ path = "/applications/#{params[:applicationId]}/experience/groups/#{params[:experienceGroupId]}"
170
+
171
+ @client.request(
172
+ method: :patch,
173
+ path: path,
174
+ query: query_params,
175
+ headers: headers,
176
+ body: body)
177
+ end
178
+
179
+ end
180
+ end
@@ -0,0 +1,141 @@
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 Experience Groups Resource
28
+ class ExperienceGroups
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Returns the experience groups 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.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceGroups.*, or experienceGroups.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
45
+ # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
+ # * {string} page - Which page of results to return
47
+ # * {string} perPage - How many items to return per page
48
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
+ # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
+ # * {hash} query - Experience group filter JSON object which overrides the filter and filterField fields. (https://api.losant.com/#/definitions/advancedExperienceGroupQuery)
51
+ # * {string} losantdomain - Domain scope of request (rarely needed)
52
+ # * {boolean} _actions - Return resource actions in response
53
+ # * {boolean} _links - Return resource link in response
54
+ # * {boolean} _embedded - Return embedded resources in response
55
+ #
56
+ # Responses:
57
+ # * 200 - Collection of experience groups (https://api.losant.com/#/definitions/experienceGroups)
58
+ #
59
+ # Errors:
60
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
61
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
62
+ def get(params = {})
63
+ params = Utils.symbolize_hash_keys(params)
64
+ query_params = { _actions: false, _links: true, _embedded: true }
65
+ headers = {}
66
+ body = nil
67
+
68
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
69
+
70
+ query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
71
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
72
+ query_params[:page] = params[:page] if params.has_key?(:page)
73
+ query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
74
+ query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
75
+ query_params[:filter] = params[:filter] if params.has_key?(:filter)
76
+ query_params[:query] = params[:query] if params.has_key?(:query)
77
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
78
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
79
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
80
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
81
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
82
+
83
+ path = "/applications/#{params[:applicationId]}/experience/groups"
84
+
85
+ @client.request(
86
+ method: :get,
87
+ path: path,
88
+ query: query_params,
89
+ headers: headers,
90
+ body: body)
91
+ end
92
+
93
+ # Create a new experience group for an application
94
+ #
95
+ # Authentication:
96
+ # The client must be configured with a valid api
97
+ # access token to call this action. The token
98
+ # must include at least one of the following scopes:
99
+ # all.Application, all.Organization, all.User, experienceGroups.*, or experienceGroups.post.
100
+ #
101
+ # Parameters:
102
+ # * {string} applicationId - ID associated with the application
103
+ # * {hash} experienceGroup - New experience group information (https://api.losant.com/#/definitions/experienceGroupPost)
104
+ # * {string} losantdomain - Domain scope of request (rarely needed)
105
+ # * {boolean} _actions - Return resource actions in response
106
+ # * {boolean} _links - Return resource link in response
107
+ # * {boolean} _embedded - Return embedded resources in response
108
+ #
109
+ # Responses:
110
+ # * 201 - Successfully created experience group (https://api.losant.com/#/definitions/experienceGroup)
111
+ #
112
+ # Errors:
113
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
114
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
115
+ def post(params = {})
116
+ params = Utils.symbolize_hash_keys(params)
117
+ query_params = { _actions: false, _links: true, _embedded: true }
118
+ headers = {}
119
+ body = nil
120
+
121
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
122
+ raise ArgumentError.new("experienceGroup is required") unless params.has_key?(:experienceGroup)
123
+
124
+ body = params[:experienceGroup] if params.has_key?(:experienceGroup)
125
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
126
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
127
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
128
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
129
+
130
+ path = "/applications/#{params[:applicationId]}/experience/groups"
131
+
132
+ @client.request(
133
+ method: :post,
134
+ path: path,
135
+ query: query_params,
136
+ headers: headers,
137
+ body: body)
138
+ end
139
+
140
+ end
141
+ end