google_api_jobs

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.Jobs.V2.Api.V2 do
  @moduledoc """
  API calls for all endpoints tagged `V2`.
  """

  alias GoogleApi.Jobs.V2.Connection
  alias GoogleApi.Gax.{Request, Response}

  @library_version Mix.Project.config() |> Keyword.get(:version, "")

  @doc """
  Completes the specified prefix with job keyword suggestions.
  Intended for use by a job search auto-complete search box.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.Jobs.V2.Connection.t`) - Connection to server
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
      *   `:access_token` (*type:* `String.t`) - OAuth access token.
      *   `:alt` (*type:* `String.t`) - Data format for response.
      *   `:callback` (*type:* `String.t`) - JSONP
      *   `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
      *   `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
      *   `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
      *   `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
      *   `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
      *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
      *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
      *   `:companyName` (*type:* `String.t`) - Optional. If provided, restricts completion to the specified company.
      *   `:languageCode` (*type:* `String.t`) - Required. The language of the query. This is
          the BCP-47 language code, such as "en-US" or "sr-Latn".
          For more information, see
          [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

          For CompletionType.JOB_TITLE type, only open jobs with same
          language_code are returned.

          For CompletionType.COMPANY_NAME type,
          only companies having open jobs with same language_code are
          returned.

          For CompletionType.COMBINED type, only open jobs with same
          language_code or companies having open jobs with same
          language_code are returned.
      *   `:pageSize` (*type:* `integer()`) - Required. Completion result count.
          The maximum allowed page size is 10.
      *   `:query` (*type:* `String.t`) - Required. The query used to generate suggestions.
      *   `:scope` (*type:* `String.t`) - Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
      *   `:type` (*type:* `String.t`) - Optional. The completion topic. The default is CompletionType.COMBINED.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.Jobs.V2.Model.CompleteQueryResponse{}}` on success
  *   `{:error, info}` on failure
  """
  @spec jobs_complete(Tesla.Env.client(), keyword(), keyword()) ::
          {:ok, GoogleApi.Jobs.V2.Model.CompleteQueryResponse.t()}
          | {:ok, Tesla.Env.t()}
          | {:error, Tesla.Env.t()}
  def jobs_complete(connection, optional_params \\ [], opts \\ []) do
    optional_params_config = %{
      :"$.xgafv" => :query,
      :access_token => :query,
      :alt => :query,
      :callback => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :uploadType => :query,
      :upload_protocol => :query,
      :companyName => :query,
      :languageCode => :query,
      :pageSize => :query,
      :query => :query,
      :scope => :query,
      :type => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/v2:complete", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)
      |> Request.library_version(@library_version)

    connection
    |> Connection.execute(request)
    |> Response.decode(opts ++ [struct: %GoogleApi.Jobs.V2.Model.CompleteQueryResponse{}])
  end
end