@finbourne/lusid-sdk-angular18/lib/.generated/api/taxRuleSets.service.d.ts

An Angular (18) 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 { CreateTaxRuleSetRequest } from '../model/createTaxRuleSetRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { ResourceListOfTaxRuleSet } from '../model/resourceListOfTaxRuleSet';
import { TaxRuleSet } from '../model/taxRuleSet';
import { UpdateTaxRuleSetRequest } from '../model/updateTaxRuleSetRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateTaxRuleSetRequestParams {
    /** The contents of the rule set. */
    createTaxRuleSetRequest: CreateTaxRuleSetRequest;
    /** The effective datetime or cut label at which the rule set will take effect.  Defaults to the current LUSID system datetime if not specified. */
    effectiveAt?: string;
}
export interface DeleteTaxRuleSetRequestParams {
    /** The rule set scope. */
    scope: string;
    /** The rule set code. */
    code: string;
}
export interface GetTaxRuleSetRequestParams {
    /** 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 ListTaxRuleSetsRequestParams {
    /** 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;
}
export interface UpdateTaxRuleSetRequestParams {
    /** The rule set scope. */
    scope: string;
    /** The rule set code. */
    code: string;
    /** The contents of the rule set. */
    updateTaxRuleSetRequest: UpdateTaxRuleSetRequest;
    /** The effective datetime or cut label at which the rule set will take effect.  Defaults to the current LUSID system datetime if not specified. */
    effectiveAt?: string;
}
export declare class TaxRuleSetsService {
    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] CreateTaxRuleSet: Create a tax rule set.
     * Creates a tax 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.
     */
    createTaxRuleSet(requestParameters?: CreateTaxRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<TaxRuleSet>;
    createTaxRuleSet(requestParameters?: CreateTaxRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<TaxRuleSet>>;
    createTaxRuleSet(requestParameters?: CreateTaxRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<TaxRuleSet>>;
    /**
     * [EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set.
     * Deletes the rule set for all effective time.    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.
     */
    deleteTaxRuleSet(requestParameters?: DeleteTaxRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteTaxRuleSet(requestParameters?: DeleteTaxRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteTaxRuleSet(requestParameters?: DeleteTaxRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set.
     * Retrieves the tax 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.
     */
    getTaxRuleSet(requestParameters?: GetTaxRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<TaxRuleSet>;
    getTaxRuleSet(requestParameters?: GetTaxRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<TaxRuleSet>>;
    getTaxRuleSet(requestParameters?: GetTaxRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<TaxRuleSet>>;
    /**
     * [EXPERIMENTAL] ListTaxRuleSets: List tax rule sets.
     * Retrieves all tax rule set definitions 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.
     */
    listTaxRuleSets(requestParameters?: ListTaxRuleSetsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfTaxRuleSet>;
    listTaxRuleSets(requestParameters?: ListTaxRuleSetsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfTaxRuleSet>>;
    listTaxRuleSets(requestParameters?: ListTaxRuleSetsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfTaxRuleSet>>;
    /**
     * [EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set.
     * Updates the tax rule set definition at the given effective time.  The changes will take place from this effective time until the next effective time that the rule has been updated at.  For example, consider a rule that has been created or updated effective at the first day of the coming month.  An upsert effective from the current day will only change the definition until that day.  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.  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.
     */
    updateTaxRuleSet(requestParameters?: UpdateTaxRuleSetRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<TaxRuleSet>;
    updateTaxRuleSet(requestParameters?: UpdateTaxRuleSetRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<TaxRuleSet>>;
    updateTaxRuleSet(requestParameters?: UpdateTaxRuleSetRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<TaxRuleSet>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<TaxRuleSetsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<TaxRuleSetsService>;
}