liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,018 lines (1,017 loc) • 31.2 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?: NecessaryCookieEntry;
readonly 'x-class-name'?: string;
};
export type PageNecessaryCookieEntry = {
items?: Array<NecessaryCookieEntry>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
readonly 'x-schema-name'?: string;
};
export type NecessaryCookieEntry = {
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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-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/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}';
};
export type GetByExternalReferenceCodeResponses = {
/**
* default response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
default: unknown;
};
export type PostNecessaryCookieEntryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/necessary-cookies-entries/batch';
};
export type PostNecessaryCookieEntryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutNecessaryCookieEntryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/necessary-cookies-entries/batch';
};
export type PutNecessaryCookieEntryBatchResponses = {
/**
* default response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
default: unknown;
};
export type PostValidateData = {
body?: ValidationRequest;
path?: never;
query?: never;
url: '/o/necessary-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/necessary-cookies-entries/by-external-reference-code/{externalReferenceCode}/by-version/{version}/restore';
};
export type PutByExternalReferenceCodeByVersionRestoreResponses = {
/**
* default response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
default: unknown;
};
export type DeleteNecessaryCookieEntryData = {
body?: never;
path: {
necessaryCookieEntryId: string;
};
query?: never;
url: '/o/necessary-cookies-entries/{necessaryCookieEntryId}';
};
export type DeleteNecessaryCookieEntryResponses = {
/**
* default response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
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 response
*/
default: NecessaryCookieEntry;
};
export type PostNecessaryCookieEntryByVersionExpireResponse = PostNecessaryCookieEntryByVersionExpireResponses[keyof PostNecessaryCookieEntryByVersionExpireResponses];
export type PostNecessaryCookieEntryExpireData = {
body?: never;
path: {
necessaryCookieEntryId: string;
};
query?: never;
url: '/o/necessary-cookies-entries/{necessaryCookieEntryId}/expire';
};
export type PostNecessaryCookieEntryExpireResponses = {
/**
* default response
*/
default: NecessaryCookieEntry;
};
export type PostNecessaryCookieEntryExpireResponse = PostNecessaryCookieEntryExpireResponses[keyof PostNecessaryCookieEntryExpireResponses];
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 response
*/
default: NecessaryCookieEntry;
};
export type PutNecessaryCookieEntryByVersionRestoreResponse = PutNecessaryCookieEntryByVersionRestoreResponses[keyof PutNecessaryCookieEntryByVersionRestoreResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};