umbraco-management-api-client
Version:
TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)
1,245 lines • 57.6 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.DocumentApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class DocumentApi extends runtime.BaseAPI {
/**
*/
async deleteDocumentByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDocumentById().');
}
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/document/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteDocumentById(requestParameters, initOverrides) {
await this.deleteDocumentByIdRaw(requestParameters, initOverrides);
}
/**
*/
async deleteDocumentByIdPublicAccessRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDocumentByIdPublicAccess().');
}
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/document/{id}/public-access`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteDocumentByIdPublicAccess(requestParameters, initOverrides) {
await this.deleteDocumentByIdPublicAccessRaw(requestParameters, initOverrides);
}
/**
*/
async deleteRecycleBinDocumentRaw(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/recycle-bin/document`,
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteRecycleBinDocument(initOverrides) {
await this.deleteRecycleBinDocumentRaw(initOverrides);
}
/**
*/
async deleteRecycleBinDocumentByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteRecycleBinDocumentById().');
}
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/recycle-bin/document/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async deleteRecycleBinDocumentById(requestParameters, initOverrides) {
await this.deleteRecycleBinDocumentByIdRaw(requestParameters, initOverrides);
}
/**
*/
async getCollectionDocumentByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getCollectionDocumentById().');
}
const queryParameters = {};
if (requestParameters['dataTypeId'] != null) {
queryParameters['dataTypeId'] = requestParameters['dataTypeId'];
}
if (requestParameters['orderBy'] != null) {
queryParameters['orderBy'] = requestParameters['orderBy'];
}
if (requestParameters['orderCulture'] != null) {
queryParameters['orderCulture'] = requestParameters['orderCulture'];
}
if (requestParameters['orderDirection'] != null) {
queryParameters['orderDirection'] = requestParameters['orderDirection'];
}
if (requestParameters['filter'] != null) {
queryParameters['filter'] = requestParameters['filter'];
}
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/collection/document/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentCollectionResponseModelFromJSON)(jsonValue));
}
/**
*/
async getCollectionDocumentById(requestParameters, initOverrides) {
const response = await this.getCollectionDocumentByIdRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentAreReferencedRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['id'] != null) {
queryParameters['id'] = requestParameters['id'];
}
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/document/are-referenced`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedReferenceByIdModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentAreReferenced(requestParameters = {}, initOverrides) {
const response = await this.getDocumentAreReferencedRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentById().');
}
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/document/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentById(requestParameters, initOverrides) {
const response = await this.getDocumentByIdRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdAuditLogRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdAuditLog().');
}
const queryParameters = {};
if (requestParameters['orderDirection'] != null) {
queryParameters['orderDirection'] = requestParameters['orderDirection'];
}
if (requestParameters['sinceDate'] != null) {
queryParameters['sinceDate'] = requestParameters['sinceDate'].toISOString();
}
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/document/{id}/audit-log`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedAuditLogResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdAuditLog(requestParameters, initOverrides) {
const response = await this.getDocumentByIdAuditLogRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdDomainsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdDomains().');
}
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/document/{id}/domains`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DomainsResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdDomains(requestParameters, initOverrides) {
const response = await this.getDocumentByIdDomainsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdNotificationsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdNotifications().');
}
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/document/{id}/notifications`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetDocumentByIdNotifications200ResponseInnerFromJSON));
}
/**
*/
async getDocumentByIdNotifications(requestParameters, initOverrides) {
const response = await this.getDocumentByIdNotificationsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdPublicAccessRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdPublicAccess().');
}
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/document/{id}/public-access`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PublicAccessResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdPublicAccess(requestParameters, initOverrides) {
const response = await this.getDocumentByIdPublicAccessRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdPublishWithDescendantsResultByTaskIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdPublishWithDescendantsResultByTaskId().');
}
if (requestParameters['taskId'] == null) {
throw new runtime.RequiredError('taskId', 'Required parameter "taskId" was null or undefined when calling getDocumentByIdPublishWithDescendantsResultByTaskId().');
}
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/document/{id}/publish-with-descendants/result/{taskId}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))).replace(`{${"taskId"}}`, encodeURIComponent(String(requestParameters['taskId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PublishWithDescendantsResultModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdPublishWithDescendantsResultByTaskId(requestParameters, initOverrides) {
const response = await this.getDocumentByIdPublishWithDescendantsResultByTaskIdRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdPublishedRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdPublished().');
}
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/document/{id}/published`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PublishedDocumentResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdPublished(requestParameters, initOverrides) {
const response = await this.getDocumentByIdPublishedRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdReferencedByRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdReferencedBy().');
}
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/document/{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 getDocumentByIdReferencedBy(requestParameters, initOverrides) {
const response = await this.getDocumentByIdReferencedByRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentByIdReferencedDescendantsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentByIdReferencedDescendants().');
}
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/document/{id}/referenced-descendants`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedReferenceByIdModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentByIdReferencedDescendants(requestParameters, initOverrides) {
const response = await this.getDocumentByIdReferencedDescendantsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getDocumentConfigurationRaw(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/document/configuration`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentConfigurationResponseModelFromJSON)(jsonValue));
}
/**
*/
async getDocumentConfiguration(initOverrides) {
const response = await this.getDocumentConfigurationRaw(initOverrides);
return await response.value();
}
/**
*/
async getDocumentUrlsRaw(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/document/urls`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetDocumentUrls200ResponseInnerFromJSON));
}
/**
*/
async getDocumentUrls(requestParameters = {}, initOverrides) {
const response = await this.getDocumentUrlsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getItemDocumentRaw(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/document`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetItemDocument200ResponseInnerFromJSON));
}
/**
*/
async getItemDocument(requestParameters = {}, initOverrides) {
const response = await this.getItemDocumentRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getItemDocumentSearchRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['query'] != null) {
queryParameters['query'] = requestParameters['query'];
}
if (requestParameters['trashed'] != null) {
queryParameters['trashed'] = requestParameters['trashed'];
}
if (requestParameters['culture'] != null) {
queryParameters['culture'] = requestParameters['culture'];
}
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
if (requestParameters['parentId'] != null) {
queryParameters['parentId'] = requestParameters['parentId'];
}
if (requestParameters['allowedDocumentTypes'] != null) {
queryParameters['allowedDocumentTypes'] = requestParameters['allowedDocumentTypes'];
}
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/document/search`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedModelDocumentItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getItemDocumentSearch(requestParameters = {}, initOverrides) {
const response = await this.getItemDocumentSearchRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getRecycleBinDocumentByIdOriginalParentRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getRecycleBinDocumentByIdOriginalParent().');
}
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/recycle-bin/document/{id}/original-parent`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReferenceByIdModelFromJSON)(jsonValue));
}
/**
*/
async getRecycleBinDocumentByIdOriginalParent(requestParameters, initOverrides) {
const response = await this.getRecycleBinDocumentByIdOriginalParentRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getRecycleBinDocumentChildrenRaw(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'];
}
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/recycle-bin/document/children`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentRecycleBinItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getRecycleBinDocumentChildren(requestParameters = {}, initOverrides) {
const response = await this.getRecycleBinDocumentChildrenRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getRecycleBinDocumentReferencedByRaw(requestParameters, initOverrides) {
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/recycle-bin/document/referenced-by`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedIReferenceResponseModelFromJSON)(jsonValue));
}
/**
*/
async getRecycleBinDocumentReferencedBy(requestParameters = {}, initOverrides) {
const response = await this.getRecycleBinDocumentReferencedByRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getRecycleBinDocumentRootRaw(requestParameters, initOverrides) {
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/recycle-bin/document/root`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentRecycleBinItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getRecycleBinDocumentRoot(requestParameters = {}, initOverrides) {
const response = await this.getRecycleBinDocumentRootRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDocumentAncestorsRaw(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/document/ancestors`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetTreeDocumentAncestors200ResponseInnerFromJSON));
}
/**
*/
async getTreeDocumentAncestors(requestParameters = {}, initOverrides) {
const response = await this.getTreeDocumentAncestorsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDocumentChildrenRaw(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['dataTypeId'] != null) {
queryParameters['dataTypeId'] = requestParameters['dataTypeId'];
}
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/document/children`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentTreeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getTreeDocumentChildren(requestParameters = {}, initOverrides) {
const response = await this.getTreeDocumentChildrenRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async getTreeDocumentRootRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters['skip'] != null) {
queryParameters['skip'] = requestParameters['skip'];
}
if (requestParameters['take'] != null) {
queryParameters['take'] = requestParameters['take'];
}
if (requestParameters['dataTypeId'] != null) {
queryParameters['dataTypeId'] = requestParameters['dataTypeId'];
}
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/document/root`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentTreeItemResponseModelFromJSON)(jsonValue));
}
/**
*/
async getTreeDocumentRoot(requestParameters = {}, initOverrides) {
const response = await this.getTreeDocumentRootRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async postDocumentRaw(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/document`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CreateDocumentRequestModelToJSON)(requestParameters['createDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDocument(requestParameters = {}, initOverrides) {
await this.postDocumentRaw(requestParameters, initOverrides);
}
/**
*/
async postDocumentByIdCopyRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling postDocumentByIdCopy().');
}
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/document/{id}/copy`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CopyDocumentRequestModelToJSON)(requestParameters['copyDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDocumentByIdCopy(requestParameters, initOverrides) {
await this.postDocumentByIdCopyRaw(requestParameters, initOverrides);
}
/**
*/
async postDocumentByIdPublicAccessRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling postDocumentByIdPublicAccess().');
}
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/document/{id}/public-access`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PublicAccessRequestModelToJSON)(requestParameters['publicAccessRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDocumentByIdPublicAccess(requestParameters, initOverrides) {
await this.postDocumentByIdPublicAccessRaw(requestParameters, initOverrides);
}
/**
*/
async postDocumentValidateRaw(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/document/validate`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.CreateDocumentRequestModelToJSON)(requestParameters['createDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async postDocumentValidate(requestParameters = {}, initOverrides) {
await this.postDocumentValidateRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentById().');
}
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/document/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateDocumentRequestModelToJSON)(requestParameters['updateDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentById(requestParameters, initOverrides) {
await this.putDocumentByIdRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdDomainsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdDomains().');
}
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/document/{id}/domains`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateDomainsRequestModelToJSON)(requestParameters['updateDomainsRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdDomains(requestParameters, initOverrides) {
await this.putDocumentByIdDomainsRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdMoveRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdMove().');
}
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/document/{id}/move`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.MoveDocumentRequestModelToJSON)(requestParameters['moveDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdMove(requestParameters, initOverrides) {
await this.putDocumentByIdMoveRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdMoveToRecycleBinRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdMoveToRecycleBin().');
}
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/document/{id}/move-to-recycle-bin`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdMoveToRecycleBin(requestParameters, initOverrides) {
await this.putDocumentByIdMoveToRecycleBinRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdNotificationsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdNotifications().');
}
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/document/{id}/notifications`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateDocumentNotificationsRequestModelToJSON)(requestParameters['updateDocumentNotificationsRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdNotifications(requestParameters, initOverrides) {
await this.putDocumentByIdNotificationsRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdPublicAccessRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdPublicAccess().');
}
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/document/{id}/public-access`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PublicAccessRequestModelToJSON)(requestParameters['publicAccessRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdPublicAccess(requestParameters, initOverrides) {
await this.putDocumentByIdPublicAccessRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdPublishRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdPublish().');
}
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/document/{id}/publish`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PublishDocumentRequestModelToJSON)(requestParameters['publishDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdPublish(requestParameters, initOverrides) {
await this.putDocumentByIdPublishRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentByIdPublishWithDescendantsRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdPublishWithDescendants().');
}
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/document/{id}/publish-with-descendants`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PublishDocumentWithDescendantsRequestModelToJSON)(requestParameters['publishDocumentWithDescendantsRequestModel']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PublishWithDescendantsResultModelFromJSON)(jsonValue));
}
/**
*/
async putDocumentByIdPublishWithDescendants(requestParameters, initOverrides) {
const response = await this.putDocumentByIdPublishWithDescendantsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
*/
async putDocumentByIdUnpublishRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentByIdUnpublish().');
}
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/document/{id}/unpublish`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UnpublishDocumentRequestModelToJSON)(requestParameters['unpublishDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentByIdUnpublish(requestParameters, initOverrides) {
await this.putDocumentByIdUnpublishRaw(requestParameters, initOverrides);
}
/**
*/
async putDocumentSortRaw(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/document/sort`,
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.SortingRequestModelToJSON)(requestParameters['sortingRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putDocumentSort(requestParameters = {}, initOverrides) {
await this.putDocumentSortRaw(requestParameters, initOverrides);
}
/**
*/
async putRecycleBinDocumentByIdRestoreRaw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putRecycleBinDocumentByIdRestore().');
}
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/recycle-bin/document/{id}/restore`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.MoveMediaRequestModelToJSON)(requestParameters['moveMediaRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putRecycleBinDocumentByIdRestore(requestParameters, initOverrides) {
await this.putRecycleBinDocumentByIdRestoreRaw(requestParameters, initOverrides);
}
/**
*/
async putUmbracoManagementApiV11DocumentByIdValidate11Raw(requestParameters, initOverrides) {
if (requestParameters['id'] == null) {
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putUmbracoManagementApiV11DocumentByIdValidate11().');
}
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.1/document/{id}/validate`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.ValidateUpdateDocumentRequestModelToJSON)(requestParameters['validateUpdateDocumentRequestModel']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
*/
async putUmbracoManagementApiV11DocumentByIdValidate11(requestParameters, initOverrides) {
await this.putUmbracoManagementApiV11DocumentByIdValidate11Raw(requestParameters, initOverrides);
}
}
exports.DocumentApi = DocumentApi;