liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,505 lines (1,504 loc) • 42.1 kB
TypeScript
export type DataDefinition = {
availableLanguageIds?: Array<string>;
contentType?: string;
dataDefinitionFields?: Array<DataDefinitionField>;
dataDefinitionKey?: string;
dataRules?: Array<DataRule>;
dateCreated?: string;
dateModified?: string;
defaultDataLayout?: DataLayout;
defaultLanguageId?: string;
description?: {
[key: string]: {
[key: string]: unknown;
};
};
externalReferenceCode?: string;
id?: number;
name?: {
[key: string]: {
[key: string]: unknown;
};
};
siteId?: number;
storageType?: string;
userId?: number;
readonly 'x-class-name'?: string;
};
export type DataDefinitionField = {
customProperties?: {
[key: string]: {
[key: string]: unknown;
};
};
defaultValue?: {
[key: string]: {
[key: string]: unknown;
};
};
fieldType?: string;
id?: number;
indexable?: boolean;
label?: {
[key: string]: {
[key: string]: unknown;
};
};
localizable?: boolean;
name?: string;
/**
* A list of child data definition fields that depend on this resource.
*/
nestedDataDefinitionFields?: Array<DataDefinitionField>;
readOnly?: boolean;
repeatable?: boolean;
required?: boolean;
showLabel?: boolean;
tip?: {
[key: string]: {
[key: string]: unknown;
};
};
visible?: boolean;
readonly 'x-class-name'?: string;
indexType?: 'all' | 'keyword' | 'none' | 'text';
};
export type DataDefinitionFieldLink = {
dataDefinition?: DataDefinition;
dataLayouts?: Array<DataLayout>;
dataListViews?: Array<DataListView>;
readonly 'x-class-name'?: string;
};
export type DataLayout = {
contentType?: string;
dataDefinitionId?: number;
dataLayoutFields?: {
[key: string]: {
[key: string]: unknown;
};
};
dataLayoutKey?: string;
dataLayoutPages?: Array<DataLayoutPage>;
dataRules?: Array<DataRule>;
dateCreated?: string;
dateModified?: string;
description?: {
[key: string]: {
[key: string]: unknown;
};
};
id?: number;
name?: {
[key: string]: {
[key: string]: unknown;
};
};
paginationMode?: string;
siteId?: number;
userId?: number;
readonly 'x-class-name'?: string;
};
export type DataLayoutColumn = {
columnSize?: number;
fieldNames?: Array<string>;
readonly 'x-class-name'?: string;
};
export type DataLayoutPage = {
dataLayoutRows?: Array<DataLayoutRow>;
description?: {
[key: string]: {
[key: string]: unknown;
};
};
title?: {
[key: string]: {
[key: string]: unknown;
};
};
readonly 'x-class-name'?: string;
};
export type DataLayoutRow = {
dataLayoutColumns?: Array<DataLayoutColumn>;
readonly 'x-class-name'?: string;
};
export type DataListView = {
appliedFilters?: {
[key: string]: {
[key: string]: unknown;
};
};
dataDefinitionId?: number;
dateCreated?: string;
dateModified?: string;
fieldNames?: Array<string>;
id?: number;
name?: {
[key: string]: {
[key: string]: unknown;
};
};
siteId?: number;
sortField?: string;
userId?: number;
readonly 'x-class-name'?: string;
};
export type DataRule = {
actions?: Array<{
[key: string]: {
[key: string]: unknown;
};
}>;
conditions?: Array<{
[key: string]: {
[key: string]: unknown;
};
}>;
logicalOperator?: string;
name?: {
[key: string]: {
[key: string]: unknown;
};
};
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type PageDataDefinitionFieldLink = {
items?: Array<DataDefinitionFieldLink>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageDataDefinition = {
items?: Array<DataDefinition>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
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 Permission = {
actionIds?: Array<string>;
roleExternalReferenceCode?: string;
roleName?: string;
roleType?: string;
};
export type PageDataLayout = {
items?: Array<DataLayout>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DataLayoutRenderingContext = {
containerId?: string;
dataRecordValues?: {
[key: string]: {
[key: string]: unknown;
};
};
namespace?: string;
pathThemeImages?: string;
readOnly?: boolean;
scopeGroupId?: number;
siteGroupId?: number;
readonly 'x-class-name'?: string;
};
export type PageDataListView = {
items?: Array<DataListView>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DataRecordCollection = {
dataDefinitionId?: number;
dataRecordCollectionKey?: string;
description?: {
[key: string]: {
[key: string]: unknown;
};
};
id?: number;
name?: {
[key: string]: {
[key: string]: unknown;
};
};
siteId?: number;
readonly 'x-class-name'?: string;
};
export type PageDataRecordCollection = {
items?: Array<DataRecordCollection>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DataRecord = {
dataRecordCollectionId?: number;
dataRecordValues?: {
[key: string]: {
[key: string]: unknown;
};
};
id?: number;
readonly status?: number;
readonly 'x-class-name'?: string;
};
export type PageDataRecord = {
items?: Array<DataRecord>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type GetDataDefinitionDataDefinitionFieldLinksPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
fieldName?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-definition-field-links';
};
export type GetDataDefinitionDataDefinitionFieldLinksPageResponses = {
/**
* default response
*/
default: PageDataDefinitionFieldLink;
};
export type GetDataDefinitionDataDefinitionFieldLinksPageResponse = GetDataDefinitionDataDefinitionFieldLinksPageResponses[keyof GetDataDefinitionDataDefinitionFieldLinksPageResponses];
export type PostDataDefinitionDataDefinitionFieldLinksPageExportBatchData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
fieldName?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-definition-field-links/export-batch';
};
export type PostDataDefinitionDataDefinitionFieldLinksPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDataDefinitionData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}';
};
export type DeleteDataDefinitionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataDefinitionData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}';
};
export type GetDataDefinitionResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type GetDataDefinitionResponse = GetDataDefinitionResponses[keyof GetDataDefinitionResponses];
export type PatchDataDefinitionData = {
body?: DataDefinition;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}';
};
export type PatchDataDefinitionResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PatchDataDefinitionResponse = PatchDataDefinitionResponses[keyof PatchDataDefinitionResponses];
export type PutDataDefinitionData = {
body?: DataDefinition;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}';
};
export type PutDataDefinitionResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PutDataDefinitionResponse = PutDataDefinitionResponses[keyof PutDataDefinitionResponses];
export type DeleteDataDefinitionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/batch';
};
export type DeleteDataDefinitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutDataDefinitionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/batch';
};
export type PutDataDefinitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteSiteDataDefinitionByContentTypeByExternalReferenceCodeData = {
body?: never;
path: {
siteId: string;
contentType: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetSiteDataDefinitionByContentTypeByExternalReferenceCodeData = {
body?: never;
path: {
siteId: string;
contentType: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}/by-external-reference-code/{externalReferenceCode}';
};
export type GetSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type GetSiteDataDefinitionByContentTypeByExternalReferenceCodeResponse = GetSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses[keyof GetSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses];
export type PutSiteDataDefinitionByContentTypeByExternalReferenceCodeData = {
body?: DataDefinition;
path: {
siteId: string;
contentType: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}/by-external-reference-code/{externalReferenceCode}';
};
export type PutSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PutSiteDataDefinitionByContentTypeByExternalReferenceCodeResponse = PutSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses[keyof PutSiteDataDefinitionByContentTypeByExternalReferenceCodeResponses];
export type GetDataDefinitionByContentTypeContentTypePageData = {
body?: never;
path: {
contentType: string;
};
query?: {
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/by-content-type/{contentType}';
};
export type GetDataDefinitionByContentTypeContentTypePageResponses = {
/**
* default response
*/
default: PageDataDefinition;
};
export type GetDataDefinitionByContentTypeContentTypePageResponse = GetDataDefinitionByContentTypeContentTypePageResponses[keyof GetDataDefinitionByContentTypeContentTypePageResponses];
export type PostDataDefinitionByContentTypeData = {
body?: DataDefinition;
path: {
contentType: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/by-content-type/{contentType}';
};
export type PostDataDefinitionByContentTypeResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PostDataDefinitionByContentTypeResponse = PostDataDefinitionByContentTypeResponses[keyof PostDataDefinitionByContentTypeResponses];
export type GetDataDefinitionDataDefinitionFieldFieldTypesData = {
body?: never;
path?: never;
query?: never;
url: '/o/data-engine/v2.0/data-definitions/data-definition-fields/field-types';
};
export type GetDataDefinitionDataDefinitionFieldFieldTypesResponses = {
/**
* default response
*/
default: string;
};
export type GetDataDefinitionDataDefinitionFieldFieldTypesResponse = GetDataDefinitionDataDefinitionFieldFieldTypesResponses[keyof GetDataDefinitionDataDefinitionFieldFieldTypesResponses];
export type GetDataDefinitionPermissionsPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
roleNames?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/permissions';
};
export type GetDataDefinitionPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type GetDataDefinitionPermissionsPageResponse = GetDataDefinitionPermissionsPageResponses[keyof GetDataDefinitionPermissionsPageResponses];
export type PutDataDefinitionPermissionsPageData = {
body?: Array<Permission>;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/permissions';
};
export type PutDataDefinitionPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type PutDataDefinitionPermissionsPageResponse = PutDataDefinitionPermissionsPageResponses[keyof PutDataDefinitionPermissionsPageResponses];
export type GetSiteDataDefinitionByContentTypeByDataDefinitionKeyData = {
body?: never;
path: {
siteId: string;
contentType: string;
dataDefinitionKey: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}/by-data-definition-key/{dataDefinitionKey}';
};
export type GetSiteDataDefinitionByContentTypeByDataDefinitionKeyResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type GetSiteDataDefinitionByContentTypeByDataDefinitionKeyResponse = GetSiteDataDefinitionByContentTypeByDataDefinitionKeyResponses[keyof GetSiteDataDefinitionByContentTypeByDataDefinitionKeyResponses];
export type GetSiteDataDefinitionByContentTypeContentTypePageData = {
body?: never;
path: {
siteId: string;
contentType: string;
};
query?: {
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}';
};
export type GetSiteDataDefinitionByContentTypeContentTypePageResponses = {
/**
* default response
*/
default: PageDataDefinition;
};
export type GetSiteDataDefinitionByContentTypeContentTypePageResponse = GetSiteDataDefinitionByContentTypeContentTypePageResponses[keyof GetSiteDataDefinitionByContentTypeContentTypePageResponses];
export type PostSiteDataDefinitionByContentTypeData = {
body?: DataDefinition;
path: {
siteId: string;
contentType: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-definitions/by-content-type/{contentType}';
};
export type PostSiteDataDefinitionByContentTypeResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PostSiteDataDefinitionByContentTypeResponse = PostSiteDataDefinitionByContentTypeResponses[keyof PostSiteDataDefinitionByContentTypeResponses];
export type PostDataDefinitionCopyData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/copy';
};
export type PostDataDefinitionCopyResponses = {
/**
* default response
*/
default: DataDefinition;
};
export type PostDataDefinitionCopyResponse = PostDataDefinitionCopyResponses[keyof PostDataDefinitionCopyResponses];
export type DeleteDataDefinitionDataLayoutData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-layouts';
};
export type DeleteDataDefinitionDataLayoutResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataDefinitionDataLayoutsPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-layouts';
};
export type GetDataDefinitionDataLayoutsPageResponses = {
/**
* default response
*/
default: PageDataLayout;
};
export type GetDataDefinitionDataLayoutsPageResponse = GetDataDefinitionDataLayoutsPageResponses[keyof GetDataDefinitionDataLayoutsPageResponses];
export type PostDataDefinitionDataLayoutData = {
body?: DataLayout;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-layouts';
};
export type PostDataDefinitionDataLayoutResponses = {
/**
* default response
*/
default: DataLayout;
};
export type PostDataDefinitionDataLayoutResponse = PostDataDefinitionDataLayoutResponses[keyof PostDataDefinitionDataLayoutResponses];
export type DeleteDataLayoutData = {
body?: never;
path: {
dataLayoutId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-layouts/{dataLayoutId}';
};
export type DeleteDataLayoutResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataLayoutData = {
body?: never;
path: {
dataLayoutId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-layouts/{dataLayoutId}';
};
export type GetDataLayoutResponses = {
/**
* default response
*/
default: DataLayout;
};
export type GetDataLayoutResponse = GetDataLayoutResponses[keyof GetDataLayoutResponses];
export type PutDataLayoutData = {
body?: DataLayout;
path: {
dataLayoutId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-layouts/{dataLayoutId}';
};
export type PutDataLayoutResponses = {
/**
* default response
*/
default: DataLayout;
};
export type PutDataLayoutResponse = PutDataLayoutResponses[keyof PutDataLayoutResponses];
export type DeleteDataLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-layouts/batch';
};
export type DeleteDataLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutDataLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-layouts/batch';
};
export type PutDataLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetSiteDataLayoutByContentTypeByDataLayoutKeyData = {
body?: never;
path: {
siteId: string;
contentType: string;
dataLayoutKey: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-layouts/by-content-type/{contentType}/by-data-layout-key/{dataLayoutKey}';
};
export type GetSiteDataLayoutByContentTypeByDataLayoutKeyResponses = {
/**
* default response
*/
default: DataLayout;
};
export type GetSiteDataLayoutByContentTypeByDataLayoutKeyResponse = GetSiteDataLayoutByContentTypeByDataLayoutKeyResponses[keyof GetSiteDataLayoutByContentTypeByDataLayoutKeyResponses];
export type PostDataDefinitionDataLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path: {
dataDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-layouts/batch';
};
export type PostDataDefinitionDataLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataDefinitionDataLayoutsPageExportBatchData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-layouts/export-batch';
};
export type PostDataDefinitionDataLayoutsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataLayoutContextData = {
body?: DataLayoutRenderingContext;
path: {
dataLayoutId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-layouts/{dataLayoutId}/context';
};
export type PostDataLayoutContextResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDataDefinitionDataListViewData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-list-views';
};
export type DeleteDataDefinitionDataListViewResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataDefinitionDataListViewsPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-list-views';
};
export type GetDataDefinitionDataListViewsPageResponses = {
/**
* default response
*/
default: PageDataListView;
};
export type GetDataDefinitionDataListViewsPageResponse = GetDataDefinitionDataListViewsPageResponses[keyof GetDataDefinitionDataListViewsPageResponses];
export type PostDataDefinitionDataListViewData = {
body?: DataListView;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-list-views';
};
export type PostDataDefinitionDataListViewResponses = {
/**
* default response
*/
default: DataListView;
};
export type PostDataDefinitionDataListViewResponse = PostDataDefinitionDataListViewResponses[keyof PostDataDefinitionDataListViewResponses];
export type DeleteDataListViewData = {
body?: never;
path: {
dataListViewId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-list-views/{dataListViewId}';
};
export type DeleteDataListViewResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataListViewData = {
body?: never;
path: {
dataListViewId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-list-views/{dataListViewId}';
};
export type GetDataListViewResponses = {
/**
* default response
*/
default: DataListView;
};
export type GetDataListViewResponse = GetDataListViewResponses[keyof GetDataListViewResponses];
export type PutDataListViewData = {
body?: DataListView;
path: {
dataListViewId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-list-views/{dataListViewId}';
};
export type PutDataListViewResponses = {
/**
* default response
*/
default: DataListView;
};
export type PutDataListViewResponse = PutDataListViewResponses[keyof PutDataListViewResponses];
export type DeleteDataListViewBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-list-views/batch';
};
export type DeleteDataListViewBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutDataListViewBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-list-views/batch';
};
export type PutDataListViewBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataDefinitionDataListViewBatchData = {
body?: {
[key: string]: unknown;
};
path: {
dataDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-list-views/batch';
};
export type PostDataDefinitionDataListViewBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataDefinitionDataListViewsPageExportBatchData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-list-views/export-batch';
};
export type PostDataDefinitionDataListViewsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDataRecordCollectionData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}';
};
export type DeleteDataRecordCollectionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataRecordCollectionData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}';
};
export type GetDataRecordCollectionResponses = {
/**
* default response
*/
default: DataRecordCollection;
};
export type GetDataRecordCollectionResponse = GetDataRecordCollectionResponses[keyof GetDataRecordCollectionResponses];
export type PutDataRecordCollectionData = {
body?: DataRecordCollection;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}';
};
export type PutDataRecordCollectionResponses = {
/**
* default response
*/
default: DataRecordCollection;
};
export type PutDataRecordCollectionResponse = PutDataRecordCollectionResponses[keyof PutDataRecordCollectionResponses];
export type DeleteDataRecordCollectionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/batch';
};
export type DeleteDataRecordCollectionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutDataRecordCollectionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/batch';
};
export type PutDataRecordCollectionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataDefinitionDataRecordCollectionData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-record-collection';
};
export type GetDataDefinitionDataRecordCollectionResponses = {
/**
* default response
*/
default: DataRecordCollection;
};
export type GetDataDefinitionDataRecordCollectionResponse = GetDataDefinitionDataRecordCollectionResponses[keyof GetDataDefinitionDataRecordCollectionResponses];
export type GetDataDefinitionDataRecordCollectionsPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-record-collections';
};
export type GetDataDefinitionDataRecordCollectionsPageResponses = {
/**
* default response
*/
default: PageDataRecordCollection;
};
export type GetDataDefinitionDataRecordCollectionsPageResponse = GetDataDefinitionDataRecordCollectionsPageResponses[keyof GetDataDefinitionDataRecordCollectionsPageResponses];
export type PostDataDefinitionDataRecordCollectionData = {
body?: DataRecordCollection;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-record-collections';
};
export type PostDataDefinitionDataRecordCollectionResponses = {
/**
* default response
*/
default: DataRecordCollection;
};
export type PostDataDefinitionDataRecordCollectionResponse = PostDataDefinitionDataRecordCollectionResponses[keyof PostDataDefinitionDataRecordCollectionResponses];
export type GetDataRecordCollectionPermissionByCurrentUserData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/permissions/by-current-user';
};
export type GetDataRecordCollectionPermissionByCurrentUserResponses = {
/**
* default response
*/
default: string;
};
export type GetDataRecordCollectionPermissionByCurrentUserResponse = GetDataRecordCollectionPermissionByCurrentUserResponses[keyof GetDataRecordCollectionPermissionByCurrentUserResponses];
export type GetDataRecordCollectionPermissionsPageData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: {
roleNames?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/permissions';
};
export type GetDataRecordCollectionPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type GetDataRecordCollectionPermissionsPageResponse = GetDataRecordCollectionPermissionsPageResponses[keyof GetDataRecordCollectionPermissionsPageResponses];
export type PutDataRecordCollectionPermissionsPageData = {
body?: Array<Permission>;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/permissions';
};
export type PutDataRecordCollectionPermissionsPageResponses = {
/**
* default response
*/
default: PagePermission;
};
export type PutDataRecordCollectionPermissionsPageResponse = PutDataRecordCollectionPermissionsPageResponses[keyof PutDataRecordCollectionPermissionsPageResponses];
export type GetSiteDataRecordCollectionByDataRecordCollectionKeyData = {
body?: never;
path: {
siteId: string;
dataRecordCollectionKey: string;
};
query?: never;
url: '/o/data-engine/v2.0/sites/{siteId}/data-record-collections/by-data-record-collection-key/{dataRecordCollectionKey}';
};
export type GetSiteDataRecordCollectionByDataRecordCollectionKeyResponses = {
/**
* default response
*/
default: DataRecordCollection;
};
export type GetSiteDataRecordCollectionByDataRecordCollectionKeyResponse = GetSiteDataRecordCollectionByDataRecordCollectionKeyResponses[keyof GetSiteDataRecordCollectionByDataRecordCollectionKeyResponses];
export type PostDataDefinitionDataRecordCollectionBatchData = {
body?: {
[key: string]: unknown;
};
path: {
dataDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-record-collections/batch';
};
export type PostDataDefinitionDataRecordCollectionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataDefinitionDataRecordCollectionsPageExportBatchData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
keywords?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-record-collections/export-batch';
};
export type PostDataDefinitionDataRecordCollectionsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteDataRecordData = {
body?: never;
path: {
dataRecordId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-records/{dataRecordId}';
};
export type DeleteDataRecordResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataRecordData = {
body?: never;
path: {
dataRecordId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-records/{dataRecordId}';
};
export type GetDataRecordResponses = {
/**
* default response
*/
default: DataRecord;
};
export type GetDataRecordResponse = GetDataRecordResponses[keyof GetDataRecordResponses];
export type PatchDataRecordData = {
body?: DataRecord;
path: {
dataRecordId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-records/{dataRecordId}';
};
export type PatchDataRecordResponses = {
/**
* default response
*/
default: DataRecord;
};
export type PatchDataRecordResponse = PatchDataRecordResponses[keyof PatchDataRecordResponses];
export type PutDataRecordData = {
body?: DataRecord;
path: {
dataRecordId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-records/{dataRecordId}';
};
export type PutDataRecordResponses = {
/**
* default response
*/
default: DataRecord;
};
export type PutDataRecordResponse = PutDataRecordResponses[keyof PutDataRecordResponses];
export type DeleteDataRecordBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-records/batch';
};
export type DeleteDataRecordBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutDataRecordBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-records/batch';
};
export type PutDataRecordBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetDataDefinitionDataRecordsPageData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
dataListViewId?: string;
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-records';
};
export type GetDataDefinitionDataRecordsPageResponses = {
/**
* default response
*/
default: PageDataRecord;
};
export type GetDataDefinitionDataRecordsPageResponse = GetDataDefinitionDataRecordsPageResponses[keyof GetDataDefinitionDataRecordsPageResponses];
export type PostDataDefinitionDataRecordData = {
body?: DataRecord;
path: {
dataDefinitionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-records';
};
export type PostDataDefinitionDataRecordResponses = {
/**
* default response
*/
default: DataRecord;
};
export type PostDataDefinitionDataRecordResponse = PostDataDefinitionDataRecordResponses[keyof PostDataDefinitionDataRecordResponses];
export type GetDataRecordCollectionDataRecordExportData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: {
page?: string;
pageSize?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/data-records/export';
};
export type GetDataRecordCollectionDataRecordExportResponses = {
/**
* default response
*/
default: string;
};
export type GetDataRecordCollectionDataRecordExportResponse = GetDataRecordCollectionDataRecordExportResponses[keyof GetDataRecordCollectionDataRecordExportResponses];
export type GetDataRecordCollectionDataRecordsPageData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: {
dataListViewId?: string;
keywords?: string;
page?: string;
pageSize?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/data-records';
};
export type GetDataRecordCollectionDataRecordsPageResponses = {
/**
* default response
*/
default: PageDataRecord;
};
export type GetDataRecordCollectionDataRecordsPageResponse = GetDataRecordCollectionDataRecordsPageResponses[keyof GetDataRecordCollectionDataRecordsPageResponses];
export type PostDataRecordCollectionDataRecordData = {
body?: DataRecord;
path: {
dataRecordCollectionId: string;
};
query?: never;
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/data-records';
};
export type PostDataRecordCollectionDataRecordResponses = {
/**
* default response
*/
default: DataRecord;
};
export type PostDataRecordCollectionDataRecordResponse = PostDataRecordCollectionDataRecordResponses[keyof PostDataRecordCollectionDataRecordResponses];
export type PostDataDefinitionDataRecordBatchData = {
body?: {
[key: string]: unknown;
};
path: {
dataDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-records/batch';
};
export type PostDataDefinitionDataRecordBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataDefinitionDataRecordsPageExportBatchData = {
body?: never;
path: {
dataDefinitionId: string;
};
query?: {
dataListViewId?: string;
keywords?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-definitions/{dataDefinitionId}/data-records/export-batch';
};
export type PostDataDefinitionDataRecordsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataRecordCollectionDataRecordBatchData = {
body?: {
[key: string]: unknown;
};
path: {
dataRecordCollectionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/data-records/batch';
};
export type PostDataRecordCollectionDataRecordBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostDataRecordCollectionDataRecordsPageExportBatchData = {
body?: never;
path: {
dataRecordCollectionId: string;
};
query?: {
dataListViewId?: string;
keywords?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/data-engine/v2.0/data-record-collections/{dataRecordCollectionId}/data-records/export-batch';
};
export type PostDataRecordCollectionDataRecordsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOpenApiData = {
body?: never;
path: {
type: string;
};
query?: never;
url: '/o/data-engine/v2.0/openapi.{type}';
};
export type GetOpenApiResponses = {
/**
* default response
*/
default: unknown;
};
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};