liferay-headless-rest-client/dist/clients/necessary-cookies-entries/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

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?:NecessaryCookieEntry;readonly'x-class-name'?:string;};export type PageNecessaryCookieEntry={items?:Array<NecessaryCookieEntry>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;readonly'x-schema-name'?:string;};export type NecessaryCookieEntry={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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type GetByExternalReferenceCodeResponses={default:NecessaryCookieEntry;};export type GetByExternalReferenceCodeResponse=GetByExternalReferenceCodeResponses[keyof GetByExternalReferenceCodeResponses];export type PatchByExternalReferenceCodeData={body?:NecessaryCookieEntry;path:{externalReferenceCode:string;};query?:never;url:'/o/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type PatchByExternalReferenceCodeResponses={default:NecessaryCookieEntry;};export type PatchByExternalReferenceCodeResponse=PatchByExternalReferenceCodeResponses[keyof PatchByExternalReferenceCodeResponses];export type PutByExternalReferenceCodeData={body?:NecessaryCookieEntry;path:{externalReferenceCode:string;};query?:never;url:'/o/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}';};export type PutByExternalReferenceCodeResponses={default:NecessaryCookieEntry;};export type PutByExternalReferenceCodeResponse=PutByExternalReferenceCodeResponses[keyof PutByExternalReferenceCodeResponses];export type DeleteByExternalReferenceCodeByVersionData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/necessary-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/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}';};export type GetByExternalReferenceCodeByVersionResponses={default:NecessaryCookieEntry;};export type GetByExternalReferenceCodeByVersionResponse=GetByExternalReferenceCodeByVersionResponses[keyof GetByExternalReferenceCodeByVersionResponses];export type DeleteNecessaryCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/necessary-cookies-entries/batch';};export type DeleteNecessaryCookieEntryBatchResponses={default:unknown;};export type PostNecessaryCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/necessary-cookies-entries/batch';};export type PostNecessaryCookieEntryBatchResponses={default:unknown;};export type PutNecessaryCookieEntryBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/necessary-cookies-entries/batch';};export type PutNecessaryCookieEntryBatchResponses={default:unknown;};export type GetByExternalReferenceCodeVersionsPageData={body?:never;path:{externalReferenceCode:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/versions';};export type GetByExternalReferenceCodeVersionsPageResponses={default:PageNecessaryCookieEntry;};export type GetByExternalReferenceCodeVersionsPageResponse=GetByExternalReferenceCodeVersionsPageResponses[keyof GetByExternalReferenceCodeVersionsPageResponses];export type GetNecessaryCookieEntriesPageData={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/necessary-cookies-entries/';};export type GetNecessaryCookieEntriesPageResponses={default:PageNecessaryCookieEntry;};export type GetNecessaryCookieEntriesPageResponse=GetNecessaryCookieEntriesPageResponses[keyof GetNecessaryCookieEntriesPageResponses];export type PostNecessaryCookieEntryData={body?:NecessaryCookieEntry;path?:never;query?:never;url:'/o/necessary-cookies-entries/';};export type PostNecessaryCookieEntryResponses={default:NecessaryCookieEntry;};export type PostNecessaryCookieEntryResponse=PostNecessaryCookieEntryResponses[keyof PostNecessaryCookieEntryResponses];export type PostByExternalReferenceCodeByVersionCopyData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/copy';};export type PostByExternalReferenceCodeByVersionCopyResponses={default:NecessaryCookieEntry;};export type PostByExternalReferenceCodeByVersionCopyResponse=PostByExternalReferenceCodeByVersionCopyResponses[keyof PostByExternalReferenceCodeByVersionCopyResponses];export type PostByExternalReferenceCodeByVersionExpireData={body?:never;path:{externalReferenceCode:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/expire';};export type PostByExternalReferenceCodeByVersionExpireResponses={default:NecessaryCookieEntry;};export type PostByExternalReferenceCodeByVersionExpireResponse=PostByExternalReferenceCodeByVersionExpireResponses[keyof PostByExternalReferenceCodeByVersionExpireResponses];export type PostNecessaryCookieEntriesPageExportBatchData={body?:never;path?:never;query?:{filter?:string;search?:string;sort?:string;callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/necessary-cookies-entries/export-batch';};export type PostNecessaryCookieEntriesPageExportBatchResponses={default:unknown;};export type PostValidateData={body?:ValidationRequest;path?:never;query?:never;url:'/o/necessary-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/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/restore';};export type PutByExternalReferenceCodeByVersionRestoreResponses={default:NecessaryCookieEntry;};export type PutByExternalReferenceCodeByVersionRestoreResponse=PutByExternalReferenceCodeByVersionRestoreResponses[keyof PutByExternalReferenceCodeByVersionRestoreResponses];export type GetOpenApiData={body?:never;path:{type:string;};query?:never;url:'/o/necessary-cookies-entries/openapi.{type}';};export type GetOpenApiResponses={default:unknown;};export type DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorData={body?:never;path:{necessaryCookieEntryId:string;type:string;collaboratorId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type DeleteNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses={default:unknown;};export type GetNecessaryCookieEntryCollaboratorByTypeCollaboratorData={body?:never;path:{necessaryCookieEntryId:string;type:string;collaboratorId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponse=GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses[keyof GetNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses];export type PutNecessaryCookieEntryCollaboratorByTypeCollaboratorData={body?:Collaborator;path:{necessaryCookieEntryId:string;type:string;collaboratorId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';};export type PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponse=PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses[keyof PutNecessaryCookieEntryCollaboratorByTypeCollaboratorResponses];export type GetNecessaryCookieEntryCollaboratorsPageData={body?:never;path:{necessaryCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators';};export type GetNecessaryCookieEntryCollaboratorsPageResponses={default:PageCollaborator;};export type GetNecessaryCookieEntryCollaboratorsPageResponse=GetNecessaryCookieEntryCollaboratorsPageResponses[keyof GetNecessaryCookieEntryCollaboratorsPageResponses];export type PostNecessaryCookieEntryCollaboratorsPageData={body?:Array<Collaborator>;path:{necessaryCookieEntryId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators';};export type PostNecessaryCookieEntryCollaboratorsPageResponses={default:PageCollaborator;};export type PostNecessaryCookieEntryCollaboratorsPageResponse=PostNecessaryCookieEntryCollaboratorsPageResponses[keyof PostNecessaryCookieEntryCollaboratorsPageResponses];export type PostNecessaryCookieEntryCollaboratorsPageExportBatchData={body?:never;path:{necessaryCookieEntryId:string;};query?:{callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/collaborators/export-batch';};export type PostNecessaryCookieEntryCollaboratorsPageExportBatchResponses={default:unknown;};export type DeleteNecessaryCookieEntryData={body?:never;path:{necessaryCookieEntryId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}';};export type DeleteNecessaryCookieEntryResponses={default:unknown;};export type GetNecessaryCookieEntryData={body?:never;path:{necessaryCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}';};export type GetNecessaryCookieEntryResponses={default:NecessaryCookieEntry;};export type GetNecessaryCookieEntryResponse=GetNecessaryCookieEntryResponses[keyof GetNecessaryCookieEntryResponses];export type PatchNecessaryCookieEntryData={body?:NecessaryCookieEntry;path:{necessaryCookieEntryId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}';};export type PatchNecessaryCookieEntryResponses={default:NecessaryCookieEntry;};export type PatchNecessaryCookieEntryResponse=PatchNecessaryCookieEntryResponses[keyof PatchNecessaryCookieEntryResponses];export type PutNecessaryCookieEntryData={body?:NecessaryCookieEntry;path:{necessaryCookieEntryId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}';};export type PutNecessaryCookieEntryResponses={default:NecessaryCookieEntry;};export type PutNecessaryCookieEntryResponse=PutNecessaryCookieEntryResponses[keyof PutNecessaryCookieEntryResponses];export type DeleteNecessaryCookieEntryByVersionData={body?:never;path:{necessaryCookieEntryId:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/by-version/{version}';};export type DeleteNecessaryCookieEntryByVersionResponses={default:unknown;};export type GetNecessaryCookieEntryByVersionData={body?:never;path:{necessaryCookieEntryId:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/by-version/{version}';};export type GetNecessaryCookieEntryByVersionResponses={default:NecessaryCookieEntry;};export type GetNecessaryCookieEntryByVersionResponse=GetNecessaryCookieEntryByVersionResponses[keyof GetNecessaryCookieEntryByVersionResponses];export type GetNecessaryCookieEntriesVersionsPageData={body?:never;path:{necessaryCookieEntryId:string;};query?:{page?:string;pageSize?:string;nestedFields?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/versions';};export type GetNecessaryCookieEntriesVersionsPageResponses={default:PageNecessaryCookieEntry;};export type GetNecessaryCookieEntriesVersionsPageResponse=GetNecessaryCookieEntriesVersionsPageResponses[keyof GetNecessaryCookieEntriesVersionsPageResponses];export type GetNecessaryCookieEntryPermissionsPageData={body?:never;path:{necessaryCookieEntryId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;roleNames?:string;};url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/permissions';};export type GetNecessaryCookieEntryPermissionsPageResponses={default:PagePermission;};export type GetNecessaryCookieEntryPermissionsPageResponse=GetNecessaryCookieEntryPermissionsPageResponses[keyof GetNecessaryCookieEntryPermissionsPageResponses];export type PutNecessaryCookieEntryPermissionsPageData={body?:Array<Permission>;path:{necessaryCookieEntryId:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/permissions';};export type PutNecessaryCookieEntryPermissionsPageResponses={default:PagePermission;};export type PutNecessaryCookieEntryPermissionsPageResponse=PutNecessaryCookieEntryPermissionsPageResponses[keyof PutNecessaryCookieEntryPermissionsPageResponses];export type PostNecessaryCookieEntryByVersionCopyData={body?:never;path:{necessaryCookieEntryId:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/by-version/{version}/copy';};export type PostNecessaryCookieEntryByVersionCopyResponses={default:NecessaryCookieEntry;};export type PostNecessaryCookieEntryByVersionCopyResponse=PostNecessaryCookieEntryByVersionCopyResponses[keyof PostNecessaryCookieEntryByVersionCopyResponses];export type PostNecessaryCookieEntryByVersionExpireData={body?:never;path:{necessaryCookieEntryId:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/by-version/{version}/expire';};export type PostNecessaryCookieEntryByVersionExpireResponses={default:NecessaryCookieEntry;};export type PostNecessaryCookieEntryByVersionExpireResponse=PostNecessaryCookieEntryByVersionExpireResponses[keyof PostNecessaryCookieEntryByVersionExpireResponses];export type PutNecessaryCookieEntryByVersionRestoreData={body?:never;path:{necessaryCookieEntryId:string;version:string;};query?:never;url:'/o/necessary-cookies-entries/{necessaryCookieEntryId}/by-version/{version}/restore';};export type PutNecessaryCookieEntryByVersionRestoreResponses={default:NecessaryCookieEntry;};export type PutNecessaryCookieEntryByVersionRestoreResponse=PutNecessaryCookieEntryByVersionRestoreResponses[keyof PutNecessaryCookieEntryByVersionRestoreResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};