@tribeplatform/gql-client / Modules / clients / DevClient

Class: DevClient

clients.DevClient

Table of contents

Constructors

• constructor

Methods

• addAppCollaborator
• app
• appCollaborators
• appPublications
• apps
• createApp
• createImages
• deleteApp
• eventTypes
• networks
• publishAppPrivately
• regenerateClientSecret
• removeAppCollaborator
• testAppWebhook
• unPublishAppPrivately
• updateApp
• uploadImages

Constructors

constructor

• new DevClient(client)

Parameters

Name	Type
client	GraphqlClient

Defined in

packages/client/src/clients/dev.client.ts:57

Methods

addAppCollaborator

▸ addAppCollaborator(variables, fields?, accessToken?): Promise<AppCollaborator>

Parameters

Name	Type	Default value
variables	MutationGlobalAddAppCollaboratorArgs	undefined
fields	AppCollaboratorFields	'basic'
accessToken?	string	undefined

Returns

Promise<AppCollaborator>

Defined in

packages/client/src/clients/dev.client.ts:234

---

app

▸ app(variables, fields?, accessToken?): Promise<App>

Parameters

Name	Type	Default value
variables	QueryGlobalAppArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<App>

Defined in

packages/client/src/clients/dev.client.ts:75

---

appCollaborators

▸ appCollaborators(variables, fields?, accessToken?): Promise<AppCollaborator[]>

Parameters

Name	Type	Default value
variables	QueryGlobalAppCollaboratorsArgs	undefined
fields	AppCollaboratorFields	'basic'
accessToken?	string	undefined

Returns

Promise<AppCollaborator[]>

Defined in

packages/client/src/clients/dev.client.ts:220

---

appPublications

▸ appPublications(variables, fields?, accessToken?): Promise<AppPublication[]>

Parameters

Name	Type	Default value
variables	QueryGlobalAppPublicationsArgs	undefined
fields	"basic"	'basic'
accessToken?	string	undefined

Returns

Promise<AppPublication[]>

Defined in

packages/client/src/clients/dev.client.ts:263

---

apps

▸ apps(variables, fields?, accessToken?): Promise<PaginatedApp>

Parameters

Name	Type	Default value
variables	QueryGlobalAppsArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedApp>

Defined in

packages/client/src/clients/dev.client.ts:61

---

createApp

▸ createApp(variables, fields?, accessToken?): Promise<App>

Parameters

Name	Type	Default value
variables	MutationGlobalCreateAppArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<App>

Defined in

packages/client/src/clients/dev.client.ts:89

---

createImages

▸ createImages(variables): Promise<SignedUrl[]>

Parameters

Name	Type
variables	CreateImageInput[]

Returns

Promise<SignedUrl[]>

Defined in

packages/client/src/clients/dev.client.ts:159

---

deleteApp

▸ deleteApp(variables, fields?, accessToken?): Promise<App>

Parameters

Name	Type	Default value
variables	MutationGlobalDeleteAppArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<App>

Defined in

packages/client/src/clients/dev.client.ts:117

---

eventTypes

▸ eventTypes(variables, fields?, accessToken?): Promise<EventType[]>

Parameters

Name	Type	Default value
variables	any	undefined
fields	EventTypeFields	'basic'
accessToken?	string	undefined

Returns

Promise<EventType[]>

Defined in

packages/client/src/clients/dev.client.ts:320

---

networks

▸ networks(variables, fields?, accessToken?): Promise<PaginatedNetwork>

Parameters

Name	Type	Default value
variables	QueryGlobalNetworksArgs	undefined
fields	PluralNetworkFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedNetwork>

Defined in

packages/client/src/clients/dev.client.ts:131

---

publishAppPrivately

▸ publishAppPrivately(variables, fields?, accessToken?): Promise<AppPublication>

Parameters

Name	Type	Default value
variables	MutationGlobalPublishAppPrivatelyArgs	undefined
fields	"basic"	'basic'
accessToken?	string	undefined

Returns

Promise<AppPublication>

Defined in

packages/client/src/clients/dev.client.ts:277

---

regenerateClientSecret

▸ regenerateClientSecret(variables, fields?, accessToken?): Promise<App>

Parameters

Name	Type	Default value
variables	MutationGlobalRegenerateClientSecretArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<App>

Defined in

packages/client/src/clients/dev.client.ts:145

---

removeAppCollaborator

▸ removeAppCollaborator(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationGlobalRemoveAppCollaboratorArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/dev.client.ts:249

---

testAppWebhook

▸ testAppWebhook(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationGlobalTestAppWebhookArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/dev.client.ts:306

---

unPublishAppPrivately

▸ unPublishAppPrivately(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationGlobalUnPublishAppPrivatelyArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/dev.client.ts:292

---

updateApp

▸ updateApp(variables, fields?, accessToken?): Promise<App>

Parameters

Name	Type	Default value
variables	MutationGlobalUpdateAppArgs	undefined
fields	GlobalAppFields	'basic'
accessToken?	string	undefined

Returns

Promise<App>

Defined in

packages/client/src/clients/dev.client.ts:103

---

uploadImages

▸ uploadImages(input): Promise<Image[]>

Parameters

Name	Type
input	UploadImagesArgs[]

Returns

Promise<Image[]>

Defined in

packages/client/src/clients/dev.client.ts:171