mollie_api

# NOTE: This file is auto generated by OpenAPI Generator 7.17.0 (https://openapi-generator.tech).
# Do not edit this file manually.

defmodule MollieAPI.Api.WebhooksAPI do
  @moduledoc """
  API calls for all endpoints tagged `WebhooksAPI`.
  """

  alias MollieAPI.Connection
  import MollieAPI.RequestBuilder

  @doc """
  Create a webhook
  A webhook must have a name, an url and a list of event types. You can also create webhooks in the webhooks settings section of the Dashboard.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `opts` (keyword): Optional parameters
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.
    - `:body` (CreateWebhookRequest): 

  ### Returns

  - `{:ok, MollieAPI.Model.CreateWebhook.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec create_webhook(Tesla.Env.client, keyword()) :: {:ok, MollieAPI.Model.CreateWebhook.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def create_webhook(connection, opts \\ []) do
    optional_params = %{
      :"idempotency-key" => :headers,
      :body => :body
    }

    request =
      %{}
      |> method(:post)
      |> url("/v2/webhooks")
      |> add_optional_params(optional_params, opts)
      |> ensure_body()
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {201, MollieAPI.Model.CreateWebhook},
      {422, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  Delete a webhook
  Delete a single webhook object by its webhook ID.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `webhook_id` (String.t): Provide the ID of the related webhook.
  - `opts` (keyword): Optional parameters
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.
    - `:body` (DeleteWebhookRequest): 

  ### Returns

  - `{:ok, nil}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec delete_webhook(Tesla.Env.client, String.t, keyword()) :: {:ok, nil} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def delete_webhook(connection, webhook_id, opts \\ []) do
    optional_params = %{
      :"idempotency-key" => :headers,
      :body => :body
    }

    request =
      %{}
      |> method(:delete)
      |> url("/v2/webhooks/#{webhook_id}")
      |> add_optional_params(optional_params, opts)
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {204, false},
      {404, MollieAPI.Model.ErrorResponse},
      {422, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  Get a webhook
  Retrieve a single webhook object by its ID.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `webhook_id` (String.t): Provide the ID of the related webhook.
  - `opts` (keyword): Optional parameters
    - `:testmode` (boolean()): You can enable test mode by setting the `testmode` query parameter to `true`.  Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.

  ### Returns

  - `{:ok, MollieAPI.Model.EntityWebhook.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec get_webhook(Tesla.Env.client, String.t, keyword()) :: {:ok, MollieAPI.Model.EntityWebhook.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def get_webhook(connection, webhook_id, opts \\ []) do
    optional_params = %{
      :testmode => :query,
      :"idempotency-key" => :headers
    }

    request =
      %{}
      |> method(:get)
      |> url("/v2/webhooks/#{webhook_id}")
      |> add_optional_params(optional_params, opts)
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {200, MollieAPI.Model.EntityWebhook},
      {404, MollieAPI.Model.ErrorResponse},
      {422, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  List all webhooks
  Returns a paginated list of your webhooks. If no webhook endpoints are available, the resulting array will be empty. This request should never throw an error.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `opts` (keyword): Optional parameters
    - `:from` (String.t): Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
    - `:limit` (integer()): The maximum number of items to return. Defaults to 50 items.
    - `:sort` (Sorting): Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
    - `:eventTypes` (WebhookEventTypes): Used to filter out only the webhooks that are subscribed to certain types of events.
    - `:testmode` (boolean()): You can enable test mode by setting the `testmode` query parameter to `true`.  Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.

  ### Returns

  - `{:ok, MollieAPI.Model.ListWebhooks200Response.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec list_webhooks(Tesla.Env.client, keyword()) :: {:ok, MollieAPI.Model.ErrorResponse.t} | {:ok, MollieAPI.Model.ListWebhooks200Response.t} | {:error, Tesla.Env.t}
  def list_webhooks(connection, opts \\ []) do
    optional_params = %{
      :from => :query,
      :limit => :query,
      :sort => :query,
      :eventTypes => :query,
      :testmode => :query,
      :"idempotency-key" => :headers
    }

    request =
      %{}
      |> method(:get)
      |> url("/v2/webhooks")
      |> add_optional_params(optional_params, opts)
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {200, MollieAPI.Model.ListWebhooks200Response},
      {400, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  Test a webhook
  Sends a test event to the webhook to verify the endpoint is working as expected.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `webhook_id` (String.t): Provide the ID of the related webhook.
  - `opts` (keyword): Optional parameters
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.
    - `:body` (DeleteWebhookRequest): 

  ### Returns

  - `{:ok, nil}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec test_webhook(Tesla.Env.client, String.t, keyword()) :: {:ok, nil} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def test_webhook(connection, webhook_id, opts \\ []) do
    optional_params = %{
      :"idempotency-key" => :headers,
      :body => :body
    }

    request =
      %{}
      |> method(:post)
      |> url("/v2/webhooks/#{webhook_id}/ping")
      |> add_optional_params(optional_params, opts)
      |> ensure_body()
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {202, false},
      {404, MollieAPI.Model.ErrorResponse},
      {422, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  Update a webhook
  Updates the webhook. You may edit the name, url and the list of subscribed event types.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `webhook_id` (String.t): Provide the ID of the related webhook.
  - `opts` (keyword): Optional parameters
    - `:"idempotency-key"` (String.t): A unique key to ensure idempotent requests. This key should be a UUID v4 string.
    - `:body` (UpdateWebhookRequest): 

  ### Returns

  - `{:ok, MollieAPI.Model.EntityWebhook.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec update_webhook(Tesla.Env.client, String.t, keyword()) :: {:ok, MollieAPI.Model.EntityWebhook.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def update_webhook(connection, webhook_id, opts \\ []) do
    optional_params = %{
      :"idempotency-key" => :headers,
      :body => :body
    }

    request =
      %{}
      |> method(:patch)
      |> url("/v2/webhooks/#{webhook_id}")
      |> add_optional_params(optional_params, opts)
      |> ensure_body()
      |> Enum.into([])

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {200, MollieAPI.Model.EntityWebhook},
      {404, MollieAPI.Model.ErrorResponse},
      {422, MollieAPI.Model.ErrorResponse}
    ])
  end
end