HookSniffAPI.Api.Admin (HookSniff v0.3.0)

@spec admin_revenue_get(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [HookSniffAPI.Model.AdminRevenueGet200ResponseInner.t()]}
  | {:error, Tesla.Env.t()}

Revenue by month (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%AdminRevenueGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

admin_sdk_update_post(connection, opts \\ [])

@spec admin_sdk_update_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Send SDK update notification to users

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :body (AdminSdkUpdatePostRequest):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

admin_stats_get(connection, opts \\ [])

@spec admin_stats_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, HookSniffAPI.Model.SystemStats.t()} | {:error, Tesla.Env.t()}

System-wide statistics (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.SystemStats.t} on success
{:error, Tesla.Env.t} on failure

admin_users_get(connection, opts \\ [])

@spec admin_users_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, HookSniffAPI.Model.PaginatedUsers.t()} | {:error, Tesla.Env.t()}

List all users (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :page (integer()):
- :per_page (integer()):

Returns

{:ok, HookSniffAPI.Model.PaginatedUsers.t} on success
{:error, Tesla.Env.t} on failure

admin_users_id_get(connection, id, opts \\ [])

@spec admin_users_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get user details (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

admin_users_id_plan_put(connection, id, admin_users_id_plan_put_request, opts \\ [])

@spec admin_users_id_plan_put(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.AdminUsersIdPlanPutRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Change user plan (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
admin_users_id_plan_put_request (AdminUsersIdPlanPutRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

admin_users_id_status_put(connection, id, admin_users_id_status_put_request, opts \\ [])

@spec admin_users_id_status_put(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.AdminUsersIdStatusPutRequest.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Change user status (admin)

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
admin_users_id_status_put_request (AdminUsersIdStatusPutRequest):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure