MembersClient
@tribeplatform/gql-client / Modules / clients / MembersClient
Class: MembersClient#
clients.MembersClient
Table of contents#
Constructors#
Methods#
Constructors#
constructor#
• new MembersClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/members.client.ts:24
Methods#
cancelEmailUpdate#
▸ cancelEmailUpdate(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationCancelEmailUpdateArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/members.client.ts:83
delete#
▸ delete(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationDeleteMemberArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/members.client.ts:70
get#
▸ get(id, fields?, accessToken?): Promise<Member>
Parameters#
| Name | Type | Default value |
|---|---|---|
id | string | undefined |
fields | MemberFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Member>
Defined in#
packages/client/src/clients/members.client.ts:42
list#
▸ list(variables, fields?, accessToken?): Promise<PaginatedMember>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryMembersArgs | undefined |
fields | MemberFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<PaginatedMember>
Defined in#
packages/client/src/clients/members.client.ts:28
update#
▸ update(variables, fields?, accessToken?): Promise<Member>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationUpdateMemberArgs | undefined |
fields | MemberFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Member>