artikcloud 2.0.0 → 2.0.5

Sign up to get free protection for your applications and to get access to all the features.
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,285 @@
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
+ # Normalized Actions Envelope
28
+ class NormalizedActionsEnvelope
29
+ attr_accessor :ddids
30
+
31
+ attr_accessor :ddid
32
+
33
+ attr_accessor :uid
34
+
35
+ attr_accessor :start_date
36
+
37
+ attr_accessor :end_date
38
+
39
+ attr_accessor :order
40
+
41
+ attr_accessor :_next
42
+
43
+ attr_accessor :count
44
+
45
+ attr_accessor :size
46
+
47
+ attr_accessor :data
48
+
49
+
50
+ # Attribute mapping from ruby-style variable name to JSON key.
51
+ def self.attribute_map
52
+ {
53
+ :'ddids' => :'ddids',
54
+ :'ddid' => :'ddid',
55
+ :'uid' => :'uid',
56
+ :'start_date' => :'startDate',
57
+ :'end_date' => :'endDate',
58
+ :'order' => :'order',
59
+ :'_next' => :'next',
60
+ :'count' => :'count',
61
+ :'size' => :'size',
62
+ :'data' => :'data'
63
+ }
64
+ end
65
+
66
+ # Attribute type mapping.
67
+ def self.swagger_types
68
+ {
69
+ :'ddids' => :'String',
70
+ :'ddid' => :'String',
71
+ :'uid' => :'String',
72
+ :'start_date' => :'Integer',
73
+ :'end_date' => :'Integer',
74
+ :'order' => :'String',
75
+ :'_next' => :'String',
76
+ :'count' => :'Integer',
77
+ :'size' => :'Integer',
78
+ :'data' => :'Array<NormalizedAction>'
79
+ }
80
+ end
81
+
82
+ # Initializes the object
83
+ # @param [Hash] attributes Model attributes in the form of hash
84
+ def initialize(attributes = {})
85
+ return unless attributes.is_a?(Hash)
86
+
87
+ # convert string to symbol for hash key
88
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
89
+
90
+ if attributes.has_key?(:'ddids')
91
+ self.ddids = attributes[:'ddids']
92
+ end
93
+
94
+ if attributes.has_key?(:'ddid')
95
+ self.ddid = attributes[:'ddid']
96
+ end
97
+
98
+ if attributes.has_key?(:'uid')
99
+ self.uid = attributes[:'uid']
100
+ end
101
+
102
+ if attributes.has_key?(:'startDate')
103
+ self.start_date = attributes[:'startDate']
104
+ end
105
+
106
+ if attributes.has_key?(:'endDate')
107
+ self.end_date = attributes[:'endDate']
108
+ end
109
+
110
+ if attributes.has_key?(:'order')
111
+ self.order = attributes[:'order']
112
+ end
113
+
114
+ if attributes.has_key?(:'next')
115
+ self._next = attributes[:'next']
116
+ end
117
+
118
+ if attributes.has_key?(:'count')
119
+ self.count = attributes[:'count']
120
+ end
121
+
122
+ if attributes.has_key?(:'size')
123
+ self.size = attributes[:'size']
124
+ end
125
+
126
+ if attributes.has_key?(:'data')
127
+ if (value = attributes[:'data']).is_a?(Array)
128
+ self.data = value
129
+ end
130
+ end
131
+
132
+ end
133
+
134
+ # Show invalid properties with the reasons. Usually used together with valid?
135
+ # @return Array for valid properies with the reasons
136
+ def list_invalid_properties
137
+ invalid_properties = Array.new
138
+ return invalid_properties
139
+ end
140
+
141
+ # Check to see if the all the properties in the model are valid
142
+ # @return true if the model is valid
143
+ def valid?
144
+ return false if @count.nil?
145
+ return false if @size.nil?
146
+ return false if @data.nil?
147
+ return true
148
+ end
149
+
150
+ # Checks equality by comparing each attribute.
151
+ # @param [Object] Object to be compared
152
+ def ==(o)
153
+ return true if self.equal?(o)
154
+ self.class == o.class &&
155
+ ddids == o.ddids &&
156
+ ddid == o.ddid &&
157
+ uid == o.uid &&
158
+ start_date == o.start_date &&
159
+ end_date == o.end_date &&
160
+ order == o.order &&
161
+ _next == o._next &&
162
+ count == o.count &&
163
+ size == o.size &&
164
+ data == o.data
165
+ end
166
+
167
+ # @see the `==` method
168
+ # @param [Object] Object to be compared
169
+ def eql?(o)
170
+ self == o
171
+ end
172
+
173
+ # Calculates hash code according to all attributes.
174
+ # @return [Fixnum] Hash code
175
+ def hash
176
+ [ddids, ddid, uid, start_date, end_date, order, _next, count, size, data].hash
177
+ end
178
+
179
+ # Builds the object from hash
180
+ # @param [Hash] attributes Model attributes in the form of hash
181
+ # @return [Object] Returns the model itself
182
+ def build_from_hash(attributes)
183
+ return nil unless attributes.is_a?(Hash)
184
+ self.class.swagger_types.each_pair do |key, type|
185
+ if type =~ /^Array<(.*)>/i
186
+ # check to ensure the input is an array given that the the attribute
187
+ # is documented as an array but the input is not
188
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
189
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
190
+ end
191
+ elsif !attributes[self.class.attribute_map[key]].nil?
192
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
193
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
194
+ end
195
+
196
+ self
197
+ end
198
+
199
+ # Deserializes the data based on type
200
+ # @param string type Data type
201
+ # @param string value Value to be deserialized
202
+ # @return [Object] Deserialized data
203
+ def _deserialize(type, value)
204
+ case type.to_sym
205
+ when :DateTime
206
+ DateTime.parse(value)
207
+ when :Date
208
+ Date.parse(value)
209
+ when :String
210
+ value.to_s
211
+ when :Integer
212
+ value.to_i
213
+ when :Float
214
+ value.to_f
215
+ when :BOOLEAN
216
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
217
+ true
218
+ else
219
+ false
220
+ end
221
+ when :Object
222
+ # generic object (usually a Hash), return directly
223
+ value
224
+ when /\AArray<(?<inner_type>.+)>\z/
225
+ inner_type = Regexp.last_match[:inner_type]
226
+ value.map { |v| _deserialize(inner_type, v) }
227
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
228
+ k_type = Regexp.last_match[:k_type]
229
+ v_type = Regexp.last_match[:v_type]
230
+ {}.tap do |hash|
231
+ value.each do |k, v|
232
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
233
+ end
234
+ end
235
+ else # model
236
+ temp_model = ArtikCloud.const_get(type).new
237
+ temp_model.build_from_hash(value)
238
+ end
239
+ end
240
+
241
+ # Returns the string representation of the object
242
+ # @return [String] String presentation of the object
243
+ def to_s
244
+ to_hash.to_s
245
+ end
246
+
247
+ # to_body is an alias to to_hash (backward compatibility)
248
+ # @return [Hash] Returns the object in the form of hash
249
+ def to_body
250
+ to_hash
251
+ end
252
+
253
+ # Returns the object in the form of hash
254
+ # @return [Hash] Returns the object in the form of hash
255
+ def to_hash
256
+ hash = {}
257
+ self.class.attribute_map.each_pair do |attr, param|
258
+ value = self.send(attr)
259
+ next if value.nil?
260
+ hash[param] = _to_hash(value)
261
+ end
262
+ hash
263
+ end
264
+
265
+ # Outputs non-array value in the form of hash
266
+ # For object, use to_hash. Otherwise, just return the value
267
+ # @param [Object] value Any valid value
268
+ # @return [Hash] Returns the value in the form of hash
269
+ def _to_hash(value)
270
+ if value.is_a?(Array)
271
+ value.compact.map{ |v| _to_hash(v) }
272
+ elsif value.is_a?(Hash)
273
+ {}.tap do |hash|
274
+ value.each { |k, v| hash[k] = _to_hash(v) }
275
+ end
276
+ elsif value.respond_to? :to_hash
277
+ value.to_hash
278
+ else
279
+ value
280
+ end
281
+ end
282
+
283
+ end
284
+
285
+ 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
 
@@ -33,26 +42,18 @@ module ArtikCloud
33
42
 
34
43
  attr_accessor :data
35
44
 
45
+
36
46
  # Attribute mapping from ruby-style variable name to JSON key.
37
47
  def self.attribute_map
38
48
  {
39
-
40
49
  :'cts' => :'cts',
41
-
42
50
  :'ts' => :'ts',
43
-
44
51
  :'mid' => :'mid',
45
-
46
52
  :'sdid' => :'sdid',
47
-
48
53
  :'sdtid' => :'sdtid',
49
-
50
54
  :'uid' => :'uid',
51
-
52
55
  :'mv' => :'mv',
53
-
54
56
  :'data' => :'data'
55
-
56
57
  }
57
58
  end
58
59
 
@@ -67,54 +68,76 @@ module ArtikCloud
67
68
  :'uid' => :'String',
68
69
  :'mv' => :'Integer',
69
70
  :'data' => :'Hash<String, Object>'
70
-
71
71
  }
72
72
  end
73
73
 
74
+ # Initializes the object
75
+ # @param [Hash] attributes Model attributes in the form of hash
74
76
  def initialize(attributes = {})
75
77
  return unless attributes.is_a?(Hash)
76
78
 
77
79
  # convert string to symbol for hash key
78
- attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
80
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
79
81
 
80
-
81
- if attributes[:'cts']
82
+ if attributes.has_key?(:'cts')
82
83
  self.cts = attributes[:'cts']
83
84
  end
84
-
85
- if attributes[:'ts']
85
+
86
+ if attributes.has_key?(:'ts')
86
87
  self.ts = attributes[:'ts']
87
88
  end
88
-
89
- if attributes[:'mid']
89
+
90
+ if attributes.has_key?(:'mid')
90
91
  self.mid = attributes[:'mid']
91
92
  end
92
-
93
- if attributes[:'sdid']
93
+
94
+ if attributes.has_key?(:'sdid')
94
95
  self.sdid = attributes[:'sdid']
95
96
  end
96
-
97
- if attributes[:'sdtid']
97
+
98
+ if attributes.has_key?(:'sdtid')
98
99
  self.sdtid = attributes[:'sdtid']
99
100
  end
100
-
101
- if attributes[:'uid']
101
+
102
+ if attributes.has_key?(:'uid')
102
103
  self.uid = attributes[:'uid']
103
104
  end
104
-
105
- if attributes[:'mv']
105
+
106
+ if attributes.has_key?(:'mv')
106
107
  self.mv = attributes[:'mv']
107
108
  end
108
-
109
- if attributes[:'data']
109
+
110
+ if attributes.has_key?(:'data')
110
111
  if (value = attributes[:'data']).is_a?(Array)
111
112
  self.data = value
112
113
  end
113
114
  end
114
-
115
+
115
116
  end
116
117
 
117
- # Check equality by comparing each attribute.
118
+ # Show invalid properties with the reasons. Usually used together with valid?
119
+ # @return Array for valid properies with the reasons
120
+ def list_invalid_properties
121
+ invalid_properties = Array.new
122
+ return invalid_properties
123
+ end
124
+
125
+ # Check to see if the all the properties in the model are valid
126
+ # @return true if the model is valid
127
+ def valid?
128
+ return false if @cts.nil?
129
+ return false if @ts.nil?
130
+ return false if @mid.nil?
131
+ return false if @sdid.nil?
132
+ return false if @sdtid.nil?
133
+ return false if @uid.nil?
134
+ return false if @mv.nil?
135
+ return false if @data.nil?
136
+ return true
137
+ end
138
+
139
+ # Checks equality by comparing each attribute.
140
+ # @param [Object] Object to be compared
118
141
  def ==(o)
119
142
  return true if self.equal?(o)
120
143
  self.class == o.class &&
@@ -129,35 +152,41 @@ module ArtikCloud
129
152
  end
130
153
 
131
154
  # @see the `==` method
155
+ # @param [Object] Object to be compared
132
156
  def eql?(o)
133
157
  self == o
134
158
  end
135
159
 
136
- # Calculate hash code according to all attributes.
160
+ # Calculates hash code according to all attributes.
161
+ # @return [Fixnum] Hash code
137
162
  def hash
138
163
  [cts, ts, mid, sdid, sdtid, uid, mv, data].hash
139
164
  end
140
165
 
141
- # build the object from hash
166
+ # Builds the object from hash
167
+ # @param [Hash] attributes Model attributes in the form of hash
168
+ # @return [Object] Returns the model itself
142
169
  def build_from_hash(attributes)
143
170
  return nil unless attributes.is_a?(Hash)
144
171
  self.class.swagger_types.each_pair do |key, type|
145
172
  if type =~ /^Array<(.*)>/i
173
+ # check to ensure the input is an array given that the the attribute
174
+ # is documented as an array but the input is not
146
175
  if attributes[self.class.attribute_map[key]].is_a?(Array)
147
176
  self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
148
- else
149
- #TODO show warning in debug mode
150
177
  end
151
178
  elsif !attributes[self.class.attribute_map[key]].nil?
152
179
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
153
- else
154
- # data not found in attributes(hash), not an issue as the data can be optional
155
- end
180
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
156
181
  end
157
182
 
158
183
  self
159
184
  end
160
185
 
186
+ # Deserializes the data based on type
187
+ # @param string type Data type
188
+ # @param string value Value to be deserialized
189
+ # @return [Object] Deserialized data
161
190
  def _deserialize(type, value)
162
191
  case type.to_sym
163
192
  when :DateTime
@@ -191,21 +220,25 @@ module ArtikCloud
191
220
  end
192
221
  end
193
222
  else # model
194
- _model = ArtikCloud.const_get(type).new
195
- _model.build_from_hash(value)
223
+ temp_model = ArtikCloud.const_get(type).new
224
+ temp_model.build_from_hash(value)
196
225
  end
197
226
  end
198
227
 
228
+ # Returns the string representation of the object
229
+ # @return [String] String presentation of the object
199
230
  def to_s
200
231
  to_hash.to_s
201
232
  end
202
233
 
203
- # to_body is an alias to to_body (backward compatibility))
234
+ # to_body is an alias to to_hash (backward compatibility)
235
+ # @return [Hash] Returns the object in the form of hash
204
236
  def to_body
205
237
  to_hash
206
238
  end
207
239
 
208
- # return the object in the form of hash
240
+ # Returns the object in the form of hash
241
+ # @return [Hash] Returns the object in the form of hash
209
242
  def to_hash
210
243
  hash = {}
211
244
  self.class.attribute_map.each_pair do |attr, param|
@@ -216,8 +249,10 @@ module ArtikCloud
216
249
  hash
217
250
  end
218
251
 
219
- # Method to output non-array value in the form of hash
252
+ # Outputs non-array value in the form of hash
220
253
  # For object, use to_hash. Otherwise, just return the value
254
+ # @param [Object] value Any valid value
255
+ # @return [Hash] Returns the value in the form of hash
221
256
  def _to_hash(value)
222
257
  if value.is_a?(Array)
223
258
  value.compact.map{ |v| _to_hash(v) }
@@ -233,4 +268,5 @@ module ArtikCloud
233
268
  end
234
269
 
235
270
  end
271
+
236
272
  end