@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
166 lines (165 loc) • 10.1 kB
TypeScript
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 interface CreateStagingRuleSetRequestParams {
/** The entity type for which to create the staging rule set. */
entityType: string;
/** Request to create a staging rule set. */
createStagingRuleSetRequest: CreateStagingRuleSetRequest;
}
export interface DeleteStagingRuleSetRequestParams {
/** The entity type for which to delete the staging rule set. */
entityType: string;
}
export interface GetStagingRuleSetRequestParams {
/** The entity type for which to retrieve the staging rule set. */
entityType: string;
/** 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. */
asAt?: string;
}
export interface ListStagingRuleSetsRequestParams {
/** 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. */
asAt?: string;
/** 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. */
page?: string;
/** A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" */
sortBy?: Array<string>;
/** When paginating, limit the number of returned results to this many. */
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 UpdateStagingRuleSetRequestParams {
/** The entity type for which to update the staging rule set. */
entityType: string;
/** Request to update a staging rule set. */
updateStagingRuleSetRequest: UpdateStagingRuleSetRequest;
}
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;
/**
* CreateStagingRuleSet: Create a StagingRuleSet
* Create a new staging rule set.
* @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.
*/
createStagingRuleSet(requestParameters?: CreateStagingRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<StagingRuleSet>;
createStagingRuleSet(requestParameters?: CreateStagingRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<StagingRuleSet>>;
createStagingRuleSet(requestParameters?: CreateStagingRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<StagingRuleSet>>;
/**
* DeleteStagingRuleSet: Delete a StagingRuleSet
* Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set\'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 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.
*/
deleteStagingRuleSet(requestParameters?: DeleteStagingRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteStagingRuleSet(requestParameters?: DeleteStagingRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteStagingRuleSet(requestParameters?: DeleteStagingRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* GetStagingRuleSet: Get a StagingRuleSet
* Get the staging rule set for the given entity type at the specific 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.
*/
getStagingRuleSet(requestParameters?: GetStagingRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<StagingRuleSet>;
getStagingRuleSet(requestParameters?: GetStagingRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<StagingRuleSet>>;
getStagingRuleSet(requestParameters?: GetStagingRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<StagingRuleSet>>;
/**
* ListStagingRuleSets: List StagingRuleSets
* List all the staging rule sets 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.
*/
listStagingRuleSets(requestParameters?: ListStagingRuleSetsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfStagingRuleSet>;
listStagingRuleSets(requestParameters?: ListStagingRuleSetsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfStagingRuleSet>>;
listStagingRuleSets(requestParameters?: ListStagingRuleSetsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfStagingRuleSet>>;
/**
* UpdateStagingRuleSet: Update a StagingRuleSet
* Update an existing staging rule set.
* @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.
*/
updateStagingRuleSet(requestParameters?: UpdateStagingRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<StagingRuleSet>;
updateStagingRuleSet(requestParameters?: UpdateStagingRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<StagingRuleSet>>;
updateStagingRuleSet(requestParameters?: UpdateStagingRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<StagingRuleSet>>;
static ɵfac: i0.ɵɵFactoryDeclaration<StagingRuleSetService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<StagingRuleSetService>;
}