ynab 1.55.0 → 2.0.0-rc.0

package/dist/esm/models/UserResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { UserResponseData } from './UserResponseData';
+/**
+ *
+ * @export
+ * @interface UserResponse
+ */
+export interface UserResponse {
+    /**
+     *
+     * @type {UserResponseData}
+     * @memberof UserResponse
+     */
+    data: UserResponseData;
+}
+/**
+ * Check if a given object implements the UserResponse interface.
+ */
+export declare function instanceOfUserResponse(value: object): boolean;
+export declare function UserResponseFromJSON(json: any): UserResponse;
+export declare function UserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserResponse;
+export declare function UserResponseToJSON(value?: UserResponse | null): any;

package/dist/esm/models/UserResponse.js

@@ -0,0 +1,44 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserResponseDataFromJSON, UserResponseDataToJSON, } from './UserResponseData';
+/**
+ * Check if a given object implements the UserResponse interface.
+ */
+export function instanceOfUserResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function UserResponseFromJSON(json) {
+    return UserResponseFromJSONTyped(json, false);
+}
+export function UserResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': UserResponseDataFromJSON(json['data']),
+    };
+}
+export function UserResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': UserResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/UserResponseData.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { User } from './User';
+/**
+ *
+ * @export
+ * @interface UserResponseData
+ */
+export interface UserResponseData {
+    /**
+     *
+     * @type {User}
+     * @memberof UserResponseData
+     */
+    user: User;
+}
+/**
+ * Check if a given object implements the UserResponseData interface.
+ */
+export declare function instanceOfUserResponseData(value: object): boolean;
+export declare function UserResponseDataFromJSON(json: any): UserResponseData;
+export declare function UserResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserResponseData;
+export declare function UserResponseDataToJSON(value?: UserResponseData | null): any;

package/dist/esm/models/UserResponseData.js

@@ -0,0 +1,44 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserFromJSON, UserToJSON, } from './User';
+/**
+ * Check if a given object implements the UserResponseData interface.
+ */
+export function instanceOfUserResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "user" in value;
+    return isInstance;
+}
+export function UserResponseDataFromJSON(json) {
+    return UserResponseDataFromJSONTyped(json, false);
+}
+export function UserResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'user': UserFromJSON(json['user']),
+    };
+}
+export function UserResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'user': UserToJSON(value.user),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,90 @@
+export * from './Account';
+export * from './AccountResponse';
+export * from './AccountResponseData';
+export * from './AccountType';
+export * from './AccountsResponse';
+export * from './AccountsResponseData';
+export * from './BudgetDetail';
+export * from './BudgetDetailAllOf';
+export * from './BudgetDetailResponse';
+export * from './BudgetDetailResponseData';
+export * from './BudgetSettings';
+export * from './BudgetSettingsResponse';
+export * from './BudgetSettingsResponseData';
+export * from './BudgetSummary';
+export * from './BudgetSummaryResponse';
+export * from './BudgetSummaryResponseData';
+export * from './BulkResponse';
+export * from './BulkResponseData';
+export * from './BulkResponseDataBulk';
+export * from './BulkTransactions';
+export * from './CategoriesResponse';
+export * from './CategoriesResponseData';
+export * from './Category';
+export * from './CategoryGroup';
+export * from './CategoryGroupWithCategories';
+export * from './CategoryGroupWithCategoriesAllOf';
+export * from './CategoryResponse';
+export * from './CategoryResponseData';
+export * from './CurrencyFormat';
+export * from './DateFormat';
+export * from './ErrorDetail';
+export * from './ErrorResponse';
+export * from './HybridTransaction';
+export * from './HybridTransactionAllOf';
+export * from './HybridTransactionsResponse';
+export * from './HybridTransactionsResponseData';
+export * from './MonthDetail';
+export * from './MonthDetailAllOf';
+export * from './MonthDetailResponse';
+export * from './MonthDetailResponseData';
+export * from './MonthSummariesResponse';
+export * from './MonthSummariesResponseData';
+export * from './MonthSummary';
+export * from './PatchMonthCategoryWrapper';
+export * from './PatchTransactionsWrapper';
+export * from './Payee';
+export * from './PayeeLocation';
+export * from './PayeeLocationResponse';
+export * from './PayeeLocationResponseData';
+export * from './PayeeLocationsResponse';
+export * from './PayeeLocationsResponseData';
+export * from './PayeeResponse';
+export * from './PayeeResponseData';
+export * from './PayeesResponse';
+export * from './PayeesResponseData';
+export * from './PostAccountWrapper';
+export * from './PostTransactionsWrapper';
+export * from './PutTransactionWrapper';
+export * from './SaveAccount';
+export * from './SaveCategoryResponse';
+export * from './SaveCategoryResponseData';
+export * from './SaveMonthCategory';
+export * from './SaveSubTransaction';
+export * from './SaveTransaction';
+export * from './SaveTransactionWithId';
+export * from './SaveTransactionWithIdAllOf';
+export * from './SaveTransactionWithOptionalFields';
+export * from './SaveTransactionsResponse';
+export * from './SaveTransactionsResponseData';
+export * from './ScheduledSubTransaction';
+export * from './ScheduledTransactionDetail';
+export * from './ScheduledTransactionDetailAllOf';
+export * from './ScheduledTransactionResponse';
+export * from './ScheduledTransactionResponseData';
+export * from './ScheduledTransactionSummary';
+export * from './ScheduledTransactionsResponse';
+export * from './ScheduledTransactionsResponseData';
+export * from './SubTransaction';
+export * from './TransactionDetail';
+export * from './TransactionDetailAllOf';
+export * from './TransactionResponse';
+export * from './TransactionResponseData';
+export * from './TransactionSummary';
+export * from './TransactionsImportResponse';
+export * from './TransactionsImportResponseData';
+export * from './TransactionsResponse';
+export * from './TransactionsResponseData';
+export * from './User';
+export * from './UserResponse';
+export * from './UserResponseData';

package/dist/esm/models/index.js

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Account';
+export * from './AccountResponse';
+export * from './AccountResponseData';
+export * from './AccountType';
+export * from './AccountsResponse';
+export * from './AccountsResponseData';
+export * from './BudgetDetail';
+export * from './BudgetDetailAllOf';
+export * from './BudgetDetailResponse';
+export * from './BudgetDetailResponseData';
+export * from './BudgetSettings';
+export * from './BudgetSettingsResponse';
+export * from './BudgetSettingsResponseData';
+export * from './BudgetSummary';
+export * from './BudgetSummaryResponse';
+export * from './BudgetSummaryResponseData';
+export * from './BulkResponse';
+export * from './BulkResponseData';
+export * from './BulkResponseDataBulk';
+export * from './BulkTransactions';
+export * from './CategoriesResponse';
+export * from './CategoriesResponseData';
+export * from './Category';
+export * from './CategoryGroup';
+export * from './CategoryGroupWithCategories';
+export * from './CategoryGroupWithCategoriesAllOf';
+export * from './CategoryResponse';
+export * from './CategoryResponseData';
+export * from './CurrencyFormat';
+export * from './DateFormat';
+export * from './ErrorDetail';
+export * from './ErrorResponse';
+export * from './HybridTransaction';
+export * from './HybridTransactionAllOf';
+export * from './HybridTransactionsResponse';
+export * from './HybridTransactionsResponseData';
+export * from './MonthDetail';
+export * from './MonthDetailAllOf';
+export * from './MonthDetailResponse';
+export * from './MonthDetailResponseData';
+export * from './MonthSummariesResponse';
+export * from './MonthSummariesResponseData';
+export * from './MonthSummary';
+export * from './PatchMonthCategoryWrapper';
+export * from './PatchTransactionsWrapper';
+export * from './Payee';
+export * from './PayeeLocation';
+export * from './PayeeLocationResponse';
+export * from './PayeeLocationResponseData';
+export * from './PayeeLocationsResponse';
+export * from './PayeeLocationsResponseData';
+export * from './PayeeResponse';
+export * from './PayeeResponseData';
+export * from './PayeesResponse';
+export * from './PayeesResponseData';
+export * from './PostAccountWrapper';
+export * from './PostTransactionsWrapper';
+export * from './PutTransactionWrapper';
+export * from './SaveAccount';
+export * from './SaveCategoryResponse';
+export * from './SaveCategoryResponseData';
+export * from './SaveMonthCategory';
+export * from './SaveSubTransaction';
+export * from './SaveTransaction';
+export * from './SaveTransactionWithId';
+export * from './SaveTransactionWithIdAllOf';
+export * from './SaveTransactionWithOptionalFields';
+export * from './SaveTransactionsResponse';
+export * from './SaveTransactionsResponseData';
+export * from './ScheduledSubTransaction';
+export * from './ScheduledTransactionDetail';
+export * from './ScheduledTransactionDetailAllOf';
+export * from './ScheduledTransactionResponse';
+export * from './ScheduledTransactionResponseData';
+export * from './ScheduledTransactionSummary';
+export * from './ScheduledTransactionsResponse';
+export * from './ScheduledTransactionsResponseData';
+export * from './SubTransaction';
+export * from './TransactionDetail';
+export * from './TransactionDetailAllOf';
+export * from './TransactionResponse';
+export * from './TransactionResponseData';
+export * from './TransactionSummary';
+export * from './TransactionsImportResponse';
+export * from './TransactionsImportResponseData';
+export * from './TransactionsResponse';
+export * from './TransactionsResponseData';
+export * from './User';
+export * from './UserResponse';
+export * from './UserResponseData';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,182 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | ((name: string) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export declare type Json = any;
+export declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export declare type HTTPHeaders = {
+    [key: string]: string;
+};
+export declare type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export declare type HTTPBody = Json | FormData | URLSearchParams;
+export declare type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export declare type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function exists(json: any, key: string): boolean;
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}