@nikhil-patil/ngx-firefly-iii-api-client
Version:
OpenAPI client for ngx-firefly-iii-api-client
168 lines (167 loc) • 10.5 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { RecurrenceArray } from '../model/recurrenceArray';
import { RecurrenceSingle } from '../model/recurrenceSingle';
import { RecurrenceStore } from '../model/recurrenceStore';
import { RecurrenceUpdate } from '../model/recurrenceUpdate';
import { TransactionArray } from '../model/transactionArray';
import { TransactionTypeFilter } from '../model/transactionTypeFilter';
import { HttpConfiguration } from '../configuration';
import * as i0 from "@angular/core";
export declare class RecurrencesService {
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 recurring transaction.
* Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted.
* @param id The ID of the recurring transaction.
* @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.
*/
deleteRecurrence(id: string, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<any>;
deleteRecurrence(id: string, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<any>>;
deleteRecurrence(id: string, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<any>>;
/**
* Get a single recurring transaction.
* Get a single recurring transaction.
* @param id The ID of the recurring transaction.
* @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.
*/
getRecurrence(id: string, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RecurrenceSingle>;
getRecurrence(id: string, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RecurrenceSingle>>;
getRecurrence(id: string, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RecurrenceSingle>>;
/**
* List all recurring transactions.
* List all recurring transactions.
* @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.
*/
listRecurrence(xTraceId?: string, limit?: number, page?: number, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RecurrenceArray>;
listRecurrence(xTraceId?: string, limit?: number, page?: number, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RecurrenceArray>>;
listRecurrence(xTraceId?: string, limit?: number, page?: number, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RecurrenceArray>>;
/**
* List all transactions created by a recurring transaction.
* List all transactions created by a recurring transaction, optionally limited to the date ranges specified.
* @param id The ID of the recurring transaction.
* @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. Both the start and end date must be present.
* @param end A date formatted YYYY-MM-DD. Both the start and end date must be present.
* @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.
*/
listTransactionByRecurrence(id: string, xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TransactionArray>;
listTransactionByRecurrence(id: string, xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TransactionArray>>;
listTransactionByRecurrence(id: string, xTraceId?: string, limit?: number, page?: number, start?: string, end?: string, type?: TransactionTypeFilter, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TransactionArray>>;
/**
* Store a new recurring transaction
* Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters.
* @param recurrenceStore JSON array or key=value pairs with the necessary recurring transaction 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.
*/
storeRecurrence(recurrenceStore: RecurrenceStore, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RecurrenceSingle>;
storeRecurrence(recurrenceStore: RecurrenceStore, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RecurrenceSingle>>;
storeRecurrence(recurrenceStore: RecurrenceStore, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RecurrenceSingle>>;
/**
* Update existing recurring transaction.
* Update existing recurring transaction.
* @param id The ID of the recurring transaction.
* @param recurrenceUpdate JSON array with updated recurring transaction 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.
*/
updateRecurrence(id: string, recurrenceUpdate: RecurrenceUpdate, xTraceId?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RecurrenceSingle>;
updateRecurrence(id: string, recurrenceUpdate: RecurrenceUpdate, xTraceId?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RecurrenceSingle>>;
updateRecurrence(id: string, recurrenceUpdate: RecurrenceUpdate, xTraceId?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'application/vnd.api+json' | 'application/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RecurrenceSingle>>;
static ɵfac: i0.ɵɵFactoryDeclaration<RecurrencesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<RecurrencesService>;
}