Class Client

Hierarchy

Client

Index

Constructors

Properties

authToken endpoint name? scheduledMigrations wasExecuted

Methods

applySchemaChanges createAppInstallation createComponent createComponentField createComponentUnionField createCustomSidebarElement createEnumerableField createEnumeration createGraphQLRemoteSource createLocale createModel createRESTRemoteSource createRelationalField createRemoteField createSimpleField createStage createTaxonomy createTaxonomyField createTaxonomyNode createUnionField createWebhook createWorkflow deleteAppInstallation deleteComponent deleteCustomSidebarElement deleteEnumeration deleteField deleteLocale deleteModel deleteRemoteSource deleteStage deleteTaxonomy deleteTaxonomyNode deleteWebhook deleteWorkflow dryRun getEnvironmentDiff refreshGraphQLRemoteSourceSchema run updateAppInstallation updateComponent updateComponentField updateComponentUnionField updateEnumerableField updateEnumeration updateGraphQLRemoteSource updateLocale updateModel updateRESTRemoteSource updateRelationalField updateRemoteField updateSimpleField updateStage updateTaxonomy updateTaxonomyField updateTaxonomyNode updateUnionField updateWebhook updateWorkflow

Constructors

constructor

new Client(params: MigrationParams): Client
Parameters
- params: MigrationParams
Returns Client
- Defined in Client.ts:12

Properties

`Private` authToken

authToken: string

`Private` endpoint

endpoint: string

`Private` `Optional` name

name?: string

`Private` scheduledMigrations

scheduledMigrations: Migrations[]

`Private` wasExecuted

wasExecuted: boolean = false

Methods

applySchemaChanges

applySchemaChanges(data: Migrations[]): void
Apply custom schema changes, eg. output from getEnvironmentDiff method
Parameters
- data: Migrations[]
Returns void
- Defined in Client.ts:388

createAppInstallation

createAppInstallation(data: BatchMigrationAppInstallationInput): void
Parameters
- data: BatchMigrationAppInstallationInput
Returns void
- Defined in Client.ts:313

createComponent

createComponent(data: BatchMigrationCreateComponentInput): void
Parameters
- data: BatchMigrationCreateComponentInput
Returns void
- Defined in Client.ts:43

createComponentField

createComponentField(data: BatchMigrationCreateComponentFieldInput): void
Parameters
- data: BatchMigrationCreateComponentFieldInput
Returns void
- Defined in Client.ts:108

createComponentUnionField

createComponentUnionField(data: BatchMigrationCreateComponentUnionFieldInput): void
Parameters
- data: BatchMigrationCreateComponentUnionFieldInput
Returns void
- Defined in Client.ts:118

createCustomSidebarElement

createCustomSidebarElement(data: BatchMigrationCreateCustomSidebarElementInput): void
Parameters
- data: BatchMigrationCreateCustomSidebarElementInput
Returns void
- Defined in Client.ts:174

createEnumerableField

createEnumerableField(data: BatchMigrationCreateEnumerableFieldInput): void
Parameters
- data: BatchMigrationCreateEnumerableFieldInput
Returns void
- Defined in Client.ts:128

createEnumeration

createEnumeration(data: BatchMigrationCreateEnumerationInput): void
Parameters
- data: BatchMigrationCreateEnumerationInput
Returns void
- Defined in Client.ts:188

createGraphQLRemoteSource

createGraphQLRemoteSource(data: BatchMigrationCreateGraphQlRemoteSourceInput): void
Parameters
- data: BatchMigrationCreateGraphQlRemoteSourceInput
Returns void
- Defined in Client.ts:243

createLocale

createLocale(data: BatchMigrationCreateLocaleInput): void
Parameters
- data: BatchMigrationCreateLocaleInput
Returns void
- Defined in Client.ts:218

createModel

createModel(data: BatchMigrationCreateModelInput): void
creates a new model
Parameters
- data: BatchMigrationCreateModelInput
Returns void
- Defined in Client.ts:28

createRESTRemoteSource

createRESTRemoteSource(data: BatchMigrationCreateRestRemoteSourceInput): void
Parameters
- data: BatchMigrationCreateRestRemoteSourceInput
Returns void
- Defined in Client.ts:262

createRelationalField

createRelationalField(data: BatchMigrationCreateRelationalFieldInput): void
Parameters
- data: BatchMigrationCreateRelationalFieldInput
Returns void
- Defined in Client.ts:83

createRemoteField

createRemoteField(data: BatchMigrationCreateRemoteFieldInput): void
Parameters
- data: BatchMigrationCreateRemoteFieldInput
Returns void
- Defined in Client.ts:68

createSimpleField

createSimpleField(data: BatchMigrationCreateSimpleFieldInput): void
Parameters
- data: BatchMigrationCreateSimpleFieldInput
Returns void
- Defined in Client.ts:58

createStage

createStage(data: BatchMigrationCreateStageInput): void
Parameters
- data: BatchMigrationCreateStageInput
Returns void
- Defined in Client.ts:203

createTaxonomy

createTaxonomy(data: BatchMigrationCreateTaxonomyInput): void
Parameters
- data: BatchMigrationCreateTaxonomyInput
Returns void
- Defined in Client.ts:353

createTaxonomyField

createTaxonomyField(data: BatchMigrationCreateTaxonomyFieldInput): void
Parameters
- data: BatchMigrationCreateTaxonomyFieldInput
Returns void
- Defined in Client.ts:150

createTaxonomyNode

createTaxonomyNode(data: BatchMigrationCreateTaxonomyNodeInput): void
Parameters
- data: BatchMigrationCreateTaxonomyNodeInput
Returns void
- Defined in Client.ts:368

createUnionField

createUnionField(data: BatchMigrationCreateUnionFieldInput): void
Parameters
- data: BatchMigrationCreateUnionFieldInput
Returns void
- Defined in Client.ts:98

createWebhook

createWebhook(data: BatchMigrationCreateWebhookInput): void
creates a webhook
Parameters
- data: BatchMigrationCreateWebhookInput
Returns void
- Defined in Client.ts:298

createWorkflow

createWorkflow(data: BatchMigrationCreateWorkflowInput): void
Parameters
- data: BatchMigrationCreateWorkflowInput
Returns void
- Defined in Client.ts:328

deleteAppInstallation

deleteAppInstallation(data: BatchMigrationAppUninstallationInput): void
Parameters
- data: BatchMigrationAppUninstallationInput
Returns void
- Defined in Client.ts:318

deleteComponent

deleteComponent(data: BatchMigrationDeleteComponentInput): void
Parameters
- data: BatchMigrationDeleteComponentInput
Returns void
- Defined in Client.ts:53

deleteCustomSidebarElement

deleteCustomSidebarElement(data: BatchMigrationDeleteCustomSidebarElementInput): void
Parameters
- data: BatchMigrationDeleteCustomSidebarElementInput
Returns void
- Defined in Client.ts:183

deleteEnumeration

deleteEnumeration(data: BatchMigrationDeleteEnumerationInput): void
Parameters
- data: BatchMigrationDeleteEnumerationInput
Returns void
- Defined in Client.ts:198

deleteField

deleteField(data: BatchMigrationDeleteFieldInput): void
Parameters
- data: BatchMigrationDeleteFieldInput
Returns void
- Defined in Client.ts:138

deleteLocale

deleteLocale(data: BatchMigrationDeleteLocaleInput): void
Parameters
- data: BatchMigrationDeleteLocaleInput
Returns void
- Defined in Client.ts:223

deleteModel

deleteModel(data: BatchMigrationDeleteModelInput): void
Parameters
- data: BatchMigrationDeleteModelInput
Returns void
- Defined in Client.ts:38

deleteRemoteSource

deleteRemoteSource(data: BatchMigrationDeleteRemoteSourceInput): void
Parameters
- data: BatchMigrationDeleteRemoteSourceInput
Returns void
- Defined in Client.ts:272

deleteStage

deleteStage(data: BatchMigrationDeleteStageInput): void
Parameters
- data: BatchMigrationDeleteStageInput
Returns void
- Defined in Client.ts:208

deleteTaxonomy

deleteTaxonomy(data: BatchMigrationDeleteTaxonomyInput): void
Parameters
- data: BatchMigrationDeleteTaxonomyInput
Returns void
- Defined in Client.ts:363

deleteTaxonomyNode

deleteTaxonomyNode(data: BatchMigrationDeleteTaxonomyNodeInput): void
Parameters
- data: BatchMigrationDeleteTaxonomyNodeInput
Returns void
- Defined in Client.ts:378

deleteWebhook

deleteWebhook(data: BatchMigrationDeleteWebhookInput): void
deletes a webhook
Parameters
- data: BatchMigrationDeleteWebhookInput
Returns void
- Defined in Client.ts:308

deleteWorkflow

deleteWorkflow(data: BatchMigrationDeleteWorkflowInput): void
Parameters
- data: BatchMigrationDeleteWorkflowInput
Returns void
- Defined in Client.ts:341

dryRun

dryRun(): Migrations[]
Returns all migrations that would have been sent on submit

Returns Migrations[]
- Defined in Client.ts:383

getEnvironmentDiff

getEnvironmentDiff(targetEnvironment: string): Promise<Migrations[]>
Returns the schema difference between the current environment and target environment as migrations
Parameters
- targetEnvironment: string
Returns Promise<Migrations[]>
- Defined in Client.ts:393

refreshGraphQLRemoteSourceSchema

refreshGraphQLRemoteSourceSchema(data: BatchMigrationRefreshGraphQlRemoteSourceSchemaInput): void
Parameters
- data: BatchMigrationRefreshGraphQlRemoteSourceSchemaInput
Returns void
- Defined in Client.ts:253

run

run(foreground?: boolean): Promise<MigrationInfo>
Submits all scheduled migrations to the management server

Foreground
Wait until the migrations are scheduled and executed. If false the migrations will be submitted, but the result won't be awaited.
Parameters
- foreground: boolean = true
Returns Promise<MigrationInfo>
- Defined in Client.ts:454

updateAppInstallation

updateAppInstallation(data: BatchMigrationUpdateAppInstallationInput): void
updates config and status for an AppInstallation, only valid for App Token bearer
Parameters
- data: BatchMigrationUpdateAppInstallationInput
Returns void
- Defined in Client.ts:281

updateComponent

updateComponent(data: BatchMigrationUpdateComponentInput): void
Parameters
- data: BatchMigrationUpdateComponentInput
Returns void
- Defined in Client.ts:48

updateComponentField

updateComponentField(data: BatchMigrationUpdateComponentFieldInput): void
Parameters
- data: BatchMigrationUpdateComponentFieldInput
Returns void
- Defined in Client.ts:113

updateComponentUnionField

updateComponentUnionField(data: BatchMigrationUpdateComponentUnionFieldInput): void
Parameters
- data: BatchMigrationUpdateComponentUnionFieldInput
Returns void
- Defined in Client.ts:123

updateEnumerableField

updateEnumerableField(data: BatchMigrationUpdateEnumerableFieldInput): void
Parameters
- data: BatchMigrationUpdateEnumerableFieldInput
Returns void
- Defined in Client.ts:133

updateEnumeration

updateEnumeration(data: BatchMigrationUpdateEnumerationInput): void
Parameters
- data: BatchMigrationUpdateEnumerationInput
Returns void
- Defined in Client.ts:193

updateGraphQLRemoteSource

updateGraphQLRemoteSource(data: BatchMigrationUpdateGraphQlRemoteSourceInput): void
Parameters
- data: BatchMigrationUpdateGraphQlRemoteSourceInput
Returns void
- Defined in Client.ts:248

updateLocale

updateLocale(data: BatchMigrationUpdateLocaleInput): void
Parameters
- data: BatchMigrationUpdateLocaleInput
Returns void
- Defined in Client.ts:228

updateModel

updateModel(data: BatchMigrationUpdateModelInput): void
Parameters
- data: BatchMigrationUpdateModelInput
Returns void
- Defined in Client.ts:33

updateRESTRemoteSource

updateRESTRemoteSource(data: BatchMigrationUpdateRestRemoteSourceInput): void
Parameters
- data: BatchMigrationUpdateRestRemoteSourceInput
Returns void
- Defined in Client.ts:267

updateRelationalField

updateRelationalField(data: BatchMigrationUpdateRelationalFieldInput): void
Parameters
- data: BatchMigrationUpdateRelationalFieldInput
Returns void
- Defined in Client.ts:93

updateRemoteField

updateRemoteField(data: BatchMigrationUpdateRemoteFieldInput): void
Parameters
- data: BatchMigrationUpdateRemoteFieldInput
Returns void
- Defined in Client.ts:73

updateSimpleField

updateSimpleField(data: BatchMigrationUpdateSimpleFieldInput): void
Parameters
- data: BatchMigrationUpdateSimpleFieldInput
Returns void
- Defined in Client.ts:63

updateStage

updateStage(data: BatchMigrationUpdateStageInput): void
Parameters
- data: BatchMigrationUpdateStageInput
Returns void
- Defined in Client.ts:213

updateTaxonomy

updateTaxonomy(data: BatchMigrationUpdateTaxonomyInput): void
Parameters
- data: BatchMigrationUpdateTaxonomyInput
Returns void
- Defined in Client.ts:358

updateTaxonomyField

updateTaxonomyField(data: BatchMigrationUpdateTaxonomyFieldInput): void
Parameters
- data: BatchMigrationUpdateTaxonomyFieldInput
Returns void
- Defined in Client.ts:162

updateTaxonomyNode

updateTaxonomyNode(data: BatchMigrationUpdateTaxonomyNodeInput): void
Parameters
- data: BatchMigrationUpdateTaxonomyNodeInput
Returns void
- Defined in Client.ts:373

updateUnionField

updateUnionField(data: BatchMigrationUpdateUnionFieldInput): void
Parameters
- data: BatchMigrationUpdateUnionFieldInput
Returns void
- Defined in Client.ts:103

updateWebhook

updateWebhook(data: BatchMigrationUpdateWebhookInput): void
updates a webhook
Parameters
- data: BatchMigrationUpdateWebhookInput
Returns void
- Defined in Client.ts:303

updateWorkflow

updateWorkflow(data: BatchMigrationUpdateWorkflowInput): void
Parameters
- data: BatchMigrationUpdateWorkflowInput
Returns void
- Defined in Client.ts:336

Generated using TypeDoc