dc-management-sdk-js
Version:
Amplience Dynamic Content Management SDK
77 lines (76 loc) • 2.22 kB
TypeScript
import { HalResource } from '../hal/models/HalResource';
import { Edition } from './Edition';
import { Hub } from './Hub';
import { Page } from './Page';
import { Pageable } from './Pageable';
import { Sortable } from './Sortable';
/**
* Class representing the [Event](https://amplience.com/docs/api/dynamic-content/management/#tag/Events) resource.
* An Event represents a major date in the calendar, such as Christmas or Black Friday. An Event may span multiple days and start and end at any given UTC time.
*/
export declare class Event extends HalResource {
/**
* Unique id generated on creation
*/
id?: string;
/**
* Friendly name for the event
*/
name?: string;
/**
* Textual comment to describe the event
*/
comment?: string;
/**
* Date when the event should begin in ISO 8601 format
*/
start?: string;
/**
* Date when the event should end in ISO 8601 format
*/
end?: string;
/**
* Hyperlink to a document describing the requirements for the Event
*/
brief?: string;
/**
* Resources and actions related to an Event
*/
readonly related: {
/**
* Archive Event
*/
archive: () => Promise<Event>;
/**
* Delete Event
*/
delete: () => Promise<void>;
/**
* Retrieves the Hub this event is stored in
*/
hub: () => Promise<Hub>;
editions: {
/**
* Creates an Edition inside the Event
* @param resource The new Edition to create
*/
create: (resource: Edition) => Promise<Edition>;
/**
* Retrieves a list of Editions associated with this Event.
* @param options Pagination options
*/
list: (options?: Pageable & Sortable) => Promise<Page<Edition>>;
};
/**
* Updates this Event with the changes in the mutation parameter.
* @param mutation Mutated event
*/
update: (mutation: Event) => Promise<Event>;
};
}
/**
* @hidden
*/
export declare class EventsPage extends Page<Event> {
constructor(data?: any);
}