test-words-api-client-sdk 1.0.0

data/lib/words_api/models/definitions_response.rb

@@ -0,0 +1,56 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains response for definitions endpoint.
+  class DefinitionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # The definitions of the searched word.
+    # @return [Array[String]]
+    attr_accessor :definition
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['definition'] = 'definition'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, definition = nil)
+      @word = word
+      @definition = definition
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      definition = hash.key?('definition') ? hash['definition'] : nil
+
+      # Create object from extracted values.
+      DefinitionsResponse.new(word,
+                              definition)
+    end
+  end
+end

data/lib/words_api/models/examples_response.rb

@@ -0,0 +1,56 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains response for examples endpoint.
+  class ExamplesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # The usage examples of the searched word.
+    # @return [Array[String]]
+    attr_accessor :examples
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['examples'] = 'examples'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, examples = nil)
+      @word = word
+      @examples = examples
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      examples = hash.key?('examples') ? hash['examples'] : nil
+
+      # Create object from extracted values.
+      ExamplesResponse.new(word,
+                           examples)
+    end
+  end
+end

data/lib/words_api/models/frequency_details.rb

@@ -0,0 +1,64 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This model contains frequency details of a specific word.
+  class FrequencyDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Explains the zipf score.
+    # @return [Float]
+    attr_accessor :zipf
+
+    # Explains the perMillion score.
+    # @return [Float]
+    attr_accessor :per_million
+
+    # Explains the diversity score.
+    # @return [Float]
+    attr_accessor :diversity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['zipf'] = 'zipf'
+      @_hash['per_million'] = 'perMillion'
+      @_hash['diversity'] = 'diversity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(zipf = nil, per_million = nil, diversity = nil)
+      @zipf = zipf
+      @per_million = per_million
+      @diversity = diversity
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      zipf = hash.key?('zipf') ? hash['zipf'] : nil
+      per_million = hash.key?('perMillion') ? hash['perMillion'] : nil
+      diversity = hash.key?('diversity') ? hash['diversity'] : nil
+
+      # Create object from extracted values.
+      FrequencyDetails.new(zipf,
+                           per_million,
+                           diversity)
+    end
+  end
+end

data/lib/words_api/models/frequency_response.rb

@@ -0,0 +1,56 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains response for frequency endpoint.
+  class FrequencyResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # This model contains frequency details of a specific word.
+    # @return [FrequencyDetails]
+    attr_accessor :frequency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['frequency'] = 'frequency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, frequency = nil)
+      @word = word
+      @frequency = frequency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      frequency = FrequencyDetails.from_hash(hash['frequency']) if hash['frequency']
+
+      # Create object from extracted values.
+      FrequencyResponse.new(word,
+                            frequency)
+    end
+  end
+end

data/lib/words_api/models/pronunciation_details.rb

@@ -0,0 +1,67 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This model contains pronunciation details of a specific word.
+  class PronunciationDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pronunciation of the word.
+    # @return [String]
+    attr_accessor :all
+
+    # The noun pronunciation of the word.
+    # @return [String]
+    attr_accessor :noun
+
+    # The verb pronunciation of the word.
+    # @return [String]
+    attr_accessor :verb
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['all'] = 'all'
+      @_hash['noun'] = 'noun'
+      @_hash['verb'] = 'verb'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        noun
+        verb
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(all = nil, noun = SKIP, verb = SKIP)
+      @all = all
+      @noun = noun unless noun == SKIP
+      @verb = verb unless verb == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      all = hash.key?('all') ? hash['all'] : nil
+      noun = hash.key?('noun') ? hash['noun'] : SKIP
+      verb = hash.key?('verb') ? hash['verb'] : SKIP
+
+      # Create object from extracted values.
+      PronunciationDetails.new(all,
+                               noun,
+                               verb)
+    end
+  end
+end

data/lib/words_api/models/pronunciation_response.rb

@@ -0,0 +1,57 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains response for pronunciation endpoint.
+  class PronunciationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # This model contains pronunciation details of a specific word.
+    # @return [PronunciationDetails]
+    attr_accessor :pronunciation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['pronunciation'] = 'pronunciation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, pronunciation = nil)
+      @word = word
+      @pronunciation = pronunciation
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      pronunciation = PronunciationDetails.from_hash(hash['pronunciation']) if
+        hash['pronunciation']
+
+      # Create object from extracted values.
+      PronunciationResponse.new(word,
+                                pronunciation)
+    end
+  end
+end

data/lib/words_api/models/syllable_details.rb

@@ -0,0 +1,59 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains the syllable details for word API.
+  class SyllableDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The count of syllables.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The list of syllables.
+    # @return [Array[String]]
+    attr_accessor :list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['list'] = 'list'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        count
+        list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = SKIP, list = SKIP)
+      @count = count unless count == SKIP
+      @list = list unless list == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count = hash.key?('count') ? hash['count'] : SKIP
+      list = hash.key?('list') ? hash['list'] : SKIP
+
+      # Create object from extracted values.
+      SyllableDetails.new(count,
+                          list)
+    end
+  end
+end

data/lib/words_api/models/synonyms_response.rb

@@ -0,0 +1,56 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type contains response for synonyms endpoint.
+  class SynonymsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The word that is searched.
+    # @return [String]
+    attr_accessor :word
+
+    # The synonyms of the searched word.
+    # @return [Array[String]]
+    attr_accessor :synonyms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['word'] = 'word'
+      @_hash['synonyms'] = 'synonyms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(word = nil, synonyms = nil)
+      @word = word
+      @synonyms = synonyms
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      word = hash.key?('word') ? hash['word'] : nil
+      synonyms = hash.key?('synonyms') ? hash['synonyms'] : nil
+
+      # Create object from extracted values.
+      SynonymsResponse.new(word,
+                           synonyms)
+    end
+  end
+end

data/lib/words_api/models/word_details.rb

@@ -0,0 +1,152 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # This custom type stores word information.
+  class WordDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Explains the definition of the word.
+    # @return [String]
+    attr_accessor :definition
+
+    # Explains what part of speech the word is.
+    # @return [String]
+    attr_accessor :part_of_speech
+
+    # The list of synonyms.
+    # @return [Array[String]]
+    attr_accessor :synonyms
+
+    # List of words that are more general than the searched word.
+    # @return [Array[String]]
+    attr_accessor :type_of
+
+    # More specific examples of types of searched word.
+    # @return [Array[String]]
+    attr_accessor :has_types
+
+    # The derivation if any.
+    # @return [Array[String]]
+    attr_accessor :derivation
+
+    # The usage examples of word if any.
+    # @return [Array[String]]
+    attr_accessor :examples
+
+    # List of antonyms for the searched word.
+    # @return [Array[String]]
+    attr_accessor :antonyms
+
+    # The verb group of the searched word.
+    # @return [Array[String]]
+    attr_accessor :verb_group
+
+    # Words that are parts of the searched word.
+    # @return [Array[String]]
+    attr_accessor :has_parts
+
+    # Words that are substances of the searched word.
+    # @return [Array[String]]
+    attr_accessor :has_substances
+
+    # Words that are implied by the searched word. Usually used for verbs.
+    # @return [Array[String]]
+    attr_accessor :entails
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['definition'] = 'definition'
+      @_hash['part_of_speech'] = 'partOfSpeech'
+      @_hash['synonyms'] = 'synonyms'
+      @_hash['type_of'] = 'typeOf'
+      @_hash['has_types'] = 'hasTypes'
+      @_hash['derivation'] = 'derivation'
+      @_hash['examples'] = 'examples'
+      @_hash['antonyms'] = 'antonyms'
+      @_hash['verb_group'] = 'verbGroup'
+      @_hash['has_parts'] = 'hasParts'
+      @_hash['has_substances'] = 'hasSubstances'
+      @_hash['entails'] = 'entails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        definition
+        part_of_speech
+        synonyms
+        type_of
+        has_types
+        derivation
+        examples
+        antonyms
+        verb_group
+        has_parts
+        has_substances
+        entails
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(definition = SKIP, part_of_speech = SKIP, synonyms = SKIP,
+                   type_of = SKIP, has_types = SKIP, derivation = SKIP,
+                   examples = SKIP, antonyms = SKIP, verb_group = SKIP,
+                   has_parts = SKIP, has_substances = SKIP, entails = SKIP)
+      @definition = definition unless definition == SKIP
+      @part_of_speech = part_of_speech unless part_of_speech == SKIP
+      @synonyms = synonyms unless synonyms == SKIP
+      @type_of = type_of unless type_of == SKIP
+      @has_types = has_types unless has_types == SKIP
+      @derivation = derivation unless derivation == SKIP
+      @examples = examples unless examples == SKIP
+      @antonyms = antonyms unless antonyms == SKIP
+      @verb_group = verb_group unless verb_group == SKIP
+      @has_parts = has_parts unless has_parts == SKIP
+      @has_substances = has_substances unless has_substances == SKIP
+      @entails = entails unless entails == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      definition = hash.key?('definition') ? hash['definition'] : SKIP
+      part_of_speech = hash.key?('partOfSpeech') ? hash['partOfSpeech'] : SKIP
+      synonyms = hash.key?('synonyms') ? hash['synonyms'] : SKIP
+      type_of = hash.key?('typeOf') ? hash['typeOf'] : SKIP
+      has_types = hash.key?('hasTypes') ? hash['hasTypes'] : SKIP
+      derivation = hash.key?('derivation') ? hash['derivation'] : SKIP
+      examples = hash.key?('examples') ? hash['examples'] : SKIP
+      antonyms = hash.key?('antonyms') ? hash['antonyms'] : SKIP
+      verb_group = hash.key?('verbGroup') ? hash['verbGroup'] : SKIP
+      has_parts = hash.key?('hasParts') ? hash['hasParts'] : SKIP
+      has_substances = hash.key?('hasSubstances') ? hash['hasSubstances'] : SKIP
+      entails = hash.key?('entails') ? hash['entails'] : SKIP
+
+      # Create object from extracted values.
+      WordDetails.new(definition,
+                      part_of_speech,
+                      synonyms,
+                      type_of,
+                      has_types,
+                      derivation,
+                      examples,
+                      antonyms,
+                      verb_group,
+                      has_parts,
+                      has_substances,
+                      entails)
+    end
+  end
+end