NetworkClient
@tribeplatform/gql-client / Modules / clients / NetworkClient
Class: NetworkClient#
clients.NetworkClient
Table of contents#
Constructors#
Methods#
- addMemberSchemaField
- archiveMemberSchemaField
- clearNewDomain
- domainAvailability
- get
- newDomainStatus
- transferToNewDomain
- update
- updateMemberSchemaField
- updateNewDomain
Constructors#
constructor#
• new NetworkClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/network.client.ts:32
Methods#
addMemberSchemaField#
▸ addMemberSchemaField(variables, fields?, accessToken?): Promise<Network>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationAddMemberSchemaFieldArgs | undefined |
fields | NetworkFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Network>
Defined in#
packages/client/src/clients/network.client.ts:119
archiveMemberSchemaField#
▸ archiveMemberSchemaField(variables, fields?, accessToken?): Promise<Network>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationArchiveMemberSchemaFieldArgs | undefined |
fields | NetworkFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Network>
Defined in#
packages/client/src/clients/network.client.ts:147
clearNewDomain#
▸ clearNewDomain(accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/network.client.ts:62
domainAvailability#
▸ domainAvailability(variables, accessToken?): Promise<DomainAvailability>
Parameters#
| Name | Type |
|---|---|
variables | QueryDomainAvailabilityArgs |
accessToken? | string |
Returns#
Promise<DomainAvailability>
Defined in#
packages/client/src/clients/network.client.ts:93
get#
▸ get(fields?, accessToken?): Promise<Network>
Parameters#
| Name | Type | Default value |
|---|---|---|
fields | NetworkFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Network>
Defined in#
packages/client/src/clients/network.client.ts:36
newDomainStatus#
▸ newDomainStatus(variables, accessToken?): Promise<DomainTransferStatus>
Parameters#
| Name | Type |
|---|---|
variables | QueryNewDomainStatusArgs |
accessToken? | string |
Returns#
Promise<DomainTransferStatus>
Defined in#
packages/client/src/clients/network.client.ts:106
transferToNewDomain#
▸ transferToNewDomain(accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/network.client.ts:84
update#
▸ update(variables, fields?, accessToken?): Promise<Network>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationUpdateNetworkArgs | undefined |
fields | NetworkFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Network>
Defined in#
packages/client/src/clients/network.client.ts:48
updateMemberSchemaField#
▸ updateMemberSchemaField(variables, fields?, accessToken?): Promise<Network>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationUpdateMemberSchemaFieldArgs | undefined |
fields | NetworkFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Network>
Defined in#
packages/client/src/clients/network.client.ts:133
updateNewDomain#
▸ updateNewDomain(variables, accessToken?): Promise<DomainTransferStatus>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateNewDomainArgs |
accessToken? | string |
Returns#
Promise<DomainTransferStatus>