Bingex.User (Bingex v0.1.8)

Provides an interface to interact with the BingX User API.

Summary

Functions

extend_listen_key(listen_key, api_key)

@spec extend_listen_key(listen_key :: binary(), api_key :: binary()) ::
  {:ok, Bingex.API.Reply.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

generate_listen_key(api_key)

get_referral(user_id, api_key, secret_key)

get_referrals(page_index \\ 0, page_size \\ 200, start_time \\ nil, end_time \\ nil, api_key, secret_key)

@spec get_referrals(
  page_index :: non_neg_integer(),
  page_size :: non_neg_integer(),
  start_time :: nil | non_neg_integer(),
  end_time :: nil | non_neg_integer(),
  api_key :: binary(),
  secret_key :: binary()
) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.Data.GetReferrals.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}