dc-management-sdk-js/build/module/lib/model/Event.js

Amplience Dynamic Content Management SDK

import { HalResource } from '../hal/models/HalResource';
import { Edition, EditionsPage } from './Edition';
import { Hub } from './Hub';
import { Page } from './Page';
/**
 * 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 class Event extends HalResource {
    constructor() {
        super(...arguments);
        /**
         * Resources and actions related to an Event
         */
        this.related = {
            /**
             * Archive Event
             */
            archive: () => this.performActionThatReturnsResource('archive', {}, {}, Event),
            /**
             * Delete Event
             */
            delete: () => this.deleteResource(),
            /**
             * Retrieves the Hub this event is stored in
             */
            hub: () => this.fetchLinkedResource('hub', {}, Hub),
            editions: {
                /**
                 * Creates an Edition inside the Event
                 * @param resource The new Edition to create
                 */
                create: (resource) => this.createLinkedResource('create-edition', {}, resource, Edition),
                /**
                 * Retrieves a list of Editions associated with this Event.
                 * @param options Pagination options
                 */
                list: (options) => this.fetchLinkedResource('editions', options, EditionsPage),
            },
            /**
             * Updates this Event with the changes in the mutation parameter.
             * @param mutation Mutated event
             */
            update: (mutation) => this.updateResource(mutation, Event),
        };
    }
}
/**
 * @hidden
 */
export class EventsPage extends Page {
    constructor(data) {
        super('events', Event, data);
    }
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL21vZGVsL0V2ZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSwyQkFBMkIsQ0FBQztBQUN4RCxPQUFPLEVBQUUsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNsRCxPQUFPLEVBQUUsR0FBRyxFQUFFLE1BQU0sT0FBTyxDQUFDO0FBQzVCLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxRQUFRLENBQUM7QUFJOUI7OztHQUdHO0FBQ0gsTUFBTSxPQUFPLEtBQU0sU0FBUSxXQUFXO0lBQXRDOztRQStCRTs7V0FFRztRQUNhLFlBQU8sR0FBRztZQUN4Qjs7ZUFFRztZQUNILE9BQU8sRUFBRSxHQUFtQixFQUFFLENBQzVCLElBQUksQ0FBQyxnQ0FBZ0MsQ0FBQyxTQUFTLEVBQUUsRUFBRSxFQUFFLEVBQUUsRUFBRSxLQUFLLENBQUM7WUFFakU7O2VBRUc7WUFDSCxNQUFNLEVBQUUsR0FBa0IsRUFBRSxDQUFDLElBQUksQ0FBQyxjQUFjLEVBQUU7WUFFbEQ7O2VBRUc7WUFDSCxHQUFHLEVBQUUsR0FBaUIsRUFBRSxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFLEdBQUcsQ0FBQztZQUVqRSxRQUFRLEVBQUU7Z0JBQ1I7OzttQkFHRztnQkFDSCxNQUFNLEVBQUUsQ0FBQyxRQUFpQixFQUFvQixFQUFFLENBQzlDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxnQkFBZ0IsRUFBRSxFQUFFLEVBQUUsUUFBUSxFQUFFLE9BQU8sQ0FBQztnQkFFcEU7OzttQkFHRztnQkFDSCxJQUFJLEVBQUUsQ0FBQyxPQUE2QixFQUEwQixFQUFFLENBQzlELElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxVQUFVLEVBQUUsT0FBTyxFQUFFLFlBQVksQ0FBQzthQUM5RDtZQUVEOzs7ZUFHRztZQUNILE1BQU0sRUFBRSxDQUFDLFFBQWUsRUFBa0IsRUFBRSxDQUMxQyxJQUFJLENBQUMsY0FBYyxDQUFDLFFBQVEsRUFBRSxLQUFLLENBQUM7U0FDdkMsQ0FBQztJQUNKLENBQUM7Q0FBQTtBQUVEOztHQUVHO0FBQ0gsTUFBTSxPQUFPLFVBQVcsU0FBUSxJQUFXO0lBQ3pDLFlBQVksSUFBVTtRQUNwQixLQUFLLENBQUMsUUFBUSxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQztJQUMvQixDQUFDO0NBQ0YifQ==