ghostcrawl 2.2.0

data/_generated/models/search_request.rb

@@ -0,0 +1,469 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../ghostcrawl'
+require_relative './models'
+
+module Ghostcrawl
+    module Models
+        ## 
+        # POST /v1/search request body.
+        class SearchRequest
+            include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
+            ## 
+            # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            @additional_data
+            ## 
+            # Optional 2-letter ISO country code for geo-filter. Tavily v1 ignores this silently.
+            @country
+            ## 
+            # Search engine to use: 'brave', 'tavily', 'google', 'bing', or 'yandex'. May also be passed via X-Ghostcrawl-Search-Engine header.
+            @engine
+            ## 
+            # Optional freshness filter (adapter-specific; Brave: 'pd'/'pw'/'pm'/'py' for day/week/month/year).
+            @freshness
+            ## 
+            # Maximum results (1-20).
+            @limit
+            ## 
+            # Search query string.
+            @query
+            ## 
+            # Engine-specific vertical (google only): 'search' (default) | 'jobs' | 'scholar' | 'play' | 'reviews'. Ignored by brave/tavily.
+            @vertical
+            ## 
+            ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @return a i_dictionary
+            ## 
+            def additional_data
+                return @additional_data
+            end
+            ## 
+            ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @param value Value to set for the AdditionalData property.
+            ## @return a void
+            ## 
+            def additional_data=(value)
+                @additional_data = value
+            end
+            ## 
+            ## Instantiates a new SearchRequest and sets the default values.
+            ## @return a void
+            ## 
+            def initialize()
+                @additional_data = Hash.new
+                @limit = 10
+            end
+            ## 
+            ## Gets the country property value. Optional 2-letter ISO country code for geo-filter. Tavily v1 ignores this silently.
+            ## @return a search_request_country
+            ## 
+            def country
+                return @country
+            end
+            ## 
+            ## Sets the country property value. Optional 2-letter ISO country code for geo-filter. Tavily v1 ignores this silently.
+            ## @param value Value to set for the country property.
+            ## @return a void
+            ## 
+            def country=(value)
+                @country = value
+            end
+            ## 
+            ## Creates a new instance of the appropriate class based on discriminator value
+            ## @param parse_node The parse node to use to read the discriminator value and create the object
+            ## @return a search_request
+            ## 
+            def self.create_from_discriminator_value(parse_node)
+                raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                return SearchRequest.new
+            end
+            ## 
+            ## Gets the engine property value. Search engine to use: 'brave', 'tavily', 'google', 'bing', or 'yandex'. May also be passed via X-Ghostcrawl-Search-Engine header.
+            ## @return a search_request_engine
+            ## 
+            def engine
+                return @engine
+            end
+            ## 
+            ## Sets the engine property value. Search engine to use: 'brave', 'tavily', 'google', 'bing', or 'yandex'. May also be passed via X-Ghostcrawl-Search-Engine header.
+            ## @param value Value to set for the engine property.
+            ## @return a void
+            ## 
+            def engine=(value)
+                @engine = value
+            end
+            ## 
+            ## Gets the freshness property value. Optional freshness filter (adapter-specific; Brave: 'pd'/'pw'/'pm'/'py' for day/week/month/year).
+            ## @return a search_request_freshness
+            ## 
+            def freshness
+                return @freshness
+            end
+            ## 
+            ## Sets the freshness property value. Optional freshness filter (adapter-specific; Brave: 'pd'/'pw'/'pm'/'py' for day/week/month/year).
+            ## @param value Value to set for the freshness property.
+            ## @return a void
+            ## 
+            def freshness=(value)
+                @freshness = value
+            end
+            ## 
+            ## The deserialization information for the current model
+            ## @return a i_dictionary
+            ## 
+            def get_field_deserializers()
+                return {
+                    "country" => lambda {|n| @country = n.get_object_value(lambda {|pn| SearchRequest::SearchRequestCountry.create_from_discriminator_value(pn) }) },
+                    "engine" => lambda {|n| @engine = n.get_object_value(lambda {|pn| SearchRequest::SearchRequestEngine.create_from_discriminator_value(pn) }) },
+                    "freshness" => lambda {|n| @freshness = n.get_object_value(lambda {|pn| SearchRequest::SearchRequestFreshness.create_from_discriminator_value(pn) }) },
+                    "limit" => lambda {|n| @limit = n.get_number_value() },
+                    "query" => lambda {|n| @query = n.get_string_value() },
+                    "vertical" => lambda {|n| @vertical = n.get_object_value(lambda {|pn| SearchRequest::SearchRequestVertical.create_from_discriminator_value(pn) }) },
+                }
+            end
+            ## 
+            ## Gets the limit property value. Maximum results (1-20).
+            ## @return a integer
+            ## 
+            def limit
+                return @limit
+            end
+            ## 
+            ## Sets the limit property value. Maximum results (1-20).
+            ## @param value Value to set for the limit property.
+            ## @return a void
+            ## 
+            def limit=(value)
+                @limit = value
+            end
+            ## 
+            ## Gets the query property value. Search query string.
+            ## @return a string
+            ## 
+            def query
+                return @query
+            end
+            ## 
+            ## Sets the query property value. Search query string.
+            ## @param value Value to set for the query property.
+            ## @return a void
+            ## 
+            def query=(value)
+                @query = value
+            end
+            ## 
+            ## Serializes information the current object
+            ## @param writer Serialization writer to use to serialize this model
+            ## @return a void
+            ## 
+            def serialize(writer)
+                raise StandardError, 'writer cannot be null' if writer.nil?
+                writer.write_object_value("country", @country)
+                writer.write_object_value("engine", @engine)
+                writer.write_object_value("freshness", @freshness)
+                writer.write_number_value("limit", @limit)
+                writer.write_string_value("query", @query)
+                writer.write_object_value("vertical", @vertical)
+                writer.write_additional_data(@additional_data)
+            end
+            ## 
+            ## Gets the vertical property value. Engine-specific vertical (google only): 'search' (default) | 'jobs' | 'scholar' | 'play' | 'reviews'. Ignored by brave/tavily.
+            ## @return a search_request_vertical
+            ## 
+            def vertical
+                return @vertical
+            end
+            ## 
+            ## Sets the vertical property value. Engine-specific vertical (google only): 'search' (default) | 'jobs' | 'scholar' | 'play' | 'reviews'. Ignored by brave/tavily.
+            ## @param value Value to set for the vertical property.
+            ## @return a void
+            ## 
+            def vertical=(value)
+                @vertical = value
+            end
+
+            ## 
+            # Composed type wrapper for classes SearchRequestCountryMember1, string
+            class SearchRequestCountry
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type SearchRequestCountryMember1
+                @search_request_country_member1
+                ## 
+                # Composed type representation for type string
+                @string
+                ## 
+                ## Creates a new instance of the appropriate class based on discriminator value
+                ## @param parse_node The parse node to use to read the discriminator value and create the object
+                ## @return a search_request_country
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return SearchRequestCountry.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "SearchRequest_countryMember1" => lambda {|n| @search_request_country_member1 = n.get_object_value(lambda {|pn| Ghostcrawl::Models::SearchRequestCountryMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the SearchRequest_countryMember1 property value. Composed type representation for type SearchRequestCountryMember1
+                ## @return a search_request_country_member1
+                ## 
+                def search_request_country_member1
+                    return @search_request_country_member1
+                end
+                ## 
+                ## Sets the SearchRequest_countryMember1 property value. Composed type representation for type SearchRequestCountryMember1
+                ## @param value Value to set for the SearchRequest_countryMember1 property.
+                ## @return a void
+                ## 
+                def search_request_country_member1=(value)
+                    @search_request_country_member1 = value
+                end
+                ## 
+                ## Serializes information the current object
+                ## @param writer Serialization writer to use to serialize this model
+                ## @return a void
+                ## 
+                def serialize(writer)
+                    raise StandardError, 'writer cannot be null' if writer.nil?
+                    writer.write_object_value("SearchRequest_countryMember1", @search_request_country_member1)
+                    writer.write_string_value("string", @string)
+                end
+                ## 
+                ## Gets the string property value. Composed type representation for type string
+                ## @return a string
+                ## 
+                def string
+                    return @string
+                end
+                ## 
+                ## Sets the string property value. Composed type representation for type string
+                ## @param value Value to set for the string property.
+                ## @return a void
+                ## 
+                def string=(value)
+                    @string = value
+                end
+            end
+
+            ## 
+            # Composed type wrapper for classes SearchRequestEngineMember1, string
+            class SearchRequestEngine
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type SearchRequestEngineMember1
+                @search_request_engine_member1
+                ## 
+                # Composed type representation for type string
+                @string
+                ## 
+                ## Creates a new instance of the appropriate class based on discriminator value
+                ## @param parse_node The parse node to use to read the discriminator value and create the object
+                ## @return a search_request_engine
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return SearchRequestEngine.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "SearchRequest_engineMember1" => lambda {|n| @search_request_engine_member1 = n.get_object_value(lambda {|pn| Ghostcrawl::Models::SearchRequestEngineMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the SearchRequest_engineMember1 property value. Composed type representation for type SearchRequestEngineMember1
+                ## @return a search_request_engine_member1
+                ## 
+                def search_request_engine_member1
+                    return @search_request_engine_member1
+                end
+                ## 
+                ## Sets the SearchRequest_engineMember1 property value. Composed type representation for type SearchRequestEngineMember1
+                ## @param value Value to set for the SearchRequest_engineMember1 property.
+                ## @return a void
+                ## 
+                def search_request_engine_member1=(value)
+                    @search_request_engine_member1 = value
+                end
+                ## 
+                ## Serializes information the current object
+                ## @param writer Serialization writer to use to serialize this model
+                ## @return a void
+                ## 
+                def serialize(writer)
+                    raise StandardError, 'writer cannot be null' if writer.nil?
+                    writer.write_object_value("SearchRequest_engineMember1", @search_request_engine_member1)
+                    writer.write_string_value("string", @string)
+                end
+                ## 
+                ## Gets the string property value. Composed type representation for type string
+                ## @return a string
+                ## 
+                def string
+                    return @string
+                end
+                ## 
+                ## Sets the string property value. Composed type representation for type string
+                ## @param value Value to set for the string property.
+                ## @return a void
+                ## 
+                def string=(value)
+                    @string = value
+                end
+            end
+
+            ## 
+            # Composed type wrapper for classes SearchRequestFreshnessMember1, string
+            class SearchRequestFreshness
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type SearchRequestFreshnessMember1
+                @search_request_freshness_member1
+                ## 
+                # Composed type representation for type string
+                @string
+                ## 
+                ## Creates a new instance of the appropriate class based on discriminator value
+                ## @param parse_node The parse node to use to read the discriminator value and create the object
+                ## @return a search_request_freshness
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return SearchRequestFreshness.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "SearchRequest_freshnessMember1" => lambda {|n| @search_request_freshness_member1 = n.get_object_value(lambda {|pn| Ghostcrawl::Models::SearchRequestFreshnessMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the SearchRequest_freshnessMember1 property value. Composed type representation for type SearchRequestFreshnessMember1
+                ## @return a search_request_freshness_member1
+                ## 
+                def search_request_freshness_member1
+                    return @search_request_freshness_member1
+                end
+                ## 
+                ## Sets the SearchRequest_freshnessMember1 property value. Composed type representation for type SearchRequestFreshnessMember1
+                ## @param value Value to set for the SearchRequest_freshnessMember1 property.
+                ## @return a void
+                ## 
+                def search_request_freshness_member1=(value)
+                    @search_request_freshness_member1 = value
+                end
+                ## 
+                ## Serializes information the current object
+                ## @param writer Serialization writer to use to serialize this model
+                ## @return a void
+                ## 
+                def serialize(writer)
+                    raise StandardError, 'writer cannot be null' if writer.nil?
+                    writer.write_object_value("SearchRequest_freshnessMember1", @search_request_freshness_member1)
+                    writer.write_string_value("string", @string)
+                end
+                ## 
+                ## Gets the string property value. Composed type representation for type string
+                ## @return a string
+                ## 
+                def string
+                    return @string
+                end
+                ## 
+                ## Sets the string property value. Composed type representation for type string
+                ## @param value Value to set for the string property.
+                ## @return a void
+                ## 
+                def string=(value)
+                    @string = value
+                end
+            end
+
+            ## 
+            # Composed type wrapper for classes SearchRequestVerticalMember1, string
+            class SearchRequestVertical
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type SearchRequestVerticalMember1
+                @search_request_vertical_member1
+                ## 
+                # Composed type representation for type string
+                @string
+                ## 
+                ## Creates a new instance of the appropriate class based on discriminator value
+                ## @param parse_node The parse node to use to read the discriminator value and create the object
+                ## @return a search_request_vertical
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return SearchRequestVertical.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "SearchRequest_verticalMember1" => lambda {|n| @search_request_vertical_member1 = n.get_object_value(lambda {|pn| Ghostcrawl::Models::SearchRequestVerticalMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the SearchRequest_verticalMember1 property value. Composed type representation for type SearchRequestVerticalMember1
+                ## @return a search_request_vertical_member1
+                ## 
+                def search_request_vertical_member1
+                    return @search_request_vertical_member1
+                end
+                ## 
+                ## Sets the SearchRequest_verticalMember1 property value. Composed type representation for type SearchRequestVerticalMember1
+                ## @param value Value to set for the SearchRequest_verticalMember1 property.
+                ## @return a void
+                ## 
+                def search_request_vertical_member1=(value)
+                    @search_request_vertical_member1 = value
+                end
+                ## 
+                ## Serializes information the current object
+                ## @param writer Serialization writer to use to serialize this model
+                ## @return a void
+                ## 
+                def serialize(writer)
+                    raise StandardError, 'writer cannot be null' if writer.nil?
+                    writer.write_object_value("SearchRequest_verticalMember1", @search_request_vertical_member1)
+                    writer.write_string_value("string", @string)
+                end
+                ## 
+                ## Gets the string property value. Composed type representation for type string
+                ## @return a string
+                ## 
+                def string
+                    return @string
+                end
+                ## 
+                ## Sets the string property value. Composed type representation for type string
+                ## @param value Value to set for the string property.
+                ## @return a void
+                ## 
+                def string=(value)
+                    @string = value
+                end
+            end
+        end
+    end
+end

data/_generated/models/search_request_country_member1.rb

@@ -0,0 +1,62 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../ghostcrawl'
+require_relative './models'
+
+module Ghostcrawl
+    module Models
+        class SearchRequestCountryMember1
+            include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
+            ## 
+            # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            @additional_data
+            ## 
+            ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @return a i_dictionary
+            ## 
+            def additional_data
+                return @additional_data
+            end
+            ## 
+            ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @param value Value to set for the AdditionalData property.
+            ## @return a void
+            ## 
+            def additional_data=(value)
+                @additional_data = value
+            end
+            ## 
+            ## Instantiates a new SearchRequestCountryMember1 and sets the default values.
+            ## @return a void
+            ## 
+            def initialize()
+                @additional_data = Hash.new
+            end
+            ## 
+            ## Creates a new instance of the appropriate class based on discriminator value
+            ## @param parse_node The parse node to use to read the discriminator value and create the object
+            ## @return a search_request_country_member1
+            ## 
+            def self.create_from_discriminator_value(parse_node)
+                raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                return SearchRequestCountryMember1.new
+            end
+            ## 
+            ## The deserialization information for the current model
+            ## @return a i_dictionary
+            ## 
+            def get_field_deserializers()
+                return {
+                }
+            end
+            ## 
+            ## Serializes information the current object
+            ## @param writer Serialization writer to use to serialize this model
+            ## @return a void
+            ## 
+            def serialize(writer)
+                raise StandardError, 'writer cannot be null' if writer.nil?
+                writer.write_additional_data(@additional_data)
+            end
+        end
+    end
+end

data/_generated/models/search_request_engine_member1.rb

@@ -0,0 +1,62 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../ghostcrawl'
+require_relative './models'
+
+module Ghostcrawl
+    module Models
+        class SearchRequestEngineMember1
+            include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
+            ## 
+            # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            @additional_data
+            ## 
+            ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @return a i_dictionary
+            ## 
+            def additional_data
+                return @additional_data
+            end
+            ## 
+            ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @param value Value to set for the AdditionalData property.
+            ## @return a void
+            ## 
+            def additional_data=(value)
+                @additional_data = value
+            end
+            ## 
+            ## Instantiates a new SearchRequestEngineMember1 and sets the default values.
+            ## @return a void
+            ## 
+            def initialize()
+                @additional_data = Hash.new
+            end
+            ## 
+            ## Creates a new instance of the appropriate class based on discriminator value
+            ## @param parse_node The parse node to use to read the discriminator value and create the object
+            ## @return a search_request_engine_member1
+            ## 
+            def self.create_from_discriminator_value(parse_node)
+                raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                return SearchRequestEngineMember1.new
+            end
+            ## 
+            ## The deserialization information for the current model
+            ## @return a i_dictionary
+            ## 
+            def get_field_deserializers()
+                return {
+                }
+            end
+            ## 
+            ## Serializes information the current object
+            ## @param writer Serialization writer to use to serialize this model
+            ## @return a void
+            ## 
+            def serialize(writer)
+                raise StandardError, 'writer cannot be null' if writer.nil?
+                writer.write_additional_data(@additional_data)
+            end
+        end
+    end
+end

data/_generated/models/search_request_freshness_member1.rb

@@ -0,0 +1,62 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../ghostcrawl'
+require_relative './models'
+
+module Ghostcrawl
+    module Models
+        class SearchRequestFreshnessMember1
+            include MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
+            ## 
+            # Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            @additional_data
+            ## 
+            ## Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @return a i_dictionary
+            ## 
+            def additional_data
+                return @additional_data
+            end
+            ## 
+            ## Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
+            ## @param value Value to set for the AdditionalData property.
+            ## @return a void
+            ## 
+            def additional_data=(value)
+                @additional_data = value
+            end
+            ## 
+            ## Instantiates a new SearchRequestFreshnessMember1 and sets the default values.
+            ## @return a void
+            ## 
+            def initialize()
+                @additional_data = Hash.new
+            end
+            ## 
+            ## Creates a new instance of the appropriate class based on discriminator value
+            ## @param parse_node The parse node to use to read the discriminator value and create the object
+            ## @return a search_request_freshness_member1
+            ## 
+            def self.create_from_discriminator_value(parse_node)
+                raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                return SearchRequestFreshnessMember1.new
+            end
+            ## 
+            ## The deserialization information for the current model
+            ## @return a i_dictionary
+            ## 
+            def get_field_deserializers()
+                return {
+                }
+            end
+            ## 
+            ## Serializes information the current object
+            ## @param writer Serialization writer to use to serialize this model
+            ## @return a void
+            ## 
+            def serialize(writer)
+                raise StandardError, 'writer cannot be null' if writer.nil?
+                writer.write_additional_data(@additional_data)
+            end
+        end
+    end
+end