Members: user accounts under a merchant, including virtual/managed
users. API version v0.1.
Summary
Functions
Creates a member under merchant_code.
Removes a member from a merchant.
Retrieves a single member.
Lists a single page of members.
Lazily streams every member, paging by offset/limit. See Sumup.Pagination.
Replaces a member's roles/metadata/attributes/managed-user credentials.
Functions
@spec create(Sumup.Config.t(), String.t(), keyword() | map()) :: {:ok, Sumup.Member.t()} | {:error, Sumup.Error.t()}
Creates a member under merchant_code.
:email(String.t/0) - Required.:roles(list ofString.t/0) - Required. Role ids to assign on creation.:is_managed_user(boolean/0) - Create a SumUp-managed (virtual) user rather than inviting a real one.:password(String.t/0) - Required whenis_managed_user: true.:nickname(String.t/0):metadata(map/0) - Free-form metadata you control.:attributes(map/0) - Free-form attributes you control.
@spec delete(Sumup.Config.t(), String.t(), String.t()) :: :ok | {:error, Sumup.Error.t()}
Removes a member from a merchant.
@spec get(Sumup.Config.t(), String.t(), String.t()) :: {:ok, Sumup.Member.t()} | {:error, Sumup.Error.t()}
Retrieves a single member.
@spec list(Sumup.Config.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Sumup.Error.t()}
Lists a single page of members.
:offset(non_neg_integer/0) - Page offset. The default value is0.:limit(pos_integer/0) - Page size (max 25). The default value is10.:scroll(boolean/0) - Use scroll-based pagination instead of offset/limit.:email(String.t/0) - Filter/search by email (substring).:user_id(String.t/0) - Filter by the underlying user id (maps touser.id).:status:roles(list ofString.t/0) - Filter to one or more role ids.
@spec list_all(Sumup.Config.t(), String.t(), pos_integer()) :: Enumerable.t()
Lazily streams every member, paging by offset/limit. See Sumup.Pagination.
@spec update(Sumup.Config.t(), String.t(), String.t(), keyword() | map()) :: {:ok, Sumup.Member.t()} | {:error, Sumup.Error.t()}
Replaces a member's roles/metadata/attributes/managed-user credentials.
:roles(list ofString.t/0):metadata(map/0):attributes(map/0):user(map/0) -%{nickname:, password:}for managed users.