@finbourne/lusid-sdk-angular16/lib/.generated/api/instrumentEventTypes.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 { 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 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;
    /**
     * [EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template
     * Create a transaction template for a particular instrument event type in a scope.
     * @param instrumentEventType The type of instrument events that the template is applied to.
     * @param instrumentType The instrument type of the transaction template. The combination of the instrument              event type, instrument type and scope uniquely identifies a transaction template
     * @param scope The scope in which the template lies.
     * @param transactionTemplateRequest A request defining a new transaction template to be created.
     * @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(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<TransactionTemplate>;
    createTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<TransactionTemplate>>;
    createTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<TransactionTemplate>>;
    /**
     * [EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template
     * Delete a transaction template for a particular instrument event type in a scope.
     * @param instrumentEventType The type of instrument events that the template is applied to.
     * @param instrumentType The instrument type of the transaction template. The combination of the instrument              event type, instrument type and scope uniquely identifies a transaction template
     * @param scope The scope of the template.
     * @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(instrumentEventType: string, instrumentType: string, scope: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<string>;
    deleteTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<string>>;
    deleteTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<string>>;
    /**
     * [EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template
     * Gets the Transaction Template that for the instrument event type within the scope specified.
     * @param instrumentEventType The instrument event type of the transaction template
     * @param instrumentType The instrument type of the transaction template. The combination of the instrument              event type, instrument type and scope uniquely identifies a transaction template
     * @param scope The scope in which the template lies. When not supplied the scope is \&#39;default\&#39;.
     * @param asAt The AsAt time of the requested Transaction Template
     * @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(instrumentEventType: string, instrumentType: string, scope: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<TransactionTemplate>;
    getTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<TransactionTemplate>>;
    getTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<TransactionTemplate>>;
    /**
     * [EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.
     * Retrieve the transaction template specification for a particular event type.
     * @param instrumentEventType The requested instrument event 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.
     */
    getTransactionTemplateSpecification(instrumentEventType: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<TransactionTemplateSpecification>;
    getTransactionTemplateSpecification(instrumentEventType: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<TransactionTemplateSpecification>>;
    getTransactionTemplateSpecification(instrumentEventType: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<TransactionTemplateSpecification>>;
    /**
     * [EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.
     * Retrieves all transaction template specifications.
     * @param asAt AsAt of the request
     * @param page 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.
     * @param limit When paginating, limit the number of returned results to this many.
     * @param filter Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid.
     * @param sortBy A list of field names 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.
     */
    listTransactionTemplateSpecifications(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<PagedResourceListOfTransactionTemplateSpecification>;
    listTransactionTemplateSpecifications(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<PagedResourceListOfTransactionTemplateSpecification>>;
    listTransactionTemplateSpecifications(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<PagedResourceListOfTransactionTemplateSpecification>>;
    /**
     * [EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates
     * Lists all Transaction Templates.
     * @param asAt The AsAt time at which to retrieve the Transaction Templates
     * @param page 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.
     * @param limit When paginating, limit the number of returned results to this many.
     * @param filter Expression to filter the result set. Read more about filtering results from LUSID here:              https://support.lusid.com/filtering-results-from-lusid.
     * @param sortBy A list of field names 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.
     */
    listTransactionTemplates(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<PagedResourceListOfTransactionTemplate>;
    listTransactionTemplates(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<PagedResourceListOfTransactionTemplate>>;
    listTransactionTemplates(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<PagedResourceListOfTransactionTemplate>>;
    /**
     * [EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template
     * Update a transaction template for a particular instrument event type in a scope.
     * @param instrumentEventType The type of instrument events that the template is applied to.
     * @param instrumentType The instrument type of the transaction template. The combination of the instrument              event type, instrument type and scope uniquely identifies a transaction template
     * @param scope The scope in which the template lies.
     * @param transactionTemplateRequest A request defining the updated values for the transaction template.
     * @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(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<TransactionTemplate>;
    updateTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<TransactionTemplate>>;
    updateTransactionTemplate(instrumentEventType: string, instrumentType: string, scope: string, transactionTemplateRequest: TransactionTemplateRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<TransactionTemplate>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<InstrumentEventTypesService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<InstrumentEventTypesService>;
}