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
 *
 * 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 * as runtime from '../runtime';
import type { PayeeResponse, PayeesResponse } from '../models/index';
export interface GetPayeeByIdRequest {
    budgetId: string;
    payeeId: string;
}
export interface GetPayeesRequest {
    budgetId: string;
    lastKnowledgeOfServer?: number;
}
/**
 *
 */
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>;
}