Class Members

API resource for the Members endpoints.

Endpoints to manage account members. Members are users that have membership within merchant accounts.

Hierarchy

APIResource
- Members

Index

Constructors

Properties

Methods

create createWithResponse delete deleteWithResponse get getWithResponse list listWithResponse update updateWithResponse

Constructors

constructor

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

Properties

`Protected`_client

_client: SumUp

Methods

create

create(
    merchantCode: string,
    body: CreateMerchantMemberParams,
    options?: RequestOptions,
): Promise<Member>
Create a merchant member.
Parameters
- merchantCode: string
- body: CreateMerchantMemberParams
- Optionaloptions: RequestOptions
Returns Promise<Member>
- Defined in src/resources/members/index.ts:109

createWithResponse

createWithResponse(
    merchantCode: string,
    body: CreateMerchantMemberParams,
    options?: RequestOptions,
): Promise<WithResponse<Member>>
Parameters
- merchantCode: string
- body: CreateMerchantMemberParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Member>>
- Defined in src/resources/members/index.ts:121

delete

delete(
    merchantCode: string,
    memberId: string,
    options?: RequestOptions,
): Promise<void>
Deletes a merchant member.
Parameters
- merchantCode: string
- memberId: string
- Optionaloptions: RequestOptions
Returns Promise<void>
- Defined in src/resources/members/index.ts:190

deleteWithResponse

deleteWithResponse(
    merchantCode: string,
    memberId: string,
    options?: RequestOptions,
): Promise<WithResponse<void>>
Parameters
- merchantCode: string
- memberId: string
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<void>>
- Defined in src/resources/members/index.ts:201

get

get(
    merchantCode: string,
    memberId: string,
    options?: RequestOptions,
): Promise<Member>
Retrieve a merchant member.
Parameters
- merchantCode: string
- memberId: string
- Optionaloptions: RequestOptions
Returns Promise<Member>
- Defined in src/resources/members/index.ts:136

getWithResponse

getWithResponse(
    merchantCode: string,
    memberId: string,
    options?: RequestOptions,
): Promise<WithResponse<Member>>
Parameters
- merchantCode: string
- memberId: string
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Member>>
- Defined in src/resources/members/index.ts:147

list

list(
    merchantCode: string,
    query?: ListMerchantMembersQueryParams,
    options?: RequestOptions,
): Promise<ListMerchantMembersResponse>
Lists merchant members.
Parameters
- merchantCode: string
- Optionalquery: ListMerchantMembersQueryParams
- Optionaloptions: RequestOptions
Returns Promise<ListMerchantMembersResponse>
- Defined in src/resources/members/index.ts:82

listWithResponse

listWithResponse(
    merchantCode: string,
    query?: ListMerchantMembersQueryParams,
    options?: RequestOptions,
): Promise<WithResponse<ListMerchantMembersResponse>>
Parameters
- merchantCode: string
- Optionalquery: ListMerchantMembersQueryParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<ListMerchantMembersResponse>>
- Defined in src/resources/members/index.ts:94

update

update(
    merchantCode: string,
    memberId: string,
    body: UpdateMerchantMemberParams,
    options?: RequestOptions,
): Promise<Member>
Update the merchant member.
Parameters
- merchantCode: string
- memberId: string
- body: UpdateMerchantMemberParams
- Optionaloptions: RequestOptions
Returns Promise<Member>
- Defined in src/resources/members/index.ts:161

updateWithResponse

updateWithResponse(
    merchantCode: string,
    memberId: string,
    body: UpdateMerchantMemberParams,
    options?: RequestOptions,
): Promise<WithResponse<Member>>
Parameters
- merchantCode: string
- memberId: string
- body: UpdateMerchantMemberParams
- Optionaloptions: RequestOptions
Returns Promise<WithResponse<Member>>
- Defined in src/resources/members/index.ts:174