@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CheckDefinition } from '../model/checkDefinition'; import { CreateCheckDefinitionRequest } from '../model/createCheckDefinitionRequest'; import { DeleteDataQualityRule } from '../model/deleteDataQualityRule'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { PagedResourceListOfCheckDefinition } from '../model/pagedResourceListOfCheckDefinition'; import { RunCheckRequest } from '../model/runCheckRequest'; import { RunCheckResponse } from '../model/runCheckResponse'; import { UpdateCheckDefinitionRequest } from '../model/updateCheckDefinitionRequest'; import { UpsertDataQualityRule } from '../model/upsertDataQualityRule'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface CreateCheckDefinitionRequestParams { /** The request containing the details of the Check Definition */ createCheckDefinitionRequest?: CreateCheckDefinitionRequest; } export interface DeleteCheckDefinitionRequestParams { /** The scope of the specified Check Definition. */ scope: string; /** The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. */ code: string; } export interface DeleteRulesRequestParams { /** The scope of the specified Check Definition. */ scope: string; /** The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. */ code: string; /** The request containing the rules to be deleted */ deleteDataQualityRule?: Array<DeleteDataQualityRule>; } export interface GetCheckDefinitionRequestParams { /** The scope of the specified Check Definition. */ scope: string; /** The code of the specified Check Definition. Together with the scope this uniquely identifies the Check Definition. */ code: string; /** The asAt datetime at which to retrieve the Check Definition definition. Defaults to return the latest version of the definition if not specified. */ asAt?: string; /** The effective datetime or cut label at which to retrieve the check definition properties. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** A list of property keys from the \'CheckDefinition\' domain to decorate onto the Check Definition. These must have the format {domain}/{scope}/{code}, for example \'CheckDefinition/system/Name\'. */ propertyKeys?: Array<string>; } export interface ListCheckDefinitionsRequestParams { /** The asAt datetime at which to list the Check Definitions. Defaults to returning the latest version of each Check Definition if not specified. */ asAt?: string; /** The effective datetime or cut label at which to list the Check Definitions. Note that Check Definitions are monotemporal, the effectiveAt is for Timevariant Properties on the Check Definition only. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The pagination token to use to continue listing Check Definitions; 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 results to this number. Defaults to 100 if not specified. */ limit?: number; /** Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq \'MyCheckDefinition\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */ filter?: string; /** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\" */ sortBy?: Array<string>; /** A list of property keys from the \'CheckDefinition\' domain to decorate onto each Check Definition. These must take the format {domain}/{scope}/{code}, for example \'CheckDefinition/Account/id\'. */ propertyKeys?: Array<string>; } export interface RunCheckDefinitionRequestParams { /** Scope of the CheckDefinition to run. */ scope: string; /** Code of the CheckDefinition to run. */ code: string; /** Run request defining what dataset to run against. */ runCheckRequest?: RunCheckRequest; } export interface UpdateCheckDefinitionRequestParams { /** The scope of the specified Check Definition. */ scope: string; /** The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. */ code: string; /** The request containing the updated details of the Check Definition */ updateCheckDefinitionRequest?: UpdateCheckDefinitionRequest; } export interface UpsertRulesRequestParams { /** The scope of the specified Check Definition. */ scope: string; /** The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. */ code: string; /** The request containing the rules to be upserted */ upsertDataQualityRule?: Array<UpsertDataQualityRule>; } export declare class CheckDefinitionsService { 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] CreateCheckDefinition: Create a Check Definition * Creates a Check Definition. Returns the created Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt * @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. */ createCheckDefinition(requestParameters?: CreateCheckDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CheckDefinition>; createCheckDefinition(requestParameters?: CreateCheckDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CheckDefinition>>; createCheckDefinition(requestParameters?: CreateCheckDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CheckDefinition>>; /** * [EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition * The deletion will take effect from the Check Definition deletion datetime. i.e. will no longer exist at any asAt datetime after 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. */ deleteCheckDefinition(requestParameters?: DeleteCheckDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteCheckDefinition(requestParameters?: DeleteCheckDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteCheckDefinition(requestParameters?: DeleteCheckDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition * Delete rules for a given check definition. This will not affect any other rules that are not included in the request. * @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. */ deleteRules(requestParameters?: DeleteRulesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CheckDefinition>; deleteRules(requestParameters?: DeleteRulesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CheckDefinition>>; deleteRules(requestParameters?: DeleteRulesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CheckDefinition>>; /** * [EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code. * Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. * @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. */ getCheckDefinition(requestParameters?: GetCheckDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CheckDefinition>; getCheckDefinition(requestParameters?: GetCheckDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CheckDefinition>>; getCheckDefinition(requestParameters?: GetCheckDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CheckDefinition>>; /** * [EXPERIMENTAL] ListCheckDefinitions: List Check Definitions * List all the Check Definitions matching a 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. */ listCheckDefinitions(requestParameters?: ListCheckDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfCheckDefinition>; listCheckDefinitions(requestParameters?: ListCheckDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfCheckDefinition>>; listCheckDefinitions(requestParameters?: ListCheckDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfCheckDefinition>>; /** * [EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. * Runs a Check Definition against given dataset. * @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. */ runCheckDefinition(requestParameters?: RunCheckDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RunCheckResponse>; runCheckDefinition(requestParameters?: RunCheckDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RunCheckResponse>>; runCheckDefinition(requestParameters?: RunCheckDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RunCheckResponse>>; /** * [EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code * Overwrites an existing Check Definition Update request has the same required fields as Create apart from the id. Returns the updated Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt * @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. */ updateCheckDefinition(requestParameters?: UpdateCheckDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CheckDefinition>; updateCheckDefinition(requestParameters?: UpdateCheckDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CheckDefinition>>; updateCheckDefinition(requestParameters?: UpdateCheckDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CheckDefinition>>; /** * [EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition * Upsert rules for a given check definition. This will not affect any other rules that are not included in the request. * @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. */ upsertRules(requestParameters?: UpsertRulesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CheckDefinition>; upsertRules(requestParameters?: UpsertRulesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CheckDefinition>>; upsertRules(requestParameters?: UpsertRulesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CheckDefinition>>; static ɵfac: i0.ɵɵFactoryDeclaration<CheckDefinitionsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<CheckDefinitionsService>; }