HookSniffAPI.Api.Endpoints (HookSniff v0.3.0)

API calls for all endpoints tagged Endpoints.

Summary

Functions

endpoints_get(connection, opts \\ [])

List all endpoints

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

Delete endpoint

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

Get endpoint by ID

endpoints_id_put(connection, id, update_endpoint_request, opts \\ [])

Update endpoint

endpoints_id_retry_policy_put(connection, id, retry_policy, opts \\ [])

Update retry policy for an endpoint

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

Rotate endpoint signing secret

endpoints_post(connection, create_endpoint_request, opts \\ [])

Create a new endpoint

Functions

endpoints_get(connection, opts \\ [])

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

List all endpoints

Parameters

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

Returns

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

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

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

Delete endpoint

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

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

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

Get endpoint by ID

Parameters

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

Returns

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

endpoints_id_put(connection, id, update_endpoint_request, opts \\ [])

@spec endpoints_id_put(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.UpdateEndpointRequest.t(),
  keyword()
) :: {:ok, HookSniffAPI.Model.Endpoint.t()} | {:error, Tesla.Env.t()}

Update endpoint

Parameters

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

Returns

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

endpoints_id_retry_policy_put(connection, id, retry_policy, opts \\ [])

@spec endpoints_id_retry_policy_put(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.RetryPolicy.t(),
  keyword()
) :: {:ok, HookSniffAPI.Model.Endpoint.t()} | {:error, Tesla.Env.t()}

Update retry policy for an endpoint

Parameters

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

Returns

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

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

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

Rotate endpoint signing secret

Parameters

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

Returns

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

endpoints_post(connection, create_endpoint_request, opts \\ [])

@spec endpoints_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.CreateEndpointRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.Endpoint.t()} | {:error, Tesla.Env.t()}

Create a new endpoint

Parameters

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

Returns

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