Class Members

Hierarchy

APIResource
- Members

Index

Constructors

Properties

Methods

create delete get list update

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

create

create(
    merchantCode: string,
    body: CreateMerchantMemberParams,
    params?: FetchParams,
): APIPromise<Member>
Create a merchant member.
Parameters
- merchantCode: string
- body: CreateMerchantMemberParams
- Optionalparams: FetchParams
Returns APIPromise<Member>
- Defined in resources/members/index.ts:197

delete

delete(
    merchantCode: string,
    memberId: string,
    params?: FetchParams,
): APIPromise<void>
Deletes a merchant member.
Parameters
- merchantCode: string
- memberId: string
- Optionalparams: FetchParams
Returns APIPromise<void>
- Defined in resources/members/index.ts:242

get

get(
    merchantCode: string,
    memberId: string,
    params?: FetchParams,
): APIPromise<Member>
Retrieve a merchant member.
Parameters
- merchantCode: string
- memberId: string
- Optionalparams: FetchParams
Returns APIPromise<Member>
- Defined in resources/members/index.ts:212

list

list(
    merchantCode: string,
    query?: ListMerchantMembersQueryParams,
    params?: FetchParams,
): APIPromise<ListMerchantMembersResponse>
Lists merchant members.
Parameters
- merchantCode: string
- Optionalquery: ListMerchantMembersQueryParams
- Optionalparams: FetchParams
Returns APIPromise<ListMerchantMembersResponse>
- Defined in resources/members/index.ts:182

update

update(
    merchantCode: string,
    memberId: string,
    body: UpdateMerchantMemberParams,
    params?: FetchParams,
): APIPromise<Member>
Update the merchant member.
Parameters
- merchantCode: string
- memberId: string
- body: UpdateMerchantMemberParams
- Optionalparams: FetchParams
Returns APIPromise<Member>
- Defined in resources/members/index.ts:226