liferay-headless-rest-client/dist/clients/headless-object-v1.0/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 ObjectEntryFolder={readonly actions?:{[key:string]:{[key:string]:string;};};creator?:Creator;readonly dateCreated?:string;readonly dateModified?:string;description?:string;externalReferenceCode?:string;readonly id?:number;label?:string;label_i18n?:{[key:string]:string;};readonly numberOfObjectEntries?:number;readonly numberOfObjectEntryFolders?:number;parentObjectEntryFolderBrief?:ParentObjectEntryFolderBrief;parentObjectEntryFolderExternalReferenceCode?:string;parentObjectEntryFolderId?:number;readonly scopeKey?:string;title:string;viewableBy?:'Anyone'|'Members'|'Owner';readonly'x-class-name'?:string;};export type ParentObjectEntryFolderBrief={externalReferenceCode?:string;id?:number;label?:string;label_i18n?:{[key:string]:string;};title?:string;readonly'x-class-name'?:string;};export type PageObjectEntryFolder={items?:Array<ObjectEntryFolder>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type DeleteObjectEntryFolderCollaboratorByTypeCollaboratorData={body?:never;path:{objectEntryFolderId:string;type:string;collaboratorId:string;};query?:never;url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators/by-type/{type}/{collaboratorId}';};export type DeleteObjectEntryFolderCollaboratorByTypeCollaboratorResponses={default:unknown;};export type GetObjectEntryFolderCollaboratorByTypeCollaboratorData={body?:never;path:{objectEntryFolderId:string;type:string;collaboratorId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators/by-type/{type}/{collaboratorId}';};export type GetObjectEntryFolderCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type GetObjectEntryFolderCollaboratorByTypeCollaboratorResponse=GetObjectEntryFolderCollaboratorByTypeCollaboratorResponses[keyof GetObjectEntryFolderCollaboratorByTypeCollaboratorResponses];export type PutObjectEntryFolderCollaboratorByTypeCollaboratorData={body?:Collaborator;path:{objectEntryFolderId:string;type:string;collaboratorId:string;};query?:never;url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators/by-type/{type}/{collaboratorId}';};export type PutObjectEntryFolderCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type PutObjectEntryFolderCollaboratorByTypeCollaboratorResponse=PutObjectEntryFolderCollaboratorByTypeCollaboratorResponses[keyof PutObjectEntryFolderCollaboratorByTypeCollaboratorResponses];export type DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:never;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:unknown;};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:never;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponse=GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses[keyof GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses];export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorData={body?:Collaborator;path:{scopeKey:string;externalReferenceCode:string;type:string;collaboratorId:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';};export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses={default:Collaborator;};export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponse=PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses[keyof PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses];export type GetObjectEntryFolderCollaboratorsPageData={body?:never;path:{objectEntryFolderId:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators';};export type GetObjectEntryFolderCollaboratorsPageResponses={default:PageCollaborator;};export type GetObjectEntryFolderCollaboratorsPageResponse=GetObjectEntryFolderCollaboratorsPageResponses[keyof GetObjectEntryFolderCollaboratorsPageResponses];export type PostObjectEntryFolderCollaboratorsPageData={body?:Array<Collaborator>;path:{objectEntryFolderId:string;};query?:never;url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators';};export type PostObjectEntryFolderCollaboratorsPageResponses={default:PageCollaborator;};export type PostObjectEntryFolderCollaboratorsPageResponse=PostObjectEntryFolderCollaboratorsPageResponses[keyof PostObjectEntryFolderCollaboratorsPageResponses];export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData={body?:never;path:{scopeKey:string;externalReferenceCode:string;};query?:{fields?:string;nestedFields?:string;page?:string;pageSize?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders/by-external-reference-code/{externalReferenceCode}/collaborators';};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses={default:PageCollaborator;};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponse=GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses[keyof GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses];export type PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageData={body?:Array<Collaborator>;path:{scopeKey:string;externalReferenceCode:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders/by-external-reference-code/{externalReferenceCode}/collaborators';};export type PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses={default:PageCollaborator;};export type PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponse=PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses[keyof PostScopeScopeKeyObjectEntryFolderByExternalReferenceCodeCollaboratorsPageResponses];export type PostObjectEntryFolderCollaboratorsPageExportBatchData={body?:never;path:{objectEntryFolderId:string;};query?:{callbackURL?:string;contentType?:string;fieldNames?:string;};url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}/collaborators/export-batch';};export type PostObjectEntryFolderCollaboratorsPageExportBatchResponses={default:unknown;};export type DeleteObjectEntryFolderData={body?:never;path:{objectEntryFolderId:string;};query?:never;url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}';};export type DeleteObjectEntryFolderResponses={default:unknown;};export type GetObjectEntryFolderData={body?:never;path:{objectEntryFolderId:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}';};export type GetObjectEntryFolderResponses={default:ObjectEntryFolder;};export type GetObjectEntryFolderResponse=GetObjectEntryFolderResponses[keyof GetObjectEntryFolderResponses];export type PatchObjectEntryFolderData={body?:ObjectEntryFolder;path:{objectEntryFolderId:string;};query?:never;url:'/o/headless-object/v1.0/object-entry-folders/{objectEntryFolderId}';};export type PatchObjectEntryFolderResponses={default:ObjectEntryFolder;};export type PatchObjectEntryFolderResponse=PatchObjectEntryFolderResponses[keyof PatchObjectEntryFolderResponses];export type DeleteObjectEntryFolderBatchData={body?:{[key:string]:unknown;};path?:never;query?:{callbackURL?:string;};url:'/o/headless-object/v1.0/object-entry-folders/batch';};export type DeleteObjectEntryFolderBatchResponses={default:unknown;};export type DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData={body?:never;path:{scopeKey:string;externalReferenceCode:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folder/by-external-reference-code/{externalReferenceCode}';};export type DeleteScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses={default:unknown;};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData={body?:never;path:{scopeKey:string;externalReferenceCode:string;};query?:{fields?:string;nestedFields?:string;restrictFields?:string;};url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folder/by-external-reference-code/{externalReferenceCode}';};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses={default:ObjectEntryFolder;};export type GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponse=GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses[keyof GetScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses];export type PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData={body?:ObjectEntryFolder;path:{scopeKey:string;externalReferenceCode:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folder/by-external-reference-code/{externalReferenceCode}';};export type PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses={default:ObjectEntryFolder;};export type PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponse=PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses[keyof PatchScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses];export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeData={body?:ObjectEntryFolder;path:{scopeKey:string;externalReferenceCode:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folder/by-external-reference-code/{externalReferenceCode}';};export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses={default:ObjectEntryFolder;};export type PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponse=PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses[keyof PutScopeScopeKeyObjectEntryFolderByExternalReferenceCodeResponses];export type GetScopeScopeKeyObjectEntryFoldersPageData={body?:never;path:{scopeKey: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-object/v1.0/scopes/{scopeKey}/object-entry-folders';};export type GetScopeScopeKeyObjectEntryFoldersPageResponses={default:PageObjectEntryFolder;};export type GetScopeScopeKeyObjectEntryFoldersPageResponse=GetScopeScopeKeyObjectEntryFoldersPageResponses[keyof GetScopeScopeKeyObjectEntryFoldersPageResponses];export type PostScopeScopeKeyObjectEntryFolderData={body?:ObjectEntryFolder;path:{scopeKey:string;};query?:never;url:'/o/headless-object/v1.0/scopes/{scopeKey}/object-entry-folders';};export type PostScopeScopeKeyObjectEntryFolderResponses={default:ObjectEntryFolder;};export type PostScopeScopeKeyObjectEntryFolderResponse=PostScopeScopeKeyObjectEntryFolderResponses[keyof PostScopeScopeKeyObjectEntryFolderResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};