PayeesApi.d.ts

/**
 * 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 { PatchPayeeWrapper, PayeeResponse, PayeesResponse, SavePayeeResponse } from '../models/index';
export interface GetPayeeByIdRequest {
    budgetId: string;
    payeeId: string;
}
export interface GetPayeesRequest {
    budgetId: string;
    lastKnowledgeOfServer?: number;
}
export interface UpdatePayeeRequest {
    budgetId: string;
    payeeId: string;
    data: PatchPayeeWrapper;
}
/**
 *
 */
export declare class PayeesApi extends runtime.BaseAPI {
    /**
     * Returns a single payee
     * Single payee
     */
    getPayeeByIdRaw(requestParameters: GetPayeeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeeResponse>>;
    /**
     * Returns a single payee
     * Single payee
     */
    getPayeeById(budgetId: string, payeeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeResponse>;
    /**
     * Returns all payees
     * List payees
     */
    getPayeesRaw(requestParameters: GetPayeesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeesResponse>>;
    /**
     * Returns all payees
     * List payees
     */
    getPayees(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeesResponse>;
    /**
     * Update a payee
     * Update a payee
     */
    updatePayeeRaw(requestParameters: UpdatePayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavePayeeResponse>>;
    /**
     * Update a payee
     * Update a payee
     */
    updatePayee(budgetId: string, payeeId: string, data: PatchPayeeWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavePayeeResponse>;
}