defmodule ESI.API.Sovereignty do

  @doc """
  Shows sovereignty data for structures..

  ## Response Example

  A list of sovereignty structures:

      [
        %{
          "alliance_id" => 498125261,
          "solar_system_id" => 30000570,
          "structure_id" => 1018253388776,
          "structure_type_id" => 32226,
          "vulnerability_occupancy_level" => 2,
          "vulnerable_end_time" => "2016-10-29T05:30:00Z",
          "vulnerable_start_time" => "2016-10-28T20:30:00Z"
        }
      ]

  ## Swagger Source

  This function was generated from the following Swagger operation:

  - `operationId` -- `get_sovereignty_structures`
  - `path` -- `/sovereignty/structures/`

  [View on ESI Site](https://esi.tech.ccp.is/latest/#!/Sovereignty/get_sovereignty_structures)

  """
  @spec structures() :: ESI.Request.t
  def structures() do
    %ESI.Request{
      verb: :get,
      path: "/sovereignty/structures/",
      opts_schema: %{datasource: {:query, :optional}},

    }
  end

  @doc """
  Shows sovereignty data for campaigns..

  ## Response Example

  A list of sovereignty campaigns:

      [
        %{
          "attackers_score" => 0.4,
          "campaign_id" => 32833,
          "constellation_id" => 20000125,
          "defender_id" => 1695357456,
          "defender_score" => 0.6,
          "event_type" => "station_defense",
          "solar_system_id" => 30000856,
          "start_time" => "2016-10-29T14:34:40Z",
          "structure_id" => 61001096
        }
      ]

  ## Swagger Source

  This function was generated from the following Swagger operation:

  - `operationId` -- `get_sovereignty_campaigns`
  - `path` -- `/sovereignty/campaigns/`

  [View on ESI Site](https://esi.tech.ccp.is/latest/#!/Sovereignty/get_sovereignty_campaigns)

  """
  @spec campaigns() :: ESI.Request.t
  def campaigns() do
    %ESI.Request{
      verb: :get,
      path: "/sovereignty/campaigns/",
      opts_schema: %{datasource: {:query, :optional}},

    }
  end

  @doc """
  Shows sovereignty information for solar systems.

  ## Response Example

  A list of sovereignty information for solar systems in New Eden:

      [%{"faction_id" => 500001, "system_id" => 30045334}]

  ## Swagger Source

  This function was generated from the following Swagger operation:

  - `operationId` -- `get_sovereignty_map`
  - `path` -- `/sovereignty/map/`

  [View on ESI Site](https://esi.tech.ccp.is/latest/#!/Sovereignty/get_sovereignty_map)

  """
  @spec map() :: ESI.Request.t
  def map() do
    %ESI.Request{
      verb: :get,
      path: "/sovereignty/map/",
      opts_schema: %{datasource: {:query, :optional}},

    }
  end
end