@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { PagedResourceListOfTransactionTemplate } from '../model/pagedResourceListOfTransactionTemplate'; import { PagedResourceListOfTransactionTemplateSpecification } from '../model/pagedResourceListOfTransactionTemplateSpecification'; import { TransactionTemplate } from '../model/transactionTemplate'; import { TransactionTemplateRequest } from '../model/transactionTemplateRequest'; import { TransactionTemplateSpecification } from '../model/transactionTemplateSpecification'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface CreateTransactionTemplateRequestParams { /** The type of instrument events that the template is applied to. */ instrumentEventType: string; /** The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template */ instrumentType: string; /** The scope in which the template lies. */ scope: string; /** A request defining a new transaction template to be created. */ transactionTemplateRequest: TransactionTemplateRequest; } export interface DeleteTransactionTemplateRequestParams { /** The type of instrument events that the template is applied to. */ instrumentEventType: string; /** The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template */ instrumentType: string; /** The scope of the template. */ scope: string; } export interface GetTransactionTemplateRequestParams { /** The instrument event type of the transaction template */ instrumentEventType: string; /** The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template */ instrumentType: string; /** The scope in which the template lies. When not supplied the scope is \'default\'. */ scope: string; /** The AsAt time of the requested Transaction Template */ asAt?: string; } export interface GetTransactionTemplateSpecificationRequestParams { /** The requested instrument event type. */ instrumentEventType: string; } export interface ListTransactionTemplateSpecificationsRequestParams { /** AsAt of the request */ asAt?: string; /** The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. */ page?: string; /** When paginating, limit the number of returned results to this many. */ limit?: number; /** Expression to filter the result set. 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>; } export interface ListTransactionTemplatesRequestParams { /** The AsAt time at which to retrieve the Transaction Templates */ asAt?: string; /** The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, and asAt fields must not have changed since the original request. */ page?: string; /** When paginating, limit the number of returned results to this many. */ limit?: number; /** Expression to filter the result set. 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>; } export interface UpdateTransactionTemplateRequestParams { /** The type of instrument events that the template is applied to. */ instrumentEventType: string; /** The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template */ instrumentType: string; /** The scope in which the template lies. */ scope: string; /** A request defining the updated values for the transaction template. */ transactionTemplateRequest: TransactionTemplateRequest; } export declare class InstrumentEventTypesService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * CreateTransactionTemplate: Create Transaction Template * Create a transaction template for a particular instrument event type in a scope. * @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. */ createTransactionTemplate(requestParameters?: CreateTransactionTemplateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<TransactionTemplate>; createTransactionTemplate(requestParameters?: CreateTransactionTemplateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<TransactionTemplate>>; createTransactionTemplate(requestParameters?: CreateTransactionTemplateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<TransactionTemplate>>; /** * DeleteTransactionTemplate: Delete Transaction Template * Delete a transaction template for a particular instrument event type in a scope. * @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. */ deleteTransactionTemplate(requestParameters?: DeleteTransactionTemplateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<string>; deleteTransactionTemplate(requestParameters?: DeleteTransactionTemplateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<string>>; deleteTransactionTemplate(requestParameters?: DeleteTransactionTemplateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<string>>; /** * GetTransactionTemplate: Get Transaction Template * Gets the Transaction Template that for the instrument event type within the scope specified. * @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. */ getTransactionTemplate(requestParameters?: GetTransactionTemplateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<TransactionTemplate>; getTransactionTemplate(requestParameters?: GetTransactionTemplateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<TransactionTemplate>>; getTransactionTemplate(requestParameters?: GetTransactionTemplateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<TransactionTemplate>>; /** * GetTransactionTemplateSpecification: Get Transaction Template Specification. * Retrieve the transaction template specification for a particular event 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. */ getTransactionTemplateSpecification(requestParameters?: GetTransactionTemplateSpecificationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<TransactionTemplateSpecification>; getTransactionTemplateSpecification(requestParameters?: GetTransactionTemplateSpecificationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<TransactionTemplateSpecification>>; getTransactionTemplateSpecification(requestParameters?: GetTransactionTemplateSpecificationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<TransactionTemplateSpecification>>; /** * ListTransactionTemplateSpecifications: List Transaction Template Specifications. * Retrieves all transaction template specifications. * @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. */ listTransactionTemplateSpecifications(requestParameters?: ListTransactionTemplateSpecificationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfTransactionTemplateSpecification>; listTransactionTemplateSpecifications(requestParameters?: ListTransactionTemplateSpecificationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfTransactionTemplateSpecification>>; listTransactionTemplateSpecifications(requestParameters?: ListTransactionTemplateSpecificationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfTransactionTemplateSpecification>>; /** * ListTransactionTemplates: List Transaction Templates * Lists all Transaction Templates. * @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. */ listTransactionTemplates(requestParameters?: ListTransactionTemplatesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfTransactionTemplate>; listTransactionTemplates(requestParameters?: ListTransactionTemplatesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfTransactionTemplate>>; listTransactionTemplates(requestParameters?: ListTransactionTemplatesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfTransactionTemplate>>; /** * UpdateTransactionTemplate: Update Transaction Template * Update a transaction template for a particular instrument event type in a scope. * @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. */ updateTransactionTemplate(requestParameters?: UpdateTransactionTemplateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<TransactionTemplate>; updateTransactionTemplate(requestParameters?: UpdateTransactionTemplateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<TransactionTemplate>>; updateTransactionTemplate(requestParameters?: UpdateTransactionTemplateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<TransactionTemplate>>; static ɵfac: i0.ɵɵFactoryDeclaration<InstrumentEventTypesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<InstrumentEventTypesService>; }