Roles: role definitions (built-in and custom) grouping permissions,
assignable to Sumup.Members. API version v0.1.
Summary
Functions
Creates a custom role under merchant_code.
Deletes a custom role.
Retrieves a single role.
Lists all roles (built-in and custom) for a merchant.
Updates a custom role's name/permissions/description.
Functions
@spec create(Sumup.Config.t(), String.t(), keyword() | map()) :: {:ok, Sumup.Role.t()} | {:error, Sumup.Error.t()}
Creates a custom role under merchant_code.
:name(String.t/0) - Required.:permissions(list ofString.t/0) - Required. Permission strings, e.g."members_create".:description(String.t/0):metadata(map/0) - Free-form metadata you control.
@spec delete(Sumup.Config.t(), String.t(), String.t()) :: :ok | {:error, Sumup.Error.t()}
Deletes a custom role.
@spec get(Sumup.Config.t(), String.t(), String.t()) :: {:ok, Sumup.Role.t()} | {:error, Sumup.Error.t()}
Retrieves a single role.
@spec list(Sumup.Config.t(), String.t()) :: {:ok, [Sumup.Role.t()]} | {:error, Sumup.Error.t()}
Lists all roles (built-in and custom) for a merchant.
@spec update(Sumup.Config.t(), String.t(), String.t(), keyword() | map()) :: {:ok, Sumup.Role.t()} | {:error, Sumup.Error.t()}
Updates a custom role's name/permissions/description.
:name(String.t/0):permissions(list ofString.t/0):description(String.t/0)