azure_cognitiveservices_localsearch 0.17.0

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/query_context.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Defines the query context that Bing used for the request.
+    #
+    class QueryContext
+
+      include MsRestAzure
+
+      @@discriminatorMap = Hash.new
+
+      def initialize
+        @_type = "QueryContext"
+      end
+
+      attr_accessor :_type
+
+      # @return [String] The query string as specified in the request.
+      attr_accessor :original_query
+
+      # @return [String] The query string used by Bing to perform the query.
+      # Bing uses the altered query string if the original query string
+      # contained spelling mistakes. For example, if the query string is
+      # "saling downwind", the altered query string will be "sailing downwind".
+      # This field is included only if the original query string contains a
+      # spelling mistake.
+      attr_accessor :altered_query
+
+      # @return [String] AlteredQuery that is formatted for display purpose.
+      # The query string in the AlterationDisplayQuery can be html-escaped and
+      # can contain hit-highlighting characters
+      attr_accessor :alteration_display_query
+
+      # @return [String] The query string to use to force Bing to use the
+      # original string. For example, if the query string is "saling downwind",
+      # the override query string will be "+saling downwind". Remember to
+      # encode the query string which results in "%2Bsaling+downwind". This
+      # field is included only if the original query string contains a spelling
+      # mistake.
+      attr_accessor :alteration_override_query
+
+      # @return [Boolean] A Boolean value that indicates whether the specified
+      # query has adult intent. The value is true if the query has adult
+      # intent; otherwise, false.
+      attr_accessor :adult_intent
+
+      # @return [Boolean] A Boolean value that indicates whether Bing requires
+      # the user's location to provide accurate results. If you specified the
+      # user's location by using the X-MSEdge-ClientIP and X-Search-Location
+      # headers, you can ignore this field. For location aware queries, such as
+      # "today's weather" or "restaurants near me" that need the user's
+      # location to provide accurate results, this field is set to true. For
+      # location aware queries that include the location (for example, "Seattle
+      # weather"), this field is set to false. This field is also set to false
+      # for queries that are not location aware, such as "best sellers".
+      attr_accessor :ask_user_for_location
+
+      # @return [Boolean]
+      attr_accessor :is_transactional
+
+
+      #
+      # Mapper for QueryContext class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'QueryContext',
+          type: {
+            name: 'Composite',
+            polymorphic_discriminator: '_type',
+            uber_parent: 'QueryContext',
+            class_name: 'QueryContext',
+            model_properties: {
+              original_query: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'originalQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              altered_query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alteredQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              alteration_display_query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alterationDisplayQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              alteration_override_query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alterationOverrideQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              adult_intent: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'adultIntent',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              ask_user_for_location: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'askUserForLocation',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              is_transactional: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isTransactional',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Defines a response. All schemas that return at the root of the response
+    # must inherit from this object.
+    #
+    class Response < Identifiable
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "Response"
+      end
+
+      attr_accessor :_type
+
+      # @return [String] The URL that returns this resource.
+      attr_accessor :read_link
+
+      # @return [String] The URL to Bing's search result for this item.
+      attr_accessor :web_search_url
+
+      # @return [Array<Action>]
+      attr_accessor :potential_action
+
+      # @return [Array<Action>]
+      attr_accessor :immediate_action
+
+      # @return [String]
+      attr_accessor :preferred_clickthrough_url
+
+      # @return [String]
+      attr_accessor :adaptive_card
+
+
+      #
+      # Mapper for Response class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Response',
+          type: {
+            name: 'Composite',
+            class_name: 'Response',
+            model_properties: {
+              _type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: '_type',
+                type: {
+                  name: 'String'
+                }
+              },
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              read_link: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'readLink',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              potential_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'potentialAction',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Action'
+                      }
+                  }
+                }
+              },
+              immediate_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'immediateAction',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Action'
+                      }
+                  }
+                }
+              },
+              preferred_clickthrough_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'preferredClickthroughUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              adaptive_card: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'adaptiveCard',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/response_base.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Response base
+    #
+    class ResponseBase
+
+      include MsRestAzure
+
+      @@discriminatorMap = Hash.new
+      @@discriminatorMap["Thing"] = "Thing"
+      @@discriminatorMap["Places"] = "Places"
+      @@discriminatorMap["SearchResultsAnswer"] = "SearchResultsAnswer"
+      @@discriminatorMap["SearchResponse"] = "SearchResponse"
+      @@discriminatorMap["PostalAddress"] = "PostalAddress"
+      @@discriminatorMap["Place"] = "Place"
+      @@discriminatorMap["Action"] = "Action"
+      @@discriminatorMap["Response"] = "Response"
+      @@discriminatorMap["Identifiable"] = "Identifiable"
+      @@discriminatorMap["Answer"] = "Answer"
+      @@discriminatorMap["ErrorResponse"] = "ErrorResponse"
+      @@discriminatorMap["CreativeWork"] = "CreativeWork"
+      @@discriminatorMap["Intangible"] = "Intangible"
+      @@discriminatorMap["SearchAction"] = "SearchAction"
+      @@discriminatorMap["StructuredValue"] = "StructuredValue"
+
+      def initialize
+        @_type = "ResponseBase"
+      end
+
+      attr_accessor :_type
+
+
+      #
+      # Mapper for ResponseBase class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ResponseBase',
+          type: {
+            name: 'Composite',
+            polymorphic_discriminator: '_type',
+            uber_parent: 'ResponseBase',
+            class_name: 'ResponseBase',
+            model_properties: {
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/response_format.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Defines values for ResponseFormat
+    #
+    module ResponseFormat
+      Json = "Json"
+      JsonLd = "JsonLd"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/safe_search.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Defines values for SafeSearch
+    #
+    module SafeSearch
+      Off = "Off"
+      Moderate = "Moderate"
+      Strict = "Strict"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_action.rb

@@ -0,0 +1,464 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::LocalSearch::V1_0
+  module Models
+    #
+    # Model object.
+    #
+    #
+    class SearchAction < Action
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "SearchAction"
+      end
+
+      attr_accessor :_type
+
+      # @return [String]
+      attr_accessor :display_text
+
+      # @return [String]
+      attr_accessor :query
+
+      # @return [Array<Answer>]
+      attr_accessor :rich_content
+
+      # @return [String]
+      attr_accessor :formatting_rule_id
+
+
+      #
+      # Mapper for SearchAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'SearchAction',
+          type: {
+            name: 'Composite',
+            class_name: 'SearchAction',
+            model_properties: {
+              _type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: '_type',
+                type: {
+                  name: 'String'
+                }
+              },
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              read_link: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'readLink',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              potential_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'potentialAction',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Action'
+                      }
+                  }
+                }
+              },
+              immediate_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'immediateAction',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Action'
+                      }
+                  }
+                }
+              },
+              preferred_clickthrough_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'preferredClickthroughUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              adaptive_card: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'adaptiveCard',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              },
+              entity_presentation_info: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'entityPresentationInfo',
+                type: {
+                  name: 'Composite',
+                  polymorphic_discriminator: '_type',
+                  uber_parent: 'EntitiesEntityPresentationInfo',
+                  class_name: 'EntitiesEntityPresentationInfo'
+                }
+              },
+              thumbnail_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnailUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              about: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'about',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              mentions: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'mentions',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              provider: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'provider',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              creator: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'creator',
+                type: {
+                  name: 'Composite',
+                  class_name: 'Thing'
+                }
+              },
+              text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              discussion_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'discussionUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              comment_count: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'commentCount',
+                type: {
+                  name: 'Number'
+                }
+              },
+              main_entity: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'mainEntity',
+                type: {
+                  name: 'Composite',
+                  class_name: 'Thing'
+                }
+              },
+              head_line: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'headLine',
+                type: {
+                  name: 'String'
+                }
+              },
+              copyright_holder: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'copyrightHolder',
+                type: {
+                  name: 'Composite',
+                  class_name: 'Thing'
+                }
+              },
+              copyright_year: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'copyrightYear',
+                type: {
+                  name: 'Number'
+                }
+              },
+              disclaimer: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'disclaimer',
+                type: {
+                  name: 'String'
+                }
+              },
+              is_accessible_for_free: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isAccessibleForFree',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              genre: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'genre',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              is_family_friendly: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isFamilyFriendly',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              location: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'location',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'PlaceElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Place'
+                      }
+                  }
+                }
+              },
+              result: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'result',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              display_name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'displayName',
+                type: {
+                  name: 'String'
+                }
+              },
+              is_top_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isTopAction',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              service_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'serviceUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              display_text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'displayText',
+                type: {
+                  name: 'String'
+                }
+              },
+              query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'query',
+                type: {
+                  name: 'String'
+                }
+              },
+              rich_content: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'richContent',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'AnswerElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Answer'
+                      }
+                  }
+                }
+              },
+              formatting_rule_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'formattingRuleId',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end