dc-management-sdk-js
Version:
Amplience Dynamic Content Management SDK
87 lines (86 loc) • 2.22 kB
TypeScript
import { HalResource } from '../hal/models/HalResource';
import { Hub } from './Hub';
import { Page } from './Page';
import { Status } from './Status';
/**
* Supported validation levels
*/
export declare enum ValidationLevel {
SLOT = "SLOT",
CONTENT_TYPE = "CONTENT_TYPE",
PARTIAL = "PARTIAL"
}
/**
* Content type schema
*/
export declare class ContentTypeSchema extends HalResource {
/**
* Unique id generated on creation
*/
id?: string;
/**
* Content Type Schema
*/
body?: string;
/**
* Schema ID (URI)
*/
schemaId?: string;
/**
* Version number of the content type schema returned.
* This number will automatically be incremented for each update.
*/
version?: number;
/**
* Validation level for this content type schema
*/
validationLevel?: ValidationLevel;
/**
* Id of the user responsible for originally creating the content item
*/
createdBy?: string;
/**
* Timestamp representing when the content item was originally created in ISO 8601 format
*/
createdDate?: string;
/**
* Id of the user responsible for the last update to the content item
*/
lastModifiedBy?: string;
/**
* Timestamp representing when the content item was last updated in ISO 8601 format
*/
lastModifiedDate?: string;
/**
* Lifecycle status of the content type schema
*/
status: Status;
/**
* Resources and actions related to a ContentTypeSchema
*/
readonly related: {
/**
* Retrieves the Hub this content type schema is stored in
*/
hub: () => Promise<Hub>;
/**
* Updated content type schema
* @param updated
*/
update: (mutation: ContentTypeSchema) => Promise<ContentTypeSchema>;
/**
* Archive content type schema
*/
archive: () => Promise<ContentTypeSchema>;
/**
* Unarchive content type schema
*/
unarchive: () => Promise<ContentTypeSchema>;
};
}
/**
* @hidden
*/
export declare class ContentTypeSchemaPage extends Page<ContentTypeSchema> {
constructor(data?: any);
}