/** * 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) */ import * as runtime from '../runtime'; import type { CategoriesResponse, CategoryResponse, PatchCategoryGroupWrapper, PatchCategoryWrapper, PatchMonthCategoryWrapper, PostCategoryGroupWrapper, PostCategoryWrapper, SaveCategoryGroupResponse, SaveCategoryResponse } from '../models/index'; export interface CreateCategoryRequest { planId: string; data: PostCategoryWrapper; } export interface CreateCategoryGroupRequest { planId: string; data: PostCategoryGroupWrapper; } export interface GetCategoriesRequest { planId: string; lastKnowledgeOfServer?: number; } export interface GetCategoryByIdRequest { planId: string; categoryId: string; } export interface GetMonthCategoryByIdRequest { planId: string; month: string; categoryId: string; } export interface UpdateCategoryRequest { planId: string; categoryId: string; data: PatchCategoryWrapper; } export interface UpdateCategoryGroupRequest { planId: string; categoryGroupId: string; data: PatchCategoryGroupWrapper; } export interface UpdateMonthCategoryRequest { planId: string; month: string; categoryId: string; data: PatchMonthCategoryWrapper; } /** * */ export declare class CategoriesApi extends runtime.BaseAPI { /** * Creates a new category * Create a category */ createCategoryRaw(requestParameters: CreateCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new category * Create a category */ createCategory(planId: string, data: PostCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a new category group * Create a category group */ createCategoryGroupRaw(requestParameters: CreateCategoryGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new category group * Create a category group */ createCategoryGroup(planId: string, data: PostCategoryGroupWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get all categories */ getCategoriesRaw(requestParameters: GetCategoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get all categories */ getCategories(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get a category */ getCategoryByIdRaw(requestParameters: GetCategoryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get a category */ getCategoryById(planId: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get a category for a specific plan month */ getMonthCategoryByIdRaw(requestParameters: GetMonthCategoryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). * Get a category for a specific plan month */ getMonthCategoryById(planId: string, month: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update a category * Update a category */ updateCategoryRaw(requestParameters: UpdateCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a category * Update a category */ updateCategory(planId: string, categoryId: string, data: PatchCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update a category group * Update a category group */ updateCategoryGroupRaw(requestParameters: UpdateCategoryGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a category group * Update a category group */ updateCategoryGroup(planId: string, categoryGroupId: string, data: PatchCategoryGroupWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update a category for a specific month. Only `budgeted` (assigned) amount can be updated. * Update a category for a specific month */ updateMonthCategoryRaw(requestParameters: UpdateMonthCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a category for a specific month. Only `budgeted` (assigned) amount can be updated. * Update a category for a specific month */ updateMonthCategory(planId: string, month: string, categoryId: string, data: PatchMonthCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }