# Copyright 2017 Google Inc.
#
# 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 swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

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

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

  @doc """
  Get an activity.

  ## Parameters

  - connection (GoogleApi.Plus.V1.Connection): Connection to server
  - activity_id (String.t): The ID of the activity to get.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String.t): Data format for the response.
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    - :userIp (String.t): Deprecated. Please use quotaUser instead.

  ## Returns

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

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/activities/{activityId}", %{
        "activityId" => URI.encode_www_form(activity_id)
      })
      |> Request.add_optional_params(optional_params, opts)

    connection
    |> Connection.execute(request)
    |> Response.decode(struct: %GoogleApi.Plus.V1.Model.Activity{})
  end

  @doc """
  List all of the activities in the specified collection for a particular user.

  ## Parameters

  - connection (GoogleApi.Plus.V1.Connection): Connection to server
  - user_id (String.t): The ID of the user to get activities for. The special value \"me\" can be used to indicate the authenticated user.
  - collection (String.t): The collection of activities to list.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String.t): Data format for the response.
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    - :userIp (String.t): Deprecated. Please use quotaUser instead.
    - :maxResults (integer()): The maximum number of activities 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 (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.

  ## Returns

  {:ok, %GoogleApi.Plus.V1.Model.ActivityFeed{}} on success
  {:error, info} on failure
  """
  @spec plus_activities_list(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
          {:ok, GoogleApi.Plus.V1.Model.ActivityFeed.t()} | {:error, Tesla.Env.t()}
  def plus_activities_list(connection, user_id, collection, opts \\ []) do
    optional_params = %{
      :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("/people/{userId}/activities/{collection}", %{
        "userId" => URI.encode_www_form(user_id),
        "collection" => URI.encode_www_form(collection)
      })
      |> Request.add_optional_params(optional_params, opts)

    connection
    |> Connection.execute(request)
    |> Response.decode(struct: %GoogleApi.Plus.V1.Model.ActivityFeed{})
  end

  @doc """
  Search public activities.

  ## Parameters

  - connection (GoogleApi.Plus.V1.Connection): Connection to server
  - query (String.t): Full-text search query string.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String.t): Data format for the response.
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    - :userIp (String.t): Deprecated. Please use quotaUser instead.
    - :language (String.t): Specify the preferred language to search with. See search language codes for available values.
    - :maxResults (integer()): The maximum number of activities 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 (String.t): Specifies how to order search results.
    - :pageToken (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.

  ## Returns

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

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/activities")
      |> Request.add_param(:query, :query, query)
      |> Request.add_optional_params(optional_params, opts)

    connection
    |> Connection.execute(request)
    |> Response.decode(struct: %GoogleApi.Plus.V1.Model.ActivityFeed{})
  end
end