@finbourne/lusid-sdk-angular16/lib/.generated/api/stagingRuleSet.service.d.ts

An angular (16) 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 { CreateStagingRuleSetRequest } from '../model/createStagingRuleSetRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfStagingRuleSet } from '../model/pagedResourceListOfStagingRuleSet';
import { StagingRuleSet } from '../model/stagingRuleSet';
import { UpdateStagingRuleSetRequest } from '../model/updateStagingRuleSetRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class StagingRuleSetService {
    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] CreateStagingRuleSet: Create a StagingRuleSet
     * Create a new staging rule set.
     * @param entityType The entity type for which to create the staging rule set.
     * @param createStagingRuleSetRequest Request to create a staging rule set.
     * @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.
     */
    createStagingRuleSet(entityType: string, createStagingRuleSetRequest: CreateStagingRuleSetRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<StagingRuleSet>;
    createStagingRuleSet(entityType: string, createStagingRuleSetRequest: CreateStagingRuleSetRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<StagingRuleSet>>;
    createStagingRuleSet(entityType: string, createStagingRuleSetRequest: CreateStagingRuleSetRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<StagingRuleSet>>;
    /**
     * [EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet
     * Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set\&#39;s creation datetime.  This means that the staging rule set will no longer exist at any effective datetime from the asAt datetime of deletion.
     * @param entityType The entity type for which to delete the staging rule set.
     * @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.
     */
    deleteStagingRuleSet(entityType: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<DeletedEntityResponse>;
    deleteStagingRuleSet(entityType: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteStagingRuleSet(entityType: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet
     * Get the staging rule set for the given entity type at the specific asAt time.
     * @param entityType The entity type for which to retrieve the staging rule set.
     * @param asAt The asAt datetime at which to retrieve the staging rule set. Defaults to return the latest              version of the staging rule set 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.
     */
    getStagingRuleSet(entityType: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<StagingRuleSet>;
    getStagingRuleSet(entityType: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<StagingRuleSet>>;
    getStagingRuleSet(entityType: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<StagingRuleSet>>;
    /**
     * [EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets
     * List all the staging rule sets matching particular criteria.
     * @param asAt The asAt datetime at which to retrieve the staging rule sets. Defaults to return the latest              version of the staging rule sets if not specified.
     * @param page The pagination token to use to continue listing staging rule sets from a previous call to list              staging rule sets. This value is returned from the previous call. If a pagination token is provided the sortBy,              filter, effectiveAt, and asAt fields must not have changed since the original request.
     * @param sortBy A list of field names to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;
     * @param limit When paginating, limit the number of returned results to this many.
     * @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.
     */
    listStagingRuleSets(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<PagedResourceListOfStagingRuleSet>;
    listStagingRuleSets(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<PagedResourceListOfStagingRuleSet>>;
    listStagingRuleSets(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<PagedResourceListOfStagingRuleSet>>;
    /**
     * [EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet
     * Update an existing staging rule set.
     * @param entityType The entity type for which to update the staging rule set.
     * @param updateStagingRuleSetRequest Request to update a staging rule set.
     * @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.
     */
    updateStagingRuleSet(entityType: string, updateStagingRuleSetRequest: UpdateStagingRuleSetRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<StagingRuleSet>;
    updateStagingRuleSet(entityType: string, updateStagingRuleSetRequest: UpdateStagingRuleSetRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<StagingRuleSet>>;
    updateStagingRuleSet(entityType: string, updateStagingRuleSetRequest: UpdateStagingRuleSetRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<StagingRuleSet>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<StagingRuleSetService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<StagingRuleSetService>;
}