@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
99 lines (98 loc) • 10.1 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { FeeRule } from '../model/feeRule';
import { FeeRuleUpsertRequest } from '../model/feeRuleUpsertRequest';
import { FeeRuleUpsertResponse } from '../model/feeRuleUpsertResponse';
import { ResourceListOfFeeRule } from '../model/resourceListOfFeeRule';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class TransactionFeesService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
/**
* @param consumes string[] mime-types
* @return true: consumes contains 'multipart/form-data', false: otherwise
*/
private canConsumeForm;
/**
* [EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.
* <br> Deletes the rule for all effective time. <br> The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. <br> This cannot be undone.
* @param code The fee rule code.
* @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.
*/
deleteTransactionFeeRule(code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteTransactionFeeRule(code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteTransactionFeeRule(code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.
* Additionally, matching can be based on the instrument\'s properties, its portfolio properties, and any additional property keys present in the data file.
* @param effectiveAt The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.
* @param instrumentIdentifierType Optional. The unique identifier type to use, eg \'Figi\' or \'LusidInstrumentId\'.
* @param instrumentIdentifier Optional. The Instrument Identifier to get properties for.
* @param portfolioScope Optional. The scope of the portfolio to fetch properties from.
* @param portfolioCode Optional. The code of the portfolio to fetch properties from.
* @param requestBody Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".
* @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.
*/
getApplicableTransactionFees(effectiveAt?: string, asAt?: Date, instrumentIdentifierType?: string, instrumentIdentifier?: string, portfolioScope?: string, portfolioCode?: string, requestBody?: {
[key: string]: string;
}, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfFeeRule>;
getApplicableTransactionFees(effectiveAt?: string, asAt?: Date, instrumentIdentifierType?: string, instrumentIdentifier?: string, portfolioScope?: string, portfolioCode?: string, requestBody?: {
[key: string]: string;
}, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfFeeRule>>;
getApplicableTransactionFees(effectiveAt?: string, asAt?: Date, instrumentIdentifierType?: string, instrumentIdentifier?: string, portfolioScope?: string, portfolioCode?: string, requestBody?: {
[key: string]: string;
}, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfFeeRule>>;
/**
* [EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.
* Retrieves the fee rule definition at the given effective and as at times.
* @param code The fee rule code.
* @param effectiveAt The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version 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.
*/
getTransactionFeeRule(code: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<FeeRule>;
getTransactionFeeRule(code: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<FeeRule>>;
getTransactionFeeRule(code: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<FeeRule>>;
/**
* [EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.
* For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
* @param effectiveAt The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
* @param asAt The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
* @param limit When paginating, limit the results to this number. Defaults to 100 if not specified.
* @param filter Expression to filter the results.
* @param page The pagination token to use to continue listing entities; 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 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.
*/
listTransactionFeeRules(effectiveAt?: string, asAt?: Date, limit?: number, filter?: string, page?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfFeeRule>;
listTransactionFeeRules(effectiveAt?: string, asAt?: Date, limit?: number, filter?: string, page?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfFeeRule>>;
listTransactionFeeRules(effectiveAt?: string, asAt?: Date, limit?: number, filter?: string, page?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfFeeRule>>;
/**
* [EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.
* <br> To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. <br> The upsert is transactional - either all create/update operations will succeed or none of them will.
* @param requestBody A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.
* @param effectiveAt The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. 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.
* @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.
*/
upsertTransactionFeeRules(requestBody: {
[key: string]: FeeRuleUpsertRequest;
}, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<FeeRuleUpsertResponse>;
upsertTransactionFeeRules(requestBody: {
[key: string]: FeeRuleUpsertRequest;
}, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<FeeRuleUpsertResponse>>;
upsertTransactionFeeRules(requestBody: {
[key: string]: FeeRuleUpsertRequest;
}, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<FeeRuleUpsertResponse>>;
static ɵfac: i0.ɵɵFactoryDef<TransactionFeesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<TransactionFeesService>;
}