Current section

Files

Jump to
tornex lib torngen_client path user attacksfull.ex
Raw

lib/torngen_client/path/user/attacksfull.ex

defmodule Torngen.Client.Path.User.Attacksfull do
@moduledoc """
Get your simplified attacks.
Requires limited access key. <br>Returns up to 1,000 rows. <br>
## Parmeters
- limit: N/A
- sort: Sorted by the greatest timestamps
- to: Timestamp that sets the upper limit for the data returned
- from: Timestamp that sets the lower limit for the data returned
- timestamp: Timestamp to bypass cache
- comment: Comment for your tool/service/bot/website to be visible in the logs.
- key: API key (Limited)
## Response Module(s)
- FactionAttacksFullResponse
"""
import Torngen.Client.Path, only: [defparameter: 3]
@behaviour Torngen.Client.Path
@path "user/attacksfull"
@response_modules [FactionAttacksFullResponse]
Module.register_attribute(__MODULE__, :parameter_keys, accumulate: true)
@impl true
def path(), do: @path
@impl true
def path_selection(), do: Torngen.Client.Path.path_selection(@path)
@impl true
defparameter :limit, value do
# N/A
{:query, :limit, value}
end
@impl true
defparameter :sort, value do
# Sorted by the greatest timestamps
{:query, :sort, value}
end
@impl true
defparameter :to, value do
# Timestamp that sets the upper limit for the data returned. Data returned will be up to and including this time
{:query, :to, value}
end
@impl true
defparameter :from, value do
# Timestamp that sets the lower limit for the data returned. Data returned will be after this time
{:query, :from, value}
end
@impl true
defparameter :timestamp, value do
# Timestamp to bypass cache
{:query, :timestamp, value}
end
@impl true
defparameter :comment, value do
# Comment for your tool/service/bot/website to be visible in the logs.
{:query, :comment, value}
end
@impl true
defparameter :key, value do
# API key (Limited). It's not required to use this parameter when passing the API key via the Authorization header.
{:query, :key, value}
end
@impl true
def parameter(parameter_name, _value) when is_atom(parameter_name) do
:error
end
@impl true
def parameters(), do: @parameter_keys
@impl true
def parse(response), do: Torngen.Client.Path.parse(@response_modules, response)
end