Class Roles

Hierarchy

APIResource
- Roles

Index

Constructors

Properties

Methods

create delete get list update

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

create

create(
    merchantCode: string,
    body: CreateMerchantRoleParams,
    options?: RequestOptions,
): APIPromise<Role, Problem>
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
- Optionaloptions: RequestOptions
Returns APIPromise<Role, Problem>
- Defined in src/resources/roles/index.ts:55

delete

delete(
    merchantCode: string,
    roleId: string,
    options?: RequestOptions,
): APIPromise<void, Problem>
Delete a custom role.
Parameters
- merchantCode: string
- roleId: string
- Optionaloptions: RequestOptions
Returns APIPromise<void, Problem>
- Defined in src/resources/roles/index.ts:84

get

get(
    merchantCode: string,
    roleId: string,
    options?: RequestOptions,
): APIPromise<Role, Problem>
Retrieve a custom role by ID.
Parameters
- merchantCode: string
- roleId: string
- Optionaloptions: RequestOptions
Returns APIPromise<Role, Problem>
- Defined in src/resources/roles/index.ts:70

list

list(
merchantCode: string,
options?: RequestOptions,
): APIPromise<ListMerchantRolesResponse, Problem>
List merchant's custom roles.
Parameters
- merchantCode: string
- Optionaloptions: RequestOptions
Returns APIPromise<ListMerchantRolesResponse, Problem>
- Defined in src/resources/roles/index.ts:42

update

update(
    merchantCode: string,
    roleId: string,
    body: UpdateMerchantRoleParams,
    options?: RequestOptions,
): APIPromise<Role, Problem>
Update a custom role.
Parameters
- merchantCode: string
- roleId: string
- body: UpdateMerchantRoleParams
- Optionaloptions: RequestOptions
Returns APIPromise<Role, Problem>
- Defined in src/resources/roles/index.ts:98