Packages
Google Play Games Services API client library. The Google Play Games Service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.
Current section
Files
Jump to
Current section
Files
lib/google_api/games/v1/api/quest_milestones.ex
# 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.Games.V1.Api.QuestMilestones do
@moduledoc """
API calls for all endpoints tagged `QuestMilestones`.
"""
alias GoogleApi.Games.V1.Connection
import GoogleApi.Games.V1.RequestBuilder
@doc """
Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.
## Parameters
- connection (GoogleApi.Games.V1.Connection): Connection to server
- quest_id (String): The ID of the quest.
- milestone_id (String): The ID of the milestone.
- request_id (String): A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly.
- 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.
- :consistency_token (String): The last-seen mutation timestamp.
## Returns
{:ok, %{}} on success
{:error, info} on failure
"""
@spec games_quest_milestones_claim(Tesla.Env.client, String.t, String.t, String.t, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t}
def games_quest_milestones_claim(connection, quest_id, milestone_id, request_id, opts \\ []) do
optional_params = %{
:"alt" => :query,
:"fields" => :query,
:"key" => :query,
:"oauth_token" => :query,
:"prettyPrint" => :query,
:"quotaUser" => :query,
:"userIp" => :query,
:"consistencyToken" => :query
}
%{}
|> method(:put)
|> url("/quests/{questId}/milestones/{milestoneId}/claim", %{
"questId" => URI.encode_www_form(quest_id),
"milestoneId" => URI.encode_www_form(milestone_id)
})
|> add_param(:query, :"requestId", request_id)
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(false)
end
end