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.DelayedRoutingAPI do
  @moduledoc """
  API calls for all endpoints tagged `DelayedRoutingAPI`.
  """

  alias MollieAPI.Connection
  import MollieAPI.RequestBuilder

  @doc """
  Create a delayed route
  Create a route for a specific payment. The routed amount is credited to the account of your customer.

  ### Parameters

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

  ### Returns

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

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

    connection
    |> Connection.request(request)
    |> evaluate_response([
      {201, MollieAPI.Model.RouteCreateResponse},
      {404, MollieAPI.Model.ErrorResponse},
      {429, MollieAPI.Model.ErrorResponse}
    ])
  end

  @doc """
  Get a delayed route
  Retrieve a single route created for a specific payment.

  ### Parameters

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

  ### Returns

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

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

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

  @doc """
  List payment routes
  Retrieve a list of all routes created for a specific payment.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `payment_id` (String.t): Provide the ID of the related payment.
  - `opts` (keyword): Optional parameters
    - `:testmode` (boolean()): Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query parameter must not be sent. For organization-level credentials such as OAuth access tokens, 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.PaymentListRoutes200Response.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec payment_list_routes(Tesla.Env.client, String.t, keyword()) :: {:ok, MollieAPI.Model.PaymentListRoutes200Response.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def payment_list_routes(connection, payment_id, opts \\ []) do
    optional_params = %{
      :testmode => :query,
      :"idempotency-key" => :headers
    }

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

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