losant_rest 1.10.1 → 1.11.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +26941 -15658
  4. data/docs/application.md +42 -0
  5. data/docs/applicationApiTokens.md +2 -2
  6. data/docs/applicationCertificateAuthorities.md +1 -1
  7. data/docs/applicationCertificates.md +1 -1
  8. data/docs/applicationKeys.md +1 -1
  9. data/docs/applicationTemplate.md +46 -0
  10. data/docs/applicationTemplates.md +77 -2
  11. data/docs/applications.md +1 -1
  12. data/docs/auditLogs.md +1 -1
  13. data/docs/dashboards.md +1 -1
  14. data/docs/dataTables.md +1 -1
  15. data/docs/device.md +6 -3
  16. data/docs/deviceRecipes.md +1 -1
  17. data/docs/devices.md +217 -5
  18. data/docs/edgeDeployments.md +1 -1
  19. data/docs/events.md +1 -1
  20. data/docs/experienceEndpoints.md +1 -0
  21. data/docs/experienceGroups.md +1 -1
  22. data/docs/experienceUsers.md +1 -1
  23. data/docs/experienceVersions.md +1 -1
  24. data/docs/experienceViews.md +1 -1
  25. data/docs/file.md +4 -4
  26. data/docs/files.md +1 -1
  27. data/docs/flow.md +94 -1
  28. data/docs/flowVersion.md +96 -1
  29. data/docs/flowVersions.md +2 -1
  30. data/docs/flows.md +4 -2
  31. data/docs/integrations.md +1 -1
  32. data/docs/me.md +0 -36
  33. data/docs/notebooks.md +1 -1
  34. data/docs/orgs.md +1 -1
  35. data/docs/webhooks.md +1 -1
  36. data/lib/losant_rest.rb +1 -0
  37. data/lib/losant_rest/application.rb +48 -0
  38. data/lib/losant_rest/application_api_tokens.rb +1 -1
  39. data/lib/losant_rest/application_template.rb +79 -0
  40. data/lib/losant_rest/application_templates.rb +89 -1
  41. data/lib/losant_rest/client.rb +6 -2
  42. data/lib/losant_rest/device.rb +9 -3
  43. data/lib/losant_rest/devices.rb +255 -3
  44. data/lib/losant_rest/experience_endpoints.rb +2 -0
  45. data/lib/losant_rest/file.rb +3 -3
  46. data/lib/losant_rest/flow.rb +115 -1
  47. data/lib/losant_rest/flow_version.rb +115 -1
  48. data/lib/losant_rest/flow_versions.rb +3 -0
  49. data/lib/losant_rest/flows.rb +6 -0
  50. data/lib/losant_rest/me.rb +0 -41
  51. data/lib/losant_rest/version.rb +1 -1
  52. data/schemas/advancedDeviceQuery.json +110 -0
  53. data/schemas/advancedEventQuery.json +198 -0
  54. data/schemas/advancedFlowByVersionQuery.json +665 -0
  55. data/schemas/advancedFlowQuery.json +665 -0
  56. data/schemas/advancedFlowVersionQuery.json +707 -0
  57. data/schemas/advancedQuery.json +22 -0
  58. data/schemas/application.json +8 -0
  59. data/schemas/applicationApiTokenPost.json +11 -1
  60. data/schemas/applicationApplyTemplatePatch.json +19 -0
  61. data/schemas/applicationCreationByTemplateResult.json +8 -0
  62. data/schemas/applicationPost.json +8 -0
  63. data/schemas/applicationTemplate.json +20 -0
  64. data/schemas/applicationTemplateCategories.json +43 -0
  65. data/schemas/applicationTemplateCategory.json +23 -0
  66. data/schemas/applicationTemplates.json +32 -0
  67. data/schemas/applications.json +8 -0
  68. data/schemas/attributeNamesResponse.json +14 -0
  69. data/schemas/authedUser.json +3 -0
  70. data/schemas/changePassword.json +2 -2
  71. data/schemas/dashboard.json +175 -25
  72. data/schemas/dashboardPatch.json +175 -25
  73. data/schemas/dashboardPost.json +175 -25
  74. data/schemas/dashboards.json +175 -25
  75. data/schemas/dataExport.json +142 -0
  76. data/schemas/dataTableRowsExport.json +22 -0
  77. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  78. data/schemas/deviceClassFilter.json +1 -2
  79. data/schemas/devicesDataRemoved.json +12 -0
  80. data/schemas/devicesDeletePost.json +1034 -0
  81. data/schemas/devicesDeleted.json +12 -0
  82. data/schemas/devicesExportPost.json +1035 -0
  83. data/schemas/devicesPatch.json +1757 -4
  84. data/schemas/devicesRemoveDataPost.json +1056 -0
  85. data/schemas/devicesUpdated.json +18 -0
  86. data/schemas/eventPost.json +22 -0
  87. data/schemas/eventsExport.json +198 -0
  88. data/schemas/experienceDomain.json +1 -1
  89. data/schemas/experienceDomainPatch.json +1 -1
  90. data/schemas/experienceDomainPost.json +1 -1
  91. data/schemas/experienceDomains.json +1 -1
  92. data/schemas/experienceLinkedResources.json +96 -0
  93. data/schemas/experienceVersion.json +10 -1
  94. data/schemas/experienceVersionPatch.json +9 -0
  95. data/schemas/experienceVersions.json +10 -1
  96. data/schemas/flow.json +32 -0
  97. data/schemas/flowErrors.json +87 -0
  98. data/schemas/flowPatch.json +32 -0
  99. data/schemas/flowPost.json +32 -0
  100. data/schemas/flowStats.json +54 -0
  101. data/schemas/flowVersion.json +64 -0
  102. data/schemas/flowVersionPost.json +32 -0
  103. data/schemas/flowVersions.json +64 -0
  104. data/schemas/flows.json +32 -0
  105. data/schemas/flowsImportPost.json +64 -0
  106. data/schemas/flowsImportResult.json +96 -0
  107. data/schemas/githubLogin.json +17 -4
  108. data/schemas/integration.json +3 -0
  109. data/schemas/integrationPatch.json +3 -0
  110. data/schemas/integrationPost.json +3 -0
  111. data/schemas/integrations.json +3 -0
  112. data/schemas/me.json +3 -3
  113. data/schemas/mePatch.json +2 -2
  114. data/schemas/multiDeviceCommand.json +1019 -0
  115. data/schemas/notebook.json +96 -0
  116. data/schemas/notebookExecutionLogs.json +7 -0
  117. data/schemas/notebookPatch.json +96 -0
  118. data/schemas/notebookPost.json +96 -0
  119. data/schemas/notebooks.json +96 -0
  120. data/schemas/org.json +1 -1
  121. data/schemas/orgInviteInfo.json +3 -0
  122. data/schemas/orgInvitePost.json +3 -0
  123. data/schemas/orgInvites.json +3 -0
  124. data/schemas/orgPatch.json +1 -1
  125. data/schemas/orgs.json +1 -1
  126. data/schemas/passwordResetFinish.json +2 -2
  127. data/schemas/samlResponse.json +1 -1
  128. data/schemas/tagKeysResponse.json +14 -0
  129. data/schemas/tagValuesResponse.json +19 -0
  130. data/schemas/templateKeywords.json +14 -0
  131. data/schemas/timeSeriesData.json +12 -2
  132. data/schemas/timeSeriesQuery.json +94 -14
  133. data/schemas/userCredentials.json +15 -3
  134. data/schemas/userPost.json +23 -7
  135. metadata +27 -6
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*notebook |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
@@ -33,7 +33,7 @@ all.User, all.User.read, orgs.*, or orgs.get.
33
33
  | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
34
34
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
35
35
  | page | string | N | Which page of results to return | 0 | 0 |
36
- | perPage | string | N | How many items to return per page | 1000 | 10 |
36
+ | perPage | string | N | How many items to return per page | 100 | 10 |
37
37
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
38
38
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*org |
39
39
  | summaryExclude | string | N | Comma-separated list of summary fields to exclude from org summaries | | payloadCount |
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
34
34
  | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
- | perPage | string | N | How many items to return per page | 1000 | 10 |
37
+ | perPage | string | N | How many items to return per page | 100 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*webhook |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
@@ -32,6 +32,7 @@ require_relative "losant_rest/application_certificate_authority"
32
32
  require_relative "losant_rest/application_certificates"
33
33
  require_relative "losant_rest/application_key"
34
34
  require_relative "losant_rest/application_keys"
35
+ require_relative "losant_rest/application_template"
35
36
  require_relative "losant_rest/application_templates"
36
37
  require_relative "losant_rest/applications"
37
38
  require_relative "losant_rest/audit_log"
@@ -31,6 +31,54 @@ module LosantRest
31
31
  @client = client
32
32
  end
33
33
 
34
+ # Add resources to an application via an application template
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, application.*, or application.applyTemplate.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID of the associated application
44
+ # * {hash} options - Object containing template import options (https://api.losant.com/#/definitions/applicationApplyTemplatePatch)
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 - Updated application information (https://api.losant.com/#/definitions/application)
52
+ # * 202 - If a job was enqueued for the resources to be imported into the application (https://api.losant.com/#/definitions/jobEnqueuedResult)
53
+ #
54
+ # Errors:
55
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
56
+ # * 404 - Error if application is not found (https://api.losant.com/#/definitions/error)
57
+ def apply_template(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("options is required") unless params.has_key?(:options)
65
+
66
+ body = params[:options] if params.has_key?(:options)
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]}/applyTemplate"
73
+
74
+ @client.request(
75
+ method: :patch,
76
+ path: path,
77
+ query: query_params,
78
+ headers: headers,
79
+ body: body)
80
+ end
81
+
34
82
  # Returns success when a job has been enqueued to archive this application's device data for a given day
35
83
  #
36
84
  # Authentication:
@@ -41,7 +41,7 @@ module LosantRest
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
44
- # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate
45
45
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
46
  # * {string} page - Which page of results to return
47
47
  # * {string} perPage - How many items to return per page
@@ -0,0 +1,79 @@
1
+ # The MIT License (MIT)
2
+ #
3
+ # Copyright (c) 2020 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 Application Template Resource
28
+ class ApplicationTemplate
29
+
30
+ def initialize(client)
31
+ @client = client
32
+ end
33
+
34
+ # Retrieves information on an application template
35
+ #
36
+ # Authentication:
37
+ # The client must be configured with a valid api
38
+ # access token to call this action. The token
39
+ # must include at least one of the following scopes:
40
+ # all.User, all.User.read, applicationTemplate.*, or applicationTemplate.get.
41
+ #
42
+ # Parameters:
43
+ # * {string} templateId - ID associated with the template
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 - Application template information (https://api.losant.com/#/definitions/applicationTemplate)
51
+ #
52
+ # Errors:
53
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
54
+ # * 404 - Error if template 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("templateId is required") unless params.has_key?(:templateId)
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 = "/applicationTemplates/#{params[:templateId]}"
69
+
70
+ @client.request(
71
+ method: :get,
72
+ path: path,
73
+ query: query_params,
74
+ headers: headers,
75
+ body: body)
76
+ end
77
+
78
+ end
79
+ end
@@ -44,8 +44,10 @@ module LosantRest
44
44
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
45
45
  # * {string} page - Which page of results to return
46
46
  # * {string} perPage - How many items to return per page
47
- # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
47
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, authorName
48
48
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
49
+ # * {array} keywords - List of keywords to filter by. Matches all provided keywords.
50
+ # * {string} categoryId - ID of a category to filter by.
49
51
  # * {string} losantdomain - Domain scope of request (rarely needed)
50
52
  # * {boolean} _actions - Return resource actions in response
51
53
  # * {boolean} _links - Return resource link in response
@@ -69,6 +71,8 @@ module LosantRest
69
71
  query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
70
72
  query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
71
73
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
74
+ query_params[:keywords] = params[:keywords] if params.has_key?(:keywords)
75
+ query_params[:categoryId] = params[:categoryId] if params.has_key?(:categoryId)
72
76
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
73
77
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
74
78
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -84,5 +88,89 @@ module LosantRest
84
88
  body: body)
85
89
  end
86
90
 
91
+ # Returns a category list, beginning at the specified category
92
+ #
93
+ # Authentication:
94
+ # The client must be configured with a valid api
95
+ # access token to call this action. The token
96
+ # must include at least one of the following scopes:
97
+ # all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getCategories.
98
+ #
99
+ # Parameters:
100
+ # * {string} baseId - ID of the category to begin from
101
+ # * {string} losantdomain - Domain scope of request (rarely needed)
102
+ # * {boolean} _actions - Return resource actions in response
103
+ # * {boolean} _links - Return resource link in response
104
+ # * {boolean} _embedded - Return embedded resources in response
105
+ #
106
+ # Responses:
107
+ # * 200 - Collection of application categories (https://api.losant.com/#/definitions/applicationTemplateCategories)
108
+ #
109
+ # Errors:
110
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
111
+ def get_categories(params = {})
112
+ params = Utils.symbolize_hash_keys(params)
113
+ query_params = { _actions: false, _links: true, _embedded: true }
114
+ headers = {}
115
+ body = nil
116
+
117
+
118
+ query_params[:baseId] = params[:baseId] if params.has_key?(:baseId)
119
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
120
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
121
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
122
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
123
+
124
+ path = "/applicationTemplates/categories"
125
+
126
+ @client.request(
127
+ method: :get,
128
+ path: path,
129
+ query: query_params,
130
+ headers: headers,
131
+ body: body)
132
+ end
133
+
134
+ # Returns an array of all unique keywords currently in use by templates
135
+ #
136
+ # Authentication:
137
+ # The client must be configured with a valid api
138
+ # access token to call this action. The token
139
+ # must include at least one of the following scopes:
140
+ # all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getUniqueKeywords.
141
+ #
142
+ # Parameters:
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 - Array of all unique template keywords (https://api.losant.com/#/definitions/templateKeywords)
150
+ #
151
+ # Errors:
152
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
153
+ def get_unique_keywords(params = {})
154
+ params = Utils.symbolize_hash_keys(params)
155
+ query_params = { _actions: false, _links: true, _embedded: true }
156
+ headers = {}
157
+ body = nil
158
+
159
+
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 = "/applicationTemplates/keywords"
166
+
167
+ @client.request(
168
+ method: :get,
169
+ path: path,
170
+ query: query_params,
171
+ headers: headers,
172
+ body: body)
173
+ end
174
+
87
175
  end
88
176
  end
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.17.1
30
+ # Built For Version 1.18.1
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -72,6 +72,10 @@ module LosantRest
72
72
  @application_keys ||= ApplicationKeys.new(self)
73
73
  end
74
74
 
75
+ def application_template
76
+ @application_template ||= ApplicationTemplate.new(self)
77
+ end
78
+
75
79
  def application_templates
76
80
  @application_templates ||= ApplicationTemplates.new(self)
77
81
  end
@@ -278,7 +282,7 @@ module LosantRest
278
282
 
279
283
  headers["Accept"] = "application/json"
280
284
  headers["Content-Type"] = "application/json"
281
- headers["Accept-Version"] = "^1.17.1"
285
+ headers["Accept-Version"] = "^1.18.1"
282
286
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
283
287
  path = self.url + options.fetch(:path, "")
284
288
 
@@ -192,8 +192,9 @@ module LosantRest
192
192
  # Parameters:
193
193
  # * {string} applicationId - ID associated with the application
194
194
  # * {string} deviceId - ID associated with the device
195
- # * {string} limit - Max command entries to return (ordered by time descending)
195
+ # * {string} limit - Maximum number of command entries to return
196
196
  # * {string} since - Look for command entries since this time (ms since epoch)
197
+ # * {string} sortDirection - Direction to sort the command entries (by time). Accepted values are: asc, desc
197
198
  # * {string} losantdomain - Domain scope of request (rarely needed)
198
199
  # * {boolean} _actions - Return resource actions in response
199
200
  # * {boolean} _links - Return resource link in response
@@ -216,6 +217,7 @@ module LosantRest
216
217
 
217
218
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
218
219
  query_params[:since] = params[:since] if params.has_key?(:since)
220
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
219
221
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
220
222
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
221
223
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -294,8 +296,9 @@ module LosantRest
294
296
  # Parameters:
295
297
  # * {string} applicationId - ID associated with the application
296
298
  # * {string} deviceId - ID associated with the device
297
- # * {string} limit - Max log entries to return (ordered by time descending)
299
+ # * {string} limit - Maximum number of log entries to return
298
300
  # * {string} since - Look for log entries since this time (ms since epoch)
301
+ # * {string} sortDirection - Direction to sort the log entries (by time). Accepted values are: asc, desc
299
302
  # * {string} losantdomain - Domain scope of request (rarely needed)
300
303
  # * {boolean} _actions - Return resource actions in response
301
304
  # * {boolean} _links - Return resource link in response
@@ -318,6 +321,7 @@ module LosantRest
318
321
 
319
322
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
320
323
  query_params[:since] = params[:since] if params.has_key?(:since)
324
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
321
325
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
322
326
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
323
327
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -344,8 +348,9 @@ module LosantRest
344
348
  # Parameters:
345
349
  # * {string} applicationId - ID associated with the application
346
350
  # * {string} deviceId - ID associated with the device
347
- # * {string} limit - Max state entries to return (ordered by time descending)
351
+ # * {string} limit - Maximum number of state entries to return
348
352
  # * {string} since - Look for state entries since this time (ms since epoch)
353
+ # * {string} sortDirection - Direction to sort the state entries (by time). Accepted values are: asc, desc
349
354
  # * {string} losantdomain - Domain scope of request (rarely needed)
350
355
  # * {boolean} _actions - Return resource actions in response
351
356
  # * {boolean} _links - Return resource link in response
@@ -368,6 +373,7 @@ module LosantRest
368
373
 
369
374
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
370
375
  query_params[:since] = params[:since] if params.has_key?(:since)
376
+ query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
371
377
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
372
378
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
373
379
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -31,6 +31,105 @@ module LosantRest
31
31
  @client = client
32
32
  end
33
33
 
34
+ # Gets the attribute names that match the given query. Maximum 1K returned.
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, devices.*, or devices.attributeNames.
41
+ #
42
+ # Parameters:
43
+ # * {string} applicationId - ID associated with the application
44
+ # * {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
45
+ # * {hash} dataType - Filter the devices by the given attribute data type or types (https://api.losant.com/#/definitions/deviceAttributeDataTypeFilter)
46
+ # * {string} startsWith - Filter attributes down to those that have names starting with the given string. Case insensitive.
47
+ # * {string} losantdomain - Domain scope of request (rarely needed)
48
+ # * {boolean} _actions - Return resource actions in response
49
+ # * {boolean} _links - Return resource link in response
50
+ # * {boolean} _embedded - Return embedded resources in response
51
+ #
52
+ # Responses:
53
+ # * 200 - The matching attribute names (https://api.losant.com/#/definitions/attributeNamesResponse)
54
+ #
55
+ # Errors:
56
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
57
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
58
+ def attribute_names(params = {})
59
+ params = Utils.symbolize_hash_keys(params)
60
+ query_params = { _actions: false, _links: true, _embedded: true }
61
+ headers = {}
62
+ body = nil
63
+
64
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
65
+
66
+ query_params[:query] = params[:query] if params.has_key?(:query)
67
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
68
+ query_params[:dataType] = params[:dataType] if params.has_key?(:dataType)
69
+ query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
70
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
71
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
72
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
73
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
74
+
75
+ path = "/applications/#{params[:applicationId]}/devices/attributeNames"
76
+
77
+ @client.request(
78
+ method: :get,
79
+ path: path,
80
+ query: query_params,
81
+ headers: headers,
82
+ body: body)
83
+ end
84
+
85
+ # Delete devices
86
+ #
87
+ # Authentication:
88
+ # The client must be configured with a valid api
89
+ # access token to call this action. The token
90
+ # must include at least one of the following scopes:
91
+ # all.Application, all.Organization, all.User, devices.*, or devices.delete.
92
+ #
93
+ # Parameters:
94
+ # * {string} applicationId - ID associated with the application
95
+ # * {hash} options - Object containing device query and email (https://api.losant.com/#/definitions/devicesDeletePost)
96
+ # * {string} losantdomain - Domain scope of request (rarely needed)
97
+ # * {boolean} _actions - Return resource actions in response
98
+ # * {boolean} _links - Return resource link in response
99
+ # * {boolean} _embedded - Return embedded resources in response
100
+ #
101
+ # Responses:
102
+ # * 200 - Object indicating number of devices deleted or failed (https://api.losant.com/#/definitions/devicesDeleted)
103
+ # * 202 - If a job was enqueued for the devices to be deleted (https://api.losant.com/#/definitions/jobEnqueuedResult)
104
+ #
105
+ # Errors:
106
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
107
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
108
+ def delete(params = {})
109
+ params = Utils.symbolize_hash_keys(params)
110
+ query_params = { _actions: false, _links: true, _embedded: true }
111
+ headers = {}
112
+ body = nil
113
+
114
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
115
+ raise ArgumentError.new("options is required") unless params.has_key?(:options)
116
+
117
+ body = params[:options] if params.has_key?(:options)
118
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
119
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
120
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
121
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
122
+
123
+ path = "/applications/#{params[:applicationId]}/devices/delete"
124
+
125
+ @client.request(
126
+ method: :post,
127
+ path: path,
128
+ query: query_params,
129
+ headers: headers,
130
+ body: body)
131
+ end
132
+
34
133
  # Creates an export of all device metadata
35
134
  #
36
135
  # Authentication:
@@ -43,6 +142,7 @@ module LosantRest
43
142
  # * {string} applicationId - ID associated with the application
44
143
  # * {string} email - Email address to send export to. Defaults to current user's email.
45
144
  # * {string} callbackUrl - Callback URL to call with export result
145
+ # * {hash} options - Object containing device query and optionally email or callback (https://api.losant.com/#/definitions/devicesExportPost)
46
146
  # * {string} losantdomain - Domain scope of request (rarely needed)
47
147
  # * {boolean} _actions - Return resource actions in response
48
148
  # * {boolean} _links - Return resource link in response
@@ -64,6 +164,7 @@ module LosantRest
64
164
 
65
165
  query_params[:email] = params[:email] if params.has_key?(:email)
66
166
  query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
167
+ body = params[:options] if params.has_key?(:options)
67
168
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
68
169
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
69
170
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -99,7 +200,7 @@ module LosantRest
99
200
  # * {hash} tagFilter - Array of tag pairs to filter by (https://api.losant.com/#/definitions/deviceTagFilter)
100
201
  # * {string} excludeConnectionInfo - If set, do not return connection info
101
202
  # * {string} parentId - Filter devices as children of a given system id
102
- # * {hash} query - Device filter JSON object which overides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
203
+ # * {hash} query - Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
103
204
  # * {string} losantdomain - Domain scope of request (rarely needed)
104
205
  # * {boolean} _actions - Return resource actions in response
105
206
  # * {boolean} _links - Return resource link in response
@@ -156,14 +257,15 @@ module LosantRest
156
257
  #
157
258
  # Parameters:
158
259
  # * {string} applicationId - ID associated with the application
159
- # * {hash} patchInfo - Object containing device filter fields and updated properties (https://api.losant.com/#/definitions/devicesPatch)
260
+ # * {hash} patchInfo - Object containing device query or IDs and update operations (https://api.losant.com/#/definitions/devicesPatch)
160
261
  # * {string} losantdomain - Domain scope of request (rarely needed)
161
262
  # * {boolean} _actions - Return resource actions in response
162
263
  # * {boolean} _links - Return resource link in response
163
264
  # * {boolean} _embedded - Return embedded resources in response
164
265
  #
165
266
  # Responses:
166
- # * 201 - Successfully queued bulk update job (https://api.losant.com/#/definitions/success)
267
+ # * 200 - Object including an update log link and the number of devices updated, failed, and skipped (https://api.losant.com/#/definitions/devicesUpdated)
268
+ # * 202 - Successfully queued bulk update job (https://api.losant.com/#/definitions/jobEnqueuedResult)
167
269
  #
168
270
  # Errors:
169
271
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -175,6 +277,7 @@ module LosantRest
175
277
  body = nil
176
278
 
177
279
  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
280
+ raise ArgumentError.new("patchInfo is required") unless params.has_key?(:patchInfo)
178
281
 
179
282
  body = params[:patchInfo] if params.has_key?(:patchInfo)
180
283
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
@@ -239,6 +342,54 @@ module LosantRest
239
342
  body: body)
240
343
  end
241
344
 
345
+ # Removes all device data for the specified time range. Defaults to all data.
346
+ #
347
+ # Authentication:
348
+ # The client must be configured with a valid api
349
+ # access token to call this action. The token
350
+ # must include at least one of the following scopes:
351
+ # all.Application, all.Organization, all.User, devices.*, or devices.removeData.
352
+ #
353
+ # Parameters:
354
+ # * {string} applicationId - ID associated with the application
355
+ # * {hash} options - Object defining the device data to delete and devices to delete from (https://api.losant.com/#/definitions/devicesRemoveDataPost)
356
+ # * {string} losantdomain - Domain scope of request (rarely needed)
357
+ # * {boolean} _actions - Return resource actions in response
358
+ # * {boolean} _links - Return resource link in response
359
+ # * {boolean} _embedded - Return embedded resources in response
360
+ #
361
+ # Responses:
362
+ # * 200 - Object indicating number of devices completed or skipped (https://api.losant.com/#/definitions/devicesDataRemoved)
363
+ # * 202 - If a job was enqueued for device data to be removed (https://api.losant.com/#/definitions/jobEnqueuedResult)
364
+ #
365
+ # Errors:
366
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
367
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
368
+ def remove_data(params = {})
369
+ params = Utils.symbolize_hash_keys(params)
370
+ query_params = { _actions: false, _links: true, _embedded: true }
371
+ headers = {}
372
+ body = nil
373
+
374
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
375
+ raise ArgumentError.new("options is required") unless params.has_key?(:options)
376
+
377
+ body = params[:options] if params.has_key?(:options)
378
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
379
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
380
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
381
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
382
+
383
+ path = "/applications/#{params[:applicationId]}/devices/removeData"
384
+
385
+ @client.request(
386
+ method: :post,
387
+ path: path,
388
+ query: query_params,
389
+ headers: headers,
390
+ body: body)
391
+ end
392
+
242
393
  # Send a command to multiple devices
243
394
  #
244
395
  # Authentication:
@@ -286,5 +437,106 @@ module LosantRest
286
437
  body: body)
287
438
  end
288
439
 
440
+ # Gets the unique tag keys for devices that match the given query. Maximum 1K returned.
441
+ #
442
+ # Authentication:
443
+ # The client must be configured with a valid api
444
+ # access token to call this action. The token
445
+ # must include at least one of the following scopes:
446
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagKeys.
447
+ #
448
+ # Parameters:
449
+ # * {string} applicationId - ID associated with the application
450
+ # * {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
451
+ # * {string} startsWith - Filter keys down to those that start with the given string. Case insensitive.
452
+ # * {string} losantdomain - Domain scope of request (rarely needed)
453
+ # * {boolean} _actions - Return resource actions in response
454
+ # * {boolean} _links - Return resource link in response
455
+ # * {boolean} _embedded - Return embedded resources in response
456
+ #
457
+ # Responses:
458
+ # * 200 - The matching tag keys (https://api.losant.com/#/definitions/tagKeysResponse)
459
+ #
460
+ # Errors:
461
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
462
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
463
+ def tag_keys(params = {})
464
+ params = Utils.symbolize_hash_keys(params)
465
+ query_params = { _actions: false, _links: true, _embedded: true }
466
+ headers = {}
467
+ body = nil
468
+
469
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
470
+
471
+ query_params[:query] = params[:query] if params.has_key?(:query)
472
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
473
+ query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
474
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
475
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
476
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
477
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
478
+
479
+ path = "/applications/#{params[:applicationId]}/devices/tagKeys"
480
+
481
+ @client.request(
482
+ method: :get,
483
+ path: path,
484
+ query: query_params,
485
+ headers: headers,
486
+ body: body)
487
+ end
488
+
489
+ # Gets the unique tag values for the given key for devices that match the given query. Maximum 1K returned.
490
+ #
491
+ # Authentication:
492
+ # The client must be configured with a valid api
493
+ # access token to call this action. The token
494
+ # must include at least one of the following scopes:
495
+ # all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagValues.
496
+ #
497
+ # Parameters:
498
+ # * {string} applicationId - ID associated with the application
499
+ # * {hash} query - Device filter JSON object (https://api.losant.com/#/definitions/advancedDeviceQuery)
500
+ # * {string} key - The tag key to get the values for
501
+ # * {string} startsWith - Filter values down to those that start with the given string. Case insensitive.
502
+ # * {string} losantdomain - Domain scope of request (rarely needed)
503
+ # * {boolean} _actions - Return resource actions in response
504
+ # * {boolean} _links - Return resource link in response
505
+ # * {boolean} _embedded - Return embedded resources in response
506
+ #
507
+ # Responses:
508
+ # * 200 - The matching tag values (https://api.losant.com/#/definitions/tagValuesResponse)
509
+ #
510
+ # Errors:
511
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
512
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
513
+ def tag_values(params = {})
514
+ params = Utils.symbolize_hash_keys(params)
515
+ query_params = { _actions: false, _links: true, _embedded: true }
516
+ headers = {}
517
+ body = nil
518
+
519
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
520
+ raise ArgumentError.new("key is required") unless params.has_key?(:key)
521
+
522
+ query_params[:query] = params[:query] if params.has_key?(:query)
523
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
524
+ query_params[:key] = params[:key] if params.has_key?(:key)
525
+ query_params[:startsWith] = params[:startsWith] if params.has_key?(:startsWith)
526
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
527
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
528
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
529
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
530
+
531
+ path = "/applications/#{params[:applicationId]}/devices/tagValues"
532
+
533
+ @client.request(
534
+ method: :get,
535
+ path: path,
536
+ query: query_params,
537
+ headers: headers,
538
+ body: body)
539
+ end
540
+
289
541
  end
290
542
  end