liferay-headless-rest-client/dist/clients/headless-admin-content-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type ClientExtension={clientExtensionConfig?:{[key:string]:string;};externalReferenceCode?:string;readonly name?:string;readonly'x-class-name'?:string;};export type ContentAssociation={contentSubtype?:string;contentType?:string;readonly'x-class-name'?:string;};export type Creator={readonly additionalName?:string;readonly contentType?:string;readonly externalReferenceCode?:string;readonly familyName?:string;readonly givenName?:string;readonly id?:number;readonly image?:string;readonly name?:string;readonly profileURL?:string;userGroupBriefs?:Array<UserGroupBrief>;readonly'x-class-name'?:string;};export type CustomField={readonly'x-class-name'?:string;customValue?:CustomValue;readonly dataType?:string;name?:string;};export type CustomValue={readonly'x-class-name'?:string;data?:{[key:string]:unknown;};data_i18n?:{[key:string]:string;};geo?:Geo;};export type DisplayPageTemplate={readonly actions?:{[key:string]:{[key:string]:string;};};readonly availableLanguages?:Array<string>;creator?:Creator;customFields?:Array<CustomField>;readonly dateCreated?:string;readonly dateModified?:string;displayPageTemplateKey?:string;displayPageTemplateSettings?:DisplayPageTemplateSettings;markedAsDefault?:boolean;pageDefinition?:PageDefinition;readonly siteId?:number;title:string;readonly uuid?:string;readonly'x-class-name'?:string;};export type DisplayPageTemplateSettings={contentAssociation?:ContentAssociation;openGraphSettingsMapping?:OpenGraphSettingsMapping;seoSettingsMapping?:SeoSettingsMapping;readonly'x-class-name'?:string;};export type Geo={readonly'x-class-name'?:string;latitude?:number;longitude?:number;};export type MasterPage={key?:string;name?:string;readonly'x-class-name'?:string;};export type OpenGraphSettingsMapping={descriptionMappingFieldKey?:string;imageAltMappingFieldKey?:string;imageMappingFieldKey?:string;titleMappingFieldKey?:string;readonly'x-class-name'?:string;};export type Options={value?:string;readonly'x-class-name'?:string;type?:'Equal'|'NotEqual';};export type PageDefinition={pageElement?:PageElement;pageRules?:Array<PageRule>;settings?:Settings;version?:number;readonly'x-class-name'?:string;};export type PageElement={definition?:{[key:string]:unknown;};id?:string;pageElements?:Array<PageElement>;readonly'x-class-name'?:string;type?:'Collection'|'CollectionItem'|'Column'|'DropZone'|'Form'|'FormStep'|'FormStepContainer'|'Fragment'|'FragmentDropZone'|'Root'|'Row'|'Section'|'Widget';};export type PageRule={id?:string;name?:string;pageRuleActions?:Array<PageRuleAction>;pageRuleConditions?:Array<PageRuleCondition>;readonly'x-class-name'?:string;conditionType?:'All'|'Any';};export type PageRuleAction={id?:string;itemId?:string;type?:string;readonly'x-class-name'?:string;};export type PageRuleCondition={field?:string;id?:string;options?:Options;type?:string;readonly'x-class-name'?:string;};export type SeoSettingsMapping={descriptionMappingFieldKey?:string;htmlTitleMappingFieldKey?:string;robots?:string;robots_i18n?:{[key:string]:string;};readonly'x-class-name'?:string;};export type Settings={colorSchemeName?:string;css?:string;favIcon?:{[key:string]:unknown;};globalCSSClientExtensions?:Array<ClientExtension>;globalJSClientExtensions?:Array<ClientExtension>;javascript?:string;masterPage?:MasterPage;styleBook?:StyleBook;themeCSSClientExtension?:ClientExtension;themeName?:string;themeSettings?:{[key:string]:unknown;};themeSpritemapClientExtension?:ClientExtension;readonly'x-class-name'?:string;};export type StyleBook={key?:string;name?:string;readonly'x-class-name'?:string;};export type UserGroupBrief={readonly id?:number;readonly name?:string;readonly'x-class-name'?:string;};export type Facet={facetCriteria?:string;facetValues?:Array<FacetValue>;};export type FacetValue={numberOfOccurrences?:number;term?:string;};export type PageDisplayPageTemplate={items?:Array<DisplayPageTemplate>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type AggregateRating={readonly bestRating?:number;readonly ratingAverage?:number;readonly ratingCount?:number;readonly ratingValue?:number;readonly worstRating?:number;readonly'x-class-name'?:string;};export type ContentDocument={readonly actions?:{[key:string]:{[key:string]:string;};};readonly contentType?:string;readonly contentUrl?:string;readonly contentValue?:string;description?:string;readonly encodingFormat?:string;readonly fileExtension?:string;id?:number;readonly sizeInBytes?:number;title?:string;readonly'x-class-name'?:string;};export type ContentField={contentFieldValue?:ContentFieldValue;contentFieldValue_i18n?:{[key:string]:ContentFieldValue;};readonly dataType?:string;readonly inputControl?:string;readonly label?:string;readonly label_i18n?:{[key:string]:string;};name?:string;nestedContentFields?:Array<ContentField>;readonly repeatable?:boolean;readonly'x-class-name'?:string;};export type ContentFieldValue={data?:string;document?:ContentDocument;geo?:Geo;image?:ContentDocument;link?:string;structuredContentLink?:StructuredContentLink;value?:string;readonly'x-class-name'?:string;};export type PageStructuredContent={items?:Array<StructuredContent>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type Permission={actionIds?:Array<string>;roleExternalReferenceCode?:string;roleName?:string;roleType?:string;};export type RelatedContent={contentType?:string;id?:number;readonly title?:string;readonly'x-class-name'?:string;};export type RenderedContent={readonly contentTemplateId?:string;contentTemplateName?:string;contentTemplateName_i18n?:{[key:string]:string;};markedAsDefault?:boolean;renderedContentURL?:string;renderedContentValue?:string;readonly'x-class-name'?:string;};export type StructuredContent={readonly actions?:{[key:string]:{[key:string]:string;};};aggregateRating?:AggregateRating;readonly assetLibraryKey?:string;readonly availableLanguages?:Array<string>;contentFields?:Array<ContentField>;contentStructureId:number;creator?:Creator;customFields?:Array<CustomField>;readonly dateCreated?:string;dateExpired?:string;readonly dateModified?:string;datePublished?:string;description?:string;description_i18n?:{[key:string]:string;};externalReferenceCode?:string;friendlyUrlPath?:string;friendlyUrlPath_i18n?:{[key:string]:string;};readonly id?:number;readonly key?:string;keywords?:Array<string>;neverExpire?:boolean;readonly numberOfComments?:number;permissions?:Array<Permission>;priority?:number;relatedContents?:Array<RelatedContent>;readonly renderedContents?:Array<RenderedContent>;readonly siteId?:number;structuredContentFolderId?:number;readonly subscribed?:boolean;readonly taxonomyCategoryBriefs?:Array<TaxonomyCategoryBrief>;taxonomyCategoryIds?:Array<number>;title:string;title_i18n?:{[key:string]:string;};readonly uuid?:string;viewableBy?:'Anyone'|'Members'|'Owner';readonly'x-class-name'?:string;};export type StructuredContentLink={readonly contentType?:string;embeddedStructuredContent?:StructuredContent;id?:number;title?:string;readonly'x-class-name'?:string;};export type TaxonomyCategoryBrief={readonly embeddedTaxonomyCategory?:{[key:string]:unknown;};readonly taxonomyCategoryId?:number;readonly taxonomyCategoryName?:string;readonly taxonomyCategoryName_i18n?:{[key:string]:string;};taxonomyCategoryReference?:TaxonomyCategoryReference;readonly'x-class-name'?:string;};export type TaxonomyCategoryReference={externalReferenceCode:string;siteKey?:string;readonly'x-class-name'?:string;};export type GetSiteDisplayPageTemplateData={body?:never;path:{siteId:string;displayPageTemplateKey:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-admin-content/v1.0/sites/{siteId}/display-page-templates/{displayPageTemplateKey}';};export type GetSiteDisplayPageTemplateResponses={default:DisplayPageTemplate;};export type GetSiteDisplayPageTemplateResponse=GetSiteDisplayPageTemplateResponses[keyof GetSiteDisplayPageTemplateResponses];export type GetSiteDisplayPageTemplatesPageData={body?:never;path:{siteId:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;sort?:string;};url:'/o/headless-admin-content/v1.0/sites/{siteId}/display-page-templates';};export type GetSiteDisplayPageTemplatesPageResponses={default:PageDisplayPageTemplate;};export type GetSiteDisplayPageTemplatesPageResponse=GetSiteDisplayPageTemplatesPageResponses[keyof GetSiteDisplayPageTemplatesPageResponses];export type PostSitePageDefinitionPreviewData={body?:PageDefinition;path:{siteId:string;};query?:never;url:'/o/headless-admin-content/v1.0/sites/{siteId}/page-definitions/preview';};export type PostSitePageDefinitionPreviewResponses={default:unknown;};export type DeleteStructuredContentByVersionData={body?:never;path:{structuredContentId:string;version:string;};query?:never;url:'/o/headless-admin-content/v1.0/structured-contents/{structuredContentId}/by-version/{version}';};export type DeleteStructuredContentByVersionResponses={default:unknown;};export type GetStructuredContentByVersionData={body?:never;path:{structuredContentId:string;version:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-admin-content/v1.0/structured-contents/{structuredContentId}/by-version/{version}';};export type GetStructuredContentByVersionResponses={default:StructuredContent;};export type GetStructuredContentByVersionResponse=GetStructuredContentByVersionResponses[keyof GetStructuredContentByVersionResponses];export type GetSiteStructuredContentsPageData={body?:never;path:{siteId:string;};query?:{aggregationTerms?:string;fields?:string;filter?:string;flatten?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;search?:string;sort?:string;};url:'/o/headless-admin-content/v1.0/sites/{siteId}/structured-contents';};export type GetSiteStructuredContentsPageResponses={default:PageStructuredContent;};export type GetSiteStructuredContentsPageResponse=GetSiteStructuredContentsPageResponses[keyof GetSiteStructuredContentsPageResponses];export type GetStructuredContentsVersionsPageData={body?:never;path:{structuredContentId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-admin-content/v1.0/structured-contents/{structuredContentId}/versions';};export type GetStructuredContentsVersionsPageResponses={default:PageStructuredContent;};export type GetStructuredContentsVersionsPageResponse=GetStructuredContentsVersionsPageResponses[keyof GetStructuredContentsVersionsPageResponses];export type PostSiteStructuredContentDraftData={body?:StructuredContent;path:{siteId:string;};query?:never;url:'/o/headless-admin-content/v1.0/sites/{siteId}/structured-contents/draft';};export type PostSiteStructuredContentDraftResponses={default:StructuredContent;};export type PostSiteStructuredContentDraftResponse=PostSiteStructuredContentDraftResponses[keyof PostSiteStructuredContentDraftResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};