UNPKG

umbraco-management-api-client

Version:

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

441 lines (440 loc) 19 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.MemberApi = void 0; const runtime = __importStar(require("../runtime")); const index_1 = require("../models/index"); /** * */ class MemberApi extends runtime.BaseAPI { /** */ async deleteMemberByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteMemberById().'); } 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/member/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async deleteMemberById(requestParameters, initOverrides) { await this.deleteMemberByIdRaw(requestParameters, initOverrides); } /** */ async getFilterMemberRaw(requestParameters, initOverrides) { const queryParameters = {}; if (requestParameters['memberTypeId'] != null) { queryParameters['memberTypeId'] = requestParameters['memberTypeId']; } if (requestParameters['memberGroupName'] != null) { queryParameters['memberGroupName'] = requestParameters['memberGroupName']; } if (requestParameters['isApproved'] != null) { queryParameters['isApproved'] = requestParameters['isApproved']; } if (requestParameters['isLockedOut'] != null) { queryParameters['isLockedOut'] = requestParameters['isLockedOut']; } if (requestParameters['orderBy'] != null) { queryParameters['orderBy'] = requestParameters['orderBy']; } 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/filter/member`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedMemberResponseModelFromJSON)(jsonValue)); } /** */ async getFilterMember(requestParameters = {}, initOverrides) { const response = await this.getFilterMemberRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getItemMemberRaw(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/member`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetItemMember200ResponseInnerFromJSON)); } /** */ async getItemMember(requestParameters = {}, initOverrides) { const response = await this.getItemMemberRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getItemMemberSearchRaw(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']; } if (requestParameters['allowedMemberTypes'] != null) { queryParameters['allowedMemberTypes'] = requestParameters['allowedMemberTypes']; } 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/member/search`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedModelMemberItemResponseModelFromJSON)(jsonValue)); } /** */ async getItemMemberSearch(requestParameters = {}, initOverrides) { const response = await this.getItemMemberSearchRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getMemberAreReferencedRaw(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/member/are-referenced`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PagedReferenceByIdModelFromJSON)(jsonValue)); } /** */ async getMemberAreReferenced(requestParameters = {}, initOverrides) { const response = await this.getMemberAreReferencedRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getMemberByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getMemberById().'); } 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/member/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MemberResponseModelFromJSON)(jsonValue)); } /** */ async getMemberById(requestParameters, initOverrides) { const response = await this.getMemberByIdRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getMemberByIdReferencedByRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getMemberByIdReferencedBy().'); } 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/member/{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 getMemberByIdReferencedBy(requestParameters, initOverrides) { const response = await this.getMemberByIdReferencedByRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getMemberByIdReferencedDescendantsRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getMemberByIdReferencedDescendants().'); } 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/member/{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 getMemberByIdReferencedDescendants(requestParameters, initOverrides) { const response = await this.getMemberByIdReferencedDescendantsRaw(requestParameters, initOverrides); return await response.value(); } /** */ async getMemberConfigurationRaw(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/member/configuration`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response); } /** */ async getMemberConfiguration(initOverrides) { const response = await this.getMemberConfigurationRaw(initOverrides); return await response.value(); } /** */ async postMemberRaw(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/member`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.CreateMemberRequestModelToJSON)(requestParameters['createMemberRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async postMember(requestParameters = {}, initOverrides) { await this.postMemberRaw(requestParameters, initOverrides); } /** */ async postMemberValidateRaw(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/member/validate`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.CreateMemberRequestModelToJSON)(requestParameters['createMemberRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async postMemberValidate(requestParameters = {}, initOverrides) { await this.postMemberValidateRaw(requestParameters, initOverrides); } /** */ async putMemberByIdRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putMemberById().'); } 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/member/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, index_1.UpdateMemberRequestModelToJSON)(requestParameters['updateMemberRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async putMemberById(requestParameters, initOverrides) { await this.putMemberByIdRaw(requestParameters, initOverrides); } /** */ async putMemberByIdValidateRaw(requestParameters, initOverrides) { if (requestParameters['id'] == null) { throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling putMemberByIdValidate().'); } 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/member/{id}/validate`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))), method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, index_1.UpdateMemberRequestModelToJSON)(requestParameters['updateMemberRequestModel']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** */ async putMemberByIdValidate(requestParameters, initOverrides) { await this.putMemberByIdValidateRaw(requestParameters, initOverrides); } } exports.MemberApi = MemberApi;