InvitationsClient
@tribeplatform/gql-client / Modules / clients / InvitationsClient
Class: InvitationsClient#
clients.InvitationsClient
Table of contents#
Constructors#
Methods#
Constructors#
constructor#
• new InvitationsClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/invitations.client.ts:23
Methods#
getLink#
▸ getLink(accessToken?): Promise<MemberInvitationLink>
Parameters#
| Name | Type |
|---|---|
accessToken? | string |
Returns#
Promise<MemberInvitationLink>
Defined in#
packages/client/src/clients/invitations.client.ts:27
invite#
▸ invite(variables, fields?, accessToken?): Promise<MemberInvitation[]>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationInviteMembersArgs | undefined |
fields | MemberInvitationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<MemberInvitation[]>
Defined in#
packages/client/src/clients/invitations.client.ts:49
list#
▸ list(variables, fields?, accessToken?): Promise<PaginatedMemberInvitation>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryMemberInvitationsArgs | undefined |
fields | MemberInvitationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<PaginatedMemberInvitation>
Defined in#
packages/client/src/clients/invitations.client.ts:77
validate#
▸ validate(variables, fields?, accessToken?): Promise<MemberInvitation>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryMemberInvitationValidityArgs | undefined |
fields | MemberInvitationFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<MemberInvitation>
Defined in#
packages/client/src/clients/invitations.client.ts:63
validateLink#
▸ validateLink(variables, accessToken?): Promise<MemberInvitationLink>
Parameters#
| Name | Type |
|---|---|
variables | QueryInvitationLinkValidityArgs |
accessToken? | string |
Returns#
Promise<MemberInvitationLink>