@nikhil-patil/ngx-firefly-iii-api-client/api/about.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 { CronResult } from '../model/cronResult';
import { SystemInfo } from '../model/systemInfo';
import { UserSingle } from '../model/userSingle';
import { HttpConfiguration } from '../configuration';
import * as i0 from "@angular/core";
export declare class AboutService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: HttpConfiguration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: HttpConfiguration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * System information end point.
     * Returns general system information and versions of the (supporting) software.
     * @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.
     */
    getAbout(xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<SystemInfo>;
    getAbout(xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<SystemInfo>>;
    getAbout(xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<SystemInfo>>;
    /**
     * Cron job endpoint
     * Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint to run the cron. The cron requires the CLI token to be present. The cron job will fire for all users.
     * @param cliToken The CLI token of any user in Firefly III, required to run the cron job.
     * @param xTraceId Unique identifier associated with this request.
     * @param date A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it\&#39;s running on another day.
     * @param force Forces the cron job to fire, regardless of whether it has fired before. This may result in double transactions or weird budgets, so be careful.
     * @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.
     */
    getCron(cliToken: string, xTraceId?: string, date?: string, force?: boolean, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CronResult>;
    getCron(cliToken: string, xTraceId?: string, date?: string, force?: boolean, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CronResult>>;
    getCron(cliToken: string, xTraceId?: string, date?: string, force?: boolean, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CronResult>>;
    /**
     * Currently authenticated user endpoint.
     * Returns the currently authenticated user.
     * @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.
     */
    getCurrentUser(xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<UserSingle>;
    getCurrentUser(xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<UserSingle>>;
    getCurrentUser(xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json' | 'application/vnd.api+json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<UserSingle>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<AboutService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<AboutService>;
}