Bingex.User (Bingex v0.1.13)

Provides an interface to interact with the BingX User API.

Summary

Functions

extend_listen_key(listen_key, api_key)

generate_listen_key(api_key)

get_referral(user_id, api_key, secret_key)

get_referrals(page_index, page_size, api_key, secret_key, opts \\ [])

Functions

extend_listen_key(listen_key, api_key)

@spec extend_listen_key(Bingex.Types.listen_key(), Bingex.Types.api_key()) ::
  {: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)

@spec generate_listen_key(Bingex.Types.api_key()) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.Data.GenerateListenKey.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

get_referral(user_id, api_key, secret_key)

@spec get_referral(
  Bingex.Types.user_id(),
  Bingex.Types.api_key(),
  Bingex.Types.secret_key()
) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.Data.GetReferral.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

get_referrals(page_index, page_size, api_key, secret_key, opts \\ [])

@spec get_referrals(
  page_index :: pos_integer(),
  page_size :: pos_integer(),
  Bingex.Types.api_key(),
  Bingex.Types.secret_key(),
  opts :: [start_time: pos_integer(), end_time: pos_integer()]
) ::
  {: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()}