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
158 lines (157 loc) • 6.86 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.PlansApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class PlansApi extends runtime.BaseAPI {
/**
* Returns a single plan with all related entities. This resource is effectively a full plan export.
* Get a plan
*/
async getPlanByIdRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPlanById.');
}
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}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PlanDetailResponseFromJSON)(jsonValue));
}
/**
* Returns a single plan with all related entities. This resource is effectively a full plan export.
* Get a plan
*/
async getPlanById(planId, lastKnowledgeOfServer, initOverrides) {
const response = await this.getPlanByIdRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
return await response.value();
}
/**
* Returns settings for a plan
* Get plan settings
*/
async getPlanSettingsByIdRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPlanSettingsById.');
}
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}/settings`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PlanSettingsResponseFromJSON)(jsonValue));
}
/**
* Returns settings for a plan
* Get plan settings
*/
async getPlanSettingsById(planId, initOverrides) {
const response = await this.getPlanSettingsByIdRaw({ planId: planId }, initOverrides);
return await response.value();
}
/**
* Returns plans list with summary information
* Get all plans
*/
async getPlansRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters.includeAccounts !== undefined) {
queryParameters['include_accounts'] = requestParameters.includeAccounts;
}
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`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PlanSummaryResponseFromJSON)(jsonValue));
}
/**
* Returns plans list with summary information
* Get all plans
*/
async getPlans(includeAccounts, initOverrides) {
const response = await this.getPlansRaw({ includeAccounts: includeAccounts }, initOverrides);
return await response.value();
}
}
exports.PlansApi = PlansApi;