google_api_surveys

# 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.Surveys.V2.Api.Surveys do
  @moduledoc """
  API calls for all endpoints tagged `Surveys`.
  """

  alias GoogleApi.Surveys.V2.Connection
  import GoogleApi.Surveys.V2.RequestBuilder


  @doc """
  Removes a survey from view in all user GET requests.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - survey_url_id (String): External URL ID for the survey.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.SurveysDeleteResponse{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_delete(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysDeleteResponse.t} | {:error, Tesla.Env.t}
  def surveys_surveys_delete(connection, survey_url_id, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query
    }
    %{}
    |> method(:delete)
    |> url("/surveys/{surveyUrlId}", %{
         "surveyUrlId" => URI.encode_www_form(survey_url_id)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.SurveysDeleteResponse{})
  end

  @doc """
  Retrieves information about the specified survey.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - survey_url_id (String): External URL ID for the survey.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_get(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t} | {:error, Tesla.Env.t}
  def surveys_surveys_get(connection, survey_url_id, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query
    }
    %{}
    |> method(:get)
    |> url("/surveys/{surveyUrlId}", %{
         "surveyUrlId" => URI.encode_www_form(survey_url_id)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.Survey{})
  end

  @doc """
  Creates a survey.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    - :body (Survey): 

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_insert(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t} | {:error, Tesla.Env.t}
  def surveys_surveys_insert(connection, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/surveys")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.Survey{})
  end

  @doc """
  Lists the surveys owned by the authenticated user.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    - :max_results (Integer): 
    - :start_index (Integer): 
    - :token (String): 

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.SurveysListResponse{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_list(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysListResponse.t} | {:error, Tesla.Env.t}
  def surveys_surveys_list(connection, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query,
      :"maxResults" => :query,
      :"startIndex" => :query,
      :"token" => :query
    }
    %{}
    |> method(:get)
    |> url("/surveys")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.SurveysListResponse{})
  end

  @doc """
  Begins running a survey.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - resource_id (String): 
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    - :body (SurveysStartRequest): 

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.SurveysStartResponse{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_start(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysStartResponse.t} | {:error, Tesla.Env.t}
  def surveys_surveys_start(connection, resource_id, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/surveys/{resourceId}/start", %{
         "resourceId" => URI.encode_www_form(resource_id)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.SurveysStartResponse{})
  end

  @doc """
  Stops a running survey.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - resource_id (String): 
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.SurveysStopResponse{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_stop(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.SurveysStopResponse.t} | {:error, Tesla.Env.t}
  def surveys_surveys_stop(connection, resource_id, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query
    }
    %{}
    |> method(:post)
    |> url("/surveys/{resourceId}/stop", %{
         "resourceId" => URI.encode_www_form(resource_id)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.SurveysStopResponse{})
  end

  @doc """
  Updates a survey. Currently the only property that can be updated is the owners property.

  ## Parameters

  - connection (GoogleApi.Surveys.V2.Connection): Connection to server
  - survey_url_id (String): External URL ID for the survey.
  - opts (KeywordList): [optional] Optional parameters
    - :alt (String): Data format for the response.
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :key (String): 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): OAuth 2.0 token for the current user.
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :quota_user (String): 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. Overrides userIp if both are provided.
    - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    - :body (Survey): 

  ## Returns

  {:ok, %GoogleApi.Surveys.V2.Model.Survey{}} on success
  {:error, info} on failure
  """
  @spec surveys_surveys_update(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Surveys.V2.Model.Survey.t} | {:error, Tesla.Env.t}
  def surveys_surveys_update(connection, survey_url_id, opts \\ []) do
    optional_params = %{
      :"alt" => :query,
      :"fields" => :query,
      :"key" => :query,
      :"oauth_token" => :query,
      :"prettyPrint" => :query,
      :"quotaUser" => :query,
      :"userIp" => :query,
      :"body" => :body
    }
    %{}
    |> method(:put)
    |> url("/surveys/{surveyUrlId}", %{
         "surveyUrlId" => URI.encode_www_form(survey_url_id)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.Surveys.V2.Model.Survey{})
  end
end