@finbourne/lusid-sdk-angular8

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { ComplianceRule } from '../model/complianceRule'; import { ComplianceRuleUpsertRequest } from '../model/complianceRuleUpsertRequest'; import { ComplianceRuleUpsertResponse } from '../model/complianceRuleUpsertResponse'; import { ComplianceRunInfo } from '../model/complianceRunInfo'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { ResourceListOfComplianceBreachedOrderInfo } from '../model/resourceListOfComplianceBreachedOrderInfo'; import { ResourceListOfComplianceRule } from '../model/resourceListOfComplianceRule'; import { ResourceListOfComplianceRuleResult } from '../model/resourceListOfComplianceRuleResult'; import { ResourceListOfComplianceRunInfo } from '../model/resourceListOfComplianceRunInfo'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class ComplianceService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * [EXPERIMENTAL] DeleteComplianceRule: Deletes a compliance rule. * Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone. * @param scope The compliance rule scope. * @param code The compliance rule code. * @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. */ deleteComplianceRule(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deleteComplianceRule(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deleteComplianceRule(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. * Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach. * @param runId The RunId that the results should be checked for * @param orderScope Optional. Find rules related to a specific order by providing an Order Scope/Code combination * @param orderCode Optional. Find rules related to a specific order by providing an Order Scope/Code combination * @param limit When paginating, limit the number of returned results to this many. * @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. */ getBreachedOrdersInfo(runId: string, orderScope?: string, orderCode?: string, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfComplianceBreachedOrderInfo>; getBreachedOrdersInfo(runId: string, orderScope?: string, orderCode?: string, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfComplianceBreachedOrderInfo>>; getBreachedOrdersInfo(runId: string, orderScope?: string, orderCode?: string, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfComplianceBreachedOrderInfo>>; /** * [EXPERIMENTAL] GetComplianceRule: Retrieve the definition of single compliance rule. * Retrieves the compliance rule definition at the given effective and as at times. * @param scope The compliance rule scope. * @param code The compliance rule code. * @param effectiveAt The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version 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. */ getComplianceRule(scope: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ComplianceRule>; getComplianceRule(scope: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ComplianceRule>>; getComplianceRule(scope: string, code: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ComplianceRule>>; /** * [EXPERIMENTAL] GetComplianceRunResults: Get the details of a single compliance run. * Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination. * @param runId The unique identifier of the compliance run requested. * @param page The pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. * @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. */ getComplianceRunResults(runId: string, page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfComplianceRuleResult>; getComplianceRunResults(runId: string, page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfComplianceRuleResult>>; getComplianceRunResults(runId: string, page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfComplianceRuleResult>>; /** * [EXPERIMENTAL] ListComplianceRules: List compliance rules, with optional filtering. * For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. * @param effectiveAt The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. * @param page The pagination token to use to continue listing entities; 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. * @param limit When paginating, limit the results to this number. Defaults to 100 if not specified. * @param filter Expression to filter the results. * @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. */ listComplianceRules(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfComplianceRule>; listComplianceRules(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfComplianceRule>>; listComplianceRules(effectiveAt?: string, asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfComplianceRule>>; /** * [EXPERIMENTAL] ListComplianceRunInfo: List historical compliance run ids. * Use this endpoint to fetch a list of all historical compliance runs. * @param asAt Optional. The time at which to get results from. Default : latest * @param page The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. * @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. */ listComplianceRunInfo(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfComplianceRunInfo>; listComplianceRunInfo(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfComplianceRunInfo>>; listComplianceRunInfo(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfComplianceRunInfo>>; /** * [EXPERIMENTAL] RunCompliance: Kick off the compliance check process * Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file. * @param isPreTrade Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false * @param recipeIdScope Required: the scope of the recipe to be used * @param recipeIdCode Optional: The code of the recipe to be used. If left blank, the default recipe will be used. * @param byTaxlots Optional. * @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. */ runCompliance(isPreTrade: boolean, recipeIdScope: string, recipeIdCode?: string, byTaxlots?: boolean, observe?: 'body', reportProgress?: boolean): Observable<ComplianceRunInfo>; runCompliance(isPreTrade: boolean, recipeIdScope: string, recipeIdCode?: string, byTaxlots?: boolean, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ComplianceRunInfo>>; runCompliance(isPreTrade: boolean, recipeIdScope: string, recipeIdCode?: string, byTaxlots?: boolean, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ComplianceRunInfo>>; /** * [EXPERIMENTAL] UpsertComplianceRules: Upsert compliance rules. * To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. * @param requestBody A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule. * @param effectiveAt The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. * @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. */ upsertComplianceRules(requestBody: { [key: string]: ComplianceRuleUpsertRequest; }, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<ComplianceRuleUpsertResponse>; upsertComplianceRules(requestBody: { [key: string]: ComplianceRuleUpsertRequest; }, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ComplianceRuleUpsertResponse>>; upsertComplianceRules(requestBody: { [key: string]: ComplianceRuleUpsertRequest; }, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ComplianceRuleUpsertResponse>>; static ɵfac: i0.ɵɵFactoryDef<ComplianceService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDef<ComplianceService>; }