@nikhil-patil/ngx-firefly-iii-api-client

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AttachmentArray } from '../model/attachmentArray'; import { BillArray } from '../model/billArray'; import { BillSingle } from '../model/billSingle'; import { BillStore } from '../model/billStore'; import { BillUpdate } from '../model/billUpdate'; import { RuleArray } from '../model/ruleArray'; import { TransactionArray } from '../model/transactionArray'; import { TransactionTypeFilter } from '../model/transactionTypeFilter'; import { HttpConfiguration } from '../configuration'; import * as i0 from "@angular/core"; export declare class BillsService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: HttpConfiguration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: HttpConfiguration); private addToHttpParams; private addToHttpParamsRecursive; /** * Delete a bill. * Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments. * @param id The ID of the bill. * @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. */ deleteBill(id: string, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<any>; deleteBill(id: string, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<any>>; deleteBill(id: string, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<any>>; /** * Get a single bill. * Get a single bill. * @param id The ID of the bill. * @param xTraceId Unique identifier associated with this request. * @param start A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. * @param end A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. * @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. */ getBill(id: string, xTraceId?: string, start?: string, end?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<BillSingle>; getBill(id: string, xTraceId?: string, start?: string, end?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<BillSingle>>; getBill(id: string, xTraceId?: string, start?: string, end?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<BillSingle>>; /** * List all attachments uploaded to the bill. * This endpoint will list all attachments linked to the bill. * @param id The ID of the bill. * @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 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. */ listAttachmentByBill(id: string, xTraceId?: string, limit?: number, page?: number, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<AttachmentArray>; listAttachmentByBill(id: string, xTraceId?: string, limit?: number, page?: number, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AttachmentArray>>; listAttachmentByBill(id: string, xTraceId?: string, limit?: number, page?: number, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AttachmentArray>>; /** * List all bills. * This endpoint will list all the user\'s bills. * @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. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. * @param end A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. * @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. */ listBill(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<BillArray>; listBill(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<BillArray>>; listBill(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<BillArray>>; /** * List all rules associated with the bill. * This endpoint will list all rules that have an action to set the bill to this bill. * @param id The ID of the bill. * @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. */ listRuleByBill(id: string, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<RuleArray>; listRuleByBill(id: string, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RuleArray>>; listRuleByBill(id: string, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RuleArray>>; /** * List all transactions associated with the bill. * This endpoint will list all transactions linked to this bill. * @param id The ID of the bill. * @param xTraceId Unique identifier associated with this request. * @param start A date formatted YYYY-MM-DD. * @param end A date formatted YYYY-MM-DD. * @param type Optional filter on the transaction type(s) returned * @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. */ listTransactionByBill(id: string, xTraceId?: string, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<TransactionArray>; listTransactionByBill(id: string, xTraceId?: string, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<TransactionArray>>; listTransactionByBill(id: string, xTraceId?: string, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<TransactionArray>>; /** * Store a new bill * Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters. * @param billStore JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. * @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. */ storeBill(billStore: BillStore, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<BillSingle>; storeBill(billStore: BillStore, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<BillSingle>>; storeBill(billStore: BillStore, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<BillSingle>>; /** * Update existing bill. * Update existing bill. * @param id The ID of the bill. * @param billUpdate JSON array or key=value pairs with updated bill information. See the model for the exact specifications. * @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. */ updateBill(id: string, billUpdate: BillUpdate, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<BillSingle>; updateBill(id: string, billUpdate: BillUpdate, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<BillSingle>>; updateBill(id: string, billUpdate: BillUpdate, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' | 'application/vnd.api+json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<BillSingle>>; static ɵfac: i0.ɵɵFactoryDeclaration<BillsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<BillsService>; }