Current section

Files

Jump to
mollie_api lib mollie_api api permissions_api.ex
Raw

lib/mollie_api/api/permissions_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.PermissionsAPI do
@moduledoc """
API calls for all endpoints tagged `PermissionsAPI`.
"""
alias MollieAPI.Connection
import MollieAPI.RequestBuilder
@doc """
Get permission
Retrieve a single permission by its ID, and see if the permission is granted to the current access token.
### Parameters
- `connection` (MollieAPI.Connection): Connection to server
- `permission_id` (String.t): Provide the ID of the related permission.
- `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.EntityPermission.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec get_permission(Tesla.Env.client, String.t, keyword()) :: {:ok, MollieAPI.Model.EntityPermission.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
def get_permission(connection, permission_id, opts \\ []) do
optional_params = %{
:testmode => :query,
:"idempotency-key" => :headers
}
request =
%{}
|> method(:get)
|> url("/v2/permissions/#{permission_id}")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, MollieAPI.Model.EntityPermission},
{404, MollieAPI.Model.ErrorResponse},
{429, MollieAPI.Model.ErrorResponse}
])
end
@doc """
List permissions
Retrieve a list of all permissions available to the current access token. The results are **not** paginated.
### 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.ListPermissions200Response.t}` on success
- `{:error, Tesla.Env.t}` on failure
"""
@spec list_permissions(Tesla.Env.client, keyword()) :: {:ok, MollieAPI.Model.ListPermissions200Response.t} | {:ok, MollieAPI.Model.ErrorResponse.t} | {:error, Tesla.Env.t}
def list_permissions(connection, opts \\ []) do
optional_params = %{
:"idempotency-key" => :headers
}
request =
%{}
|> method(:get)
|> url("/v2/permissions")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, MollieAPI.Model.ListPermissions200Response},
{400, MollieAPI.Model.ErrorResponse},
{429, MollieAPI.Model.ErrorResponse}
])
end
end