Bingex.Types (Bingex v0.2.1)

Provides general types.

Summary

Types

api_key()

@type api_key() :: binary()

income_type()

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

leverage()

@type leverage() :: pos_integer()

listen_key()

@type listen_key() :: binary()

position_side()

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

request_api_error_result()

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

request_error_metadata()

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

request_error_result()

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

request_http_error_result()

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

request_ok_metadata()

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

request_ok_result()

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

request_ok_result(reply)

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

request_result()

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

request_result(reply)

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

secret_key()

@type secret_key() :: binary()

symbol()

@type symbol() :: binary()

timestamp()

@type timestamp() :: non_neg_integer()

user_id()

@type user_id() :: binary()