ghostcrawl 2.3.4

data/_generated/models/scrape_result.rb

@@ -0,0 +1,630 @@
+require 'microsoft_kiota_abstractions'
+require_relative '../ghostcrawl'
+require_relative './models'
+
+module GhostCrawl
+    module Models
+        ## 
+        # POST /v1/scrape 200 response body. Documents the customer-facing shape so the OpenAPI 200 schema is no longer an empty ``{}`` (Kiota/typed SDKs need a named schema). ``extra="allow"`` keeps it forward-compatible with the markdown envelope (``format``/``markdown``/ ``chunks``/``citations``/``token_estimate``/``estimated_llm_input_tokens``) and the html envelope (``results``/``identity_id``/``identity_ids``/ ``identities_used``) without over-constraining the route (which returns a JSONResponse, so this model documents but does not coerce the body).
+        class ScrapeResult
+            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
+            ## 
+            # Output format when a non-default format was requested.
+            @format
+            ## 
+            # Generated identity id (single-identity path).
+            @identity_id
+            ## 
+            # Concatenated Markdown (format=markdown path).
+            @markdown
+            ## 
+            # Per-URL results (html/default path).
+            @results
+            ## 
+            # Aggregate run status (e.g. completed / partial / failed).
+            @status
+            ## 
+            # Estimated token count of the markdown output.
+            @token_estimate
+            ## 
+            # Non-fatal warnings (e.g. host-identity fallback).
+            @warnings
+            ## 
+            ## 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 ScrapeResult 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 scrape_result
+            ## 
+            def self.create_from_discriminator_value(parse_node)
+                raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                return ScrapeResult.new
+            end
+            ## 
+            ## Gets the format property value. Output format when a non-default format was requested.
+            ## @return a scrape_result_format
+            ## 
+            def format
+                return @format
+            end
+            ## 
+            ## Sets the format property value. Output format when a non-default format was requested.
+            ## @param value Value to set for the format property.
+            ## @return a void
+            ## 
+            def format=(value)
+                @format = value
+            end
+            ## 
+            ## The deserialization information for the current model
+            ## @return a i_dictionary
+            ## 
+            def get_field_deserializers()
+                return {
+                    "format" => lambda {|n| @format = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultFormat.create_from_discriminator_value(pn) }) },
+                    "identity_id" => lambda {|n| @identity_id = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultIdentityId.create_from_discriminator_value(pn) }) },
+                    "markdown" => lambda {|n| @markdown = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultMarkdown.create_from_discriminator_value(pn) }) },
+                    "results" => lambda {|n| @results = n.get_collection_of_object_values(lambda {|pn| GhostCrawl::Models::ScrapePageResult.create_from_discriminator_value(pn) }) },
+                    "status" => lambda {|n| @status = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultStatus.create_from_discriminator_value(pn) }) },
+                    "token_estimate" => lambda {|n| @token_estimate = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultTokenEstimate.create_from_discriminator_value(pn) }) },
+                    "warnings" => lambda {|n| @warnings = n.get_object_value(lambda {|pn| ScrapeResult::ScrapeResultWarnings.create_from_discriminator_value(pn) }) },
+                }
+            end
+            ## 
+            ## Gets the identity_id property value. Generated identity id (single-identity path).
+            ## @return a scrape_result_identity_id
+            ## 
+            def identity_id
+                return @identity_id
+            end
+            ## 
+            ## Sets the identity_id property value. Generated identity id (single-identity path).
+            ## @param value Value to set for the identity_id property.
+            ## @return a void
+            ## 
+            def identity_id=(value)
+                @identity_id = value
+            end
+            ## 
+            ## Gets the markdown property value. Concatenated Markdown (format=markdown path).
+            ## @return a scrape_result_markdown
+            ## 
+            def markdown
+                return @markdown
+            end
+            ## 
+            ## Sets the markdown property value. Concatenated Markdown (format=markdown path).
+            ## @param value Value to set for the markdown property.
+            ## @return a void
+            ## 
+            def markdown=(value)
+                @markdown = value
+            end
+            ## 
+            ## Gets the results property value. Per-URL results (html/default path).
+            ## @return a scrape_page_result
+            ## 
+            def results
+                return @results
+            end
+            ## 
+            ## Sets the results property value. Per-URL results (html/default path).
+            ## @param value Value to set for the results property.
+            ## @return a void
+            ## 
+            def results=(value)
+                @results = 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("format", @format)
+                writer.write_object_value("identity_id", @identity_id)
+                writer.write_object_value("markdown", @markdown)
+                writer.write_collection_of_object_values("results", @results)
+                writer.write_object_value("status", @status)
+                writer.write_object_value("token_estimate", @token_estimate)
+                writer.write_object_value("warnings", @warnings)
+                writer.write_additional_data(@additional_data)
+            end
+            ## 
+            ## Gets the status property value. Aggregate run status (e.g. completed / partial / failed).
+            ## @return a scrape_result_status
+            ## 
+            def status
+                return @status
+            end
+            ## 
+            ## Sets the status property value. Aggregate run status (e.g. completed / partial / failed).
+            ## @param value Value to set for the status property.
+            ## @return a void
+            ## 
+            def status=(value)
+                @status = value
+            end
+            ## 
+            ## Gets the token_estimate property value. Estimated token count of the markdown output.
+            ## @return a scrape_result_token_estimate
+            ## 
+            def token_estimate
+                return @token_estimate
+            end
+            ## 
+            ## Sets the token_estimate property value. Estimated token count of the markdown output.
+            ## @param value Value to set for the token_estimate property.
+            ## @return a void
+            ## 
+            def token_estimate=(value)
+                @token_estimate = value
+            end
+            ## 
+            ## Gets the warnings property value. Non-fatal warnings (e.g. host-identity fallback).
+            ## @return a scrape_result_warnings
+            ## 
+            def warnings
+                return @warnings
+            end
+            ## 
+            ## Sets the warnings property value. Non-fatal warnings (e.g. host-identity fallback).
+            ## @param value Value to set for the warnings property.
+            ## @return a void
+            ## 
+            def warnings=(value)
+                @warnings = value
+            end
+
+            ## 
+            # Composed type wrapper for classes ScrapeResultFormatMember1, string
+            class ScrapeResultFormat
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type ScrapeResultFormatMember1
+                @scrape_result_format_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 scrape_result_format
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultFormat.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "ScrapeResult_formatMember1" => lambda {|n| @scrape_result_format_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultFormatMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the ScrapeResult_formatMember1 property value. Composed type representation for type ScrapeResultFormatMember1
+                ## @return a scrape_result_format_member1
+                ## 
+                def scrape_result_format_member1
+                    return @scrape_result_format_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_formatMember1 property value. Composed type representation for type ScrapeResultFormatMember1
+                ## @param value Value to set for the ScrapeResult_formatMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_format_member1=(value)
+                    @scrape_result_format_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("ScrapeResult_formatMember1", @scrape_result_format_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 number, ScrapeResultIdentityIdMember1
+            class ScrapeResultIdentityId
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type number
+                @integer
+                ## 
+                # Composed type representation for type ScrapeResultIdentityIdMember1
+                @scrape_result_identity_id_member1
+                ## 
+                ## 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 scrape_result_identity_id
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultIdentityId.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "integer" => lambda {|n| @integer = n.get_number_value() },
+                        "ScrapeResult_identity_idMember1" => lambda {|n| @scrape_result_identity_id_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultIdentityIdMember1.create_from_discriminator_value(pn) }) },
+                    }
+                end
+                ## 
+                ## Gets the integer property value. Composed type representation for type number
+                ## @return a integer
+                ## 
+                def integer
+                    return @integer
+                end
+                ## 
+                ## Sets the integer property value. Composed type representation for type number
+                ## @param value Value to set for the integer property.
+                ## @return a void
+                ## 
+                def integer=(value)
+                    @integer = value
+                end
+                ## 
+                ## Gets the ScrapeResult_identity_idMember1 property value. Composed type representation for type ScrapeResultIdentityIdMember1
+                ## @return a scrape_result_identity_id_member1
+                ## 
+                def scrape_result_identity_id_member1
+                    return @scrape_result_identity_id_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_identity_idMember1 property value. Composed type representation for type ScrapeResultIdentityIdMember1
+                ## @param value Value to set for the ScrapeResult_identity_idMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_identity_id_member1=(value)
+                    @scrape_result_identity_id_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_number_value("integer", @integer)
+                    writer.write_object_value("ScrapeResult_identity_idMember1", @scrape_result_identity_id_member1)
+                end
+            end
+
+            ## 
+            # Composed type wrapper for classes ScrapeResultMarkdownMember1, string
+            class ScrapeResultMarkdown
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type ScrapeResultMarkdownMember1
+                @scrape_result_markdown_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 scrape_result_markdown
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultMarkdown.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "ScrapeResult_markdownMember1" => lambda {|n| @scrape_result_markdown_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultMarkdownMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the ScrapeResult_markdownMember1 property value. Composed type representation for type ScrapeResultMarkdownMember1
+                ## @return a scrape_result_markdown_member1
+                ## 
+                def scrape_result_markdown_member1
+                    return @scrape_result_markdown_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_markdownMember1 property value. Composed type representation for type ScrapeResultMarkdownMember1
+                ## @param value Value to set for the ScrapeResult_markdownMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_markdown_member1=(value)
+                    @scrape_result_markdown_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("ScrapeResult_markdownMember1", @scrape_result_markdown_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 ScrapeResultStatusMember1, string
+            class ScrapeResultStatus
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type ScrapeResultStatusMember1
+                @scrape_result_status_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 scrape_result_status
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultStatus.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "ScrapeResult_statusMember1" => lambda {|n| @scrape_result_status_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultStatusMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_string_value() },
+                    }
+                end
+                ## 
+                ## Gets the ScrapeResult_statusMember1 property value. Composed type representation for type ScrapeResultStatusMember1
+                ## @return a scrape_result_status_member1
+                ## 
+                def scrape_result_status_member1
+                    return @scrape_result_status_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_statusMember1 property value. Composed type representation for type ScrapeResultStatusMember1
+                ## @param value Value to set for the ScrapeResult_statusMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_status_member1=(value)
+                    @scrape_result_status_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("ScrapeResult_statusMember1", @scrape_result_status_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 number, ScrapeResultTokenEstimateMember1
+            class ScrapeResultTokenEstimate
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type number
+                @integer
+                ## 
+                # Composed type representation for type ScrapeResultTokenEstimateMember1
+                @scrape_result_token_estimate_member1
+                ## 
+                ## 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 scrape_result_token_estimate
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultTokenEstimate.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "integer" => lambda {|n| @integer = n.get_number_value() },
+                        "ScrapeResult_token_estimateMember1" => lambda {|n| @scrape_result_token_estimate_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultTokenEstimateMember1.create_from_discriminator_value(pn) }) },
+                    }
+                end
+                ## 
+                ## Gets the integer property value. Composed type representation for type number
+                ## @return a integer
+                ## 
+                def integer
+                    return @integer
+                end
+                ## 
+                ## Sets the integer property value. Composed type representation for type number
+                ## @param value Value to set for the integer property.
+                ## @return a void
+                ## 
+                def integer=(value)
+                    @integer = value
+                end
+                ## 
+                ## Gets the ScrapeResult_token_estimateMember1 property value. Composed type representation for type ScrapeResultTokenEstimateMember1
+                ## @return a scrape_result_token_estimate_member1
+                ## 
+                def scrape_result_token_estimate_member1
+                    return @scrape_result_token_estimate_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_token_estimateMember1 property value. Composed type representation for type ScrapeResultTokenEstimateMember1
+                ## @param value Value to set for the ScrapeResult_token_estimateMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_token_estimate_member1=(value)
+                    @scrape_result_token_estimate_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_number_value("integer", @integer)
+                    writer.write_object_value("ScrapeResult_token_estimateMember1", @scrape_result_token_estimate_member1)
+                end
+            end
+
+            ## 
+            # Composed type wrapper for classes ScrapeResultWarningsMember1, string
+            class ScrapeResultWarnings
+                include MicrosoftKiotaAbstractions::Parsable
+                ## 
+                # Composed type representation for type ScrapeResultWarningsMember1
+                @scrape_result_warnings_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 scrape_result_warnings
+                ## 
+                def self.create_from_discriminator_value(parse_node)
+                    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
+                    return ScrapeResultWarnings.new
+                end
+                ## 
+                ## The deserialization information for the current model
+                ## @return a i_dictionary
+                ## 
+                def get_field_deserializers()
+                    return {
+                        "ScrapeResult_warningsMember1" => lambda {|n| @scrape_result_warnings_member1 = n.get_object_value(lambda {|pn| GhostCrawl::Models::ScrapeResultWarningsMember1.create_from_discriminator_value(pn) }) },
+                        "string" => lambda {|n| @string = n.get_collection_of_primitive_values(String) },
+                    }
+                end
+                ## 
+                ## Gets the ScrapeResult_warningsMember1 property value. Composed type representation for type ScrapeResultWarningsMember1
+                ## @return a scrape_result_warnings_member1
+                ## 
+                def scrape_result_warnings_member1
+                    return @scrape_result_warnings_member1
+                end
+                ## 
+                ## Sets the ScrapeResult_warningsMember1 property value. Composed type representation for type ScrapeResultWarningsMember1
+                ## @param value Value to set for the ScrapeResult_warningsMember1 property.
+                ## @return a void
+                ## 
+                def scrape_result_warnings_member1=(value)
+                    @scrape_result_warnings_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("ScrapeResult_warningsMember1", @scrape_result_warnings_member1)
+                    writer.write_collection_of_primitive_values("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