@finbourne/lusid-sdk-angular18/lib/.generated/api/referenceLists.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 { 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 interface DeleteReferenceListRequestParams {
    /** The scope to which the Reference List belongs. */
    scope: string;
    /** The Reference List\'s unique identifier. */
    code: string;
}
export interface GetReferenceListRequestParams {
    /** The scope to which the Reference List belongs. */
    scope: string;
    /** The Reference List\'s unique identifier. */
    code: string;
    /** The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified. */
    asAt?: string;
}
export interface ListReferenceListsRequestParams {
    /** The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified. */
    asAt?: string;
    /** 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. */
    page?: string;
    /** When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. */
    limit?: number;
    /** Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid. */
    filter?: string;
}
export interface UpsertReferenceListRequestParams {
    /** The payload describing the Reference List instance. */
    referenceListRequest?: ReferenceListRequest;
}
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 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.
     */
    deleteReferenceList(requestParameters?: DeleteReferenceListRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteReferenceList(requestParameters?: DeleteReferenceListRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteReferenceList(requestParameters?: DeleteReferenceListRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * GetReferenceList: Get Reference List
     * Retrieve a Reference List instance at a point in AsAt time.
     * @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.
     */
    getReferenceList(requestParameters?: GetReferenceListRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ReferenceListResponse>;
    getReferenceList(requestParameters?: GetReferenceListRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ReferenceListResponse>>;
    getReferenceList(requestParameters?: GetReferenceListRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ReferenceListResponse>>;
    /**
     * [EARLY ACCESS] ListReferenceLists: List Reference Lists
     * List all the Reference Lists matching particular criteria.
     * @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.
     */
    listReferenceLists(requestParameters?: ListReferenceListsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfReferenceListResponse>;
    listReferenceLists(requestParameters?: ListReferenceListsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfReferenceListResponse>>;
    listReferenceLists(requestParameters?: ListReferenceListsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): 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 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.
     */
    upsertReferenceList(requestParameters?: UpsertReferenceListRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ReferenceListResponse>;
    upsertReferenceList(requestParameters?: UpsertReferenceListRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ReferenceListResponse>>;
    upsertReferenceList(requestParameters?: UpsertReferenceListRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ReferenceListResponse>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<ReferenceListsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ReferenceListsService>;
}