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 role
Parameters
- merchantCode: string
- body: CreateMerchantRoleParams
- Optionalparams: FetchParams
Returns APIPromise<Role>
- Defined in resources/roles/index.ts:94

delete

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

get

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

list

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

update

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