esi

v0.1.1

esi v0.1.1 ESI.API.Opportunities

Summary

Types

group_opt()
group_opts()

Options for Opportunities.group/2

Functions

group(group_id, opts \\ [])

Return information of an opportunities group

groups()

Return a list of opportunities groups

task(task_id)

Return information of an opportunities task

tasks()

Return a list of opportunities tasks

Types

group_opt() 
group_opt() :: {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh}
group_opts() 
group_opts() :: [group_opt]

Options for Opportunities.group/2.

  • :language (DEFAULT: :"en-us") — Language to use in the response

Functions

group(group_id, opts \\ []) 
group(group_id :: integer, opts :: group_opts) :: ESI.Request.t

Return information of an opportunities group.

Response Example

Details of an opportunities group:

%{"connected_groups" => [100], "description" => "As a capsuleer...",
  "group_id" => 103, "name" => "Welcome to New Eden",
  "notification" => "Completed:<br>Welcome to New Eden",
  "required_tasks" => [19]}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_opportunities_groups_group_id
  • path — /opportunities/groups/{group_id}/

View on ESI Site

groups() 
groups() :: ESI.Request.t

Return a list of opportunities groups.

Response Example

A list of opportunities group ids:

[100, 101, 102, 103]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_opportunities_groups
  • path — /opportunities/groups/

View on ESI Site

task(task_id) 
task(task_id :: integer) :: ESI.Request.t

Return information of an opportunities task.

Response Example

Details of an opportunities task:

%{"description" => "To use station services...",
  "name" => "Dock in the station",
  "notification" => "Completed:<br>Docked in a station!", "task_id" => 10}

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_opportunities_tasks_task_id
  • path — /opportunities/tasks/{task_id}/

View on ESI Site

tasks() 
tasks() :: ESI.Request.t

Return a list of opportunities tasks.

Response Example

A list of opportunities task ids:

[1, 2, 3, 4]

Swagger Source

This function was generated from the following Swagger operation:

  • operationId — get_opportunities_tasks
  • path — /opportunities/tasks/

View on ESI Site