@finbourne/lusid-sdk-angular18/lib/.generated/api/aggregatedReturns.service.d.ts

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { ResourceListOfReturnsEntity } from '../model/resourceListOfReturnsEntity';
import { ReturnsEntity } from '../model/returnsEntity';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface DeleteReturnsEntityRequestParams {
    /** Returns entity scope. */
    scope: string;
    /** Returns entity code. */
    code: string;
}
export interface GetReturnsEntityRequestParams {
    /** Returns entity scope. */
    scope: string;
    /** Returns entity code. */
    code: string;
    /** The asAt datetime at which to retrieve the returns entity. Defaults to return              the latest version of the definition if not specified. */
    asAt?: string;
}
export interface ListReturnsEntitiesRequestParams {
    /** The asAt datetime at which to retrieve the relation definitions. Defaults to return              the latest version of each definition if not specified. */
    asAt?: string;
}
export interface UpsertReturnsEntityRequestParams {
    /** Definition of the returns entity. */
    returnsEntity: ReturnsEntity;
}
export declare class AggregatedReturnsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * [EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity.
     * Delete returns entity.
     * @param requestParameters
     * @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.
     */
    deleteReturnsEntity(requestParameters?: DeleteReturnsEntityRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteReturnsEntity(requestParameters?: DeleteReturnsEntityRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteReturnsEntity(requestParameters?: DeleteReturnsEntityRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetReturnsEntity: Get returns entity.
     * Get returns entity.
     * @param requestParameters
     * @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.
     */
    getReturnsEntity(requestParameters?: GetReturnsEntityRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ReturnsEntity>;
    getReturnsEntity(requestParameters?: GetReturnsEntityRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ReturnsEntity>>;
    getReturnsEntity(requestParameters?: GetReturnsEntityRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ReturnsEntity>>;
    /**
     * [EXPERIMENTAL] ListReturnsEntities: List returns entities.
     * List returns entities.
     * @param requestParameters
     * @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.
     */
    listReturnsEntities(requestParameters?: ListReturnsEntitiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfReturnsEntity>;
    listReturnsEntities(requestParameters?: ListReturnsEntitiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfReturnsEntity>>;
    listReturnsEntities(requestParameters?: ListReturnsEntitiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfReturnsEntity>>;
    /**
     * [EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity.
     * Upsert returns entity.
     * @param requestParameters
     * @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.
     */
    upsertReturnsEntity(requestParameters?: UpsertReturnsEntityRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ReturnsEntity>;
    upsertReturnsEntity(requestParameters?: UpsertReturnsEntityRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ReturnsEntity>>;
    upsertReturnsEntity(requestParameters?: UpsertReturnsEntityRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ReturnsEntity>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<AggregatedReturnsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<AggregatedReturnsService>;
}