Class Roles

Hierarchy

APIResource
- Roles

Index

Constructors

Properties

Methods

create delete get list update

Constructors

constructor

new Roles(client: SumUp): SumUp.Roles
Parameters
- client: SumUp
Returns SumUp.Roles
Inherited from Core.APIResource.constructor
- Defined in core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

create

create(
    merchantCode: string,
    body: CreateMerchantRoleParams,
    params?: FetchParams,
): APIPromise<Role>
Create a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.
Parameters
- merchantCode: string
- body: CreateMerchantRoleParams
- Optionalparams: FetchParams
Returns APIPromise<Role>
- Defined in resources/roles/index.ts:97

delete

delete(
    merchantCode: string,
    roleId: string,
    params?: FetchParams,
): APIPromise<void>
Delete a custom role.
Parameters
- merchantCode: string
- roleId: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/roles/index.ts:126

get

get(
    merchantCode: string,
    roleId: string,
    params?: FetchParams,
): APIPromise<Role>
Retrieve a custom role by ID.
Parameters
- merchantCode: string
- roleId: string
- Optionalparams: FetchParams
Returns APIPromise<Role>
- Defined in resources/roles/index.ts:112

list

list(
merchantCode: string,
params?: FetchParams,
): APIPromise<ListMerchantRolesResponse>
List merchant's custom roles.
Parameters
- merchantCode: string
- Optionalparams: FetchParams
Returns APIPromise<ListMerchantRolesResponse>
- Defined in resources/roles/index.ts:84

update

update(
    merchantCode: string,
    roleId: string,
    body: UpdateMerchantRoleParams,
    params?: FetchParams,
): APIPromise<Role>
Update a custom role.
Parameters
- merchantCode: string
- roleId: string
- body: UpdateMerchantRoleParams
- Optionalparams: FetchParams
Returns APIPromise<Role>
- Defined in resources/roles/index.ts:140