@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
103 lines (102 loc) • 7.33 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfReferenceListResponse } from '../model/pagedResourceListOfReferenceListResponse';
import { ReferenceListRequest } from '../model/referenceListRequest';
import { ReferenceListResponse } from '../model/referenceListResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class ReferenceListsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EARLY ACCESS] DeleteReferenceList: Delete Reference List
* Delete a Reference List instance.
* @param scope The scope to which the Reference List belongs.
* @param code The Reference List\'s unique identifier.
* @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.
*/
deleteReferenceList(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<DeletedEntityResponse>;
deleteReferenceList(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteReferenceList(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* GetReferenceList: Get Reference List
* Retrieve a Reference List instance at a point in AsAt time.
* @param scope The scope to which the Reference List belongs.
* @param code The Reference List\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified.
* @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.
*/
getReferenceList(scope: string, code: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<ReferenceListResponse>;
getReferenceList(scope: string, code: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<ReferenceListResponse>>;
getReferenceList(scope: string, code: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<ReferenceListResponse>>;
/**
* [EARLY ACCESS] ListReferenceLists: List Reference Lists
* List all the Reference Lists matching particular criteria.
* @param asAt The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified.
* @param page The pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
* @param limit When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
* @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.
*/
listReferenceLists(asAt?: string, page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfReferenceListResponse>;
listReferenceLists(asAt?: string, page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfReferenceListResponse>>;
listReferenceLists(asAt?: string, page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfReferenceListResponse>>;
/**
* [EARLY ACCESS] UpsertReferenceList: Upsert Reference List
* Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.
* @param referenceListRequest The payload describing the Reference List instance.
* @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.
*/
upsertReferenceList(referenceListRequest?: ReferenceListRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<ReferenceListResponse>;
upsertReferenceList(referenceListRequest?: ReferenceListRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<ReferenceListResponse>>;
upsertReferenceList(referenceListRequest?: ReferenceListRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<ReferenceListResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<ReferenceListsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<ReferenceListsService>;
}