fineract_sdk
Version:
Wrapper around fineract api.
626 lines (625 loc) • 39.3 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* Apache Fineract
* Apache Fineract is a secure, multi-tenanted microfinance platform The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation - The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top) - You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact) - The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts) - Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers) - For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview) - Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors) Please refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries
*
* The version of the OpenAPI document: 1.5.0-66-gffae7d4-dirty
* Contact: dev@fineract.apache.org
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.NotesApi = exports.NotesApiFactory = exports.NotesApiFp = exports.NotesApiAxiosParamCreator = void 0;
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var common_1 = require("../common");
// @ts-ignore
var base_1 = require("../base");
/**
* NotesApi - axios parameter creator
* @export
*/
exports.NotesApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes
* @summary Add a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addNewNote: function (resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'resourceType' is not null or undefined
common_1.assertParamExists('addNewNote', 'resourceType', resourceType);
// verify required parameter 'resourceId' is not null or undefined
common_1.assertParamExists('addNewNote', 'resourceId', resourceId);
// verify required parameter 'postResourceTypeResourceIdNotesRequest' is not null or undefined
common_1.assertParamExists('addNewNote', 'postResourceTypeResourceIdNotesRequest', postResourceTypeResourceIdNotesRequest);
localVarPath = "/{resourceType}/{resourceId}/notes"
.replace("{" + "resourceType" + "}", encodeURIComponent(String(resourceType)))
.replace("{" + "resourceId" + "}", encodeURIComponent(String(resourceId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(postResourceTypeResourceIdNotesRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Deletes a Resource Note
* @summary Delete a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteNote: function (resourceType, resourceId, noteId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'resourceType' is not null or undefined
common_1.assertParamExists('deleteNote', 'resourceType', resourceType);
// verify required parameter 'resourceId' is not null or undefined
common_1.assertParamExists('deleteNote', 'resourceId', resourceId);
// verify required parameter 'noteId' is not null or undefined
common_1.assertParamExists('deleteNote', 'noteId', noteId);
localVarPath = "/{resourceType}/{resourceId}/notes/{noteId}"
.replace("{" + "resourceType" + "}", encodeURIComponent(String(resourceType)))
.replace("{" + "resourceId" + "}", encodeURIComponent(String(resourceId)))
.replace("{" + "noteId" + "}", encodeURIComponent(String(noteId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNote: function (resourceType, resourceId, noteId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'resourceType' is not null or undefined
common_1.assertParamExists('retrieveNote', 'resourceType', resourceType);
// verify required parameter 'resourceId' is not null or undefined
common_1.assertParamExists('retrieveNote', 'resourceId', resourceId);
// verify required parameter 'noteId' is not null or undefined
common_1.assertParamExists('retrieveNote', 'noteId', noteId);
localVarPath = "/{resourceType}/{resourceId}/notes/{noteId}"
.replace("{" + "resourceType" + "}", encodeURIComponent(String(resourceType)))
.replace("{" + "resourceId" + "}", encodeURIComponent(String(resourceId)))
.replace("{" + "noteId" + "}", encodeURIComponent(String(noteId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource\'s description
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNotesByResource: function (resourceType, resourceId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'resourceType' is not null or undefined
common_1.assertParamExists('retrieveNotesByResource', 'resourceType', resourceType);
// verify required parameter 'resourceId' is not null or undefined
common_1.assertParamExists('retrieveNotesByResource', 'resourceId', resourceId);
localVarPath = "/{resourceType}/{resourceId}/notes"
.replace("{" + "resourceType" + "}", encodeURIComponent(String(resourceType)))
.replace("{" + "resourceId" + "}", encodeURIComponent(String(resourceId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Updates a Resource Note
* @summary Update a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNote: function (resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'resourceType' is not null or undefined
common_1.assertParamExists('updateNote', 'resourceType', resourceType);
// verify required parameter 'resourceId' is not null or undefined
common_1.assertParamExists('updateNote', 'resourceId', resourceId);
// verify required parameter 'noteId' is not null or undefined
common_1.assertParamExists('updateNote', 'noteId', noteId);
// verify required parameter 'putResourceTypeResourceIdNotesNoteIdRequest' is not null or undefined
common_1.assertParamExists('updateNote', 'putResourceTypeResourceIdNotesNoteIdRequest', putResourceTypeResourceIdNotesNoteIdRequest);
localVarPath = "/{resourceType}/{resourceId}/notes/{noteId}"
.replace("{" + "resourceType" + "}", encodeURIComponent(String(resourceType)))
.replace("{" + "resourceId" + "}", encodeURIComponent(String(resourceId)))
.replace("{" + "noteId" + "}", encodeURIComponent(String(noteId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(putResourceTypeResourceIdNotesNoteIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
};
};
/**
* NotesApi - functional programming interface
* @export
*/
exports.NotesApiFp = function (configuration) {
var localVarAxiosParamCreator = exports.NotesApiAxiosParamCreator(configuration);
return {
/**
* Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes
* @summary Add a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addNewNote: function (resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.addNewNote(resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Deletes a Resource Note
* @summary Delete a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteNote: function (resourceType, resourceId, noteId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteNote(resourceType, resourceId, noteId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNote: function (resourceType, resourceId, noteId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveNote(resourceType, resourceId, noteId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource\'s description
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNotesByResource: function (resourceType, resourceId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveNotesByResource(resourceType, resourceId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Updates a Resource Note
* @summary Update a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNote: function (resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateNote(resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
};
};
/**
* NotesApi - factory interface
* @export
*/
exports.NotesApiFactory = function (configuration, basePath, axios) {
var localVarFp = exports.NotesApiFp(configuration);
return {
/**
* Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes
* @summary Add a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addNewNote: function (resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options) {
return localVarFp.addNewNote(resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options).then(function (request) { return request(axios, basePath); });
},
/**
* Deletes a Resource Note
* @summary Delete a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteNote: function (resourceType, resourceId, noteId, options) {
return localVarFp.deleteNote(resourceType, resourceId, noteId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNote: function (resourceType, resourceId, noteId, options) {
return localVarFp.retrieveNote(resourceType, resourceId, noteId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource\'s description
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveNotesByResource: function (resourceType, resourceId, options) {
return localVarFp.retrieveNotesByResource(resourceType, resourceId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Updates a Resource Note
* @summary Update a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNote: function (resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options) {
return localVarFp.updateNote(resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options).then(function (request) { return request(axios, basePath); });
},
};
};
/**
* NotesApi - object-oriented interface
* @export
* @class NotesApi
* @extends {BaseAPI}
*/
var NotesApi = /** @class */ (function (_super) {
__extends(NotesApi, _super);
function NotesApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes
* @summary Add a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {PostResourceTypeResourceIdNotesRequest} postResourceTypeResourceIdNotesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotesApi
*/
NotesApi.prototype.addNewNote = function (resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options) {
var _this = this;
return exports.NotesApiFp(this.configuration).addNewNote(resourceType, resourceId, postResourceTypeResourceIdNotesRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Deletes a Resource Note
* @summary Delete a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotesApi
*/
NotesApi.prototype.deleteNote = function (resourceType, resourceId, noteId, options) {
var _this = this;
return exports.NotesApiFp(this.configuration).deleteNote(resourceType, resourceId, noteId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotesApi
*/
NotesApi.prototype.retrieveNote = function (resourceType, resourceId, noteId, options) {
var _this = this;
return exports.NotesApiFp(this.configuration).retrieveNote(resourceType, resourceId, noteId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Retrieves a Resource\'s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername
* @summary Retrieve a Resource\'s description
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotesApi
*/
NotesApi.prototype.retrieveNotesByResource = function (resourceType, resourceId, options) {
var _this = this;
return exports.NotesApiFp(this.configuration).retrieveNotesByResource(resourceType, resourceId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Updates a Resource Note
* @summary Update a Resource Note
* @param {string} resourceType resourceType
* @param {number} resourceId resourceId
* @param {number} noteId noteId
* @param {PutResourceTypeResourceIdNotesNoteIdRequest} putResourceTypeResourceIdNotesNoteIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotesApi
*/
NotesApi.prototype.updateNote = function (resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options) {
var _this = this;
return exports.NotesApiFp(this.configuration).updateNote(resourceType, resourceId, noteId, putResourceTypeResourceIdNotesNoteIdRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
return NotesApi;
}(base_1.BaseAPI));
exports.NotesApi = NotesApi;