ynab
Version:
Official JavaScript client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.85.0
208 lines (207 loc) • 9.82 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* YNAB API Endpoints
* Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com
*
* Generated by: OpenAPI Generator (https://openapi-generator.tech)
*/
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.PayeesApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class PayeesApi extends runtime.BaseAPI {
/**
* Creates a new payee
* Create a payee
*/
async createPayeeRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling createPayee.');
}
if (requestParameters.data === null || requestParameters.data === undefined) {
throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling createPayee.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Accept'] = 'application/json';
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearer", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
const response = await this.request({
path: `/plans/{plan_id}/payees`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PostPayeeWrapperToJSON)(requestParameters.data),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SavePayeeResponseFromJSON)(jsonValue));
}
/**
* Creates a new payee
* Create a payee
*/
async createPayee(planId, data, initOverrides) {
const response = await this.createPayeeRaw({ planId: planId, data: data }, initOverrides);
return await response.value();
}
/**
* Returns a single payee
* Get a payee
*/
async getPayeeByIdRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayeeById.');
}
if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling getPayeeById.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Accept'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearer", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
const response = await this.request({
path: `/plans/{plan_id}/payees/{payee_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PayeeResponseFromJSON)(jsonValue));
}
/**
* Returns a single payee
* Get a payee
*/
async getPayeeById(planId, payeeId, initOverrides) {
const response = await this.getPayeeByIdRaw({ planId: planId, payeeId: payeeId }, initOverrides);
return await response.value();
}
/**
* Returns all payees
* Get all payees
*/
async getPayeesRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayees.');
}
const queryParameters = {};
if (requestParameters.lastKnowledgeOfServer !== undefined) {
queryParameters['last_knowledge_of_server'] = requestParameters.lastKnowledgeOfServer;
}
const headerParameters = {};
headerParameters['Accept'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearer", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
const response = await this.request({
path: `/plans/{plan_id}/payees`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PayeesResponseFromJSON)(jsonValue));
}
/**
* Returns all payees
* Get all payees
*/
async getPayees(planId, lastKnowledgeOfServer, initOverrides) {
const response = await this.getPayeesRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
return await response.value();
}
/**
* Update a payee
* Update a payee
*/
async updatePayeeRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling updatePayee.');
}
if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling updatePayee.');
}
if (requestParameters.data === null || requestParameters.data === undefined) {
throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling updatePayee.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Accept'] = 'application/json';
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearer", []);
if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}
const response = await this.request({
path: `/plans/{plan_id}/payees/{payee_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PatchPayeeWrapperToJSON)(requestParameters.data),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SavePayeeResponseFromJSON)(jsonValue));
}
/**
* Update a payee
* Update a payee
*/
async updatePayee(planId, payeeId, data, initOverrides) {
const response = await this.updatePayeeRaw({ planId: planId, payeeId: payeeId, data: data }, initOverrides);
return await response.value();
}
}
exports.PayeesApi = PayeesApi;