@finbourne/lusid-sdk-angular16/lib/.generated/api/feeTypes.service.d.ts

An angular (16) 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 { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { FeeTransactionTemplateSpecification } from '../model/feeTransactionTemplateSpecification';
import { FeeType } from '../model/feeType';
import { FeeTypeRequest } from '../model/feeTypeRequest';
import { PagedResourceListOfFeeType } from '../model/pagedResourceListOfFeeType';
import { UpdateFeeTypeRequest } from '../model/updateFeeTypeRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class FeeTypesService {
    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] CreateFeeType: Create a FeeType.
     * Create a FeeType that contains templates used to create fee transactions.
     * @param scope The scope of the FeeType.
     * @param feeTypeRequest The contents of the FeeType.
     * @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.
     */
    createFeeType(scope: string, feeTypeRequest: FeeTypeRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FeeType>;
    createFeeType(scope: string, feeTypeRequest: FeeTypeRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FeeType>>;
    createFeeType(scope: string, feeTypeRequest: FeeTypeRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FeeType>>;
    /**
     * [EXPERIMENTAL] DeleteFeeType: Delete a FeeType.
     * Delete a FeeType that contains templates used to create fee transactions.
     * @param scope The scope of the FeeType.
     * @param code The code of the fee type
     * @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.
     */
    deleteFeeType(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<DeletedEntityResponse>;
    deleteFeeType(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteFeeType(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType.
     * Get FeeTemplateSpecifications used in the FeeType.
     * @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.
     */
    getFeeTemplateSpecifications(observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FeeTransactionTemplateSpecification>;
    getFeeTemplateSpecifications(observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FeeTransactionTemplateSpecification>>;
    getFeeTemplateSpecifications(observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FeeTransactionTemplateSpecification>>;
    /**
     * [EXPERIMENTAL] GetFeeType: Get a FeeType
     * Get a FeeType that contains templates used to create fee transactions.
     * @param scope The scope of the FeeType
     * @param code The code of the FeeType
     * @param asAt The asAt datetime at which to retrieve the FeeType. Defaults to returning the latest version of the FeeType, 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.
     */
    getFeeType(scope: string, code: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FeeType>;
    getFeeType(scope: string, code: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FeeType>>;
    getFeeType(scope: string, code: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FeeType>>;
    /**
     * [EXPERIMENTAL] ListFeeTypes: List FeeTypes
     * List FeeTypes that contain templates used to create fee transactions.
     * @param asAt The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.
     * @param page The pagination token to use to continue listing FeeTypes; 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.              For example, to filter on the Code of the FeeType type, specify \&quot;id.Code eq \&#39;FeeType1\&#39;\&quot;. For more information about filtering              results, see https://support.lusid.com/knowledgebase/article/KA-01914.
     * @param sortBy A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;
     * @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.
     */
    listFeeTypes(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<PagedResourceListOfFeeType>;
    listFeeTypes(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<PagedResourceListOfFeeType>>;
    listFeeTypes(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<PagedResourceListOfFeeType>>;
    /**
     * [EXPERIMENTAL] UpdateFeeType: Update a FeeType.
     * Update a FeeType that contains templates used to create fee transactions.
     * @param scope The scope of the FeeType.
     * @param code The code of the fee type
     * @param updateFeeTypeRequest The contents of the FeeType.
     * @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.
     */
    updateFeeType(scope: string, code: string, updateFeeTypeRequest: UpdateFeeTypeRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<FeeType>;
    updateFeeType(scope: string, code: string, updateFeeTypeRequest: UpdateFeeTypeRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<FeeType>>;
    updateFeeType(scope: string, code: string, updateFeeTypeRequest: UpdateFeeTypeRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<FeeType>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<FeeTypesService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<FeeTypesService>;
}