Current section

Files

Jump to
mollie_api lib mollie_api api onboarding_api.ex
Raw

lib/mollie_api/api/onboarding_api.ex

# 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.OnboardingAPI do
@moduledoc """
API calls for all endpoints tagged `OnboardingAPI`.
"""
alias MollieAPI.Connection
import MollieAPI.RequestBuilder
@doc """
Get onboarding status
Retrieve the onboarding status of the currently authenticated 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.
### Returns
- `{:ok, MollieAPI.Model.EntityOnboardingStatus.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec get_onboarding_status(Tesla.Env.client, keyword()) :: {:ok, MollieAPI.Model.EntityOnboardingStatus.t} | {:error, Tesla.Env.t}
def get_onboarding_status(connection, opts \\ []) do
optional_params = %{
:"idempotency-key" => :headers
}
request =
%{}
|> method(:get)
|> url("/v2/onboarding/me")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, MollieAPI.Model.EntityOnboardingStatus}
])
end
@doc """
Submit onboarding data
**⚠️ We no longer recommend implementing this endpoint. Please refer to the Client Links API instead to kick off the onboarding process for your merchants.** Submit data that will be prefilled in the merchant's onboarding. The data you submit will only be processed when the onboarding status is `needs-data`. Information that the merchant has entered in their dashboard will not be overwritten.
### 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` (SubmitOnboardingDataRequest):
### Returns
- `{:ok, nil}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec submit_onboarding_data(Tesla.Env.client, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t}
def submit_onboarding_data(connection, opts \\ []) do
optional_params = %{
:"idempotency-key" => :headers,
:body => :body
}
request =
%{}
|> method(:post)
|> url("/v2/onboarding/me")
|> add_optional_params(optional_params, opts)
|> ensure_body()
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{204, false}
])
end
end