@nikhil-patil/ngx-firefly-iii-api-client
Version:
OpenAPI client for ngx-firefly-iii-api-client
68 lines (67 loc) • 4.31 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AvailableBudgetArray } from '../model/availableBudgetArray';
import { AvailableBudgetSingle } from '../model/availableBudgetSingle';
import { HttpConfiguration } from '../configuration';
import * as i0 from "@angular/core";
export declare class AvailableBudgetsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: HttpConfiguration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: HttpConfiguration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* Get a single available budget.
* Get a single available budget, by ID.
* @param id The ID of the available budget.
* @param xTraceId Unique identifier associated with this request.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
getAvailableBudget(id: string, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AvailableBudgetSingle>;
getAvailableBudget(id: string, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AvailableBudgetSingle>>;
getAvailableBudget(id: string, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AvailableBudgetSingle>>;
/**
* List all available budget amounts.
* Firefly III allows users to set the amount that is available to be budgeted in so-called \"available budgets\". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set.
* @param xTraceId Unique identifier associated with this request.
* @param limit Number of items per page. The default pagination is per 50 items.
* @param page Page number. The default pagination is per 50 items.
* @param start A date formatted YYYY-MM-DD.
* @param end A date formatted YYYY-MM-DD.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
listAvailableBudget(xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AvailableBudgetArray>;
listAvailableBudget(xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AvailableBudgetArray>>;
listAvailableBudget(xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AvailableBudgetArray>>;
static ɵfac: i0.ɵɵFactoryDeclaration<AvailableBudgetsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<AvailableBudgetsService>;
}