@finbourne/lusid-sdk-angular18/lib/.generated/api/stagedModifications.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 { PagedResourceListOfStagedModification } from '../model/pagedResourceListOfStagedModification';
import { PagedResourceListOfStagedModificationsRequestedChangeInterval } from '../model/pagedResourceListOfStagedModificationsRequestedChangeInterval';
import { StagedModification } from '../model/stagedModification';
import { StagedModificationDecisionRequest } from '../model/stagedModificationDecisionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface AddDecisionRequestParams {
    /** Unique Id for a staged modification.. */
    id: string;
    /** The decision on the requested staged modification, \"Approve\" or \"Reject\". */
    stagedModificationDecisionRequest: StagedModificationDecisionRequest;
}
export interface GetStagedModificationRequestParams {
    /** The unique identifier for a staged modification. */
    id: string;
    /** The asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified. */
    asAt?: string;
}
export interface ListRequestedChangesRequestParams {
    /** Unique Id for a staged modification.. */
    id: string;
    /** The asAt datetime at which to list changes. Defaults to return the latest version              of each staged change if not specified. */
    asAt?: string;
    /** The pagination token to use to continue listing requested staged modification changes from a previous call to list requested              staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt              and asAt fields must not have changed since the original request. */
    page?: string;
    /** When paginating, limit the number of returned results to this many. 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;
    /** A list of field names suffixed by \" ASC\" or \" DESC\" */
    sortBy?: Array<string>;
}
export interface ListStagedModificationsRequestParams {
    /** The asAt datetime at which to list staged modifications. Defaults to return the latest version              of each staged modification if not specified. */
    asAt?: string;
    /** The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This              value is returned from the previous call. If a pagination token is provided the filter, effectiveAt              and asAt fields must not have changed since the original request. */
    page?: string;
    /** When paginating, limit the number of returned results to this many. 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;
    /** A list of field names suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot; */
    sortBy?: Array<string>;
}
export declare class StagedModificationsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * AddDecision: AddDecision
     * Add decision to staged modification, Approve or Reject.
     * @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.
     */
    addDecision(requestParameters?: AddDecisionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<StagedModification>;
    addDecision(requestParameters?: AddDecisionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<StagedModification>>;
    addDecision(requestParameters?: AddDecisionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<StagedModification>>;
    /**
     * GetStagedModification: GetStagedModification
     * Retrieve the details of a staged modification.
     * @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.
     */
    getStagedModification(requestParameters?: GetStagedModificationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<StagedModification>;
    getStagedModification(requestParameters?: GetStagedModificationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<StagedModification>>;
    getStagedModification(requestParameters?: GetStagedModificationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<StagedModification>>;
    /**
     * ListRequestedChanges: ListRequestedChanges
     * List the requested changes for a staged modification.
     * @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.
     */
    listRequestedChanges(requestParameters?: ListRequestedChangesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfStagedModificationsRequestedChangeInterval>;
    listRequestedChanges(requestParameters?: ListRequestedChangesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfStagedModificationsRequestedChangeInterval>>;
    listRequestedChanges(requestParameters?: ListRequestedChangesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfStagedModificationsRequestedChangeInterval>>;
    /**
     * ListStagedModifications: ListStagedModifications
     * List summaries of the staged modifications.
     * @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.
     */
    listStagedModifications(requestParameters?: ListStagedModificationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfStagedModification>;
    listStagedModifications(requestParameters?: ListStagedModificationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfStagedModification>>;
    listStagedModifications(requestParameters?: ListStagedModificationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfStagedModification>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<StagedModificationsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<StagedModificationsService>;
}