Bingex.Types (Bingex v0.2.1)
Provides general types.
Summary
Types
@type api_key() :: binary()
@type income_type() :: :transfer | :realized_pnl | :funding_fee | :trading_fee
@type leverage() :: pos_integer()
@type listen_key() :: binary()
@type position_side() :: :long | :short | :both
@type request_api_error_result() :: {:error, Bingex.API.Error.t(), request_ok_metadata()}
@type request_error_metadata() :: Bingex.HTTP.Request.t()
@type request_error_result() :: request_http_error_result() | request_api_error_result()
@type request_http_error_result() :: {:error, Bingex.HTTP.Error.t(), request_error_metadata()}
@type request_ok_metadata() :: {Bingex.HTTP.Request.t(), Bingex.HTTP.Response.t()}
@type request_ok_result() :: {:ok, Bingex.API.Reply.t(), request_ok_metadata()}
@type request_ok_result(reply) :: {:ok, reply, request_ok_metadata()}
@type request_result() :: request_ok_result() | request_error_result()
@type request_result(reply) :: request_ok_result(reply) | request_error_result()
@type secret_key() :: binary()
@type symbol() :: binary()
@type timestamp() :: non_neg_integer()
@type user_id() :: binary()