@nikhil-patil/ngx-firefly-iii-api-client/api/summary.service.d.ts

OpenAPI client for ngx-firefly-iii-api-client

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { BasicSummaryEntry } from '../model/basicSummaryEntry';
import { HttpConfiguration } from '../configuration';
import * as i0 from "@angular/core";
export declare class SummaryService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: HttpConfiguration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: HttpConfiguration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * Returns basic sums of the users data.
     * Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is used in Firefly III to populate the dashboard.
     * @param start A date formatted YYYY-MM-DD.
     * @param end A date formatted YYYY-MM-DD.
     * @param xTraceId Unique identifier associated with this request.
     * @param currencyCode A currency code like EUR or USD, to filter the result.
     * @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.
     */
    getBasicSummary(start: string, end: string, xTraceId?: string, currencyCode?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<{
        [key: string]: BasicSummaryEntry;
    }>;
    getBasicSummary(start: string, end: string, xTraceId?: string, currencyCode?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<{
        [key: string]: BasicSummaryEntry;
    }>>;
    getBasicSummary(start: string, end: string, xTraceId?: string, currencyCode?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<{
        [key: string]: BasicSummaryEntry;
    }>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<SummaryService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<SummaryService>;
}