azure_cognitiveservices_localsearch 0.17.0

data/lib/1.0/generated/azure_cognitiveservices_localsearch/local_search_client.rb

@@ -0,0 +1,128 @@
+# 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
+  #
+  # A service client - single point of access to the REST API.
+  #
+  class LocalSearchClient < MsRestAzure::AzureServiceClient
+    include MsRestAzure
+    include MsRestAzure::Serialization
+
+    # @return [String] the base URI of the service.
+    attr_accessor :base_url
+
+    # @return Credentials needed for the client to connect to Azure.
+    attr_reader :credentials1
+
+    # @return Subscription credentials which uniquely identify client
+    # subscription.
+    attr_accessor :credentials
+
+    # @return [String] The preferred language for the response.
+    attr_accessor :accept_language
+
+    # @return [Integer] The retry timeout in seconds for Long Running
+    # Operations. Default value is 30.
+    attr_accessor :long_running_operation_retry_timeout
+
+    # @return [Boolean] Whether a unique x-ms-client-request-id should be
+    # generated. When set to true a unique x-ms-client-request-id value is
+    # generated and included in each request. Default is true.
+    attr_accessor :generate_client_request_id
+
+    # @return [Local] local
+    attr_reader :local
+
+    #
+    # Creates initializes a new instance of the LocalSearchClient class.
+    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client.
+    # @param base_url [String] the base URI of the service.
+    # @param options [Array] filters to be applied to the HTTP requests.
+    #
+    def initialize(credentials = nil, base_url = nil, options = nil)
+      super(credentials, options)
+      @base_url = base_url || 'https://api.cognitive.microsoft.com/localbusinesses/v7.0/search'
+
+      fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
+      @credentials = credentials
+
+      @local = Local.new(self)
+      @accept_language = 'en-US'
+      @long_running_operation_retry_timeout = 30
+      @generate_client_request_id = true
+      add_telemetry
+    end
+
+    #
+    # Makes a request and returns the body of the response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Hash{String=>String}] containing the body of the response.
+    # Example:
+    #
+    #  request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
+    #  path = "/path"
+    #  options = {
+    #    body: request_content,
+    #    query_params: {'api-version' => '2016-02-01'}
+    #  }
+    #  result = @client.make_request(:put, path, options)
+    #
+    def make_request(method, path, options = {})
+      result = make_request_with_http_info(method, path, options)
+      result.body unless result.nil?
+    end
+
+    #
+    # Makes a request and returns the operation response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
+    #
+    def make_request_with_http_info(method, path, options = {})
+      result = make_request_async(method, path, options).value!
+      result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
+      result
+    end
+
+    #
+    # Makes a request asynchronously.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def make_request_async(method, path, options = {})
+      fail ArgumentError, 'method is nil' if method.nil?
+      fail ArgumentError, 'path is nil' if path.nil?
+
+      request_url = options[:base_url] || @base_url
+      if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
+        @request_headers['Content-Type'] = options[:headers]['Content-Type']
+      end
+
+      request_headers = @request_headers
+      request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
+      options.merge!({headers: request_headers.merge(options[:headers] || {})})
+      options.merge!({credentials: @credentials}) unless @credentials.nil?
+
+      super(request_url, method, path, options)
+    end
+
+
+    private
+    #
+    # Adds telemetry information.
+    #
+    def add_telemetry
+        sdk_information = 'azure_cognitiveservices_localsearch'
+        sdk_information = "#{sdk_information}/0.17.0"
+        add_user_agent_information(sdk_information)
+    end
+  end
+end

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

@@ -0,0 +1,424 @@
+# 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 an action.
+    #
+    class Action < CreativeWork
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "Action"
+      end
+
+      attr_accessor :_type
+
+      # @return [Array<Place>]
+      attr_accessor :location
+
+      # @return [Array<Thing>] The result produced in the action.
+      attr_accessor :result
+
+      # @return [String] A display name for the action.
+      attr_accessor :display_name
+
+      # @return [Boolean] A Boolean representing whether this result is the top
+      # action.
+      attr_accessor :is_top_action
+
+      # @return [String] Use this URL to get additional data to determine how
+      # to take the appropriate action. For example, the serviceUrl might
+      # return JSON along with an image URL.
+      attr_accessor :service_url
+
+
+      #
+      # Mapper for Action class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Action',
+          type: {
+            name: 'Composite',
+            class_name: 'Action',
+            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'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end