# 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 class is auto generated by the elixir code generator program.
# Do not edit the class manually.

defmodule GoogleApi.Plus.V1.Api.People do
  @moduledoc """
  API calls for all endpoints tagged `People`.
  """

  alias GoogleApi.Plus.V1.Connection
  alias GoogleApi.Gax.{Request, Response}

  @doc """
  Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.Plus.V1.Connection.t`) - Connection to server
  *   `user_id` (*type:* `String.t`) - The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:alt` (*type:* `String.t`) - Data format for the response.
      *   `: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`) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      *   `:userIp` (*type:* `String.t`) - Deprecated. Please use quotaUser instead.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.Plus.V1.Model.Person{}}` on success
  *   `{:error, info}` on failure
  """
  @spec plus_people_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
          {:ok, GoogleApi.Plus.V1.Model.Person.t()} | {:error, Tesla.Env.t()}
  def plus_people_get(connection, user_id, optional_params \\ [], opts \\ []) do
    optional_params_config = %{
      :alt => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :userIp => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/people/{userId}", %{
        "userId" => URI.encode(user_id, &URI.char_unreserved?/1)
      })
      |> Request.add_optional_params(optional_params_config, optional_params)

    connection
    |> Connection.execute(request)
    |> Response.decode(opts ++ [struct: %GoogleApi.Plus.V1.Model.Person{}])
  end

  @doc """
  List all of the people in the specified collection.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.Plus.V1.Connection.t`) - Connection to server
  *   `user_id` (*type:* `String.t`) - Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
  *   `collection` (*type:* `String.t`) - The collection of people to list.
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:alt` (*type:* `String.t`) - Data format for the response.
      *   `: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`) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      *   `:userIp` (*type:* `String.t`) - Deprecated. Please use quotaUser instead.
      *   `:maxResults` (*type:* `integer()`) - The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
      *   `:orderBy` (*type:* `String.t`) - The order to return people in.
      *   `:pageToken` (*type:* `String.t`) - The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.Plus.V1.Model.PeopleFeed{}}` on success
  *   `{:error, info}` on failure
  """
  @spec plus_people_list(Tesla.Env.client(), String.t(), String.t(), keyword(), keyword()) ::
          {:ok, GoogleApi.Plus.V1.Model.PeopleFeed.t()} | {:error, Tesla.Env.t()}
  def plus_people_list(connection, user_id, collection, optional_params \\ [], opts \\ []) do
    optional_params_config = %{
      :alt => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :userIp => :query,
      :maxResults => :query,
      :orderBy => :query,
      :pageToken => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/people/{userId}/people/{collection}", %{
        "userId" => URI.encode(user_id, &URI.char_unreserved?/1),
        "collection" => URI.encode(collection, &URI.char_unreserved?/1)
      })
      |> Request.add_optional_params(optional_params_config, optional_params)

    connection
    |> Connection.execute(request)
    |> Response.decode(opts ++ [struct: %GoogleApi.Plus.V1.Model.PeopleFeed{}])
  end

  @doc """
  Shut down. See https://developers.google.com/+/api-shutdown for more details.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.Plus.V1.Connection.t`) - Connection to server
  *   `activity_id` (*type:* `String.t`) - The ID of the activity to get the list of people for.
  *   `collection` (*type:* `String.t`) - The collection of people to list.
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:alt` (*type:* `String.t`) - Data format for the response.
      *   `: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`) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      *   `:userIp` (*type:* `String.t`) - Deprecated. Please use quotaUser instead.
      *   `:maxResults` (*type:* `integer()`) - The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
      *   `:pageToken` (*type:* `String.t`) - The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.Plus.V1.Model.PeopleFeed{}}` on success
  *   `{:error, info}` on failure
  """
  @spec plus_people_list_by_activity(
          Tesla.Env.client(),
          String.t(),
          String.t(),
          keyword(),
          keyword()
        ) :: {:ok, GoogleApi.Plus.V1.Model.PeopleFeed.t()} | {:error, Tesla.Env.t()}
  def plus_people_list_by_activity(
        connection,
        activity_id,
        collection,
        optional_params \\ [],
        opts \\ []
      ) do
    optional_params_config = %{
      :alt => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :userIp => :query,
      :maxResults => :query,
      :pageToken => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/activities/{activityId}/people/{collection}", %{
        "activityId" => URI.encode(activity_id, &URI.char_unreserved?/1),
        "collection" => URI.encode(collection, &URI.char_unreserved?/1)
      })
      |> Request.add_optional_params(optional_params_config, optional_params)

    connection
    |> Connection.execute(request)
    |> Response.decode(opts ++ [struct: %GoogleApi.Plus.V1.Model.PeopleFeed{}])
  end

  @doc """
  Shut down. See https://developers.google.com/+/api-shutdown for more details.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.Plus.V1.Connection.t`) - Connection to server
  *   `query` (*type:* `String.t`) - Specify a query string for full text search of public text in all profiles.
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:alt` (*type:* `String.t`) - Data format for the response.
      *   `: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`) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      *   `:userIp` (*type:* `String.t`) - Deprecated. Please use quotaUser instead.
      *   `:language` (*type:* `String.t`) - Specify the preferred language to search with. See search language codes for available values.
      *   `:maxResults` (*type:* `integer()`) - The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
      *   `:pageToken` (*type:* `String.t`) - The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.Plus.V1.Model.PeopleFeed{}}` on success
  *   `{:error, info}` on failure
  """
  @spec plus_people_search(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
          {:ok, GoogleApi.Plus.V1.Model.PeopleFeed.t()} | {:error, Tesla.Env.t()}
  def plus_people_search(connection, query, optional_params \\ [], opts \\ []) do
    optional_params_config = %{
      :alt => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :userIp => :query,
      :language => :query,
      :maxResults => :query,
      :pageToken => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/people", %{})
      |> Request.add_param(:query, :query, query)
      |> Request.add_optional_params(optional_params_config, optional_params)

    connection
    |> Connection.execute(request)
    |> Response.decode(opts ++ [struct: %GoogleApi.Plus.V1.Model.PeopleFeed{}])
  end
end