UNPKG

@finbourne/lusid-sdk-angular18

Version:

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

194 lines (193 loc) 11 kB
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 interface CreateFeeTypeRequestParams { /** The scope of the FeeType. */ scope: string; /** The contents of the FeeType. */ feeTypeRequest: FeeTypeRequest; } export interface DeleteFeeTypeRequestParams { /** The scope of the FeeType. */ scope: string; /** The code of the fee type */ code: string; } export interface GetFeeTypeRequestParams { /** The scope of the FeeType */ scope: string; /** The code of the FeeType */ code: string; /** The asAt datetime at which to retrieve the FeeType. Defaults to returning the latest version of the FeeType, if not specified. */ asAt?: string; } export interface ListFeeTypesRequestParams { /** The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified. */ asAt?: string; /** 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. */ 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 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. */ filter?: string; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot; */ sortBy?: Array<string>; } export interface UpdateFeeTypeRequestParams { /** The scope of the FeeType. */ scope: string; /** The code of the fee type */ code: string; /** The contents of the FeeType. */ updateFeeTypeRequest: UpdateFeeTypeRequest; } 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 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. */ createFeeType(requestParameters?: CreateFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FeeType>; createFeeType(requestParameters?: CreateFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FeeType>>; createFeeType(requestParameters?: CreateFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FeeType>>; /** * [EXPERIMENTAL] DeleteFeeType: Delete a FeeType. * Delete a FeeType that contains templates used to create fee transactions. * @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. */ deleteFeeType(requestParameters?: DeleteFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteFeeType(requestParameters?: DeleteFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteFeeType(requestParameters?: DeleteFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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; transferCache?: boolean; }): Observable<FeeTransactionTemplateSpecification>; getFeeTemplateSpecifications(observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FeeTransactionTemplateSpecification>>; getFeeTemplateSpecifications(observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FeeTransactionTemplateSpecification>>; /** * [EXPERIMENTAL] GetFeeType: Get a FeeType * Get a FeeType that contains templates used to create fee transactions. * @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. */ getFeeType(requestParameters?: GetFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FeeType>; getFeeType(requestParameters?: GetFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FeeType>>; getFeeType(requestParameters?: GetFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FeeType>>; /** * [EXPERIMENTAL] ListFeeTypes: List FeeTypes * List FeeTypes that contain templates used to create fee transactions. * @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. */ listFeeTypes(requestParameters?: ListFeeTypesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfFeeType>; listFeeTypes(requestParameters?: ListFeeTypesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfFeeType>>; listFeeTypes(requestParameters?: ListFeeTypesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfFeeType>>; /** * [EXPERIMENTAL] UpdateFeeType: Update a FeeType. * Update a FeeType that contains templates used to create fee transactions. * @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. */ updateFeeType(requestParameters?: UpdateFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<FeeType>; updateFeeType(requestParameters?: UpdateFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<FeeType>>; updateFeeType(requestParameters?: UpdateFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<FeeType>>; static ɵfac: i0.ɵɵFactoryDeclaration<FeeTypesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<FeeTypesService>; }