HookSniffAPI.Api.Transforms (HookSniff v0.3.0)

API calls for all endpoints tagged Transforms.

Summary

Functions

endpoints_endpoint_id_transforms_get(connection, endpoint_id, opts \\ [])

List transform rules for endpoint

endpoints_endpoint_id_transforms_id_delete(connection, endpoint_id, id, opts \\ [])

Delete transform rule

endpoints_endpoint_id_transforms_id_put(connection, endpoint_id, id, body, opts \\ [])

Update transform rule

endpoints_endpoint_id_transforms_post(connection, endpoint_id, create_transform_rule_request, opts \\ [])

Create transform rule

endpoints_endpoint_id_transforms_test_post(connection, endpoint_id, endpoints_endpoint_id_transforms_test_post_request, opts \\ [])

Test a transform rule

Functions

endpoints_endpoint_id_transforms_get(connection, endpoint_id, opts \\ [])

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

List transform rules for endpoint

Parameters

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

Returns

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

endpoints_endpoint_id_transforms_id_delete(connection, endpoint_id, id, opts \\ [])

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

Delete transform rule

Parameters

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

Returns

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

endpoints_endpoint_id_transforms_id_put(connection, endpoint_id, id, body, opts \\ [])

@spec endpoints_endpoint_id_transforms_id_put(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) :: {:ok, HookSniffAPI.Model.TransformRule.t()} | {:error, Tesla.Env.t()}

Update transform rule

Parameters

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

Returns

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

endpoints_endpoint_id_transforms_post(connection, endpoint_id, create_transform_rule_request, opts \\ [])

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

Create transform rule

Parameters

connection (HookSniffAPI.Connection): Connection to server
endpoint_id (String.t):
create_transform_rule_request (CreateTransformRuleRequest):
opts (keyword): Optional parameters

Returns

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

endpoints_endpoint_id_transforms_test_post(connection, endpoint_id, endpoints_endpoint_id_transforms_test_post_request, opts \\ [])

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

Test a transform rule

Parameters

connection (HookSniffAPI.Connection): Connection to server
endpoint_id (String.t):
endpoints_endpoint_id_transforms_test_post_request (EndpointsEndpointIdTransformsTestPostRequest):
opts (keyword): Optional parameters

Returns

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