@viewdo/dxp-story-cli/dist/app/models/configuration/OrganizationConfiguration.d.ts

DXP Story Management CLI

import { DataPoint } from "./support/DataPoint";
import { IModelConfiguration } from '../IModelConfiguration';
import { AssetDefinition } from '../AssetDefinition';
import { OrganizationEntity } from './support/OrganizationEntity';
import { OrganizationService } from './support/OrganizationService';
import { OrganizationSuppressionList } from './support/OrganizationSuppressionList';
import { FlashboardConfiguration } from './FlashboardConfiguration';
/**
 * DXP ORGANIZATION CONFIG:
 * -----------------------------------------------------
 * This file defines configurable organization settings hosted in the DXP platform.
 */
export declare class OrganizationConfiguration implements IModelConfiguration {
    static file_name: string;
    /** @ignore */
    externalSyncId: string;
    private from_key;
    /**
     * DXP model-type (read-only)
     */
    readonly kind: string;
    /**
     * API version, model location (read-only)
     */
    readonly apiVersion: string;
    /**
     * The key for this model in the DXP platform (read-only)
     * @pattern ^[A-Za-z0-9-_]{1,30}$
     */
    key: string;
    /**
     * The name of this organization
     */
    name: string;
    /**
    * The URL for this organization
    */
    url: string;
    /**
     * These are extra data points that can live with the organization and be used across stories.
     * Note that they can differ by child entities.
     */
    dataPoints?: Array<DataPoint>;
    /**
     * Organizations can have sub-divisions that have alternative data-points. You can define child entities
     * here along with any data changes.
     */
    entities?: Array<OrganizationEntity>;
    /**
     * These are the services configured for the organization.
     * The keys here are what you use in the story.actions configuration.
     */
    services?: Array<OrganizationService>;
    /**
     * These are the services configured for the organization. These are read-only, as services must be
     * configured in the administration app. The keys here are what you use in the story.actions configuration.
     */
    suppressionLists?: Array<OrganizationSuppressionList>;
    scheduledDataSync: boolean;
    /**
     * These are secrets available to this organization.  They can be used in Service configurations for example.
     */
    secrets?: Array<string>;
    /**
     * These are the flashboards configured for the organization.  Note** the metric keys must be tied to an
     * existing story tied to the organization.
     */
    flashboards?: Array<FlashboardConfiguration>;
    /** @ignore */
    updated: Date;
    /** @ignore */
    get api_root(): string;
    private _local_root;
    /** @ignore */
    get local_root(): string;
    /** @ignore */
    set local_root(local_root: string);
    /** @ignore */
    get assets_directory(): string;
    /** @ignore */
    get cdn_root(): string;
    getAssets(from_key?: string, local_root?: string): AssetDefinition[];
    getExportPath(): string;
    convertFromModel(organization: any): OrganizationConfiguration;
}