CollectionsClient
@tribeplatform/gql-client / Modules / clients / CollectionsClient
Class: CollectionsClient#
clients.CollectionsClient
Table of contents#
Constructors#
Methods#
Constructors#
constructor#
• new CollectionsClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/collections.client.ts:26
Methods#
create#
▸ create(variables, fields?, accessToken?): Promise<Collection>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationCreateCollectionArgs | undefined |
fields | CollectionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Collection>
Defined in#
packages/client/src/clients/collections.client.ts:30
delete#
▸ delete(id, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
id | string |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/collections.client.ts:85
get#
▸ get(variables, fields?, accessToken?): Promise<Collection>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryCollectionArgs | undefined |
fields | CollectionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Collection>
Defined in#
packages/client/src/clients/collections.client.ts:58
list#
▸ list(variables?, fields?, accessToken?): Promise<Collection[]>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables? | QueryCollectionsArgs | undefined |
fields | CollectionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Collection[]>
Defined in#
packages/client/src/clients/collections.client.ts:44
organize#
▸ organize(variables, fields?, accessToken?): Promise<Action>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationOrganizeCollectionsArgs | undefined |
fields | ActionFields | 'basic' |
accessToken? | string | undefined |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/collections.client.ts:95
update#
▸ update(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateCollectionArgs |
accessToken? | string |
Returns#
Promise<Action>