UNPKG

umbraco-management-api-client

Version:

TypeScript client for the Umbraco Management API (auto-generated by OpenAPI Generator)

458 lines (457 loc) 20.9 kB
"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.DocumentBlueprintApi = void 0; const runtime = __importStar(require("../runtime")); const index_1 = require("../models/index"); /** * */ class DocumentBlueprintApi extends runtime.BaseAPI { /** */ async deleteDocumentBlueprintByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDocumentBlueprintById().'); } 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-blueprint/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async deleteDocumentBlueprintById(requestParameters, initOverrides) { await this.deleteDocumentBlueprintByIdRaw(requestParameters, initOverrides); } /** */ async deleteDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteDocumentBlueprintFolderById().'); } 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-blueprint/folder/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async deleteDocumentBlueprintFolderById(requestParameters, initOverrides) { await this.deleteDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides); } /** */ async getDocumentBlueprintByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentBlueprintById().'); } 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-blueprint/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentBlueprintResponseModelFromJSON)(jsonValue)); } /** */ async getDocumentBlueprintById(requestParameters, initOverrides) { const response = await this.getDocumentBlueprintByIdRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getDocumentBlueprintByIdScaffoldRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentBlueprintByIdScaffold().'); } 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-blueprint/{id}/scaffold`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentBlueprintResponseModelFromJSON)(jsonValue)); } /** */ async getDocumentBlueprintByIdScaffold(requestParameters, initOverrides) { const response = await this.getDocumentBlueprintByIdScaffoldRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getDocumentBlueprintFolderById().'); } 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-blueprint/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 getDocumentBlueprintFolderById(requestParameters, initOverrides) { const response = await this.getDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getItemDocumentBlueprintRaw(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-blueprint`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetItemDocumentBlueprint200ResponseInnerFromJSON)); } /** */ async getItemDocumentBlueprint(requestParameters = {}, initOverrides) { const response = await this.getItemDocumentBlueprintRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getTreeDocumentBlueprintAncestorsRaw(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-blueprint/ancestors`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetTreeDocumentBlueprintAncestors200ResponseInnerFromJSON)); } /** */ async getTreeDocumentBlueprintAncestors(requestParameters = {}, initOverrides) { const response = await this.getTreeDocumentBlueprintAncestorsRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getTreeDocumentBlueprintChildrenRaw(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/document-blueprint/children`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentBlueprintTreeItemResponseModelFromJSON)(jsonValue)); } /** */ async getTreeDocumentBlueprintChildren(requestParameters = {}, initOverrides) { const response = await this.getTreeDocumentBlueprintChildrenRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getTreeDocumentBlueprintRootRaw(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/document-blueprint/root`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedDocumentBlueprintTreeItemResponseModelFromJSON)(jsonValue)); } /** */ async getTreeDocumentBlueprintRoot(requestParameters = {}, initOverrides) { const response = await this.getTreeDocumentBlueprintRootRaw(requestParameters, initOverrides); return await response.value(); } /** */ async postDocumentBlueprintRaw(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-blueprint`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.CreateDocumentBlueprintRequestModelToJSON)(requestParameters['createDocumentBlueprintRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async postDocumentBlueprint(requestParameters = {}, initOverrides) { await this.postDocumentBlueprintRaw(requestParameters, initOverrides); } /** */ async postDocumentBlueprintFolderRaw(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-blueprint/folder`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.CreateFolderRequestModelToJSON)(requestParameters['createFolderRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async postDocumentBlueprintFolder(requestParameters = {}, initOverrides) { await this.postDocumentBlueprintFolderRaw(requestParameters, initOverrides); } /** */ async postDocumentBlueprintFromDocumentRaw(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-blueprint/from-document`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.CreateDocumentBlueprintFromDocumentRequestModelToJSON)(requestParameters['createDocumentBlueprintFromDocumentRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async postDocumentBlueprintFromDocument(requestParameters = {}, initOverrides) { await this.postDocumentBlueprintFromDocumentRaw(requestParameters, initOverrides); } /** */ async putDocumentBlueprintByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentBlueprintById().'); } 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-blueprint/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, index_1.UpdateDocumentBlueprintRequestModelToJSON)(requestParameters['updateDocumentBlueprintRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async putDocumentBlueprintById(requestParameters, initOverrides) { await this.putDocumentBlueprintByIdRaw(requestParameters, initOverrides); } /** */ async putDocumentBlueprintByIdMoveRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentBlueprintByIdMove().'); } 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-blueprint/{id}/move`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, index_1.MoveDocumentBlueprintRequestModelToJSON)(requestParameters['moveDocumentBlueprintRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async putDocumentBlueprintByIdMove(requestParameters, initOverrides) { await this.putDocumentBlueprintByIdMoveRaw(requestParameters, initOverrides); } /** */ async putDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putDocumentBlueprintFolderById().'); } 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-blueprint/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 putDocumentBlueprintFolderById(requestParameters, initOverrides) { await this.putDocumentBlueprintFolderByIdRaw(requestParameters, initOverrides); } } exports.DocumentBlueprintApi = DocumentBlueprintApi;