@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
182 lines (181 loc) • 11.8 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateTransactionFeeTypeRequest } from '../model/createTransactionFeeTypeRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { ResourceListOfTransactionFeeType } from '../model/resourceListOfTransactionFeeType';
import { TransactionFeeType } from '../model/transactionFeeType';
import { UpdateTransactionFeeTypeRequest } from '../model/updateTransactionFeeTypeRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateTransactionFeeTypeRequestParams {
/** The scope of the transaction fee type. */
scope: string;
/** The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. */
code: string;
/** The contents of the transaction fee type. */
createTransactionFeeTypeRequest: CreateTransactionFeeTypeRequest;
}
export interface DeleteTransactionFeeTypeRequestParams {
/** The scope of the transaction fee type. */
scope: string;
/** The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. */
code: string;
}
export interface GetTransactionFeeTypeRequestParams {
/** The scope of the transaction fee type. */
scope: string;
/** The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. */
code: string;
/** The effective datetime at which to retrieve the transaction fee type properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified. */
asAt?: string;
/** The collection of `PropertyKey`s that we want to decorate on the transaction fee type. */
propertyKeys?: Array<string>;
}
export interface ListTransactionFeeTypesRequestParams {
/** The effective datetime at which to retrieve transaction fee type properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified. */
asAt?: string;
/** The pagination token to use to continue listing transaction fee types from a previous call to list transaction fee types. This value is returned from the previous call. If a pagination token is provided the filter, sortBy, effectiveAt and asAt field must not have changed since the original request. */
page?: string;
/** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */
limit?: number;
/** Expression to filter the result set. For example, to filter on the Scope, use \"scope eq \'ExampleScope\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */
filter?: string;
/** A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" */
sortBy?: Array<string>;
/** The collection of `PropertyKey`s to filter on */
propertyKeys?: Array<string>;
}
export interface UpdateTransactionFeeTypeRequestParams {
/** The scope of the transaction fee type. */
scope: string;
/** The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. */
code: string;
/** The updated contents of the transaction fee type. */
updateTransactionFeeTypeRequest: UpdateTransactionFeeTypeRequest;
}
export declare class TransactionFeeTypesService {
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] CreateTransactionFeeType: Create a transaction fee type
* Create a transaction fee type for the specified scope and code.
* @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.
*/
createTransactionFeeType(requestParameters?: CreateTransactionFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TransactionFeeType>;
createTransactionFeeType(requestParameters?: CreateTransactionFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TransactionFeeType>>;
createTransactionFeeType(requestParameters?: CreateTransactionFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TransactionFeeType>>;
/**
* [EXPERIMENTAL] DeleteTransactionFeeType: Delete a transaction fee type
* Delete a transaction fee type for the specified scope and code. To note, this will be a monotemporal delete, meaning that the transaction fee type will be deleted for all effective time (including past and future versions of the transaction fee type).
* @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.
*/
deleteTransactionFeeType(requestParameters?: DeleteTransactionFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteTransactionFeeType(requestParameters?: DeleteTransactionFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteTransactionFeeType(requestParameters?: DeleteTransactionFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetTransactionFeeType: Get a transaction fee type
* Get the transaction fee type for the specified scope and code.
* @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.
*/
getTransactionFeeType(requestParameters?: GetTransactionFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TransactionFeeType>;
getTransactionFeeType(requestParameters?: GetTransactionFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TransactionFeeType>>;
getTransactionFeeType(requestParameters?: GetTransactionFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TransactionFeeType>>;
/**
* [EXPERIMENTAL] ListTransactionFeeTypes: List transaction fee types
* List transaction fee types that match the specified 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.
*/
listTransactionFeeTypes(requestParameters?: ListTransactionFeeTypesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfTransactionFeeType>;
listTransactionFeeTypes(requestParameters?: ListTransactionFeeTypesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfTransactionFeeType>>;
listTransactionFeeTypes(requestParameters?: ListTransactionFeeTypesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfTransactionFeeType>>;
/**
* [EXPERIMENTAL] UpdateTransactionFeeType: Update a transaction fee type
* Update a transaction fee type by providing the new contents of the transaction fee type. The displayName field cannot be updated.
* @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.
*/
updateTransactionFeeType(requestParameters?: UpdateTransactionFeeTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TransactionFeeType>;
updateTransactionFeeType(requestParameters?: UpdateTransactionFeeTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TransactionFeeType>>;
updateTransactionFeeType(requestParameters?: UpdateTransactionFeeTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TransactionFeeType>>;
static ɵfac: i0.ɵɵFactoryDeclaration<TransactionFeeTypesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<TransactionFeeTypesService>;
}