UNPKG

liferay-headless-rest-client

Version:
1 lines 22.7 kB
export type Collaborator={actionIds:Array<string>;readonly actions?:{[key:string]:{[key:string]:unknown;};};creator?:Creator;dateExpired?:string;readonly externalReferenceCode?:string;id?:number;readonly name?:string;readonly portrait?:string;share?:boolean;type: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 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 PageCollaborator={items?:Array<Collaborator>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type AuditEvent={readonly auditFieldChanges?:Array<AuditFieldChange>;creator?:Creator;readonly dateCreated?:string;readonly eventType?:string;readonly'x-class-name'?:string;};export type AuditFieldChange={name?:string;newValue?:{[key:string]:unknown;};oldValue?:{[key:string]:unknown;};readonly'x-class-name'?:string;};export type ParentTaxonomyCategory={externalReferenceCode?:string;readonly'x-class-name'?:string;};export type ParentTaxonomyVocabulary={externalReferenceCode?:string;readonly'x-class-name'?:string;};export type Permission={actionIds?:Array<string>;roleExternalReferenceCode?:string;roleName?:string;roleType?:string;};export type Scope={externalReferenceCode?:string;readonly'x-class-name'?:string;type?:'AssetLibrary'|'Site';};export type Status={code:number;label?:string;label_i18n?:string;readonly'x-class-name'?:string;};export type TaxonomyCategoryBrief={readonly embeddedTaxonomyCategory?:{[key:string]:unknown;};parentTaxonomyCategory?:ParentTaxonomyCategory;parentTaxonomyVocabulary?:ParentTaxonomyVocabulary;scope?:Scope;taxonomyCategoryExternalReferenceCode?:string;readonly taxonomyCategoryId?:number;readonly taxonomyCategoryName?:string;readonly taxonomyCategoryName_i18n?:{[key:string]:string;};readonly'x-class-name'?:string;};export type Version={readonly number?:number;readonly'x-class-name'?:string;};export type PagePermission={items?:Array<Permission>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type ValidationError={errorMessage?:string;objectFieldName?:string;objectValidationRuleExternalReferenceCode?:string;readonly'x-class-name'?:string;};export type ValidationResponse={validationErrors?:Array<ValidationError>;readonly'x-class-name'?:string;};export type ValidationRequest={objectValidationRuleExternalReferenceCodes?:Array<string>;values?:PerformanceCookieEntry;readonly'x-class-name'?:string;};export type PagePerformanceCookieEntry={items?:Array<PerformanceCookieEntry>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;readonly'x-schema-name'?:string;};export type PerformanceCookieEntry={readonly actions?:{[key:string]:{[key:string]:string;};};readonly auditEvents?:Array<AuditEvent>;readonly creator?:string;readonly dateCreated?:string;readonly dateModified?:string;defaultLanguageId?:string;displayDate?:string;expirationDate?:string;externalReferenceCode?:string;friendlyUrlPath?:string;friendlyUrlPath_i18n?:{[key:string]:string;};readonly id?:number;keywords?:Array<string>;objectEntryFolderExternalReferenceCode?:string;objectEntryFolderId?:number;permissions?:Array<Permission>;reviewDate?:string;readonly scopeId?:number;readonly scopeKey?:string;readonly status?:number;taxonomyCategoryBriefs?:Array<TaxonomyCategoryBrief>;taxonomyCategoryIds?:Array<number>;readonly'x-class-name'?:string;readonly'x-schema-name'?:string;collectedData?:string;expiration?:string;host?:string;name:string;purpose?:string;type?:string;};export type DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:never;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:never;url:'/o/performance-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:unknown;};export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:never;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponse=GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses[keyof GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses];export type PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:Collaborator;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:never;url:'/o/performance-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponse=PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses[keyof PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses];export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData={body?:never;path:{scopeKey:string;externalReferenceCode:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators';};export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses={default:PageCollaborator;};export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponse=GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses[keyof GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses];export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData={body?:Array<Collaborator>;path:{scopeKey:string;externalReferenceCode:string;};query?:never;url:'/o/performance-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators';};export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses={default:PageCollaborator;};export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponse=PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses[keyof PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses];export type DeleteByExternalReferenceCodeData={body?:never;path:{externalReferenceCode:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type DeleteByExternalReferenceCodeResponses={default:unknown;};export type GetByExternalReferenceCodeData={body?:never;path:{externalReferenceCode:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type GetByExternalReferenceCodeResponses={default:PerformanceCookieEntry;};export type GetByExternalReferenceCodeResponse=GetByExternalReferenceCodeResponses[keyof GetByExternalReferenceCodeResponses];export type PatchByExternalReferenceCodeData={body?:PerformanceCookieEntry;path:{externalReferenceCode:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type PatchByExternalReferenceCodeResponses={default:PerformanceCookieEntry;};export type PatchByExternalReferenceCodeResponse=PatchByExternalReferenceCodeResponses[keyof PatchByExternalReferenceCodeResponses];export type PutByExternalReferenceCodeData={body?:PerformanceCookieEntry;path:{externalReferenceCode:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type PutByExternalReferenceCodeResponses={default:PerformanceCookieEntry;};export type PutByExternalReferenceCodeResponse=PutByExternalReferenceCodeResponses[keyof PutByExternalReferenceCodeResponses];export type DeleteByExternalReferenceCodeByVersionData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}';};export type DeleteByExternalReferenceCodeByVersionResponses={default:unknown;};export type GetByExternalReferenceCodeByVersionData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}';};export type GetByExternalReferenceCodeByVersionResponses={default:PerformanceCookieEntry;};export type GetByExternalReferenceCodeByVersionResponse=GetByExternalReferenceCodeByVersionResponses[keyof GetByExternalReferenceCodeByVersionResponses];export type DeletePerformanceCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/performance-cookies-entries/batch';};export type DeletePerformanceCookieEntryBatchResponses={default:unknown;};export type PostPerformanceCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/performance-cookies-entries/batch';};export type PostPerformanceCookieEntryBatchResponses={default:unknown;};export type PutPerformanceCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/performance-cookies-entries/batch';};export type PutPerformanceCookieEntryBatchResponses={default:unknown;};export type GetByExternalReferenceCodeVersionsPageData={body?:never;path:{externalReferenceCode:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/versions';};export type GetByExternalReferenceCodeVersionsPageResponses={default:PagePerformanceCookieEntry;};export type GetByExternalReferenceCodeVersionsPageResponse=GetByExternalReferenceCodeVersionsPageResponses[keyof GetByExternalReferenceCodeVersionsPageResponses];export type GetPerformanceCookieEntriesPageData={body?:never;path?:never;query?:{aggregationTerms?:string;fields?:string;filter?:string;flatten?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;search?:string;sort?:string;};url:'/o/performance-cookies-entries/';};export type GetPerformanceCookieEntriesPageResponses={default:PagePerformanceCookieEntry;};export type GetPerformanceCookieEntriesPageResponse=GetPerformanceCookieEntriesPageResponses[keyof GetPerformanceCookieEntriesPageResponses];export type PostPerformanceCookieEntryData={body?:PerformanceCookieEntry;path?:never;query?:never;url:'/o/performance-cookies-entries/';};export type PostPerformanceCookieEntryResponses={default:PerformanceCookieEntry;};export type PostPerformanceCookieEntryResponse=PostPerformanceCookieEntryResponses[keyof PostPerformanceCookieEntryResponses];export type PostByExternalReferenceCodeByVersionCopyData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/copy';};export type PostByExternalReferenceCodeByVersionCopyResponses={default:PerformanceCookieEntry;};export type PostByExternalReferenceCodeByVersionCopyResponse=PostByExternalReferenceCodeByVersionCopyResponses[keyof PostByExternalReferenceCodeByVersionCopyResponses];export type PostByExternalReferenceCodeByVersionExpireData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/expire';};export type PostByExternalReferenceCodeByVersionExpireResponses={default:PerformanceCookieEntry;};export type PostByExternalReferenceCodeByVersionExpireResponse=PostByExternalReferenceCodeByVersionExpireResponses[keyof PostByExternalReferenceCodeByVersionExpireResponses];export type PostPerformanceCookieEntriesPageExportBatchData={body?:never;path?:never;query?:{filter?:string;search?:string;sort?:string;callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/performance-cookies-entries/export-batch';};export type PostPerformanceCookieEntriesPageExportBatchResponses={default:unknown;};export type PostValidateData={body?:ValidationRequest;path?:never;query?:never;url:'/o/performance-cookies-entries/validate';};export type PostValidateResponses={default:ValidationResponse;};export type PostValidateResponse=PostValidateResponses[keyof PostValidateResponses];export type PutByExternalReferenceCodeByVersionRestoreData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/performance-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/restore';};export type PutByExternalReferenceCodeByVersionRestoreResponses={default:PerformanceCookieEntry;};export type PutByExternalReferenceCodeByVersionRestoreResponse=PutByExternalReferenceCodeByVersionRestoreResponses[keyof PutByExternalReferenceCodeByVersionRestoreResponses];export type GetOpenApiData={body?:never;path:{type:string;};query?:never;url:'/o/performance-cookies-entries/openapi.{type}';};export type GetOpenApiResponses={default:unknown;};export type DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorData={body?:never;path:{performanceCookieEntryId:string;type:string;collaboratorId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type DeletePerformanceCookieEntryCollaboratorByTypeCollaboratorResponses={default:unknown;};export type GetPerformanceCookieEntryCollaboratorByTypeCollaboratorData={body?:never;path:{performanceCookieEntryId:string;type:string;collaboratorId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponse=GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses[keyof GetPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses];export type PutPerformanceCookieEntryCollaboratorByTypeCollaboratorData={body?:Collaborator;path:{performanceCookieEntryId:string;type:string;collaboratorId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponse=PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses[keyof PutPerformanceCookieEntryCollaboratorByTypeCollaboratorResponses];export type GetPerformanceCookieEntryCollaboratorsPageData={body?:never;path:{performanceCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators';};export type GetPerformanceCookieEntryCollaboratorsPageResponses={default:PageCollaborator;};export type GetPerformanceCookieEntryCollaboratorsPageResponse=GetPerformanceCookieEntryCollaboratorsPageResponses[keyof GetPerformanceCookieEntryCollaboratorsPageResponses];export type PostPerformanceCookieEntryCollaboratorsPageData={body?:Array<Collaborator>;path:{performanceCookieEntryId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators';};export type PostPerformanceCookieEntryCollaboratorsPageResponses={default:PageCollaborator;};export type PostPerformanceCookieEntryCollaboratorsPageResponse=PostPerformanceCookieEntryCollaboratorsPageResponses[keyof PostPerformanceCookieEntryCollaboratorsPageResponses];export type PostPerformanceCookieEntryCollaboratorsPageExportBatchData={body?:never;path:{performanceCookieEntryId:string;};query?:{callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}/collaborators/export-batch';};export type PostPerformanceCookieEntryCollaboratorsPageExportBatchResponses={default:unknown;};export type DeletePerformanceCookieEntryData={body?:never;path:{performanceCookieEntryId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}';};export type DeletePerformanceCookieEntryResponses={default:unknown;};export type GetPerformanceCookieEntryData={body?:never;path:{performanceCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}';};export type GetPerformanceCookieEntryResponses={default:PerformanceCookieEntry;};export type GetPerformanceCookieEntryResponse=GetPerformanceCookieEntryResponses[keyof GetPerformanceCookieEntryResponses];export type PatchPerformanceCookieEntryData={body?:PerformanceCookieEntry;path:{performanceCookieEntryId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}';};export type PatchPerformanceCookieEntryResponses={default:PerformanceCookieEntry;};export type PatchPerformanceCookieEntryResponse=PatchPerformanceCookieEntryResponses[keyof PatchPerformanceCookieEntryResponses];export type PutPerformanceCookieEntryData={body?:PerformanceCookieEntry;path:{performanceCookieEntryId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}';};export type PutPerformanceCookieEntryResponses={default:PerformanceCookieEntry;};export type PutPerformanceCookieEntryResponse=PutPerformanceCookieEntryResponses[keyof PutPerformanceCookieEntryResponses];export type DeletePerformanceCookieEntryByVersionData={body?:never;path:{performanceCookieEntryId:string;version:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/by-version/{version}';};export type DeletePerformanceCookieEntryByVersionResponses={default:unknown;};export type GetPerformanceCookieEntryByVersionData={body?:never;path:{performanceCookieEntryId:string;version:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/by-version/{version}';};export type GetPerformanceCookieEntryByVersionResponses={default:PerformanceCookieEntry;};export type GetPerformanceCookieEntryByVersionResponse=GetPerformanceCookieEntryByVersionResponses[keyof GetPerformanceCookieEntryByVersionResponses];export type GetPerformanceCookieEntriesVersionsPageData={body?:never;path:{performanceCookieEntryId:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}/versions';};export type GetPerformanceCookieEntriesVersionsPageResponses={default:PagePerformanceCookieEntry;};export type GetPerformanceCookieEntriesVersionsPageResponse=GetPerformanceCookieEntriesVersionsPageResponses[keyof GetPerformanceCookieEntriesVersionsPageResponses];export type GetPerformanceCookieEntryPermissionsPageData={body?:never;path:{performanceCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;roleNames?:string;};url:'/o/performance-cookies-entries/{performanceCookieEntryId}/permissions';};export type GetPerformanceCookieEntryPermissionsPageResponses={default:PagePermission;};export type GetPerformanceCookieEntryPermissionsPageResponse=GetPerformanceCookieEntryPermissionsPageResponses[keyof GetPerformanceCookieEntryPermissionsPageResponses];export type PutPerformanceCookieEntryPermissionsPageData={body?:Array<Permission>;path:{performanceCookieEntryId:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/permissions';};export type PutPerformanceCookieEntryPermissionsPageResponses={default:PagePermission;};export type PutPerformanceCookieEntryPermissionsPageResponse=PutPerformanceCookieEntryPermissionsPageResponses[keyof PutPerformanceCookieEntryPermissionsPageResponses];export type PostPerformanceCookieEntryByVersionCopyData={body?:never;path:{performanceCookieEntryId:string;version:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/by-version/{version}/copy';};export type PostPerformanceCookieEntryByVersionCopyResponses={default:PerformanceCookieEntry;};export type PostPerformanceCookieEntryByVersionCopyResponse=PostPerformanceCookieEntryByVersionCopyResponses[keyof PostPerformanceCookieEntryByVersionCopyResponses];export type PostPerformanceCookieEntryByVersionExpireData={body?:never;path:{performanceCookieEntryId:string;version:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/by-version/{version}/expire';};export type PostPerformanceCookieEntryByVersionExpireResponses={default:PerformanceCookieEntry;};export type PostPerformanceCookieEntryByVersionExpireResponse=PostPerformanceCookieEntryByVersionExpireResponses[keyof PostPerformanceCookieEntryByVersionExpireResponses];export type PutPerformanceCookieEntryByVersionRestoreData={body?:never;path:{performanceCookieEntryId:string;version:string;};query?:never;url:'/o/performance-cookies-entries/{performanceCookieEntryId}/by-version/{version}/restore';};export type PutPerformanceCookieEntryByVersionRestoreResponses={default:PerformanceCookieEntry;};export type PutPerformanceCookieEntryByVersionRestoreResponse=PutPerformanceCookieEntryByVersionRestoreResponses[keyof PutPerformanceCookieEntryByVersionRestoreResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};