artikcloud 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +4 -0
  3. data/Gemfile.lock +65 -0
  4. data/LICENSE +202 -0
  5. data/README.md +230 -0
  6. data/artikcloud.gemspec +32 -0
  7. data/docs/AckEnvelope.md +8 -0
  8. data/docs/Acknowledgement.md +11 -0
  9. data/docs/ActionDetails.md +9 -0
  10. data/docs/ActionDetailsArray.md +8 -0
  11. data/docs/ActionIn.md +13 -0
  12. data/docs/ActionOut.md +12 -0
  13. data/docs/AggregateData.md +13 -0
  14. data/docs/AggregatesHistogramData.md +14 -0
  15. data/docs/AggregatesHistogramResponse.md +14 -0
  16. data/docs/AggregatesResponse.md +13 -0
  17. data/docs/AppProperties.md +10 -0
  18. data/docs/CheckTokenMessage.md +8 -0
  19. data/docs/CheckTokenResponse.md +8 -0
  20. data/docs/Device.md +21 -0
  21. data/docs/DeviceArray.md +8 -0
  22. data/docs/DeviceEnvelope.md +8 -0
  23. data/docs/DeviceRegCompleteRequest.md +8 -0
  24. data/docs/DeviceRegConfirmUserRequest.md +10 -0
  25. data/docs/DeviceRegConfirmUserResponse.md +8 -0
  26. data/docs/DeviceRegConfirmUserResponseEnvelope.md +8 -0
  27. data/docs/DeviceRegStatusResponse.md +9 -0
  28. data/docs/DeviceRegStatusResponseEnvelope.md +8 -0
  29. data/docs/DeviceToken.md +11 -0
  30. data/docs/DeviceTokenEnvelope.md +8 -0
  31. data/docs/DeviceType.md +25 -0
  32. data/docs/DeviceTypeArray.md +8 -0
  33. data/docs/DeviceTypeEnvelope.md +8 -0
  34. data/docs/DeviceTypesApi.md +284 -0
  35. data/docs/DeviceTypesEnvelope.md +11 -0
  36. data/docs/DevicesApi.md +382 -0
  37. data/docs/DevicesEnvelope.md +11 -0
  38. data/docs/ErrorEnvelope.md +8 -0
  39. data/docs/ExportApi.md +225 -0
  40. data/docs/ExportData.md +14 -0
  41. data/docs/ExportDataArray.md +8 -0
  42. data/docs/ExportHistoryResponse.md +11 -0
  43. data/docs/ExportNormalizedMessagesResponse.md +20 -0
  44. data/docs/ExportRequest.md +15 -0
  45. data/docs/ExportRequestData.md +18 -0
  46. data/docs/ExportRequestInfo.md +17 -0
  47. data/docs/ExportRequestResponse.md +8 -0
  48. data/docs/ExportResponse.md +18 -0
  49. data/docs/ExportStatusResponse.md +12 -0
  50. data/docs/FieldPath.md +8 -0
  51. data/docs/FieldPresence.md +8 -0
  52. data/docs/FieldPresenceEnvelope.md +14 -0
  53. data/docs/FieldsActions.md +9 -0
  54. data/docs/ManifestProperties.md +8 -0
  55. data/docs/ManifestPropertiesEnvelope.md +8 -0
  56. data/docs/ManifestVersions.md +8 -0
  57. data/docs/ManifestVersionsEnvelope.md +8 -0
  58. data/docs/MessageAction.md +12 -0
  59. data/docs/MessageID.md +8 -0
  60. data/docs/MessageIDEnvelope.md +8 -0
  61. data/docs/MessageIn.md +13 -0
  62. data/docs/MessageOut.md +12 -0
  63. data/docs/MessagesApi.md +382 -0
  64. data/docs/NonEmptyString.md +8 -0
  65. data/docs/NormalizedMessage.md +15 -0
  66. data/docs/NormalizedMessagesEnvelope.md +17 -0
  67. data/docs/OutputRule.md +21 -0
  68. data/docs/PropertiesEnvelope.md +8 -0
  69. data/docs/RefreshTokenResponse.md +11 -0
  70. data/docs/RegisterMessage.md +12 -0
  71. data/docs/RegistrationsApi.md +167 -0
  72. data/docs/RuleArray.md +8 -0
  73. data/docs/RuleCreationInfo.md +11 -0
  74. data/docs/RuleEnvelope.md +8 -0
  75. data/docs/RuleError.md +11 -0
  76. data/docs/RuleUpdateInfo.md +11 -0
  77. data/docs/RuleWarningOutput.md +9 -0
  78. data/docs/RulesApi.md +226 -0
  79. data/docs/RulesEnvelope.md +11 -0
  80. data/docs/Tag.md +9 -0
  81. data/docs/TagArray.md +8 -0
  82. data/docs/TagsApi.md +169 -0
  83. data/docs/TagsEnvelope.md +8 -0
  84. data/docs/Token.md +11 -0
  85. data/docs/TokenRequest.md +8 -0
  86. data/docs/TokenResponse.md +8 -0
  87. data/docs/TokensApi.md +117 -0
  88. data/docs/UnregisterDeviceResponse.md +18 -0
  89. data/docs/UnregisterDeviceResponseEnvelope.md +8 -0
  90. data/docs/User.md +14 -0
  91. data/docs/UserEnvelope.md +8 -0
  92. data/docs/UsersApi.md +474 -0
  93. data/docs/WebSocketError.md +10 -0
  94. data/git_push.sh +52 -0
  95. data/lib/artikcloud/api/device_types_api.rb +340 -0
  96. data/lib/artikcloud/api/devices_api.rb +450 -0
  97. data/lib/artikcloud/api/export_api.rb +269 -0
  98. data/lib/artikcloud/api/messages_api.rb +468 -0
  99. data/lib/artikcloud/api/registrations_api.rb +205 -0
  100. data/lib/artikcloud/api/rules_api.rb +276 -0
  101. data/lib/artikcloud/api/tags_api.rb +209 -0
  102. data/lib/artikcloud/api/tokens_api.rb +152 -0
  103. data/lib/artikcloud/api/users_api.rb +552 -0
  104. data/lib/artikcloud/api_client.rb +336 -0
  105. data/lib/artikcloud/api_error.rb +38 -0
  106. data/lib/artikcloud/configuration.rb +170 -0
  107. data/lib/artikcloud/models/ack_envelope.rb +164 -0
  108. data/lib/artikcloud/models/acknowledgement.rb +198 -0
  109. data/lib/artikcloud/models/action_details.rb +178 -0
  110. data/lib/artikcloud/models/action_details_array.rb +166 -0
  111. data/lib/artikcloud/models/action_in.rb +221 -0
  112. data/lib/artikcloud/models/action_out.rb +209 -0
  113. data/lib/artikcloud/models/aggregate_data.rb +214 -0
  114. data/lib/artikcloud/models/aggregates_histogram_data.rb +224 -0
  115. data/lib/artikcloud/models/aggregates_histogram_response.rb +226 -0
  116. data/lib/artikcloud/models/aggregates_response.rb +216 -0
  117. data/lib/artikcloud/models/app_properties.rb +184 -0
  118. data/lib/artikcloud/models/check_token_message.rb +164 -0
  119. data/lib/artikcloud/models/check_token_response.rb +164 -0
  120. data/lib/artikcloud/models/device.rb +310 -0
  121. data/lib/artikcloud/models/device_array.rb +166 -0
  122. data/lib/artikcloud/models/device_envelope.rb +164 -0
  123. data/lib/artikcloud/models/device_reg_complete_request.rb +165 -0
  124. data/lib/artikcloud/models/device_reg_confirm_user_request.rb +187 -0
  125. data/lib/artikcloud/models/device_reg_confirm_user_response.rb +165 -0
  126. data/lib/artikcloud/models/device_reg_confirm_user_response_envelope.rb +164 -0
  127. data/lib/artikcloud/models/device_reg_status_response.rb +176 -0
  128. data/lib/artikcloud/models/device_reg_status_response_envelope.rb +164 -0
  129. data/lib/artikcloud/models/device_token.rb +194 -0
  130. data/lib/artikcloud/models/device_token_envelope.rb +164 -0
  131. data/lib/artikcloud/models/device_type.rb +353 -0
  132. data/lib/artikcloud/models/device_type_array.rb +166 -0
  133. data/lib/artikcloud/models/device_type_envelope.rb +164 -0
  134. data/lib/artikcloud/models/device_types_envelope.rb +194 -0
  135. data/lib/artikcloud/models/devices_envelope.rb +194 -0
  136. data/lib/artikcloud/models/error_envelope.rb +165 -0
  137. data/lib/artikcloud/models/export_data.rb +225 -0
  138. data/lib/artikcloud/models/export_data_array.rb +166 -0
  139. data/lib/artikcloud/models/export_history_response.rb +194 -0
  140. data/lib/artikcloud/models/export_normalized_messages_response.rb +284 -0
  141. data/lib/artikcloud/models/export_request.rb +234 -0
  142. data/lib/artikcloud/models/export_request_data.rb +275 -0
  143. data/lib/artikcloud/models/export_request_info.rb +264 -0
  144. data/lib/artikcloud/models/export_request_response.rb +164 -0
  145. data/lib/artikcloud/models/export_response.rb +275 -0
  146. data/lib/artikcloud/models/export_status_response.rb +205 -0
  147. data/lib/artikcloud/models/field_path.rb +166 -0
  148. data/lib/artikcloud/models/field_presence.rb +164 -0
  149. data/lib/artikcloud/models/field_presence_envelope.rb +226 -0
  150. data/lib/artikcloud/models/fields_actions.rb +180 -0
  151. data/lib/artikcloud/models/manifest_properties.rb +164 -0
  152. data/lib/artikcloud/models/manifest_properties_envelope.rb +164 -0
  153. data/lib/artikcloud/models/manifest_versions.rb +166 -0
  154. data/lib/artikcloud/models/manifest_versions_envelope.rb +164 -0
  155. data/lib/artikcloud/models/message_action.rb +210 -0
  156. data/lib/artikcloud/models/message_id.rb +165 -0
  157. data/lib/artikcloud/models/message_id_envelope.rb +164 -0
  158. data/lib/artikcloud/models/message_in.rb +224 -0
  159. data/lib/artikcloud/models/message_out.rb +209 -0
  160. data/lib/artikcloud/models/non_empty_string.rb +164 -0
  161. data/lib/artikcloud/models/normalized_message.rb +236 -0
  162. data/lib/artikcloud/models/normalized_messages_envelope.rb +256 -0
  163. data/lib/artikcloud/models/output_rule.rb +296 -0
  164. data/lib/artikcloud/models/properties_envelope.rb +164 -0
  165. data/lib/artikcloud/models/refresh_token_response.rb +194 -0
  166. data/lib/artikcloud/models/register_message.rb +211 -0
  167. data/lib/artikcloud/models/rule_array.rb +166 -0
  168. data/lib/artikcloud/models/rule_creation_info.rb +200 -0
  169. data/lib/artikcloud/models/rule_envelope.rb +164 -0
  170. data/lib/artikcloud/models/rule_error.rb +196 -0
  171. data/lib/artikcloud/models/rule_update_info.rb +200 -0
  172. data/lib/artikcloud/models/rule_warning_output.rb +174 -0
  173. data/lib/artikcloud/models/rules_envelope.rb +194 -0
  174. data/lib/artikcloud/models/tag.rb +176 -0
  175. data/lib/artikcloud/models/tag_array.rb +166 -0
  176. data/lib/artikcloud/models/tags_envelope.rb +164 -0
  177. data/lib/artikcloud/models/token.rb +194 -0
  178. data/lib/artikcloud/models/token_request.rb +164 -0
  179. data/lib/artikcloud/models/token_response.rb +164 -0
  180. data/lib/artikcloud/models/unregister_device_response.rb +275 -0
  181. data/lib/artikcloud/models/unregister_device_response_envelope.rb +164 -0
  182. data/lib/artikcloud/models/user.rb +224 -0
  183. data/lib/artikcloud/models/user_envelope.rb +164 -0
  184. data/lib/artikcloud/models/web_socket_error.rb +187 -0
  185. data/lib/artikcloud/version.rb +17 -0
  186. data/lib/artikcloud.rb +128 -0
  187. data/pom.xml +60 -0
  188. data/spec/api/messages_api_spec.rb +79 -0
  189. data/spec/api/tokens_api_spec.rb +79 -0
  190. data/spec/api/users_api_spec.rb +50 -0
  191. data/spec/spec.opts +4 -0
  192. data/spec/spec_helper.rb +36 -0
  193. metadata +420 -0
@@ -0,0 +1,468 @@
1
+ =begin
2
+ ARTIK Cloud API
3
+
4
+ OpenAPI spec version: 2.0.0
5
+
6
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
7
+
8
+ License: MIT
9
+ http://en.wikipedia.org/wiki/MIT_License
10
+
11
+ Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
12
+
13
+ =end
14
+
15
+ require "uri"
16
+
17
+ module ArtikCloud
18
+ class MessagesApi
19
+ attr_accessor :api_client
20
+
21
+ def initialize(api_client = ApiClient.default)
22
+ @api_client = api_client
23
+ end
24
+
25
+ # Get Histogram aggregates
26
+ # Get Histogram on normalized messages.
27
+ # @param start_date Timestamp of earliest message (in milliseconds since epoch).
28
+ # @param end_date Timestamp of latest message (in milliseconds since epoch).
29
+ # @param [Hash] opts the optional parameters
30
+ # @option opts [String] :sdid Source device ID of the messages being searched.
31
+ # @option opts [String] :field Message field being queried for building histogram.
32
+ # @option opts [String] :interval Interval of time for building histogram blocks. (Valid values: minute, hour, day, month, year)
33
+ # @return [AggregatesHistogramResponse]
34
+ def get_aggregates_histogram(start_date, end_date, opts = {})
35
+ data, status_code, headers = get_aggregates_histogram_with_http_info(start_date, end_date, opts)
36
+ return data
37
+ end
38
+
39
+ # Get Histogram aggregates
40
+ # Get Histogram on normalized messages.
41
+ # @param start_date Timestamp of earliest message (in milliseconds since epoch).
42
+ # @param end_date Timestamp of latest message (in milliseconds since epoch).
43
+ # @param [Hash] opts the optional parameters
44
+ # @option opts [String] :sdid Source device ID of the messages being searched.
45
+ # @option opts [String] :field Message field being queried for building histogram.
46
+ # @option opts [String] :interval Interval of time for building histogram blocks. (Valid values: minute, hour, day, month, year)
47
+ # @return [Array<(AggregatesHistogramResponse, Fixnum, Hash)>] AggregatesHistogramResponse data, response status code and response headers
48
+ def get_aggregates_histogram_with_http_info(start_date, end_date, opts = {})
49
+ if @api_client.config.debugging
50
+ @api_client.config.logger.debug "Calling API: MessagesApi#get_aggregates_histogram ..."
51
+ end
52
+
53
+ # verify the required parameter 'start_date' is set
54
+ fail "Missing the required parameter 'start_date' when calling get_aggregates_histogram" if start_date.nil?
55
+
56
+ # verify the required parameter 'end_date' is set
57
+ fail "Missing the required parameter 'end_date' when calling get_aggregates_histogram" if end_date.nil?
58
+
59
+ # resource path
60
+ local_var_path = "/messages/analytics/histogram".sub('{format}','json')
61
+
62
+ # query parameters
63
+ query_params = {}
64
+ query_params[:'startDate'] = start_date
65
+ query_params[:'endDate'] = end_date
66
+ query_params[:'sdid'] = opts[:'sdid'] if opts[:'sdid']
67
+ query_params[:'field'] = opts[:'field'] if opts[:'field']
68
+ query_params[:'interval'] = opts[:'interval'] if opts[:'interval']
69
+
70
+ # header parameters
71
+ header_params = {}
72
+
73
+ # HTTP header 'Accept' (if needed)
74
+ _header_accept = ['application/json']
75
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
76
+
77
+ # HTTP header 'Content-Type'
78
+ _header_content_type = []
79
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
80
+
81
+ # form parameters
82
+ form_params = {}
83
+
84
+ # http body (model)
85
+ post_body = nil
86
+
87
+ auth_names = ['artikcloud_oauth']
88
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names,
94
+ :return_type => 'AggregatesHistogramResponse')
95
+ if @api_client.config.debugging
96
+ @api_client.config.logger.debug "API called: MessagesApi#get_aggregates_histogram\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
97
+ end
98
+ return data, status_code, headers
99
+ end
100
+
101
+ # Get normalized message presence
102
+ # Get normalized message presence.
103
+ # @param start_date startDate
104
+ # @param end_date endDate
105
+ # @param interval String representing grouping interval. One of: &#39;minute&#39; (1 hour limit), &#39;hour&#39; (1 day limit), &#39;day&#39; (31 days limit), &#39;month&#39; (1 year limit), or &#39;year&#39; (10 years limit).
106
+ # @param [Hash] opts the optional parameters
107
+ # @option opts [String] :sdid Source device ID of the messages being searched.
108
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
109
+ # @return [FieldPresenceEnvelope]
110
+ def get_field_presence(start_date, end_date, interval, opts = {})
111
+ data, status_code, headers = get_field_presence_with_http_info(start_date, end_date, interval, opts)
112
+ return data
113
+ end
114
+
115
+ # Get normalized message presence
116
+ # Get normalized message presence.
117
+ # @param start_date startDate
118
+ # @param end_date endDate
119
+ # @param interval String representing grouping interval. One of: &#39;minute&#39; (1 hour limit), &#39;hour&#39; (1 day limit), &#39;day&#39; (31 days limit), &#39;month&#39; (1 year limit), or &#39;year&#39; (10 years limit).
120
+ # @param [Hash] opts the optional parameters
121
+ # @option opts [String] :sdid Source device ID of the messages being searched.
122
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
123
+ # @return [Array<(FieldPresenceEnvelope, Fixnum, Hash)>] FieldPresenceEnvelope data, response status code and response headers
124
+ def get_field_presence_with_http_info(start_date, end_date, interval, opts = {})
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "Calling API: MessagesApi#get_field_presence ..."
127
+ end
128
+
129
+ # verify the required parameter 'start_date' is set
130
+ fail "Missing the required parameter 'start_date' when calling get_field_presence" if start_date.nil?
131
+
132
+ # verify the required parameter 'end_date' is set
133
+ fail "Missing the required parameter 'end_date' when calling get_field_presence" if end_date.nil?
134
+
135
+ # verify the required parameter 'interval' is set
136
+ fail "Missing the required parameter 'interval' when calling get_field_presence" if interval.nil?
137
+
138
+ # resource path
139
+ local_var_path = "/messages/presence".sub('{format}','json')
140
+
141
+ # query parameters
142
+ query_params = {}
143
+ query_params[:'startDate'] = start_date
144
+ query_params[:'endDate'] = end_date
145
+ query_params[:'interval'] = interval
146
+ query_params[:'sdid'] = opts[:'sdid'] if opts[:'sdid']
147
+ query_params[:'fieldPresence'] = opts[:'field_presence'] if opts[:'field_presence']
148
+
149
+ # header parameters
150
+ header_params = {}
151
+
152
+ # HTTP header 'Accept' (if needed)
153
+ _header_accept = ['application/json']
154
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
155
+
156
+ # HTTP header 'Content-Type'
157
+ _header_content_type = []
158
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
159
+
160
+ # form parameters
161
+ form_params = {}
162
+
163
+ # http body (model)
164
+ post_body = nil
165
+
166
+ auth_names = ['artikcloud_oauth']
167
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
168
+ :header_params => header_params,
169
+ :query_params => query_params,
170
+ :form_params => form_params,
171
+ :body => post_body,
172
+ :auth_names => auth_names,
173
+ :return_type => 'FieldPresenceEnvelope')
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "API called: MessagesApi#get_field_presence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
+ end
177
+ return data, status_code, headers
178
+ end
179
+
180
+ # Get Last Normalized Message
181
+ # Get last messages normalized.
182
+ # @param [Hash] opts the optional parameters
183
+ # @option opts [Integer] :count Number of items to return per query.
184
+ # @option opts [String] :sdids Comma separated list of source device IDs (minimum: 1).
185
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
186
+ # @return [NormalizedMessagesEnvelope]
187
+ def get_last_normalized_messages(opts = {})
188
+ data, status_code, headers = get_last_normalized_messages_with_http_info(opts)
189
+ return data
190
+ end
191
+
192
+ # Get Last Normalized Message
193
+ # Get last messages normalized.
194
+ # @param [Hash] opts the optional parameters
195
+ # @option opts [Integer] :count Number of items to return per query.
196
+ # @option opts [String] :sdids Comma separated list of source device IDs (minimum: 1).
197
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
198
+ # @return [Array<(NormalizedMessagesEnvelope, Fixnum, Hash)>] NormalizedMessagesEnvelope data, response status code and response headers
199
+ def get_last_normalized_messages_with_http_info(opts = {})
200
+ if @api_client.config.debugging
201
+ @api_client.config.logger.debug "Calling API: MessagesApi#get_last_normalized_messages ..."
202
+ end
203
+
204
+ # resource path
205
+ local_var_path = "/messages/last".sub('{format}','json')
206
+
207
+ # query parameters
208
+ query_params = {}
209
+ query_params[:'count'] = opts[:'count'] if opts[:'count']
210
+ query_params[:'sdids'] = opts[:'sdids'] if opts[:'sdids']
211
+ query_params[:'fieldPresence'] = opts[:'field_presence'] if opts[:'field_presence']
212
+
213
+ # header parameters
214
+ header_params = {}
215
+
216
+ # HTTP header 'Accept' (if needed)
217
+ _header_accept = ['application/json']
218
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
219
+
220
+ # HTTP header 'Content-Type'
221
+ _header_content_type = []
222
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
223
+
224
+ # form parameters
225
+ form_params = {}
226
+
227
+ # http body (model)
228
+ post_body = nil
229
+
230
+ auth_names = ['artikcloud_oauth']
231
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
232
+ :header_params => header_params,
233
+ :query_params => query_params,
234
+ :form_params => form_params,
235
+ :body => post_body,
236
+ :auth_names => auth_names,
237
+ :return_type => 'NormalizedMessagesEnvelope')
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: MessagesApi#get_last_normalized_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
244
+ # Get Normalized Message Aggregates
245
+ # Get Aggregates on normalized messages.
246
+ # @param sdid Source device ID of the messages being searched.
247
+ # @param field Message field being queried for aggregates.
248
+ # @param start_date Timestamp of earliest message (in milliseconds since epoch).
249
+ # @param end_date Timestamp of latest message (in milliseconds since epoch).
250
+ # @param [Hash] opts the optional parameters
251
+ # @return [AggregatesResponse]
252
+ def get_message_aggregates(sdid, field, start_date, end_date, opts = {})
253
+ data, status_code, headers = get_message_aggregates_with_http_info(sdid, field, start_date, end_date, opts)
254
+ return data
255
+ end
256
+
257
+ # Get Normalized Message Aggregates
258
+ # Get Aggregates on normalized messages.
259
+ # @param sdid Source device ID of the messages being searched.
260
+ # @param field Message field being queried for aggregates.
261
+ # @param start_date Timestamp of earliest message (in milliseconds since epoch).
262
+ # @param end_date Timestamp of latest message (in milliseconds since epoch).
263
+ # @param [Hash] opts the optional parameters
264
+ # @return [Array<(AggregatesResponse, Fixnum, Hash)>] AggregatesResponse data, response status code and response headers
265
+ def get_message_aggregates_with_http_info(sdid, field, start_date, end_date, opts = {})
266
+ if @api_client.config.debugging
267
+ @api_client.config.logger.debug "Calling API: MessagesApi#get_message_aggregates ..."
268
+ end
269
+
270
+ # verify the required parameter 'sdid' is set
271
+ fail "Missing the required parameter 'sdid' when calling get_message_aggregates" if sdid.nil?
272
+
273
+ # verify the required parameter 'field' is set
274
+ fail "Missing the required parameter 'field' when calling get_message_aggregates" if field.nil?
275
+
276
+ # verify the required parameter 'start_date' is set
277
+ fail "Missing the required parameter 'start_date' when calling get_message_aggregates" if start_date.nil?
278
+
279
+ # verify the required parameter 'end_date' is set
280
+ fail "Missing the required parameter 'end_date' when calling get_message_aggregates" if end_date.nil?
281
+
282
+ # resource path
283
+ local_var_path = "/messages/analytics/aggregates".sub('{format}','json')
284
+
285
+ # query parameters
286
+ query_params = {}
287
+ query_params[:'sdid'] = sdid
288
+ query_params[:'field'] = field
289
+ query_params[:'startDate'] = start_date
290
+ query_params[:'endDate'] = end_date
291
+
292
+ # header parameters
293
+ header_params = {}
294
+
295
+ # HTTP header 'Accept' (if needed)
296
+ _header_accept = ['application/json']
297
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
298
+
299
+ # HTTP header 'Content-Type'
300
+ _header_content_type = []
301
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
302
+
303
+ # form parameters
304
+ form_params = {}
305
+
306
+ # http body (model)
307
+ post_body = nil
308
+
309
+ auth_names = ['artikcloud_oauth']
310
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
311
+ :header_params => header_params,
312
+ :query_params => query_params,
313
+ :form_params => form_params,
314
+ :body => post_body,
315
+ :auth_names => auth_names,
316
+ :return_type => 'AggregatesResponse')
317
+ if @api_client.config.debugging
318
+ @api_client.config.logger.debug "API called: MessagesApi#get_message_aggregates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
319
+ end
320
+ return data, status_code, headers
321
+ end
322
+
323
+ # Get Normalized Messages
324
+ # Get the messages normalized
325
+ # @param [Hash] opts the optional parameters
326
+ # @option opts [String] :uid User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to.
327
+ # @option opts [String] :sdid Source device ID of the messages being searched.
328
+ # @option opts [String] :mid The SAMI message ID being searched.
329
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
330
+ # @option opts [String] :filter Filter.
331
+ # @option opts [String] :offset A string that represents the starting item, should be the value of &#39;next&#39; field received in the last response. (required for pagination)
332
+ # @option opts [Integer] :count count
333
+ # @option opts [Integer] :start_date startDate
334
+ # @option opts [Integer] :end_date endDate
335
+ # @option opts [String] :order Desired sort order: &#39;asc&#39; or &#39;desc&#39;
336
+ # @return [NormalizedMessagesEnvelope]
337
+ def get_normalized_messages(opts = {})
338
+ data, status_code, headers = get_normalized_messages_with_http_info(opts)
339
+ return data
340
+ end
341
+
342
+ # Get Normalized Messages
343
+ # Get the messages normalized
344
+ # @param [Hash] opts the optional parameters
345
+ # @option opts [String] :uid User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to.
346
+ # @option opts [String] :sdid Source device ID of the messages being searched.
347
+ # @option opts [String] :mid The SAMI message ID being searched.
348
+ # @option opts [String] :field_presence String representing a field from the specified device ID.
349
+ # @option opts [String] :filter Filter.
350
+ # @option opts [String] :offset A string that represents the starting item, should be the value of &#39;next&#39; field received in the last response. (required for pagination)
351
+ # @option opts [Integer] :count count
352
+ # @option opts [Integer] :start_date startDate
353
+ # @option opts [Integer] :end_date endDate
354
+ # @option opts [String] :order Desired sort order: &#39;asc&#39; or &#39;desc&#39;
355
+ # @return [Array<(NormalizedMessagesEnvelope, Fixnum, Hash)>] NormalizedMessagesEnvelope data, response status code and response headers
356
+ def get_normalized_messages_with_http_info(opts = {})
357
+ if @api_client.config.debugging
358
+ @api_client.config.logger.debug "Calling API: MessagesApi#get_normalized_messages ..."
359
+ end
360
+
361
+ # resource path
362
+ local_var_path = "/messages".sub('{format}','json')
363
+
364
+ # query parameters
365
+ query_params = {}
366
+ query_params[:'uid'] = opts[:'uid'] if opts[:'uid']
367
+ query_params[:'sdid'] = opts[:'sdid'] if opts[:'sdid']
368
+ query_params[:'mid'] = opts[:'mid'] if opts[:'mid']
369
+ query_params[:'fieldPresence'] = opts[:'field_presence'] if opts[:'field_presence']
370
+ query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
371
+ query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
372
+ query_params[:'count'] = opts[:'count'] if opts[:'count']
373
+ query_params[:'startDate'] = opts[:'start_date'] if opts[:'start_date']
374
+ query_params[:'endDate'] = opts[:'end_date'] if opts[:'end_date']
375
+ query_params[:'order'] = opts[:'order'] if opts[:'order']
376
+
377
+ # header parameters
378
+ header_params = {}
379
+
380
+ # HTTP header 'Accept' (if needed)
381
+ _header_accept = ['application/json']
382
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
383
+
384
+ # HTTP header 'Content-Type'
385
+ _header_content_type = []
386
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
387
+
388
+ # form parameters
389
+ form_params = {}
390
+
391
+ # http body (model)
392
+ post_body = nil
393
+
394
+ auth_names = ['artikcloud_oauth']
395
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
396
+ :header_params => header_params,
397
+ :query_params => query_params,
398
+ :form_params => form_params,
399
+ :body => post_body,
400
+ :auth_names => auth_names,
401
+ :return_type => 'NormalizedMessagesEnvelope')
402
+ if @api_client.config.debugging
403
+ @api_client.config.logger.debug "API called: MessagesApi#get_normalized_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
404
+ end
405
+ return data, status_code, headers
406
+ end
407
+
408
+ # Send Message Action
409
+ # Send a message or an Action:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Send Message</td><td>sdid, type=message</td><td>Send a message from a Source Device</td></tr><tr><td>Send Action</td><td>ddid, type=action</td><td>Send an action to a Destination Device</td></tr><tr><td>Common</td><td>data, ts, token</td><td>Parameters that can be used with the above combinations.</td></tr></table>
410
+ # @param data Message or Action object that is passed in the body
411
+ # @param [Hash] opts the optional parameters
412
+ # @return [MessageIDEnvelope]
413
+ def send_message_action(data, opts = {})
414
+ data, status_code, headers = send_message_action_with_http_info(data, opts)
415
+ return data
416
+ end
417
+
418
+ # Send Message Action
419
+ # Send a message or an Action:&lt;br/&gt;&lt;table&gt;&lt;tr&gt;&lt;th&gt;Combination&lt;/th&gt;&lt;th&gt;Parameters&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Send Message&lt;/td&gt;&lt;td&gt;sdid, type=message&lt;/td&gt;&lt;td&gt;Send a message from a Source Device&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Send Action&lt;/td&gt;&lt;td&gt;ddid, type=action&lt;/td&gt;&lt;td&gt;Send an action to a Destination Device&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Common&lt;/td&gt;&lt;td&gt;data, ts, token&lt;/td&gt;&lt;td&gt;Parameters that can be used with the above combinations.&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
420
+ # @param data Message or Action object that is passed in the body
421
+ # @param [Hash] opts the optional parameters
422
+ # @return [Array<(MessageIDEnvelope, Fixnum, Hash)>] MessageIDEnvelope data, response status code and response headers
423
+ def send_message_action_with_http_info(data, opts = {})
424
+ if @api_client.config.debugging
425
+ @api_client.config.logger.debug "Calling API: MessagesApi#send_message_action ..."
426
+ end
427
+
428
+ # verify the required parameter 'data' is set
429
+ fail "Missing the required parameter 'data' when calling send_message_action" if data.nil?
430
+
431
+ # resource path
432
+ local_var_path = "/messages".sub('{format}','json')
433
+
434
+ # query parameters
435
+ query_params = {}
436
+
437
+ # header parameters
438
+ header_params = {}
439
+
440
+ # HTTP header 'Accept' (if needed)
441
+ _header_accept = ['application/json']
442
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
443
+
444
+ # HTTP header 'Content-Type'
445
+ _header_content_type = []
446
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
447
+
448
+ # form parameters
449
+ form_params = {}
450
+
451
+ # http body (model)
452
+ post_body = @api_client.object_to_http_body(data)
453
+
454
+ auth_names = ['artikcloud_oauth']
455
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
456
+ :header_params => header_params,
457
+ :query_params => query_params,
458
+ :form_params => form_params,
459
+ :body => post_body,
460
+ :auth_names => auth_names,
461
+ :return_type => 'MessageIDEnvelope')
462
+ if @api_client.config.debugging
463
+ @api_client.config.logger.debug "API called: MessagesApi#send_message_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
464
+ end
465
+ return data, status_code, headers
466
+ end
467
+ end
468
+ end
@@ -0,0 +1,205 @@
1
+ =begin
2
+ ARTIK Cloud API
3
+
4
+ OpenAPI spec version: 2.0.0
5
+
6
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
7
+
8
+ License: MIT
9
+ http://en.wikipedia.org/wiki/MIT_License
10
+
11
+ Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
12
+
13
+ =end
14
+
15
+ require "uri"
16
+
17
+ module ArtikCloud
18
+ class RegistrationsApi
19
+ attr_accessor :api_client
20
+
21
+ def initialize(api_client = ApiClient.default)
22
+ @api_client = api_client
23
+ end
24
+
25
+ # Confirm User
26
+ # This call updates the registration request issued earlier by associating it with an authenticated user and captures all additional information required to add a new device.
27
+ # @param registration_info Device Registration information.
28
+ # @param [Hash] opts the optional parameters
29
+ # @return [DeviceRegConfirmUserResponseEnvelope]
30
+ def confirm_user(registration_info, opts = {})
31
+ data, status_code, headers = confirm_user_with_http_info(registration_info, opts)
32
+ return data
33
+ end
34
+
35
+ # Confirm User
36
+ # This call updates the registration request issued earlier by associating it with an authenticated user and captures all additional information required to add a new device.
37
+ # @param registration_info Device Registration information.
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [Array<(DeviceRegConfirmUserResponseEnvelope, Fixnum, Hash)>] DeviceRegConfirmUserResponseEnvelope data, response status code and response headers
40
+ def confirm_user_with_http_info(registration_info, opts = {})
41
+ if @api_client.config.debugging
42
+ @api_client.config.logger.debug "Calling API: RegistrationsApi#confirm_user ..."
43
+ end
44
+
45
+ # verify the required parameter 'registration_info' is set
46
+ fail "Missing the required parameter 'registration_info' when calling confirm_user" if registration_info.nil?
47
+
48
+ # resource path
49
+ local_var_path = "/devices/registrations/pin".sub('{format}','json')
50
+
51
+ # query parameters
52
+ query_params = {}
53
+
54
+ # header parameters
55
+ header_params = {}
56
+
57
+ # HTTP header 'Accept' (if needed)
58
+ _header_accept = ['application/json']
59
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
60
+
61
+ # HTTP header 'Content-Type'
62
+ _header_content_type = []
63
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
64
+
65
+ # form parameters
66
+ form_params = {}
67
+
68
+ # http body (model)
69
+ post_body = @api_client.object_to_http_body(registration_info)
70
+
71
+ auth_names = ['artikcloud_oauth']
72
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => 'DeviceRegConfirmUserResponseEnvelope')
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: RegistrationsApi#confirm_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # Get Request Status For User
86
+ # This call checks the status of the request so users can poll and know when registration is complete.
87
+ # @param request_id Request ID.
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [DeviceRegStatusResponseEnvelope]
90
+ def get_request_status_for_user(request_id, opts = {})
91
+ data, status_code, headers = get_request_status_for_user_with_http_info(request_id, opts)
92
+ return data
93
+ end
94
+
95
+ # Get Request Status For User
96
+ # This call checks the status of the request so users can poll and know when registration is complete.
97
+ # @param request_id Request ID.
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [Array<(DeviceRegStatusResponseEnvelope, Fixnum, Hash)>] DeviceRegStatusResponseEnvelope data, response status code and response headers
100
+ def get_request_status_for_user_with_http_info(request_id, opts = {})
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug "Calling API: RegistrationsApi#get_request_status_for_user ..."
103
+ end
104
+
105
+ # verify the required parameter 'request_id' is set
106
+ fail "Missing the required parameter 'request_id' when calling get_request_status_for_user" if request_id.nil?
107
+
108
+ # resource path
109
+ local_var_path = "/devices/registrations/{requestId}/status".sub('{format}','json').sub('{' + 'requestId' + '}', request_id.to_s)
110
+
111
+ # query parameters
112
+ query_params = {}
113
+
114
+ # header parameters
115
+ header_params = {}
116
+
117
+ # HTTP header 'Accept' (if needed)
118
+ _header_accept = ['application/json']
119
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
120
+
121
+ # HTTP header 'Content-Type'
122
+ _header_content_type = []
123
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
124
+
125
+ # form parameters
126
+ form_params = {}
127
+
128
+ # http body (model)
129
+ post_body = nil
130
+
131
+ auth_names = ['artikcloud_oauth']
132
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => 'DeviceRegStatusResponseEnvelope')
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: RegistrationsApi#get_request_status_for_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ # Unregister Device
146
+ # This call clears any associations from the secure device registration.
147
+ # @param device_id Device ID.
148
+ # @param [Hash] opts the optional parameters
149
+ # @return [UnregisterDeviceResponseEnvelope]
150
+ def unregister_device(device_id, opts = {})
151
+ data, status_code, headers = unregister_device_with_http_info(device_id, opts)
152
+ return data
153
+ end
154
+
155
+ # Unregister Device
156
+ # This call clears any associations from the secure device registration.
157
+ # @param device_id Device ID.
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [Array<(UnregisterDeviceResponseEnvelope, Fixnum, Hash)>] UnregisterDeviceResponseEnvelope data, response status code and response headers
160
+ def unregister_device_with_http_info(device_id, opts = {})
161
+ if @api_client.config.debugging
162
+ @api_client.config.logger.debug "Calling API: RegistrationsApi#unregister_device ..."
163
+ end
164
+
165
+ # verify the required parameter 'device_id' is set
166
+ fail "Missing the required parameter 'device_id' when calling unregister_device" if device_id.nil?
167
+
168
+ # resource path
169
+ local_var_path = "/devices/{deviceId}/registrations".sub('{format}','json').sub('{' + 'deviceId' + '}', device_id.to_s)
170
+
171
+ # query parameters
172
+ query_params = {}
173
+
174
+ # header parameters
175
+ header_params = {}
176
+
177
+ # HTTP header 'Accept' (if needed)
178
+ _header_accept = ['application/json']
179
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
180
+
181
+ # HTTP header 'Content-Type'
182
+ _header_content_type = []
183
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
184
+
185
+ # form parameters
186
+ form_params = {}
187
+
188
+ # http body (model)
189
+ post_body = nil
190
+
191
+ auth_names = ['artikcloud_oauth']
192
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
193
+ :header_params => header_params,
194
+ :query_params => query_params,
195
+ :form_params => form_params,
196
+ :body => post_body,
197
+ :auth_names => auth_names,
198
+ :return_type => 'UnregisterDeviceResponseEnvelope')
199
+ if @api_client.config.debugging
200
+ @api_client.config.logger.debug "API called: RegistrationsApi#unregister_device\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
201
+ end
202
+ return data, status_code, headers
203
+ end
204
+ end
205
+ end