dc-management-sdk-js
Version:
Amplience Dynamic Content Management SDK
61 lines (60 loc) • 2.06 kB
TypeScript
import { HalResource } from '../hal/models/HalResource';
import { Hub } from './Hub';
import { Page } from './Page';
/**
* Class representing the [WorkflowState](https://amplience.com/docs/api/dynamic-content/management/#tag/Workflows) resource.
*
* It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have its status set to one of the workflow states defined within the hub.
*
* In the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.
*/
export declare class WorkflowState extends HalResource {
/**
* Unique id generated on creation
*/
id?: string;
/**
* Friendly display label for the WorkflowState
*/
label?: string;
/**
* Id of the user responsible for originally creating the Workflow State
*/
createdBy?: string;
/**
* Timestamp representing when the Workflow State was originally created in ISO 8601 format
*/
createdDate?: string;
/**
* Id of the user responsible for the last update to the Workflow State
*/
lastModifiedBy?: string;
/**
* Timestamp representing when the Workflow State was last updated in ISO 8601 format
*/
lastModifiedDate?: string;
/**
* Assigned colour in the format of `rgb(R,G,B)`
*/
'color': string;
/**
* Resources and actions related to a WorkflowState
*/
readonly related: {
/**
* Retrieves the Hub this webhook is stored in
*/
hub: () => Promise<Hub>;
/**
* Updates this Workflow State with the changes in the mutation parameter.
* @param mutation
*/
update: (mutation: WorkflowState) => Promise<WorkflowState>;
};
}
/**
* @hidden
*/
export declare class WorkflowStatesPage extends Page<WorkflowState> {
constructor(data?: Record<string, unknown>);
}