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
245 lines (244 loc) • 13.4 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.ScheduledTransactionsApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class ScheduledTransactionsApi extends runtime.BaseAPI {
/**
* Creates a single scheduled transaction (a transaction with a future date).
* Create a scheduled transaction
*/
async createScheduledTransactionRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling createScheduledTransaction.');
}
if (requestParameters.data === null || requestParameters.data === undefined) {
throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling createScheduledTransaction.');
}
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}/scheduled_transactions`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PostScheduledTransactionWrapperToJSON)(requestParameters.data),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
}
/**
* Creates a single scheduled transaction (a transaction with a future date).
* Create a scheduled transaction
*/
async createScheduledTransaction(planId, data, initOverrides) {
const response = await this.createScheduledTransactionRaw({ planId: planId, data: data }, initOverrides);
return await response.value();
}
/**
* Deletes a scheduled transaction
* Delete a scheduled transaction
*/
async deleteScheduledTransactionRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling deleteScheduledTransaction.');
}
if (requestParameters.scheduledTransactionId === null || requestParameters.scheduledTransactionId === undefined) {
throw new runtime.RequiredError('scheduledTransactionId', 'Required parameter requestParameters.scheduledTransactionId was null or undefined when calling deleteScheduledTransaction.');
}
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}/scheduled_transactions/{scheduled_transaction_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"scheduled_transaction_id"}}`, encodeURIComponent(String(requestParameters.scheduledTransactionId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
}
/**
* Deletes a scheduled transaction
* Delete a scheduled transaction
*/
async deleteScheduledTransaction(planId, scheduledTransactionId, initOverrides) {
const response = await this.deleteScheduledTransactionRaw({ planId: planId, scheduledTransactionId: scheduledTransactionId }, initOverrides);
return await response.value();
}
/**
* Returns a single scheduled transaction
* Get a scheduled transaction
*/
async getScheduledTransactionByIdRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getScheduledTransactionById.');
}
if (requestParameters.scheduledTransactionId === null || requestParameters.scheduledTransactionId === undefined) {
throw new runtime.RequiredError('scheduledTransactionId', 'Required parameter requestParameters.scheduledTransactionId was null or undefined when calling getScheduledTransactionById.');
}
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}/scheduled_transactions/{scheduled_transaction_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"scheduled_transaction_id"}}`, encodeURIComponent(String(requestParameters.scheduledTransactionId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
}
/**
* Returns a single scheduled transaction
* Get a scheduled transaction
*/
async getScheduledTransactionById(planId, scheduledTransactionId, initOverrides) {
const response = await this.getScheduledTransactionByIdRaw({ planId: planId, scheduledTransactionId: scheduledTransactionId }, initOverrides);
return await response.value();
}
/**
* Returns all scheduled transactions
* Get all scheduled transactions
*/
async getScheduledTransactionsRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getScheduledTransactions.');
}
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}/scheduled_transactions`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionsResponseFromJSON)(jsonValue));
}
/**
* Returns all scheduled transactions
* Get all scheduled transactions
*/
async getScheduledTransactions(planId, lastKnowledgeOfServer, initOverrides) {
const response = await this.getScheduledTransactionsRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
return await response.value();
}
/**
* Updates a single scheduled transaction
* Update a scheduled transaction
*/
async updateScheduledTransactionRaw(requestParameters, initOverrides) {
if (requestParameters.planId === null || requestParameters.planId === undefined) {
throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling updateScheduledTransaction.');
}
if (requestParameters.scheduledTransactionId === null || requestParameters.scheduledTransactionId === undefined) {
throw new runtime.RequiredError('scheduledTransactionId', 'Required parameter requestParameters.scheduledTransactionId was null or undefined when calling updateScheduledTransaction.');
}
if (requestParameters.putScheduledTransactionWrapper === null || requestParameters.putScheduledTransactionWrapper === undefined) {
throw new runtime.RequiredError('putScheduledTransactionWrapper', 'Required parameter requestParameters.putScheduledTransactionWrapper was null or undefined when calling updateScheduledTransaction.');
}
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}/scheduled_transactions/{scheduled_transaction_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"scheduled_transaction_id"}}`, encodeURIComponent(String(requestParameters.scheduledTransactionId))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.PutScheduledTransactionWrapperToJSON)(requestParameters.putScheduledTransactionWrapper),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
}
/**
* Updates a single scheduled transaction
* Update a scheduled transaction
*/
async updateScheduledTransaction(planId, scheduledTransactionId, putScheduledTransactionWrapper, initOverrides) {
const response = await this.updateScheduledTransactionRaw({ planId: planId, scheduledTransactionId: scheduledTransactionId, putScheduledTransactionWrapper: putScheduledTransactionWrapper }, initOverrides);
return await response.value();
}
}
exports.ScheduledTransactionsApi = ScheduledTransactionsApi;