HookSniffAPI.Api.CustomDomains (hooksniff v1.0.0)

API calls for all endpoints tagged CustomDomains.

Summary

Functions

custom_domains_get(connection, opts \\ [])

List custom domains

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

Delete custom domain

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

Verify domain ownership

custom_domains_post(connection, opts \\ [])

Add custom domain

Functions

custom_domains_get(connection, opts \\ [])

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

List custom domains

Parameters

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

Returns

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

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

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

Delete custom domain

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

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

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

Verify domain ownership

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

custom_domains_post(connection, opts \\ [])

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

Add custom domain

Parameters

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

Returns

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