liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,018 lines (1,017 loc) • 31.4 kB
TypeScript
/**
* Represents a collaborator for an entry.
*/
export type Collaborator = {
/**
* The collaborator actions for the shared asset.
*/
actionIds: Array<string>;
/**
* Block of actions allowed by the user making the request.
*/
readonly actions?: {
[key: string]: {
[key: string]: unknown;
};
};
creator?: Creator;
/**
* The expiration date to be a collaborator of the asset.
*/
dateExpired?: string;
/**
* The collaborator external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The collaborator ID.
*/
id?: number;
/**
* The collaborator name.
*/
readonly name?: string;
/**
* The collaborator portrait.
*/
readonly portrait?: string;
/**
* If the collaborator can share or not the asset.
*/
share?: boolean;
/**
* The collaborator type.
*/
type: string;
readonly 'x-class-name'?: string;
};
export type Creator = {
/**
* The author's additional name (e.g., middle name).
*/
readonly additionalName?: string;
/**
* The type of the content.
*/
readonly contentType?: string;
/**
* The external reference code of the author.
*/
readonly externalReferenceCode?: string;
/**
* The author's surname.
*/
readonly familyName?: string;
/**
* The author's first name.
*/
readonly givenName?: string;
/**
* The author's ID.
*/
readonly id?: number;
/**
* A relative URL to the author's profile image.
*/
readonly image?: string;
/**
* The author's full name.
*/
readonly name?: string;
/**
* A relative URL to the author's user profile. Optional field, can be embedded with nestedFields.
*/
readonly profileURL?: string;
/**
* A list of userGroups information.
*/
userGroupBriefs?: Array<UserGroupBrief>;
readonly 'x-class-name'?: string;
};
/**
* A list of userGroups information.
*/
export type UserGroupBrief = {
/**
* The ID of the user group.
*/
readonly id?: number;
/**
* The name of the user group.
*/
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;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
/**
* Optional field with the audit events associated with this object entry, can be embedded with nestedFields
*/
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 = {
/**
* The parent taxonomy category's external reference code.
*/
externalReferenceCode?: string;
readonly 'x-class-name'?: string;
};
export type ParentTaxonomyVocabulary = {
/**
* The parent category's `TaxonomyVocabulary` external reference code.
*/
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;
};
/**
* The categories associated with this object entry.
*/
export type TaxonomyCategoryBrief = {
/**
* Optional field with the embedded taxonomy category, can be embedded with nestedFields
*/
readonly embeddedTaxonomyCategory?: {
[key: string]: unknown;
};
parentTaxonomyCategory?: ParentTaxonomyCategory;
parentTaxonomyVocabulary?: ParentTaxonomyVocabulary;
scope?: Scope;
/**
* The category's external reference code.
*/
taxonomyCategoryExternalReferenceCode?: string;
/**
* The category's ID. This can be used to retrieve more information in the `TaxonomyCategory` API.
*/
readonly taxonomyCategoryId?: number;
/**
* The category's name.
*/
readonly taxonomyCategoryName?: string;
/**
* The localized category's names.
*/
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;
};
};
page?: number;
facets?: Array<Facet>;
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?: FunctionalCookieEntry;
readonly 'x-class-name'?: string;
};
export type PageFunctionalCookieEntry = {
items?: Array<FunctionalCookieEntry>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
readonly 'x-schema-name'?: string;
};
export type FunctionalCookieEntry = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* Optional field with the audit events associated with this object entry, can be embedded with nestedFields
*/
readonly auditEvents?: Array<AuditEvent>;
readonly creator?: string;
readonly dateCreated?: string;
readonly dateModified?: string;
defaultLanguageId?: string;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
/**
* A relative URL to the page's rendered content.
*/
friendlyUrlPath?: string;
/**
* The localized relative URLs to the page's rendered content.
*/
friendlyUrlPath_i18n?: {
[key: string]: string;
};
readonly id?: number;
/**
* A list of keywords describing the object entry.
*/
keywords?: Array<string>;
objectEntryFolderExternalReferenceCode?: string;
objectEntryFolderId?: number;
permissions?: Array<Permission>;
reviewDate?: string;
readonly scopeId?: number;
readonly scopeKey?: string;
readonly status?: number;
/**
* The categories associated with this object entry.
*/
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/functional-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';
};
export type DeleteScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
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/functional-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';
};
export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
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/functional-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators/by-type/{type}/{collaboratorId}';
};
export type PutScopeScopeKeyByExternalReferenceCodeCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
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/functional-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators';
};
export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses = {
/**
* default response
*/
default: PageCollaborator;
};
export type GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponse = GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses[keyof GetScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses];
export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageData = {
body?: Array<Collaborator>;
path: {
scopeKey: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/functional-cookies-entries/scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode}/collaborators';
};
export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses = {
/**
* default response
*/
default: PageCollaborator;
};
export type PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponse = PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses[keyof PostScopeScopeKeyByExternalReferenceCodeCollaboratorsPageResponses];
export type DeleteByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
};
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}';
};
export type GetByExternalReferenceCodeResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type GetByExternalReferenceCodeResponse = GetByExternalReferenceCodeResponses[keyof GetByExternalReferenceCodeResponses];
export type PatchByExternalReferenceCodeData = {
body?: FunctionalCookieEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}';
};
export type PatchByExternalReferenceCodeResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PatchByExternalReferenceCodeResponse = PatchByExternalReferenceCodeResponses[keyof PatchByExternalReferenceCodeResponses];
export type PutByExternalReferenceCodeData = {
body?: FunctionalCookieEntry;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}';
};
export type PutByExternalReferenceCodeResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PutByExternalReferenceCodeResponse = PutByExternalReferenceCodeResponses[keyof PutByExternalReferenceCodeResponses];
export type DeleteByExternalReferenceCodeByVersionData = {
body?: never;
path: {
externalReferenceCode: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}';
};
export type DeleteByExternalReferenceCodeByVersionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetByExternalReferenceCodeByVersionData = {
body?: never;
path: {
externalReferenceCode: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}';
};
export type GetByExternalReferenceCodeByVersionResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type GetByExternalReferenceCodeByVersionResponse = GetByExternalReferenceCodeByVersionResponses[keyof GetByExternalReferenceCodeByVersionResponses];
export type DeleteFunctionalCookieEntryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/functional-cookies-entries/batch';
};
export type DeleteFunctionalCookieEntryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostFunctionalCookieEntryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/functional-cookies-entries/batch';
};
export type PostFunctionalCookieEntryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutFunctionalCookieEntryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/functional-cookies-entries/batch';
};
export type PutFunctionalCookieEntryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetByExternalReferenceCodeVersionsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/versions';
};
export type GetByExternalReferenceCodeVersionsPageResponses = {
/**
* default response
*/
default: PageFunctionalCookieEntry;
};
export type GetByExternalReferenceCodeVersionsPageResponse = GetByExternalReferenceCodeVersionsPageResponses[keyof GetByExternalReferenceCodeVersionsPageResponses];
export type GetFunctionalCookieEntriesPageData = {
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/functional-cookies-entries/';
};
export type GetFunctionalCookieEntriesPageResponses = {
/**
* default response
*/
default: PageFunctionalCookieEntry;
};
export type GetFunctionalCookieEntriesPageResponse = GetFunctionalCookieEntriesPageResponses[keyof GetFunctionalCookieEntriesPageResponses];
export type PostFunctionalCookieEntryData = {
body?: FunctionalCookieEntry;
path?: never;
query?: never;
url: '/o/functional-cookies-entries/';
};
export type PostFunctionalCookieEntryResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostFunctionalCookieEntryResponse = PostFunctionalCookieEntryResponses[keyof PostFunctionalCookieEntryResponses];
export type PostByExternalReferenceCodeByVersionCopyData = {
body?: never;
path: {
externalReferenceCode: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/copy';
};
export type PostByExternalReferenceCodeByVersionCopyResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostByExternalReferenceCodeByVersionCopyResponse = PostByExternalReferenceCodeByVersionCopyResponses[keyof PostByExternalReferenceCodeByVersionCopyResponses];
export type PostByExternalReferenceCodeByVersionExpireData = {
body?: never;
path: {
externalReferenceCode: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/expire';
};
export type PostByExternalReferenceCodeByVersionExpireResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostByExternalReferenceCodeByVersionExpireResponse = PostByExternalReferenceCodeByVersionExpireResponses[keyof PostByExternalReferenceCodeByVersionExpireResponses];
export type PostFunctionalCookieEntriesPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/functional-cookies-entries/export-batch';
};
export type PostFunctionalCookieEntriesPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostValidateData = {
body?: ValidationRequest;
path?: never;
query?: never;
url: '/o/functional-cookies-entries/validate';
};
export type PostValidateResponses = {
/**
* default response
*/
default: ValidationResponse;
};
export type PostValidateResponse = PostValidateResponses[keyof PostValidateResponses];
export type PutByExternalReferenceCodeByVersionRestoreData = {
body?: never;
path: {
externalReferenceCode: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/restore';
};
export type PutByExternalReferenceCodeByVersionRestoreResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PutByExternalReferenceCodeByVersionRestoreResponse = PutByExternalReferenceCodeByVersionRestoreResponses[keyof PutByExternalReferenceCodeByVersionRestoreResponses];
export type GetOpenApiData = {
body?: never;
path: {
type: string;
};
query?: never;
url: '/o/functional-cookies-entries/openapi.{type}';
};
export type GetOpenApiResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorData = {
body?: never;
path: {
functionalCookieEntryId: string;
type: string;
collaboratorId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';
};
export type DeleteFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
default: unknown;
};
export type GetFunctionalCookieEntryCollaboratorByTypeCollaboratorData = {
body?: never;
path: {
functionalCookieEntryId: string;
type: string;
collaboratorId: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';
};
export type GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
default: Collaborator;
};
export type GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponse = GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses[keyof GetFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses];
export type PutFunctionalCookieEntryCollaboratorByTypeCollaboratorData = {
body?: Collaborator;
path: {
functionalCookieEntryId: string;
type: string;
collaboratorId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators/by-type/{type}/{collaboratorId}';
};
export type PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses = {
/**
* default response
*/
default: Collaborator;
};
export type PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponse = PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses[keyof PutFunctionalCookieEntryCollaboratorByTypeCollaboratorResponses];
export type GetFunctionalCookieEntryCollaboratorsPageData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: {
fields?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
restrictFields?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators';
};
export type GetFunctionalCookieEntryCollaboratorsPageResponses = {
/**
* default response
*/
default: PageCollaborator;
};
export type GetFunctionalCookieEntryCollaboratorsPageResponse = GetFunctionalCookieEntryCollaboratorsPageResponses[keyof GetFunctionalCookieEntryCollaboratorsPageResponses];
export type PostFunctionalCookieEntryCollaboratorsPageData = {
body?: Array<Collaborator>;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators';
};
export type PostFunctionalCookieEntryCollaboratorsPageResponses = {
/**
* default response
*/
default: PageCollaborator;
};
export type PostFunctionalCookieEntryCollaboratorsPageResponse = PostFunctionalCookieEntryCollaboratorsPageResponses[keyof PostFunctionalCookieEntryCollaboratorsPageResponses];
export type PostFunctionalCookieEntryCollaboratorsPageExportBatchData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/collaborators/export-batch';
};
export type PostFunctionalCookieEntryCollaboratorsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteFunctionalCookieEntryData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}';
};
export type DeleteFunctionalCookieEntryResponses = {
/**
* default response
*/
default: unknown;
};
export type GetFunctionalCookieEntryData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}';
};
export type GetFunctionalCookieEntryResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type GetFunctionalCookieEntryResponse = GetFunctionalCookieEntryResponses[keyof GetFunctionalCookieEntryResponses];
export type PatchFunctionalCookieEntryData = {
body?: FunctionalCookieEntry;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}';
};
export type PatchFunctionalCookieEntryResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PatchFunctionalCookieEntryResponse = PatchFunctionalCookieEntryResponses[keyof PatchFunctionalCookieEntryResponses];
export type PutFunctionalCookieEntryData = {
body?: FunctionalCookieEntry;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}';
};
export type PutFunctionalCookieEntryResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PutFunctionalCookieEntryResponse = PutFunctionalCookieEntryResponses[keyof PutFunctionalCookieEntryResponses];
export type DeleteFunctionalCookieEntryByVersionData = {
body?: never;
path: {
functionalCookieEntryId: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/by-version/{version}';
};
export type DeleteFunctionalCookieEntryByVersionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetFunctionalCookieEntryByVersionData = {
body?: never;
path: {
functionalCookieEntryId: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/by-version/{version}';
};
export type GetFunctionalCookieEntryByVersionResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type GetFunctionalCookieEntryByVersionResponse = GetFunctionalCookieEntryByVersionResponses[keyof GetFunctionalCookieEntryByVersionResponses];
export type GetFunctionalCookieEntriesVersionsPageData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/versions';
};
export type GetFunctionalCookieEntriesVersionsPageResponses = {
/**
* default response
*/
default: PageFunctionalCookieEntry;
};
export type GetFunctionalCookieEntriesVersionsPageResponse = GetFunctionalCookieEntriesVersionsPageResponses[keyof GetFunctionalCookieEntriesVersionsPageResponses];
export type GetFunctionalCookieEntryPermissionsPageData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
roleNames?: string;
};
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/permissions';
};
export type GetFunctionalCookieEntryPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type GetFunctionalCookieEntryPermissionsPageResponse = GetFunctionalCookieEntryPermissionsPageResponses[keyof GetFunctionalCookieEntryPermissionsPageResponses];
export type PutFunctionalCookieEntryPermissionsPageData = {
body?: Array<Permission>;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/permissions';
};
export type PutFunctionalCookieEntryPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type PutFunctionalCookieEntryPermissionsPageResponse = PutFunctionalCookieEntryPermissionsPageResponses[keyof PutFunctionalCookieEntryPermissionsPageResponses];
export type PostFunctionalCookieEntryByVersionCopyData = {
body?: never;
path: {
functionalCookieEntryId: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/by-version/{version}/copy';
};
export type PostFunctionalCookieEntryByVersionCopyResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostFunctionalCookieEntryByVersionCopyResponse = PostFunctionalCookieEntryByVersionCopyResponses[keyof PostFunctionalCookieEntryByVersionCopyResponses];
export type PostFunctionalCookieEntryByVersionExpireData = {
body?: never;
path: {
functionalCookieEntryId: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/by-version/{version}/expire';
};
export type PostFunctionalCookieEntryByVersionExpireResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostFunctionalCookieEntryByVersionExpireResponse = PostFunctionalCookieEntryByVersionExpireResponses[keyof PostFunctionalCookieEntryByVersionExpireResponses];
export type PostFunctionalCookieEntryExpireData = {
body?: never;
path: {
functionalCookieEntryId: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/expire';
};
export type PostFunctionalCookieEntryExpireResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PostFunctionalCookieEntryExpireResponse = PostFunctionalCookieEntryExpireResponses[keyof PostFunctionalCookieEntryExpireResponses];
export type PutFunctionalCookieEntryByVersionRestoreData = {
body?: never;
path: {
functionalCookieEntryId: string;
version: string;
};
query?: never;
url: '/o/functional-cookies-entries/{functionalCookieEntryId}/by-version/{version}/restore';
};
export type PutFunctionalCookieEntryByVersionRestoreResponses = {
/**
* default response
*/
default: FunctionalCookieEntry;
};
export type PutFunctionalCookieEntryByVersionRestoreResponse = PutFunctionalCookieEntryByVersionRestoreResponses[keyof PutFunctionalCookieEntryByVersionRestoreResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};