artikcloud 2.0.0 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +12 -12
  3. data/README.md +33 -10
  4. data/artikcloud.gemspec +5 -6
  5. data/docs/Action.md +9 -0
  6. data/docs/ActionArray.md +8 -0
  7. data/docs/Actions.md +12 -0
  8. data/docs/DeviceTypesApi.md +10 -10
  9. data/docs/DevicesApi.md +68 -15
  10. data/docs/ExportApi.md +10 -10
  11. data/docs/Message.md +11 -0
  12. data/docs/MessagesApi.md +205 -27
  13. data/docs/NormalizedAction.md +16 -0
  14. data/docs/NormalizedActionsEnvelope.md +17 -0
  15. data/docs/PresenceEnvelope.md +9 -0
  16. data/docs/PresenceModel.md +9 -0
  17. data/docs/RegistrationsApi.md +6 -6
  18. data/docs/RulesApi.md +8 -8
  19. data/docs/RulesEnvelope.md +1 -1
  20. data/docs/SnapshotResponse.md +9 -0
  21. data/docs/SnapshotResponses.md +10 -0
  22. data/docs/SnapshotsResponseEnvelope.md +9 -0
  23. data/docs/TagsApi.md +7 -7
  24. data/docs/TokenInfo.md +11 -0
  25. data/docs/TokenInfoSuccessResponse.md +8 -0
  26. data/docs/TokensApi.md +54 -7
  27. data/docs/UsersApi.md +18 -20
  28. data/git_push.sh +16 -1
  29. data/lib/artikcloud/api/device_types_api.rb +52 -59
  30. data/lib/artikcloud/api/devices_api.rb +120 -76
  31. data/lib/artikcloud/api/export_api.rb +43 -45
  32. data/lib/artikcloud/api/messages_api.rb +285 -103
  33. data/lib/artikcloud/api/registrations_api.rb +34 -34
  34. data/lib/artikcloud/api/rules_api.rb +43 -48
  35. data/lib/artikcloud/api/tags_api.rb +37 -35
  36. data/lib/artikcloud/api/tokens_api.rb +85 -30
  37. data/lib/artikcloud/api/users_api.rb +83 -102
  38. data/lib/artikcloud/api_client.rb +56 -13
  39. data/lib/artikcloud/api_error.rb +13 -4
  40. data/lib/artikcloud/configuration.rb +45 -1
  41. data/lib/artikcloud/models/ack_envelope.rb +59 -24
  42. data/lib/artikcloud/models/acknowledgement.rb +65 -33
  43. data/lib/artikcloud/models/action.rb +212 -0
  44. data/lib/artikcloud/models/action_array.rb +201 -0
  45. data/lib/artikcloud/models/action_details.rb +61 -27
  46. data/lib/artikcloud/models/action_details_array.rb +59 -24
  47. data/lib/artikcloud/models/action_in.rb +69 -39
  48. data/lib/artikcloud/models/action_out.rb +67 -36
  49. data/lib/artikcloud/models/actions.rb +241 -0
  50. data/lib/artikcloud/models/aggregate_data.rb +69 -39
  51. data/lib/artikcloud/models/aggregates_histogram_data.rb +71 -42
  52. data/lib/artikcloud/models/aggregates_histogram_response.rb +71 -42
  53. data/lib/artikcloud/models/aggregates_response.rb +69 -39
  54. data/lib/artikcloud/models/app_properties.rb +64 -30
  55. data/lib/artikcloud/models/check_token_message.rb +59 -24
  56. data/lib/artikcloud/models/check_token_response.rb +59 -24
  57. data/lib/artikcloud/models/device.rb +85 -63
  58. data/lib/artikcloud/models/device_array.rb +59 -24
  59. data/lib/artikcloud/models/device_envelope.rb +60 -24
  60. data/lib/artikcloud/models/device_reg_complete_request.rb +59 -24
  61. data/lib/artikcloud/models/device_reg_confirm_user_request.rb +63 -30
  62. data/lib/artikcloud/models/device_reg_confirm_user_response.rb +59 -24
  63. data/lib/artikcloud/models/device_reg_confirm_user_response_envelope.rb +59 -24
  64. data/lib/artikcloud/models/device_reg_status_response.rb +61 -27
  65. data/lib/artikcloud/models/device_reg_status_response_envelope.rb +59 -24
  66. data/lib/artikcloud/models/device_token.rb +69 -33
  67. data/lib/artikcloud/models/device_token_envelope.rb +60 -24
  68. data/lib/artikcloud/models/device_type.rb +93 -75
  69. data/lib/artikcloud/models/device_type_array.rb +59 -24
  70. data/lib/artikcloud/models/device_type_envelope.rb +60 -24
  71. data/lib/artikcloud/models/device_types_envelope.rb +68 -33
  72. data/lib/artikcloud/models/devices_envelope.rb +68 -33
  73. data/lib/artikcloud/models/error_envelope.rb +59 -24
  74. data/lib/artikcloud/models/export_data.rb +71 -42
  75. data/lib/artikcloud/models/export_data_array.rb +59 -24
  76. data/lib/artikcloud/models/export_history_response.rb +65 -33
  77. data/lib/artikcloud/models/export_normalized_messages_response.rb +83 -60
  78. data/lib/artikcloud/models/export_request.rb +73 -45
  79. data/lib/artikcloud/models/export_request_data.rb +79 -54
  80. data/lib/artikcloud/models/export_request_info.rb +77 -51
  81. data/lib/artikcloud/models/export_request_response.rb +59 -24
  82. data/lib/artikcloud/models/export_response.rb +79 -54
  83. data/lib/artikcloud/models/export_status_response.rb +67 -36
  84. data/lib/artikcloud/models/field_path.rb +59 -24
  85. data/lib/artikcloud/models/field_presence.rb +60 -24
  86. data/lib/artikcloud/models/field_presence_envelope.rb +78 -42
  87. data/lib/artikcloud/models/fields_actions.rb +61 -27
  88. data/lib/artikcloud/models/manifest_properties.rb +60 -24
  89. data/lib/artikcloud/models/manifest_properties_envelope.rb +60 -24
  90. data/lib/artikcloud/models/manifest_versions.rb +60 -24
  91. data/lib/artikcloud/models/manifest_versions_envelope.rb +60 -24
  92. data/lib/artikcloud/models/message.rb +233 -0
  93. data/lib/artikcloud/models/message_action.rb +67 -36
  94. data/lib/artikcloud/models/message_id.rb +59 -24
  95. data/lib/artikcloud/models/message_id_envelope.rb +59 -24
  96. data/lib/artikcloud/models/message_in.rb +69 -39
  97. data/lib/artikcloud/models/message_out.rb +67 -36
  98. data/lib/artikcloud/models/non_empty_string.rb +59 -24
  99. data/lib/artikcloud/models/normalized_action.rb +279 -0
  100. data/lib/artikcloud/models/normalized_actions_envelope.rb +285 -0
  101. data/lib/artikcloud/models/normalized_message.rb +81 -45
  102. data/lib/artikcloud/models/normalized_messages_envelope.rb +80 -51
  103. data/lib/artikcloud/models/output_rule.rb +85 -63
  104. data/lib/artikcloud/models/presence_envelope.rb +208 -0
  105. data/lib/artikcloud/models/presence_model.rb +208 -0
  106. data/lib/artikcloud/models/properties_envelope.rb +60 -24
  107. data/lib/artikcloud/models/refresh_token_response.rb +65 -33
  108. data/lib/artikcloud/models/register_message.rb +67 -36
  109. data/lib/artikcloud/models/rule_array.rb +59 -24
  110. data/lib/artikcloud/models/rule_creation_info.rb +65 -33
  111. data/lib/artikcloud/models/rule_envelope.rb +59 -24
  112. data/lib/artikcloud/models/rule_error.rb +65 -33
  113. data/lib/artikcloud/models/rule_update_info.rb +65 -33
  114. data/lib/artikcloud/models/rule_warning_output.rb +61 -27
  115. data/lib/artikcloud/models/rules_envelope.rb +69 -35
  116. data/lib/artikcloud/models/snapshot_response.rb +210 -0
  117. data/lib/artikcloud/models/snapshot_responses.rb +219 -0
  118. data/lib/artikcloud/models/snapshots_response_envelope.rb +208 -0
  119. data/lib/artikcloud/models/tag.rb +61 -27
  120. data/lib/artikcloud/models/tag_array.rb +59 -24
  121. data/lib/artikcloud/models/tags_envelope.rb +59 -24
  122. data/lib/artikcloud/models/token.rb +65 -33
  123. data/lib/artikcloud/models/token_info.rb +226 -0
  124. data/lib/artikcloud/models/token_info_success_response.rb +199 -0
  125. data/lib/artikcloud/models/token_request.rb +59 -24
  126. data/lib/artikcloud/models/token_response.rb +59 -24
  127. data/lib/artikcloud/models/unregister_device_response.rb +79 -54
  128. data/lib/artikcloud/models/unregister_device_response_envelope.rb +59 -24
  129. data/lib/artikcloud/models/user.rb +77 -42
  130. data/lib/artikcloud/models/user_envelope.rb +60 -24
  131. data/lib/artikcloud/models/web_socket_error.rb +63 -30
  132. data/lib/artikcloud/version.rb +14 -5
  133. data/lib/artikcloud.rb +26 -4
  134. data/spec/api/device_types_api_spec.rb +110 -0
  135. data/spec/api/devices_api_spec.rb +143 -0
  136. data/spec/api/export_api_spec.rb +96 -0
  137. data/spec/api/messages_api_spec.rb +7 -7
  138. data/spec/api/registrations_api_spec.rb +82 -0
  139. data/spec/api/rules_api_spec.rb +96 -0
  140. data/spec/api/tags_api_spec.rb +84 -0
  141. data/spec/api/tokens_api_spec.rb +12 -21
  142. data/spec/api/users_api_spec.rb +1 -1
  143. data/spec/spec_helper.rb +1 -1
  144. metadata +60 -22
@@ -0,0 +1,233 @@
1
+ =begin
2
+ #ARTIK Cloud API
3
+
4
+ #No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 2.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
15
+
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
21
+
22
+ =end
23
+
24
+ require 'date'
25
+
26
+ module ArtikCloud
27
+ # Message Information.
28
+ class Message
29
+ attr_accessor :data
30
+
31
+ # Source Device ID.
32
+ attr_accessor :sdid
33
+
34
+ # Timestamp (past, present or future). Defaults to current time if not provided.
35
+ attr_accessor :ts
36
+
37
+ # Type - message.
38
+ attr_accessor :type
39
+
40
+
41
+ # Attribute mapping from ruby-style variable name to JSON key.
42
+ def self.attribute_map
43
+ {
44
+ :'data' => :'data',
45
+ :'sdid' => :'sdid',
46
+ :'ts' => :'ts',
47
+ :'type' => :'type'
48
+ }
49
+ end
50
+
51
+ # Attribute type mapping.
52
+ def self.swagger_types
53
+ {
54
+ :'data' => :'Hash<String, Object>',
55
+ :'sdid' => :'String',
56
+ :'ts' => :'Integer',
57
+ :'type' => :'String'
58
+ }
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ return unless attributes.is_a?(Hash)
65
+
66
+ # convert string to symbol for hash key
67
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
68
+
69
+ if attributes.has_key?(:'data')
70
+ if (value = attributes[:'data']).is_a?(Array)
71
+ self.data = value
72
+ end
73
+ end
74
+
75
+ if attributes.has_key?(:'sdid')
76
+ self.sdid = attributes[:'sdid']
77
+ end
78
+
79
+ if attributes.has_key?(:'ts')
80
+ self.ts = attributes[:'ts']
81
+ end
82
+
83
+ if attributes.has_key?(:'type')
84
+ self.type = attributes[:'type']
85
+ else
86
+ self.type = "message"
87
+ end
88
+
89
+ end
90
+
91
+ # Show invalid properties with the reasons. Usually used together with valid?
92
+ # @return Array for valid properies with the reasons
93
+ def list_invalid_properties
94
+ invalid_properties = Array.new
95
+ return invalid_properties
96
+ end
97
+
98
+ # Check to see if the all the properties in the model are valid
99
+ # @return true if the model is valid
100
+ def valid?
101
+ return true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ data == o.data &&
110
+ sdid == o.sdid &&
111
+ ts == o.ts &&
112
+ type == o.type
113
+ end
114
+
115
+ # @see the `==` method
116
+ # @param [Object] Object to be compared
117
+ def eql?(o)
118
+ self == o
119
+ end
120
+
121
+ # Calculates hash code according to all attributes.
122
+ # @return [Fixnum] Hash code
123
+ def hash
124
+ [data, sdid, ts, type].hash
125
+ end
126
+
127
+ # Builds the object from hash
128
+ # @param [Hash] attributes Model attributes in the form of hash
129
+ # @return [Object] Returns the model itself
130
+ def build_from_hash(attributes)
131
+ return nil unless attributes.is_a?(Hash)
132
+ self.class.swagger_types.each_pair do |key, type|
133
+ if type =~ /^Array<(.*)>/i
134
+ # check to ensure the input is an array given that the the attribute
135
+ # is documented as an array but the input is not
136
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
137
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
138
+ end
139
+ elsif !attributes[self.class.attribute_map[key]].nil?
140
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
141
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
142
+ end
143
+
144
+ self
145
+ end
146
+
147
+ # Deserializes the data based on type
148
+ # @param string type Data type
149
+ # @param string value Value to be deserialized
150
+ # @return [Object] Deserialized data
151
+ def _deserialize(type, value)
152
+ case type.to_sym
153
+ when :DateTime
154
+ DateTime.parse(value)
155
+ when :Date
156
+ Date.parse(value)
157
+ when :String
158
+ value.to_s
159
+ when :Integer
160
+ value.to_i
161
+ when :Float
162
+ value.to_f
163
+ when :BOOLEAN
164
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
165
+ true
166
+ else
167
+ false
168
+ end
169
+ when :Object
170
+ # generic object (usually a Hash), return directly
171
+ value
172
+ when /\AArray<(?<inner_type>.+)>\z/
173
+ inner_type = Regexp.last_match[:inner_type]
174
+ value.map { |v| _deserialize(inner_type, v) }
175
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
176
+ k_type = Regexp.last_match[:k_type]
177
+ v_type = Regexp.last_match[:v_type]
178
+ {}.tap do |hash|
179
+ value.each do |k, v|
180
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
181
+ end
182
+ end
183
+ else # model
184
+ temp_model = ArtikCloud.const_get(type).new
185
+ temp_model.build_from_hash(value)
186
+ end
187
+ end
188
+
189
+ # Returns the string representation of the object
190
+ # @return [String] String presentation of the object
191
+ def to_s
192
+ to_hash.to_s
193
+ end
194
+
195
+ # to_body is an alias to to_hash (backward compatibility)
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_body
198
+ to_hash
199
+ end
200
+
201
+ # Returns the object in the form of hash
202
+ # @return [Hash] Returns the object in the form of hash
203
+ def to_hash
204
+ hash = {}
205
+ self.class.attribute_map.each_pair do |attr, param|
206
+ value = self.send(attr)
207
+ next if value.nil?
208
+ hash[param] = _to_hash(value)
209
+ end
210
+ hash
211
+ end
212
+
213
+ # Outputs non-array value in the form of hash
214
+ # For object, use to_hash. Otherwise, just return the value
215
+ # @param [Object] value Any valid value
216
+ # @return [Hash] Returns the value in the form of hash
217
+ def _to_hash(value)
218
+ if value.is_a?(Array)
219
+ value.compact.map{ |v| _to_hash(v) }
220
+ elsif value.is_a?(Hash)
221
+ {}.tap do |hash|
222
+ value.each { |k, v| hash[k] = _to_hash(v) }
223
+ end
224
+ elsif value.respond_to? :to_hash
225
+ value.to_hash
226
+ else
227
+ value
228
+ end
229
+ end
230
+
231
+ end
232
+
233
+ end
@@ -1,14 +1,23 @@
1
1
  =begin
2
- ARTIK Cloud API
2
+ #ARTIK Cloud API
3
+
4
+ #No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
3
5
 
4
6
  OpenAPI spec version: 2.0.0
5
7
 
6
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
7
9
 
8
- License: MIT
9
- http://en.wikipedia.org/wiki/MIT_License
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
10
15
 
11
- Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
12
21
 
13
22
  =end
14
23
 
@@ -31,20 +40,15 @@ module ArtikCloud
31
40
  # Type.
32
41
  attr_accessor :type
33
42
 
43
+
34
44
  # Attribute mapping from ruby-style variable name to JSON key.
35
45
  def self.attribute_map
36
46
  {
37
-
38
47
  :'data' => :'data',
39
-
40
48
  :'ddid' => :'ddid',
41
-
42
49
  :'sdid' => :'sdid',
43
-
44
50
  :'ts' => :'ts',
45
-
46
51
  :'type' => :'type'
47
-
48
52
  }
49
53
  end
50
54
 
@@ -56,42 +60,56 @@ module ArtikCloud
56
60
  :'sdid' => :'String',
57
61
  :'ts' => :'Integer',
58
62
  :'type' => :'String'
59
-
60
63
  }
61
64
  end
62
65
 
66
+ # Initializes the object
67
+ # @param [Hash] attributes Model attributes in the form of hash
63
68
  def initialize(attributes = {})
64
69
  return unless attributes.is_a?(Hash)
65
70
 
66
71
  # convert string to symbol for hash key
67
- attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
72
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
68
73
 
69
-
70
- if attributes[:'data']
74
+ if attributes.has_key?(:'data')
71
75
  if (value = attributes[:'data']).is_a?(Array)
72
76
  self.data = value
73
77
  end
74
78
  end
75
-
76
- if attributes[:'ddid']
79
+
80
+ if attributes.has_key?(:'ddid')
77
81
  self.ddid = attributes[:'ddid']
78
82
  end
79
-
80
- if attributes[:'sdid']
83
+
84
+ if attributes.has_key?(:'sdid')
81
85
  self.sdid = attributes[:'sdid']
82
86
  end
83
-
84
- if attributes[:'ts']
87
+
88
+ if attributes.has_key?(:'ts')
85
89
  self.ts = attributes[:'ts']
86
90
  end
87
-
88
- if attributes[:'type']
91
+
92
+ if attributes.has_key?(:'type')
89
93
  self.type = attributes[:'type']
90
94
  end
91
-
95
+
92
96
  end
93
97
 
94
- # Check equality by comparing each attribute.
98
+ # Show invalid properties with the reasons. Usually used together with valid?
99
+ # @return Array for valid properies with the reasons
100
+ def list_invalid_properties
101
+ invalid_properties = Array.new
102
+ return invalid_properties
103
+ end
104
+
105
+ # Check to see if the all the properties in the model are valid
106
+ # @return true if the model is valid
107
+ def valid?
108
+ return true
109
+ end
110
+
111
+ # Checks equality by comparing each attribute.
112
+ # @param [Object] Object to be compared
95
113
  def ==(o)
96
114
  return true if self.equal?(o)
97
115
  self.class == o.class &&
@@ -103,35 +121,41 @@ module ArtikCloud
103
121
  end
104
122
 
105
123
  # @see the `==` method
124
+ # @param [Object] Object to be compared
106
125
  def eql?(o)
107
126
  self == o
108
127
  end
109
128
 
110
- # Calculate hash code according to all attributes.
129
+ # Calculates hash code according to all attributes.
130
+ # @return [Fixnum] Hash code
111
131
  def hash
112
132
  [data, ddid, sdid, ts, type].hash
113
133
  end
114
134
 
115
- # build the object from hash
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
116
138
  def build_from_hash(attributes)
117
139
  return nil unless attributes.is_a?(Hash)
118
140
  self.class.swagger_types.each_pair do |key, type|
119
141
  if type =~ /^Array<(.*)>/i
142
+ # check to ensure the input is an array given that the the attribute
143
+ # is documented as an array but the input is not
120
144
  if attributes[self.class.attribute_map[key]].is_a?(Array)
121
145
  self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
122
- else
123
- #TODO show warning in debug mode
124
146
  end
125
147
  elsif !attributes[self.class.attribute_map[key]].nil?
126
148
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
127
- else
128
- # data not found in attributes(hash), not an issue as the data can be optional
129
- end
149
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
130
150
  end
131
151
 
132
152
  self
133
153
  end
134
154
 
155
+ # Deserializes the data based on type
156
+ # @param string type Data type
157
+ # @param string value Value to be deserialized
158
+ # @return [Object] Deserialized data
135
159
  def _deserialize(type, value)
136
160
  case type.to_sym
137
161
  when :DateTime
@@ -165,21 +189,25 @@ module ArtikCloud
165
189
  end
166
190
  end
167
191
  else # model
168
- _model = ArtikCloud.const_get(type).new
169
- _model.build_from_hash(value)
192
+ temp_model = ArtikCloud.const_get(type).new
193
+ temp_model.build_from_hash(value)
170
194
  end
171
195
  end
172
196
 
197
+ # Returns the string representation of the object
198
+ # @return [String] String presentation of the object
173
199
  def to_s
174
200
  to_hash.to_s
175
201
  end
176
202
 
177
- # to_body is an alias to to_body (backward compatibility))
203
+ # to_body is an alias to to_hash (backward compatibility)
204
+ # @return [Hash] Returns the object in the form of hash
178
205
  def to_body
179
206
  to_hash
180
207
  end
181
208
 
182
- # return the object in the form of hash
209
+ # Returns the object in the form of hash
210
+ # @return [Hash] Returns the object in the form of hash
183
211
  def to_hash
184
212
  hash = {}
185
213
  self.class.attribute_map.each_pair do |attr, param|
@@ -190,8 +218,10 @@ module ArtikCloud
190
218
  hash
191
219
  end
192
220
 
193
- # Method to output non-array value in the form of hash
221
+ # Outputs non-array value in the form of hash
194
222
  # For object, use to_hash. Otherwise, just return the value
223
+ # @param [Object] value Any valid value
224
+ # @return [Hash] Returns the value in the form of hash
195
225
  def _to_hash(value)
196
226
  if value.is_a?(Array)
197
227
  value.compact.map{ |v| _to_hash(v) }
@@ -207,4 +237,5 @@ module ArtikCloud
207
237
  end
208
238
 
209
239
  end
240
+
210
241
  end
@@ -1,14 +1,23 @@
1
1
  =begin
2
- ARTIK Cloud API
2
+ #ARTIK Cloud API
3
+
4
+ #No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
3
5
 
4
6
  OpenAPI spec version: 2.0.0
5
7
 
6
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
7
9
 
8
- License: MIT
9
- http://en.wikipedia.org/wiki/MIT_License
10
+ Licensed under the Apache License, Version 2.0 (the "License");
11
+ you may not use this file except in compliance with the License.
12
+ You may obtain a copy of the License at
13
+
14
+ http://www.apache.org/licenses/LICENSE-2.0
10
15
 
11
- Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
16
+ Unless required by applicable law or agreed to in writing, software
17
+ distributed under the License is distributed on an "AS IS" BASIS,
18
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19
+ See the License for the specific language governing permissions and
20
+ limitations under the License.
12
21
 
13
22
  =end
14
23
 
@@ -20,12 +29,11 @@ module ArtikCloud
20
29
  # Message ID.
21
30
  attr_accessor :mid
22
31
 
32
+
23
33
  # Attribute mapping from ruby-style variable name to JSON key.
24
34
  def self.attribute_map
25
35
  {
26
-
27
36
  :'mid' => :'mid'
28
-
29
37
  }
30
38
  end
31
39
 
@@ -33,24 +41,38 @@ module ArtikCloud
33
41
  def self.swagger_types
34
42
  {
35
43
  :'mid' => :'String'
36
-
37
44
  }
38
45
  end
39
46
 
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
40
49
  def initialize(attributes = {})
41
50
  return unless attributes.is_a?(Hash)
42
51
 
43
52
  # convert string to symbol for hash key
44
- attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
53
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
45
54
 
46
-
47
- if attributes[:'mid']
55
+ if attributes.has_key?(:'mid')
48
56
  self.mid = attributes[:'mid']
49
57
  end
50
-
58
+
59
+ end
60
+
61
+ # Show invalid properties with the reasons. Usually used together with valid?
62
+ # @return Array for valid properies with the reasons
63
+ def list_invalid_properties
64
+ invalid_properties = Array.new
65
+ return invalid_properties
51
66
  end
52
67
 
53
- # Check equality by comparing each attribute.
68
+ # Check to see if the all the properties in the model are valid
69
+ # @return true if the model is valid
70
+ def valid?
71
+ return true
72
+ end
73
+
74
+ # Checks equality by comparing each attribute.
75
+ # @param [Object] Object to be compared
54
76
  def ==(o)
55
77
  return true if self.equal?(o)
56
78
  self.class == o.class &&
@@ -58,35 +80,41 @@ module ArtikCloud
58
80
  end
59
81
 
60
82
  # @see the `==` method
83
+ # @param [Object] Object to be compared
61
84
  def eql?(o)
62
85
  self == o
63
86
  end
64
87
 
65
- # Calculate hash code according to all attributes.
88
+ # Calculates hash code according to all attributes.
89
+ # @return [Fixnum] Hash code
66
90
  def hash
67
91
  [mid].hash
68
92
  end
69
93
 
70
- # build the object from hash
94
+ # Builds the object from hash
95
+ # @param [Hash] attributes Model attributes in the form of hash
96
+ # @return [Object] Returns the model itself
71
97
  def build_from_hash(attributes)
72
98
  return nil unless attributes.is_a?(Hash)
73
99
  self.class.swagger_types.each_pair do |key, type|
74
100
  if type =~ /^Array<(.*)>/i
101
+ # check to ensure the input is an array given that the the attribute
102
+ # is documented as an array but the input is not
75
103
  if attributes[self.class.attribute_map[key]].is_a?(Array)
76
104
  self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
77
- else
78
- #TODO show warning in debug mode
79
105
  end
80
106
  elsif !attributes[self.class.attribute_map[key]].nil?
81
107
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
82
- else
83
- # data not found in attributes(hash), not an issue as the data can be optional
84
- end
108
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
85
109
  end
86
110
 
87
111
  self
88
112
  end
89
113
 
114
+ # Deserializes the data based on type
115
+ # @param string type Data type
116
+ # @param string value Value to be deserialized
117
+ # @return [Object] Deserialized data
90
118
  def _deserialize(type, value)
91
119
  case type.to_sym
92
120
  when :DateTime
@@ -120,21 +148,25 @@ module ArtikCloud
120
148
  end
121
149
  end
122
150
  else # model
123
- _model = ArtikCloud.const_get(type).new
124
- _model.build_from_hash(value)
151
+ temp_model = ArtikCloud.const_get(type).new
152
+ temp_model.build_from_hash(value)
125
153
  end
126
154
  end
127
155
 
156
+ # Returns the string representation of the object
157
+ # @return [String] String presentation of the object
128
158
  def to_s
129
159
  to_hash.to_s
130
160
  end
131
161
 
132
- # to_body is an alias to to_body (backward compatibility))
162
+ # to_body is an alias to to_hash (backward compatibility)
163
+ # @return [Hash] Returns the object in the form of hash
133
164
  def to_body
134
165
  to_hash
135
166
  end
136
167
 
137
- # return the object in the form of hash
168
+ # Returns the object in the form of hash
169
+ # @return [Hash] Returns the object in the form of hash
138
170
  def to_hash
139
171
  hash = {}
140
172
  self.class.attribute_map.each_pair do |attr, param|
@@ -145,8 +177,10 @@ module ArtikCloud
145
177
  hash
146
178
  end
147
179
 
148
- # Method to output non-array value in the form of hash
180
+ # Outputs non-array value in the form of hash
149
181
  # For object, use to_hash. Otherwise, just return the value
182
+ # @param [Object] value Any valid value
183
+ # @return [Hash] Returns the value in the form of hash
150
184
  def _to_hash(value)
151
185
  if value.is_a?(Array)
152
186
  value.compact.map{ |v| _to_hash(v) }
@@ -162,4 +196,5 @@ module ArtikCloud
162
196
  end
163
197
 
164
198
  end
199
+
165
200
  end