@springtree/eva-core/EVA.Makeup.d.ts

The EVA core typings

declare module EVA.Makeup {

  export interface MakeupCreateBlock {
    Block?: BlockDto;
  }

  export interface BlockDto {
    ID: string;
    Type: string;
    Input: { [key: string]: BlockInputDto };
    CssClasses: string[];
    Name: string;
    Template: string;
    Content: string;
    Width: string;
    Height: string;
    CssStyles: string;
    IsCurrent: boolean;
    Version: number;
    VersionDescription: string;
  }

  export interface BlockInputDto {
    Value: any;
    Description: string;
    Type: string;
    IsOptional: boolean;
  }

  export interface MakeupCreateBlockResponse {
    ID: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupDeleteBlock {
    ID?: string;
    Version: number;
  }

  export interface MakeupGetBlockByID {
    ID?: string;
    Version: number;
  }

  export interface MakeupGetBlockByIDResponse {
    Block: BlockDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetRenderedBlockByID {
    ID?: string;
    Version: number;
  }

  export interface MakeupGetRenderedBlockByIDResponse {
    Block: BlockDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupListBlocks {
    Type?: string;
    PageConfig?: EVA.Core.PageConfig;
  }

  export interface MakeupListBlocksResponse {
    Result: EVA.Core.PagedResult<BlockDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupUpdateBlock {
    Block?: BlockDto;
  }

  export interface MakeupReplaceConfigurationProfile {
    Configuration?: ConfigurationProfileDto;
    LanguageID?: string;
  }

  export interface ConfigurationProfileDto {
    SiteID: number;
    LanguageID: string;
    AggregationConfigs: ConfigurationProfileAggregationConfigDto[];
    DefaultAggregationOptions: { [key: string]: EVA.Core.AggregationFilterModel };
    ProductPropertyTypeMappings: ProductPropertyTypeMappingDto[];
    DefaultFilters: { [key: string]: EVA.Core.FilterModel };
    DefaultPageLimit: ConfigurationProfilePageLimitDto;
    DefaultSort: ConfigurationProfileSortOptionsDto[];
    DefaultIncludedFields: string[];
    AvailableSortOptions: ConfigurationProfileSortOptionsDto[];
    AvailablePageLimits: ConfigurationProfilePageLimitDto[];
  }

  export interface ConfigurationProfileAggregationConfigDto {
    TypeID: string;
    Type: string;
    InitialShownItems: number;
    Sorting: string[][];
  }

  export interface ProductPropertyTypeMappingDto {
    Key: string;
    ProductPropertyTypeID: string;
  }

  export interface ConfigurationProfilePageLimitDto {
    Limit: number;
    LimitDisplay: string;
  }

  export interface ConfigurationProfileSortOptionsDto {
    FieldName: string;
    SortDisplay: string;
    Direction?: ConfigurationProfileSortOptionsDirection;
  }

  export const enum ConfigurationProfileSortOptionsDirection {
    Ascending = 0,
    Descending = 1
  }

  export interface MakeupGetPageMap {
    LanguageID?: string;
  }

  export interface MakeupGetPageMapResponse {
    PageMap: { [key: string]: MakeupPageMapSection };
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupPageMapSection {
    Name: string;
    Sections: MakeupPageMapSection[];
    Description: string;
    IsBase: boolean;
    Pages: MakeupPageMapSectionPage[];
  }

  export interface MakeupPageMapSectionPage {
    ID: string;
    Name: string;
    Path: string;
    IsBase: boolean;
  }

  export interface MakeupCreateMenu {
    Menu?: MenuDto;
  }

  export interface MenuDto {
    ID: string;
    Name: string;
    LanguageID: string;
    Types: MenuTypeDto[];
  }

  export interface MenuTypeDto {
    Type: string;
    Items: MenuItemDto[];
  }

  export interface MenuItemDto {
    Name: string;
    Path: string;
    ImageBlobID?: string;
    Items: MenuItemDto[];
  }

  export interface MakeupCreateMenuResponse {
    ID: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupReplaceMenu {
    ID?: string;
    Menu?: MenuDto;
  }

  export interface MakeupCreatePage {
    Page?: PageDto;
  }

  export interface PageDto {
    ID: string;
    LanguageID: string;
    Name: string;
    Description: string;
    Type: string;
    SearchProductsRequest: EVA.Core.SearchProducts;
    Path: string;
    Containers: ContainerDto[];
    CssClasses: string[];
    MetaTags: MetaTagDto[];
    Version: number;
    VersionDescription: string;
    IsCurrent: boolean;
    CssStyles: string;
    StyleSheetBlobID?: string;
    Slug: string;
    Blocks: PageBlockDto[];
    Event: EventDto;
    EventID: number;
    RequiresAuthentication: boolean;
    RequiredFunctionality: string;
  }

  export interface ContainerDto {
    CssClasses: string[];
    Children: ContainerChildDto[];
    Width: string;
    Height: string;
  }

  export interface ContainerChildDto {
    CssClasses: string[];
    Blocks: PageBlockDto[];
    Width: string;
    Height: string;
  }

  export interface PageBlockDto {
    ID: string;
    Type: string;
    Input: { [key: string]: BlockInputDto };
    CssClasses: string[];
    CssStyles: string;
    Name: string;
    Content: string;
    Template: string;
    Width: string;
    Height: string;
    Version: number;
  }

  export interface MetaTagDto {
    Attribute: string;
    Content: string;
    Type: string;
  }

  export interface EventDto {
    ID: number;
    Name: string;
    StartDate?: string;
    EndDate?: string;
    IsActive: boolean;
  }

  export interface MakeupCreatePageResponse {
    ID: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupDeletePage {
    ID?: string;
    LanguageID?: string;
    Version: number;
  }

  export interface MakeupGetPageByID {
    ID?: string;
    LanguageID?: string;
    Version: number;
  }

  export interface MakeupGetPageByIdResponse {
    Page: PageDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetPageByPath {
    Path?: string;
    LanguageID?: string;
  }

  export interface MakeupGetPageByPathResponse {
    Page: PageDto;
    PathContext: PathContext;
    Error: EVA.Core.ServiceError;
  }

  export interface PathContext {
    Path: string;
    Parameters: PathParameter[];
  }

  export interface PathParameter {
    Key: string;
    Value: any;
  }

  export interface MakeupGetRenderedPageByID {
    ID: string;
    LanguageID?: string;
    Version: number;
  }

  export interface MakeupGetRenderedPageByIDResponse {
    Page: RenderedPageDto;
    Error: EVA.Core.ServiceError;
  }

  export interface RenderedPageDto {
    ID: string;
    LanguageID: string;
    Name: string;
    Description: string;
    Type: string;
    SearchProductsRequest: EVA.Core.SearchProducts;
    Path: string;
    Containers: ContainerDto[];
    CssClasses: string[];
    MetaTags: MetaTagDto[];
    StyleSheetBlobID?: string;
    Slug: string;
    RequiresAuthentication: boolean;
    RequiredFunctionality: string;
  }

  export interface MakeupGetRenderedPageByPath {
    Path?: string;
    LanguageID?: string;
  }

  export interface MakeupGetRenderedPageByPathResponse {
    Page: RenderedPageDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupReplacePage {
    ID?: string;
    Page?: PageDto;
  }

  export interface MakeupCreateSite {
    Name: string;
    OrganizationUnitID: number;
    LanguageID: string;
    BackendID?: string;
  }

  export interface MakeupCreateSiteResponse {
    SiteID: number;
    AnonymousUserToken: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupReplaceSiteConfigurationSchema {
    SiteID: number;
    Schema: { [key: string]: any };
  }

  export interface MakeupReplaceSiteConfiguration {
    SiteID: number;
    LanguageID: string;
    Configuration: { [key: string]: any };
  }

  export interface MakeupGetSiteConfigurationSchema {
    SiteID: number;
  }

  export interface MakeupGetSiteConfigurationSchemaResponse {
    Schema: { [key: string]: any };
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetSiteConfiguration {
    SiteID: number;
    LanguageID: string;
  }

  export interface MakeupGetSiteConfigurationResponse {
    Configuration: { [key: string]: any };
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetCurrentPageVersion {
    ID?: string;
    LanguageID?: string;
  }

  export interface MakeupGetCurrentPageVersionResponse {
    Version: number;
    VersionDescription: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetRenderedPagesByPartialPath {
    PartialPath?: string;
    LanguageID?: string;
  }

  export interface MakeupGetRenderedPagesByPartialPathResponse {
    Pages: RenderedPageDto[];
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupListPageVersions {
    ID?: string;
    LanguageID?: string;
    PageConfig?: EVA.Core.PageConfig;
  }

  export interface MakeupListPageVersionsResponse {
    Result: EVA.Core.PagedResult<PageVersionDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface PageVersionDto {
    ID: string;
    Version: number;
    IsCurrent: boolean;
    VersionDescription: string;
  }

  export interface MakeupPublishPageVersion {
    ID?: string;
    LanguageID?: string;
    Version: number;
  }

  export interface MakeupDeleteMenu {
    ID?: string;
    LanguageID?: string;
  }

  export interface MakeupGetMenuByID {
    ID?: string;
    LanguageID?: string;
  }

  export interface MakeupGetMenuByIDResponse {
    Menu: MenuDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupListMenus {
    LanguageID?: string;
    PageConfig?: EVA.Core.PageConfig;
  }

  export interface MakeupListMenusResponse {
    Result: EVA.Core.PagedResult<MenuDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupActivateEvent {
    EventID: number;
  }

  export interface MakeupCreateEvent {
    Event?: CreateEventModel;
  }

  export interface CreateEventModel {
    Name: string;
    StartDate?: string;
    EndDate?: string;
    IsActive: boolean;
  }

  export interface MakeupCreateEventResponse {
    ID: number;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupDeactivateEvent {
    EventID: number;
  }

  export interface MakeupDeleteEvent {
    EventID: number;
  }

  export interface MakeupGetEventByID {
    ID: number;
  }

  export interface MakeupGetEventByIDResponse {
    Event: EventDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupListEvents {
    IsActive: boolean;
    PageConfig?: EVA.Core.PageConfig;
  }

  export interface MakeupListEventsResponse {
    Result: EVA.Core.PagedResult<EventDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetConfigurationProfile {
    LanguageID?: string;
  }

  export interface MakeupGetConfigurationProfileResponse {
    Configuration: ConfigurationProfileDto;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupGetCurrentBlockVersion {
    ID?: string;
  }

  export interface MakeupGetCurrentBlockVersionResponse {
    Version: number;
    VersionDescription: string;
    Error: EVA.Core.ServiceError;
  }

  export interface MakeupListBlockVersions {
    ID?: string;
    PageConfig?: EVA.Core.PageConfig;
  }

  export interface MakeupListBlockVersionsResponse {
    Result: EVA.Core.PagedResult<BlockVersionDto>;
    Error: EVA.Core.ServiceError;
  }

  export interface BlockVersionDto {
    ID: string;
    Version: number;
    IsCurrent: boolean;
    VersionDescription: string;
  }

  export interface MakeupPublishBlockVersion {
    ID?: string;
    Version: number;
  }

}