Packages

bingex

0.2.0
0.7.0 0.6.2 0.6.1 0.6.0 0.5.1 0.5.0 0.4.0 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.1 0.2.0 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2

Bingex - library for BingX API.

HexDocs

Current section

Files

Jump to
Readme
26 Versions
2 Dependencies
Dependants
Files
Activity
bingex lib bingex types.ex
Raw

lib/bingex/types.ex 

defmodule Bingex.Types do

  @moduledoc """

  Provides general types.

  """



  alias Bingex.{HTTP, API}



  @type timestamp() :: non_neg_integer()



  @type request_ok_metadata() :: {HTTP.Request.t(), HTTP.Response.t()}



  @type request_error_metadata() :: HTTP.Request.t()



  @type request_ok_result(reply) :: {:ok, reply, request_ok_metadata()}

  @type request_ok_result() :: {:ok, API.Reply.t(), request_ok_metadata()}



  @type request_http_error_result() :: {:error, HTTP.Error.t(), request_error_metadata()}



  @type request_api_error_result() :: {:error, API.Error.t(), request_ok_metadata()}



  @type request_error_result() :: request_http_error_result() | request_api_error_result()



  @type request_result(reply) :: request_ok_result(reply) | request_error_result()

  @type request_result() :: request_ok_result() | request_error_result()



  @type leverage() :: pos_integer()



  @type symbol() :: binary()



  @type api_key() :: binary()



  @type secret_key() :: binary()



  @type listen_key() :: binary()



  @type income_type() :: :transfer | :realized_pnl | :funding_fee | :trading_fee



  @type position_side() :: :long | :short | :both



  @type user_id() :: binary()

end