umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
619 lines (618 loc) • 27.2 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* Umbraco Management API
* This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility
*
* The version of the OpenAPI document: Latest
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.DataTypeApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class DataTypeApi extends runtime.BaseAPI {
/**
*/
async deleteDataTypeByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDataTypeById().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteDataTypeById(requestParameters, initOverrides) {
await this.deleteDataTypeByIdRaw(requestParameters, initOverrides);
}
/**
*/
async deleteDataTypeFolderByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDataTypeFolderById().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/folder/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteDataTypeFolderById(requestParameters, initOverrides) {
await this.deleteDataTypeFolderByIdRaw(requestParameters, initOverrides);
}
/**
*/
async getDataTypeByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDataTypeById().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DataTypeResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDataTypeById(requestParameters, initOverrides) {
const response = await this.getDataTypeByIdRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDataTypeByIdIsUsedRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDataTypeByIdIsUsed().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}/is-used`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
if (this.isJsonMime(response.headers.get('content-type'))) {
return new runtime.JSONApiResponse(response);
}
else {
return new runtime.TextApiResponse(response);
}
}
/**
*/
async getDataTypeByIdIsUsed(requestParameters, initOverrides) {
const response = await this.getDataTypeByIdIsUsedRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDataTypeByIdReferencedByRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDataTypeByIdReferencedBy().');
}
const queryParameters = {};
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}/referenced-by`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedIReferenceResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDataTypeByIdReferencedBy(requestParameters, initOverrides) {
const response = await this.getDataTypeByIdReferencedByRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* @deprecated
*/
async getDataTypeByIdReferencesRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDataTypeByIdReferences().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}/references`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetDataTypeByIdReferences200ResponseInnerFromJSON));
}
/**
* @deprecated
*/
async getDataTypeByIdReferences(requestParameters, initOverrides) {
const response = await this.getDataTypeByIdReferencesRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDataTypeConfigurationRaw(initOverrides) {
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/configuration`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DatatypeConfigurationResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDataTypeConfiguration(initOverrides) {
const response = await this.getDataTypeConfigurationRaw(initOverrides);
return await response.value();
}
/**
*/
async getDataTypeFolderByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDataTypeFolderById().');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/folder/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FolderResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDataTypeFolderById(requestParameters, initOverrides) {
const response = await this.getDataTypeFolderByIdRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getFilterDataTypeRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
if (requestParameters['name'] != null) {
queryParameters['name'] = requestParameters['name'];
}
if (requestParameters['editorUiAlias'] != null) {
queryParameters['editorUiAlias'] = requestParameters['editorUiAlias'];
}
if (requestParameters['editorAlias'] != null) {
queryParameters['editorAlias'] = requestParameters['editorAlias'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/filter/data-type`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDataTypeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getFilterDataType(requestParameters = {}, initOverrides) {
const response = await this.getFilterDataTypeRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getItemDataTypeRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['id'] != null) {
queryParameters['id'] = requestParameters['id'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/item/data-type`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetItemDataType200ResponseInnerFromJSON));
}
/**
*/
async getItemDataType(requestParameters = {}, initOverrides) {
const response = await this.getItemDataTypeRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getItemDataTypeSearchRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['query'] != null) {
queryParameters['query'] = requestParameters['query'];
}
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/item/data-type/search`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedModelDataTypeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getItemDataTypeSearch(requestParameters = {}, initOverrides) {
const response = await this.getItemDataTypeSearchRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDataTypeAncestorsRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['descendantId'] != null) {
queryParameters['descendantId'] = requestParameters['descendantId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/tree/data-type/ancestors`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetTreeDataTypeAncestors200ResponseInnerFromJSON));
}
/**
*/
async getTreeDataTypeAncestors(requestParameters = {}, initOverrides) {
const response = await this.getTreeDataTypeAncestorsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDataTypeChildrenRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['parentId'] != null) {
queryParameters['parentId'] = requestParameters['parentId'];
}
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
if (requestParameters['foldersOnly'] != null) {
queryParameters['foldersOnly'] = requestParameters['foldersOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/tree/data-type/children`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDataTypeTreeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getTreeDataTypeChildren(requestParameters = {}, initOverrides) {
const response = await this.getTreeDataTypeChildrenRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDataTypeRootRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
if (requestParameters['foldersOnly'] != null) {
queryParameters['foldersOnly'] = requestParameters['foldersOnly'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/tree/data-type/root`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDataTypeTreeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getTreeDataTypeRoot(requestParameters = {}, initOverrides) {
const response = await this.getTreeDataTypeRootRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async postDataTypeRaw(requestParameters, initOverrides) {
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CreateDataTypeRequestModelToJSON)(requestParameters['createDataTypeRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDataType(requestParameters = {}, initOverrides) {
await this.postDataTypeRaw(requestParameters, initOverrides);
}
/**
*/
async postDataTypeByIdCopyRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling postDataTypeByIdCopy().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}/copy`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CopyDataTypeRequestModelToJSON)(requestParameters['copyDataTypeRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDataTypeByIdCopy(requestParameters, initOverrides) {
await this.postDataTypeByIdCopyRaw(requestParameters, initOverrides);
}
/**
*/
async postDataTypeFolderRaw(requestParameters, initOverrides) {
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/folder`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CreateFolderRequestModelToJSON)(requestParameters['createFolderRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDataTypeFolder(requestParameters = {}, initOverrides) {
await this.postDataTypeFolderRaw(requestParameters, initOverrides);
}
/**
*/
async putDataTypeByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDataTypeById().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateDataTypeRequestModelToJSON)(requestParameters['updateDataTypeRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDataTypeById(requestParameters, initOverrides) {
await this.putDataTypeByIdRaw(requestParameters, initOverrides);
}
/**
*/
async putDataTypeByIdMoveRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDataTypeByIdMove().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/{id}/move`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.MoveDataTypeRequestModelToJSON)(requestParameters['moveDataTypeRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDataTypeByIdMove(requestParameters, initOverrides) {
await this.putDataTypeByIdMoveRaw(requestParameters, initOverrides);
}
/**
*/
async putDataTypeFolderByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDataTypeFolderById().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("Backoffice User", []);
}
const response = await this.request({
path: `/umbraco/management/api/v1/data-type/folder/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateFolderResponseModelToJSON)(requestParameters['updateFolderResponseModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDataTypeFolderById(requestParameters, initOverrides) {
await this.putDataTypeFolderByIdRaw(requestParameters, initOverrides);
}
}
exports.DataTypeApi = DataTypeApi;