cloudmersive-nlp-api-client 1.2.9 → 2.0.1

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 (103) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +38 -35
  3. data/cloudmersive-nlp-api-client.gemspec +3 -3
  4. data/docs/CheckSentenceRequest.md +8 -0
  5. data/docs/CheckSentenceResponse.md +9 -0
  6. data/docs/CheckWordRequest.md +8 -0
  7. data/docs/{CorrectJsonResponse.md → CheckWordResponse.md} +1 -1
  8. data/docs/{CorrectWordInSentenceJsonResponse.md → CorrectWordInSentence.md} +1 -1
  9. data/docs/Entity.md +9 -0
  10. data/docs/{ExtractEntitiesStringApi.md → ExtractEntitiesApi.md} +10 -10
  11. data/docs/ExtractEntitiesRequest.md +8 -0
  12. data/docs/ExtractEntitiesResponse.md +9 -0
  13. data/docs/GetWordsRequest.md +8 -0
  14. data/docs/{GetWordsJsonResponse.md → GetWordsResponse.md} +1 -1
  15. data/docs/LanguageDetectionApi.md +7 -7
  16. data/docs/LanguageDetectionRequest.md +8 -0
  17. data/docs/{ParseStringApi.md → ParseApi.md} +10 -10
  18. data/docs/ParseRequest.md +8 -0
  19. data/docs/ParseResponse.md +8 -0
  20. data/docs/{SpellCheckApi.md → PosTaggerApi.md} +73 -73
  21. data/docs/SegmentationApi.md +118 -0
  22. data/docs/SentenceSegmentationRequest.md +8 -0
  23. data/docs/SentenceSegmentationResponse.md +10 -0
  24. data/docs/SpellcheckApi.md +118 -0
  25. data/lib/cloudmersive-nlp-api-client.rb +23 -15
  26. data/lib/cloudmersive-nlp-api-client/api/{extract_entities_string_api.rb → extract_entities_api.rb} +14 -14
  27. data/lib/cloudmersive-nlp-api-client/api/language_detection_api.rb +15 -15
  28. data/lib/cloudmersive-nlp-api-client/api/{parse_string_api.rb → parse_api.rb} +14 -14
  29. data/lib/cloudmersive-nlp-api-client/api/pos_tagger_api.rb +353 -0
  30. data/lib/cloudmersive-nlp-api-client/api/segmentation_api.rb +133 -0
  31. data/lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb +133 -0
  32. data/lib/cloudmersive-nlp-api-client/api_client.rb +3 -3
  33. data/lib/cloudmersive-nlp-api-client/api_error.rb +3 -3
  34. data/lib/cloudmersive-nlp-api-client/configuration.rb +3 -3
  35. data/lib/cloudmersive-nlp-api-client/models/check_sentence_request.rb +189 -0
  36. data/lib/cloudmersive-nlp-api-client/models/{check_sentence_json_response.rb → check_sentence_response.rb} +5 -5
  37. data/lib/cloudmersive-nlp-api-client/models/{check_json_response.rb → check_word_request.rb} +12 -13
  38. data/lib/cloudmersive-nlp-api-client/models/{correct_json_response.rb → check_word_response.rb} +4 -4
  39. data/lib/cloudmersive-nlp-api-client/models/{correct_word_in_sentence_json_response.rb → correct_word_in_sentence.rb} +4 -4
  40. data/lib/cloudmersive-nlp-api-client/models/entity.rb +197 -0
  41. data/lib/cloudmersive-nlp-api-client/models/extract_entities_request.rb +189 -0
  42. data/lib/cloudmersive-nlp-api-client/models/extract_entities_response.rb +200 -0
  43. data/lib/cloudmersive-nlp-api-client/models/get_words_request.rb +188 -0
  44. data/lib/cloudmersive-nlp-api-client/models/{get_words_json_response.rb → get_words_response.rb} +4 -4
  45. data/lib/cloudmersive-nlp-api-client/models/language_detection_request.rb +189 -0
  46. data/lib/cloudmersive-nlp-api-client/models/language_detection_response.rb +3 -3
  47. data/lib/cloudmersive-nlp-api-client/models/parse_request.rb +189 -0
  48. data/lib/cloudmersive-nlp-api-client/models/parse_response.rb +189 -0
  49. data/lib/cloudmersive-nlp-api-client/models/pos_request.rb +3 -3
  50. data/lib/cloudmersive-nlp-api-client/models/pos_response.rb +3 -3
  51. data/lib/cloudmersive-nlp-api-client/models/pos_sentence.rb +3 -3
  52. data/lib/cloudmersive-nlp-api-client/models/pos_tagged_word.rb +3 -3
  53. data/lib/cloudmersive-nlp-api-client/models/sentence_segmentation_request.rb +188 -0
  54. data/lib/cloudmersive-nlp-api-client/models/sentence_segmentation_response.rb +208 -0
  55. data/lib/cloudmersive-nlp-api-client/models/word_position.rb +3 -3
  56. data/lib/cloudmersive-nlp-api-client/version.rb +4 -4
  57. data/spec/api/{extract_entities_string_api_spec.rb → extract_entities_api_spec.rb} +12 -12
  58. data/spec/api/language_detection_api_spec.rb +6 -6
  59. data/spec/api/{parse_string_api_spec.rb → parse_api_spec.rb} +12 -12
  60. data/spec/api/pos_tagger_api_spec.rb +107 -0
  61. data/spec/api/segmentation_api_spec.rb +59 -0
  62. data/spec/api/spellcheck_api_spec.rb +59 -0
  63. data/spec/api_client_spec.rb +3 -3
  64. data/spec/configuration_spec.rb +3 -3
  65. data/spec/models/check_sentence_request_spec.rb +42 -0
  66. data/spec/models/{check_sentence_json_response_spec.rb → check_sentence_response_spec.rb} +9 -9
  67. data/spec/models/{check_json_response_spec.rb → check_word_request_spec.rb} +10 -10
  68. data/spec/models/{correct_json_response_spec.rb → check_word_response_spec.rb} +9 -9
  69. data/spec/models/{correct_word_in_sentence_json_response_spec.rb → correct_word_in_sentence_spec.rb} +9 -9
  70. data/spec/models/entity_spec.rb +48 -0
  71. data/spec/models/extract_entities_request_spec.rb +42 -0
  72. data/spec/models/extract_entities_response_spec.rb +48 -0
  73. data/spec/models/get_words_request_spec.rb +42 -0
  74. data/spec/models/{get_words_json_response_spec.rb → get_words_response_spec.rb} +9 -9
  75. data/spec/models/language_detection_request_spec.rb +42 -0
  76. data/spec/models/language_detection_response_spec.rb +3 -3
  77. data/spec/models/parse_request_spec.rb +42 -0
  78. data/spec/models/parse_response_spec.rb +42 -0
  79. data/spec/models/pos_request_spec.rb +3 -3
  80. data/spec/models/pos_response_spec.rb +3 -3
  81. data/spec/models/pos_sentence_spec.rb +3 -3
  82. data/spec/models/pos_tagged_word_spec.rb +3 -3
  83. data/spec/models/sentence_segmentation_request_spec.rb +42 -0
  84. data/spec/models/sentence_segmentation_response_spec.rb +54 -0
  85. data/spec/models/word_position_spec.rb +3 -3
  86. data/spec/spec_helper.rb +3 -3
  87. metadata +75 -52
  88. data/docs/CheckJsonResponse.md +0 -8
  89. data/docs/CheckSentenceJsonResponse.md +0 -9
  90. data/docs/PosTaggerJsonApi.md +0 -63
  91. data/docs/PosTaggerStringApi.md +0 -63
  92. data/docs/SentencesApi.md +0 -63
  93. data/docs/WordsApi.md +0 -448
  94. data/lib/cloudmersive-nlp-api-client/api/pos_tagger_json_api.rb +0 -78
  95. data/lib/cloudmersive-nlp-api-client/api/pos_tagger_string_api.rb +0 -78
  96. data/lib/cloudmersive-nlp-api-client/api/sentences_api.rb +0 -78
  97. data/lib/cloudmersive-nlp-api-client/api/spell_check_api.rb +0 -353
  98. data/lib/cloudmersive-nlp-api-client/api/words_api.rb +0 -463
  99. data/spec/api/pos_tagger_json_api_spec.rb +0 -47
  100. data/spec/api/pos_tagger_string_api_spec.rb +0 -47
  101. data/spec/api/sentences_api_spec.rb +0 -47
  102. data/spec/api/spell_check_api_spec.rb +0 -107
  103. data/spec/api/words_api_spec.rb +0 -131
@@ -1,12 +1,12 @@
1
1
  =begin
2
- #nlpapi
2
+ #nlpapiv2
3
3
 
4
- #The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
9
+ Swagger Codegen version: 2.3.1
10
10
 
11
11
  =end
12
12
 
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CloudmersiveNlpApiClient
16
16
  # Spelling correction check result
17
- class CorrectJsonResponse
17
+ class CheckWordResponse
18
18
  # True if the word is spelled correctly, false otherwise
19
19
  attr_accessor :correct
20
20
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
- #nlpapi
2
+ #nlpapiv2
3
3
 
4
- #The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
9
+ Swagger Codegen version: 2.3.1
10
10
 
11
11
  =end
12
12
 
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CloudmersiveNlpApiClient
16
16
  # A word in a sentence
17
- class CorrectWordInSentenceJsonResponse
17
+ class CorrectWordInSentence
18
18
  # Position of the word
19
19
  attr_accessor :word
20
20
 
@@ -0,0 +1,197 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveNlpApiClient
16
+
17
+ class Entity
18
+ attr_accessor :entity_type
19
+
20
+ attr_accessor :entity_text
21
+
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'entity_type' => :'EntityType',
27
+ :'entity_text' => :'EntityText'
28
+ }
29
+ end
30
+
31
+ # Attribute type mapping.
32
+ def self.swagger_types
33
+ {
34
+ :'entity_type' => :'String',
35
+ :'entity_text' => :'String'
36
+ }
37
+ end
38
+
39
+ # Initializes the object
40
+ # @param [Hash] attributes Model attributes in the form of hash
41
+ def initialize(attributes = {})
42
+ return unless attributes.is_a?(Hash)
43
+
44
+ # convert string to symbol for hash key
45
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
46
+
47
+ if attributes.has_key?(:'EntityType')
48
+ self.entity_type = attributes[:'EntityType']
49
+ end
50
+
51
+ if attributes.has_key?(:'EntityText')
52
+ self.entity_text = attributes[:'EntityText']
53
+ end
54
+
55
+ end
56
+
57
+ # Show invalid properties with the reasons. Usually used together with valid?
58
+ # @return Array for valid properties with the reasons
59
+ def list_invalid_properties
60
+ invalid_properties = Array.new
61
+ return invalid_properties
62
+ end
63
+
64
+ # Check to see if the all the properties in the model are valid
65
+ # @return true if the model is valid
66
+ def valid?
67
+ return true
68
+ end
69
+
70
+ # Checks equality by comparing each attribute.
71
+ # @param [Object] Object to be compared
72
+ def ==(o)
73
+ return true if self.equal?(o)
74
+ self.class == o.class &&
75
+ entity_type == o.entity_type &&
76
+ entity_text == o.entity_text
77
+ end
78
+
79
+ # @see the `==` method
80
+ # @param [Object] Object to be compared
81
+ def eql?(o)
82
+ self == o
83
+ end
84
+
85
+ # Calculates hash code according to all attributes.
86
+ # @return [Fixnum] Hash code
87
+ def hash
88
+ [entity_type, entity_text].hash
89
+ end
90
+
91
+ # Builds the object from hash
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ # @return [Object] Returns the model itself
94
+ def build_from_hash(attributes)
95
+ return nil unless attributes.is_a?(Hash)
96
+ self.class.swagger_types.each_pair do |key, type|
97
+ if type =~ /\AArray<(.*)>/i
98
+ # check to ensure the input is an array given that the the attribute
99
+ # is documented as an array but the input is not
100
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
101
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
102
+ end
103
+ elsif !attributes[self.class.attribute_map[key]].nil?
104
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
105
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
106
+ end
107
+
108
+ self
109
+ end
110
+
111
+ # Deserializes the data based on type
112
+ # @param string type Data type
113
+ # @param string value Value to be deserialized
114
+ # @return [Object] Deserialized data
115
+ def _deserialize(type, value)
116
+ case type.to_sym
117
+ when :DateTime
118
+ DateTime.parse(value)
119
+ when :Date
120
+ Date.parse(value)
121
+ when :String
122
+ value.to_s
123
+ when :Integer
124
+ value.to_i
125
+ when :Float
126
+ value.to_f
127
+ when :BOOLEAN
128
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
129
+ true
130
+ else
131
+ false
132
+ end
133
+ when :Object
134
+ # generic object (usually a Hash), return directly
135
+ value
136
+ when /\AArray<(?<inner_type>.+)>\z/
137
+ inner_type = Regexp.last_match[:inner_type]
138
+ value.map { |v| _deserialize(inner_type, v) }
139
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
140
+ k_type = Regexp.last_match[:k_type]
141
+ v_type = Regexp.last_match[:v_type]
142
+ {}.tap do |hash|
143
+ value.each do |k, v|
144
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
145
+ end
146
+ end
147
+ else # model
148
+ temp_model = CloudmersiveNlpApiClient.const_get(type).new
149
+ temp_model.build_from_hash(value)
150
+ end
151
+ end
152
+
153
+ # Returns the string representation of the object
154
+ # @return [String] String presentation of the object
155
+ def to_s
156
+ to_hash.to_s
157
+ end
158
+
159
+ # to_body is an alias to to_hash (backward compatibility)
160
+ # @return [Hash] Returns the object in the form of hash
161
+ def to_body
162
+ to_hash
163
+ end
164
+
165
+ # Returns the object in the form of hash
166
+ # @return [Hash] Returns the object in the form of hash
167
+ def to_hash
168
+ hash = {}
169
+ self.class.attribute_map.each_pair do |attr, param|
170
+ value = self.send(attr)
171
+ next if value.nil?
172
+ hash[param] = _to_hash(value)
173
+ end
174
+ hash
175
+ end
176
+
177
+ # Outputs non-array value in the form of hash
178
+ # For object, use to_hash. Otherwise, just return the value
179
+ # @param [Object] value Any valid value
180
+ # @return [Hash] Returns the value in the form of hash
181
+ def _to_hash(value)
182
+ if value.is_a?(Array)
183
+ value.compact.map{ |v| _to_hash(v) }
184
+ elsif value.is_a?(Hash)
185
+ {}.tap do |hash|
186
+ value.each { |k, v| hash[k] = _to_hash(v) }
187
+ end
188
+ elsif value.respond_to? :to_hash
189
+ value.to_hash
190
+ else
191
+ value
192
+ end
193
+ end
194
+
195
+ end
196
+
197
+ end
@@ -0,0 +1,189 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveNlpApiClient
16
+ # Request to extract named entities
17
+ class ExtractEntitiesRequest
18
+ # Input string to extract entities from
19
+ attr_accessor :input_string
20
+
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'input_string' => :'InputString'
26
+ }
27
+ end
28
+
29
+ # Attribute type mapping.
30
+ def self.swagger_types
31
+ {
32
+ :'input_string' => :'String'
33
+ }
34
+ end
35
+
36
+ # Initializes the object
37
+ # @param [Hash] attributes Model attributes in the form of hash
38
+ def initialize(attributes = {})
39
+ return unless attributes.is_a?(Hash)
40
+
41
+ # convert string to symbol for hash key
42
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
43
+
44
+ if attributes.has_key?(:'InputString')
45
+ self.input_string = attributes[:'InputString']
46
+ end
47
+
48
+ end
49
+
50
+ # Show invalid properties with the reasons. Usually used together with valid?
51
+ # @return Array for valid properties with the reasons
52
+ def list_invalid_properties
53
+ invalid_properties = Array.new
54
+ return invalid_properties
55
+ end
56
+
57
+ # Check to see if the all the properties in the model are valid
58
+ # @return true if the model is valid
59
+ def valid?
60
+ return true
61
+ end
62
+
63
+ # Checks equality by comparing each attribute.
64
+ # @param [Object] Object to be compared
65
+ def ==(o)
66
+ return true if self.equal?(o)
67
+ self.class == o.class &&
68
+ input_string == o.input_string
69
+ end
70
+
71
+ # @see the `==` method
72
+ # @param [Object] Object to be compared
73
+ def eql?(o)
74
+ self == o
75
+ end
76
+
77
+ # Calculates hash code according to all attributes.
78
+ # @return [Fixnum] Hash code
79
+ def hash
80
+ [input_string].hash
81
+ end
82
+
83
+ # Builds the object from hash
84
+ # @param [Hash] attributes Model attributes in the form of hash
85
+ # @return [Object] Returns the model itself
86
+ def build_from_hash(attributes)
87
+ return nil unless attributes.is_a?(Hash)
88
+ self.class.swagger_types.each_pair do |key, type|
89
+ if type =~ /\AArray<(.*)>/i
90
+ # check to ensure the input is an array given that the the attribute
91
+ # is documented as an array but the input is not
92
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
93
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
94
+ end
95
+ elsif !attributes[self.class.attribute_map[key]].nil?
96
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
97
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
98
+ end
99
+
100
+ self
101
+ end
102
+
103
+ # Deserializes the data based on type
104
+ # @param string type Data type
105
+ # @param string value Value to be deserialized
106
+ # @return [Object] Deserialized data
107
+ def _deserialize(type, value)
108
+ case type.to_sym
109
+ when :DateTime
110
+ DateTime.parse(value)
111
+ when :Date
112
+ Date.parse(value)
113
+ when :String
114
+ value.to_s
115
+ when :Integer
116
+ value.to_i
117
+ when :Float
118
+ value.to_f
119
+ when :BOOLEAN
120
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
121
+ true
122
+ else
123
+ false
124
+ end
125
+ when :Object
126
+ # generic object (usually a Hash), return directly
127
+ value
128
+ when /\AArray<(?<inner_type>.+)>\z/
129
+ inner_type = Regexp.last_match[:inner_type]
130
+ value.map { |v| _deserialize(inner_type, v) }
131
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
132
+ k_type = Regexp.last_match[:k_type]
133
+ v_type = Regexp.last_match[:v_type]
134
+ {}.tap do |hash|
135
+ value.each do |k, v|
136
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
137
+ end
138
+ end
139
+ else # model
140
+ temp_model = CloudmersiveNlpApiClient.const_get(type).new
141
+ temp_model.build_from_hash(value)
142
+ end
143
+ end
144
+
145
+ # Returns the string representation of the object
146
+ # @return [String] String presentation of the object
147
+ def to_s
148
+ to_hash.to_s
149
+ end
150
+
151
+ # to_body is an alias to to_hash (backward compatibility)
152
+ # @return [Hash] Returns the object in the form of hash
153
+ def to_body
154
+ to_hash
155
+ end
156
+
157
+ # Returns the object in the form of hash
158
+ # @return [Hash] Returns the object in the form of hash
159
+ def to_hash
160
+ hash = {}
161
+ self.class.attribute_map.each_pair do |attr, param|
162
+ value = self.send(attr)
163
+ next if value.nil?
164
+ hash[param] = _to_hash(value)
165
+ end
166
+ hash
167
+ end
168
+
169
+ # Outputs non-array value in the form of hash
170
+ # For object, use to_hash. Otherwise, just return the value
171
+ # @param [Object] value Any valid value
172
+ # @return [Hash] Returns the value in the form of hash
173
+ def _to_hash(value)
174
+ if value.is_a?(Array)
175
+ value.compact.map{ |v| _to_hash(v) }
176
+ elsif value.is_a?(Hash)
177
+ {}.tap do |hash|
178
+ value.each { |k, v| hash[k] = _to_hash(v) }
179
+ end
180
+ elsif value.respond_to? :to_hash
181
+ value.to_hash
182
+ else
183
+ value
184
+ end
185
+ end
186
+
187
+ end
188
+
189
+ end
@@ -0,0 +1,200 @@
1
+ =begin
2
+ #nlpapiv2
3
+
4
+ #The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveNlpApiClient
16
+ # Result of performing an extract entities operation
17
+ class ExtractEntitiesResponse
18
+ # True if the operation was successful, false otherwise
19
+ attr_accessor :successful
20
+
21
+ attr_accessor :entities
22
+
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'successful' => :'Successful',
28
+ :'entities' => :'Entities'
29
+ }
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.swagger_types
34
+ {
35
+ :'successful' => :'BOOLEAN',
36
+ :'entities' => :'Array<Entity>'
37
+ }
38
+ end
39
+
40
+ # Initializes the object
41
+ # @param [Hash] attributes Model attributes in the form of hash
42
+ def initialize(attributes = {})
43
+ return unless attributes.is_a?(Hash)
44
+
45
+ # convert string to symbol for hash key
46
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
47
+
48
+ if attributes.has_key?(:'Successful')
49
+ self.successful = attributes[:'Successful']
50
+ end
51
+
52
+ if attributes.has_key?(:'Entities')
53
+ if (value = attributes[:'Entities']).is_a?(Array)
54
+ self.entities = value
55
+ end
56
+ end
57
+
58
+ end
59
+
60
+ # Show invalid properties with the reasons. Usually used together with valid?
61
+ # @return Array for valid properties with the reasons
62
+ def list_invalid_properties
63
+ invalid_properties = Array.new
64
+ return invalid_properties
65
+ end
66
+
67
+ # Check to see if the all the properties in the model are valid
68
+ # @return true if the model is valid
69
+ def valid?
70
+ return true
71
+ end
72
+
73
+ # Checks equality by comparing each attribute.
74
+ # @param [Object] Object to be compared
75
+ def ==(o)
76
+ return true if self.equal?(o)
77
+ self.class == o.class &&
78
+ successful == o.successful &&
79
+ entities == o.entities
80
+ end
81
+
82
+ # @see the `==` method
83
+ # @param [Object] Object to be compared
84
+ def eql?(o)
85
+ self == o
86
+ end
87
+
88
+ # Calculates hash code according to all attributes.
89
+ # @return [Fixnum] Hash code
90
+ def hash
91
+ [successful, entities].hash
92
+ end
93
+
94
+ # Builds the object from hash
95
+ # @param [Hash] attributes Model attributes in the form of hash
96
+ # @return [Object] Returns the model itself
97
+ def build_from_hash(attributes)
98
+ return nil unless attributes.is_a?(Hash)
99
+ self.class.swagger_types.each_pair do |key, type|
100
+ if type =~ /\AArray<(.*)>/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
103
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
104
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
105
+ end
106
+ elsif !attributes[self.class.attribute_map[key]].nil?
107
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
108
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
109
+ end
110
+
111
+ self
112
+ end
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
118
+ def _deserialize(type, value)
119
+ case type.to_sym
120
+ when :DateTime
121
+ DateTime.parse(value)
122
+ when :Date
123
+ Date.parse(value)
124
+ when :String
125
+ value.to_s
126
+ when :Integer
127
+ value.to_i
128
+ when :Float
129
+ value.to_f
130
+ when :BOOLEAN
131
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
132
+ true
133
+ else
134
+ false
135
+ end
136
+ when :Object
137
+ # generic object (usually a Hash), return directly
138
+ value
139
+ when /\AArray<(?<inner_type>.+)>\z/
140
+ inner_type = Regexp.last_match[:inner_type]
141
+ value.map { |v| _deserialize(inner_type, v) }
142
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
143
+ k_type = Regexp.last_match[:k_type]
144
+ v_type = Regexp.last_match[:v_type]
145
+ {}.tap do |hash|
146
+ value.each do |k, v|
147
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
148
+ end
149
+ end
150
+ else # model
151
+ temp_model = CloudmersiveNlpApiClient.const_get(type).new
152
+ temp_model.build_from_hash(value)
153
+ end
154
+ end
155
+
156
+ # Returns the string representation of the object
157
+ # @return [String] String presentation of the object
158
+ def to_s
159
+ to_hash.to_s
160
+ end
161
+
162
+ # to_body is an alias to to_hash (backward compatibility)
163
+ # @return [Hash] Returns the object in the form of hash
164
+ def to_body
165
+ to_hash
166
+ end
167
+
168
+ # Returns the object in the form of hash
169
+ # @return [Hash] Returns the object in the form of hash
170
+ def to_hash
171
+ hash = {}
172
+ self.class.attribute_map.each_pair do |attr, param|
173
+ value = self.send(attr)
174
+ next if value.nil?
175
+ hash[param] = _to_hash(value)
176
+ end
177
+ hash
178
+ end
179
+
180
+ # Outputs non-array value in the form of hash
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
184
+ def _to_hash(value)
185
+ if value.is_a?(Array)
186
+ value.compact.map{ |v| _to_hash(v) }
187
+ elsif value.is_a?(Hash)
188
+ {}.tap do |hash|
189
+ value.each { |k, v| hash[k] = _to_hash(v) }
190
+ end
191
+ elsif value.respond_to? :to_hash
192
+ value.to_hash
193
+ else
194
+ value
195
+ end
196
+ end
197
+
198
+ end
199
+
200
+ end