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

  alias MollieAPI.Connection
  import MollieAPI.RequestBuilder

  @doc """
  Create a Connect balance transfer
  This API endpoint allows you to create a balance transfer from your organization's balance to a connected organization's balance, or vice versa. You can also create a balance transfer between two connected organizations. To create a balance transfer, you must be authenticated as the source organization, and the destination organization must be a connected organization that has authorized the `balance-transfers.write` scope for your organization.

  ### 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` (EntityBalanceTransfer): 

  ### Returns

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

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

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

  @doc """
  Get a Connect balance transfer
  Retrieve a single Connect balance transfer object by its ID.

  ### Parameters

  - `connection` (MollieAPI.Connection): Connection to server
  - `balance_transfer_id` (String.t): Provide the ID of the related balance transfer.
  - `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.EntityBalanceTransferResponse.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec get_connect_balance_transfer(Tesla.Env.client, String.t, keyword()) :: {:ok, MollieAPI.Model.ErrorResponse.t} | {:ok, MollieAPI.Model.EntityBalanceTransferResponse.t} | {:error, Tesla.Env.t}
  def get_connect_balance_transfer(connection, balance_transfer_id, opts \\ []) do
    optional_params = %{
      :testmode => :query,
      :"idempotency-key" => :headers
    }

    request =
      %{}
      |> method(:get)
      |> url("/v2/connect/balance-transfers/#{balance_transfer_id}")
      |> add_optional_params(optional_params, opts)
      |> Enum.into([])

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

  @doc """
  List all Connect balance transfers
  Returns a paginated list of balance transfers associated with your organization. These may be a balance transfer that was received or sent from your balance, or a balance transfer that you initiated on behalf of your clients. If no balance transfers 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.
    - `: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.ListConnectBalanceTransfers200Response.t}` on success
  - `{:error, Tesla.Env.t}` on failure
  """
  @spec list_connect_balance_transfers(Tesla.Env.client, keyword()) :: {:ok, MollieAPI.Model.ListConnectBalanceTransfers200Response.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
  def list_connect_balance_transfers(connection, opts \\ []) do
    optional_params = %{
      :from => :query,
      :limit => :query,
      :sort => :query,
      :testmode => :query,
      :"idempotency-key" => :headers
    }

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

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