Magidoc

Mutation
Object

Fields

#

createCloudService

Non-null

Create a new Cloud Service

updateCloudService

Non-null

Update an existing Cloud Service

deleteCloudService

Non-null

Delete an existing Cloud Service

createCloudEndpoint

Non-null

Create a new Cloud Endpoint

updateCloudEndpoint

Non-null

Update an existing Cloud Endpoint

deleteCloudEndpoint

Non-null

Delete an existing Cloud Endpoint

createIntegration

Non-null

Create a new Integration

updateIntegration

Non-null

Update an existing Integration - this will leave the existing integration in place and create a new version

deleteIntegration

Non-null

Delete an existing Integration

createIntegrationVersion

Non-null

Create a new Integration Version

deleteIntegrationVersion

Non-null

Delete an existing Integration Version

requestIntegrationVersionReview

Non-null

Request a review to validate an Integration

flagIntegration

Non-null

Flag an Integration for review due to a unexpected behaviours

flagIntegrationVersion

Non-null

Flag an Integration Version for review due to unexpected behaviours

installIntegration

Non-null

Install an Integration

updateIntegrationInstallation

Non-null

Update the config of an installed Integration

upgradeIntegrationInstallation

Non-null

Upgrade an installed Integration from one version to another

setInstalledIntegrationEnabled

Non-null

Set an installed Integration to be enabled or disabled

uninstallIntegration

Non-null

Uninstall an Integration

createRecurringTask

Non-null

Create a new Recurring Task

updateRecurringTask

Non-null

Update an existing Recurring Task

deleteRecurringTask

Non-null

Delete an existing Recurring Task

setRecurringTaskEnabled

Non-null

Set the enabled state of a Recurring Task

setRecurringTaskConfig

Non-null

Set the configuration of a Recurring Task

setRecurringTaskModule

Non-null

Set the schedule of a Recurring Task

sendCocoMessage

Send a message to a Coco chat session

setKnowledgeBase

Non-null

Set the current knowledgebase used for AI operations

createEstimate

Create a new estimate.

updateEstimate

Update an existing estimate.

deleteEstimate

Delete an existing estimate.

createEstimateItem

Create a new Estimate Item for an existing Estimate, if the estimate is accepted, this will return an error.

updateEstimateItem

Update an existing Estimate Item, if the estimate is accepted, this will return an error.

setEstimateItemEmissions

Set the emissions for an Estimate Item, if the estimate is accepted, this will return an error.

approveEstimate

Approve an estimate for production. Will apply the properties of the estimate to the job, and mark it as confirmed. If an estimate has already been approved, this will return an error.

createOrder

Non-null

Create a new Order

updateOrder

This mutation updates an Order, it only supports editing properties of the Order itself, use component mutations for line items

deleteOrder

This mutation deletes an Order

setOrderState

This mutation sets the state of an Order

createOrderLine

This mutation creates a new OrderLineItem for an Order

updateOrderLine

This mutation updates an OrderLineItem

deleteOrderLine

This mutation deletes an OrderLineItem

createCustomer

This mutation creates a new Customer

updateCustomer

This mutation updates a Customer

deleteCustomer

This mutation deletes a Customer

attachCustomerToOrder

This mutation attaches a Customer to an Order

removeCustomerFromOrder

This mutation removes a Customer from an Order

createCustomerContact

This mutation creates a new CustomerContact for a Customer

updateCustomerContact

This mutation updates a CustomerContact

deleteCustomerContact

This mutation deletes a CustomerContact

attachCustomerContactToCustomer

This mutation attaches a CustomerContact to a Customer

removeCustomerContactFromCustomer

This mutation removes a CustomerContact from a Customer

attachCustomerContactToOrder

This mutation attaches a CustomerContact to an Order

removeCustomerContactFromOrder

This mutation removes a CustomerContact from an Order

createAddress

This mutation creates a new Address

updateAddress

This mutation updates an Address

deleteAddress

This mutation deletes an Address

attachAddressToCustomer

This mutation attaches an Address to a Customer

removeAddressFromCustomer

This mutation removes an Address from a Customer

attachAddressToOrder

This mutation attaches an Address to an Order

removeAddressFromOrder

This mutation removes an Address from an Order

createShipment

Non-null

Create a new Shipment

updateShipment

Non-null

Update a Shipment

destroyShipment

Non-null

Destroy a Shipment

setShipmentState

Non-null

Set the state of a Shipment

createShipmentUnit

Non-null

Create a new Shipment Unit

updateShipmentUnit

Non-null

Update a Shipment Unit

destroyShipmentUnit

Non-null

Destroy a Shipment Unit

createShipmentPackage

Non-null

Create a new Shipment Package

updateShipmentPackage

Non-null

Update a Shipment Package

destroyShipmentPackage

Non-null

Destroy a Shipment Package

createShipmentItem

Non-null

Create a new Shipment Item

updateShipmentItem

Non-null

Update a Shipment Item

destroyShipmentItem

Non-null

Destroy a Shipment Item

createCarrier

Non-null

Create a new Carrier

updateCarrier

Non-null

Update a Carrier

destroyCarrier

Non-null

Destroy a Carrier

createShippingService

Non-null

Create a new Shipping Service

updateShippingService

Non-null

Update a Shipping Service

destroyShippingService

Non-null

Destroy a Shipping Service

createContainer

Non-null

Create a new Container

updateContainer

Non-null

Update a Container

destroyContainer

Non-null

Destroy a Container

assignShipmentUnitsToContainer

Non-null

Assign Shipment Units to a Container, will error if the container is in a state that does not allow assignment

removeShipmentUnitsFromContainer

Non-null

Remove Shipment Units from a Container, will error if the container is in a state that does not allow removal

createLocation

Non-null

Create a new Location

updateLocation

Non-null

Update a Location

destroyLocation

Non-null

Destroy a Location

createTransfer

Non-null

Create a transfer of interim production components between locations

updateTransfer

Non-null

Update a transfer of interim production components between locations

destroyTransfer

Non-null

Destroy a transfer of interim production components between locations

setLocationStockAvailability

Non-null

Set the availability of stock in a location

setLocationComponentAvailability

Non-null

Set the availability of a component in a location

createScriptLibrary

Non-null

Create a script library

updateScriptLibrary

Non-null

Update a script library

deleteScriptLibrary

Non-null

Delete a script library

createScript

Non-null

Create a script

updateScript

Non-null

Update a script

deleteScript

Non-null

Delete a script

createEmailFolder

Non-null

Creates a new email folder.

updateEmailFolder

Non-null

Updates an existing email folder.

deleteEmailFolder

Non-null

Deletes an email folder by its unique identifier.

updateUserPersonalInformation

Non-null

Update the personal information of the currently authenticated user

createCloudCredential

Non-null

Creates a Cloud Credential to be securely stored

setCloudCredentialEnabled

Non-null

Sets the enabled state of a Cloud Credential

deleteCloudCredential

Non-null

Deletes a Cloud Credential

setConfigValue

Non-null

Set the value of a ConfigValue

removeConfigValue

Non-null

Remove a ConfigValue

createInvitation

Non-null

Invite a new user

acceptInvitation

Non-null

Accept an invitation

setUserEnabled

Non-null

Set a user's activation status

cancelInvitation

Non-null

Cancel an invitation

createNotifier

Non-null

Creates a new notifier.

updateNotifier

Non-null

Updates an existing notifier.

deleteNotifier

Non-null

Deletes a notifier.

cocoCronFromPrompt

Non-null

Use CocoAI to turn human input into a cron expression for RecurringTask entries.

inferJobSpecification

Non-null

Use CocoAI to infer a Job specification from a given input.

cocoGenerateMapping

Non-null

Use CocoAI to generate a mapping from an unknown input to a known output. Initially only supports creating Jobs.

cocoInference

Non-null

Use CocoAI to perform a generic inference operation

createApiKey

Non-null

Create a new API Key

updateApiKey

Non-null

Update an existing API Key

deleteApiKey

Non-null

Delete an existing API Key

getBillingSession

Non-null

Setup a session with the Stripe Billing portal

getPricingTable

Non-null

Get a pricing table for a given Customer

updateNetworkNode

Non-null

Update properties of a NetworkNode

setNetworkNodeActive

Non-null

Set a NetworkNode to be Active

setNetworkNodeInactive

Non-null

Set a NetworkNode to be Inactive

updateNetworkReceivedJob

Non-null

Update an incoming NetworkReceivedJob - either Reject, or Confirm and create a Job

sendJobToNetwork

Non-null

Send a Job to the Network for routing

createDrive

Non-null

Create a new storage drive for file storage in the Cloud

updateDrive

Non-null

Update the details of a storage drive

deleteDrive

Non-null

Delete a storage drive - caution, this will delete all files in the drive

createFile

Non-null

Upload a file to a storage drive

downloadFile

Non-null

Create a file download link

deleteFile

Non-null

Delete a file from a storage drive

createController

Non-null

Create a new Controller

updateController

Non-null

Update an existing Controller

removeController

Non-null

Remove a Controller

registerController

Non-null

Register a Controller. This starts the controller registration handshake, and returns a code which needs to be entered into the relevant account to complete the process.

verifyControllerRegistration

Verify a Controller Registration. If the controller registration code has been consumed this will return a payload of data to the controller to complete the handshake process. If not, then there is no response.

createDevice

Non-null

Create a new Device

updateDevice

Non-null

Update a Device

reportDeviceStatus

Non-null

Provides an update to the status of the Device

pingController

Non-null

Ping a Controller to check it is alive

createHotFolder

Non-null

Create a new HotFolder

updateHotFolder

Non-null

Update an existing HotFolder

removeHotFolder

Non-null

Remove a HotFolder

setHotFolderActivation

Non-null

Set the active state of a HotFolder

createMetric

Non-null

Create a new Metric

updateMetric

Non-null

Update a Metric

removeMetric

Non-null

Remove a Metric (also removes all MetricPoints associated with it)

createMetricPoint

Non-null

Create a metric point

createProcessNet

Non-null

Create a new ProcessNet

deleteProcessNet

Non-null

Delete a ProcessNet

enableProcessNet

Non-null

Enable a ProcessNet

createJob

Non-null

Create a new Job.

updateJob

Non-null

Update an existing Job.

cancelJob

Non-null

Cancels an existing Job.

deleteJob

Non-null

Deletes an existing Job along with all associated records. To do this, the Job must be in a cancelled state.

updateJobState

Non-null

Update the state of an existing Job.

createPart

Non-null

Create a new Part for a Job

updatePart

Non-null

Update an existing Part for a Job, this will only work if the Job is in DRAFT state.

removePart

Non-null

Remove a part for a Job, this will only work if the Job is in DRAFT state.

createOperation

Non-null

Create a new Operation.

updateOperation

Non-null

Update an existing Operation.

removeOperation

Non-null

Remove an existing Operation.

createMilestone

Non-null

Create a new Milestone for a part or Job

updateMilestone

Non-null

Update an existing Milestone.

removeMilestone

Non-null

Remove an existing Milestone.

createWorkQueue

Non-null

Create a new work queue.

updateWorkQueue

Non-null

Update an existing work queue.

removeWorkQueue

Non-null

Remove an existing work queue.

createWorkQueuePlacement

Non-null

Create a new work queue placement.

updateWorkQueuePlacement

Non-null

Update an existing work queue placement.

removeWorkQueuePlacement

Non-null

Remove an existing work queue placement.

moveWorkQueuePlacement

Move an existing work queue placement.

reportOperationProgress

Report progress status of an Operation in a WorkQueue

createReaction

Non-null

Creates a new Reaction.

updateReaction

Non-null

Updates an existing Reaction.

removeReaction

Non-null

Removes a Reaction.

setReactionEnabled

Non-null

Sets the enabled status of a Reaction.

runInference

Non-null

Run intelligent setup inference on a prompt.