@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AmortisationRuleSet } from '../model/amortisationRuleSet'; import { CreateAmortisationRuleSetRequest } from '../model/createAmortisationRuleSetRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { PagedResourceListOfAmortisationRuleSet } from '../model/pagedResourceListOfAmortisationRuleSet'; import { SetAmortisationRulesRequest } from '../model/setAmortisationRulesRequest'; import { UpdateAmortisationRuleSetDetailsRequest } from '../model/updateAmortisationRuleSetDetailsRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface CreateAmortisationRuleSetRequestParams { /** The scope of the rule set. */ scope: string; /** The contents of the rule set. */ createAmortisationRuleSetRequest: CreateAmortisationRuleSetRequest; } export interface DeleteAmortisationRulesetRequestParams { /** The rule set scope. */ scope: string; /** The rule set code. */ code: string; } export interface GetAmortisationRuleSetRequestParams { /** The rule set scope. */ scope: string; /** The rule set code. */ code: string; /** The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. */ asAt?: string; } export interface ListAmortisationRuleSetsRequestParams { /** The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. */ asAt?: string; /** The pagination token to use to continue listing AmortisationRuleSets; 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 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>; } export interface SetAmortisationRulesRequestParams { /** The rule set scope. */ scope: string; /** The rule set code. */ code: string; /** The contents of the rules. */ setAmortisationRulesRequest: SetAmortisationRulesRequest; } export interface UpdateAmortisationRuleSetDetailsRequestParams { /** The rule set scope. */ scope: string; /** The rule set code. */ code: string; /** The contents of the rule set. */ updateAmortisationRuleSetDetailsRequest: UpdateAmortisationRuleSetDetailsRequest; } export declare class AmortisationRuleSetsService { 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] CreateAmortisationRuleSet: Create an amortisation rule set. * Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. * @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. */ createAmortisationRuleSet(requestParameters?: CreateAmortisationRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AmortisationRuleSet>; createAmortisationRuleSet(requestParameters?: CreateAmortisationRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AmortisationRuleSet>>; createAmortisationRuleSet(requestParameters?: CreateAmortisationRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AmortisationRuleSet>>; /** * [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. * Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. * @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. */ deleteAmortisationRuleset(requestParameters?: DeleteAmortisationRulesetRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteAmortisationRuleset(requestParameters?: DeleteAmortisationRulesetRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteAmortisationRuleset(requestParameters?: DeleteAmortisationRulesetRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set * Retrieves the amortisation rule set definition at the given effective and as at times. * @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. */ getAmortisationRuleSet(requestParameters?: GetAmortisationRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AmortisationRuleSet>; getAmortisationRuleSet(requestParameters?: GetAmortisationRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AmortisationRuleSet>>; getAmortisationRuleSet(requestParameters?: GetAmortisationRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AmortisationRuleSet>>; /** * [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. * Retrieves all amortisation rule sets at the given effective and as at times * @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. */ listAmortisationRuleSets(requestParameters?: ListAmortisationRuleSetsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfAmortisationRuleSet>; listAmortisationRuleSets(requestParameters?: ListAmortisationRuleSetsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfAmortisationRuleSet>>; listAmortisationRuleSets(requestParameters?: ListAmortisationRuleSetsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfAmortisationRuleSet>>; /** * [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. * Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided. * @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. */ setAmortisationRules(requestParameters?: SetAmortisationRulesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AmortisationRuleSet>; setAmortisationRules(requestParameters?: SetAmortisationRulesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AmortisationRuleSet>>; setAmortisationRules(requestParameters?: SetAmortisationRulesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AmortisationRuleSet>>; /** * [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. * Updates the amortisation rule set definition for all effective 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. */ updateAmortisationRuleSetDetails(requestParameters?: UpdateAmortisationRuleSetDetailsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AmortisationRuleSet>; updateAmortisationRuleSetDetails(requestParameters?: UpdateAmortisationRuleSetDetailsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AmortisationRuleSet>>; updateAmortisationRuleSetDetails(requestParameters?: UpdateAmortisationRuleSetDetailsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AmortisationRuleSet>>; static ɵfac: i0.ɵɵFactoryDeclaration<AmortisationRuleSetsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<AmortisationRuleSetsService>; }