@finbourne/lusid-sdk-angular8/lib/generated/api/conventions.service.d.ts

An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AnnulSingleStructuredDataResponse } from '../model/annulSingleStructuredDataResponse';
import { GetCdsFlowConventionsResponse } from '../model/getCdsFlowConventionsResponse';
import { GetFlowConventionsResponse } from '../model/getFlowConventionsResponse';
import { GetIndexConventionResponse } from '../model/getIndexConventionResponse';
import { ResourceListOfGetCdsFlowConventionsResponse } from '../model/resourceListOfGetCdsFlowConventionsResponse';
import { ResourceListOfGetFlowConventionsResponse } from '../model/resourceListOfGetFlowConventionsResponse';
import { ResourceListOfGetIndexConventionResponse } from '../model/resourceListOfGetIndexConventionResponse';
import { UpsertCdsFlowConventionsRequest } from '../model/upsertCdsFlowConventionsRequest';
import { UpsertFlowConventionsRequest } from '../model/upsertFlowConventionsRequest';
import { UpsertIndexConventionRequest } from '../model/upsertIndexConventionRequest';
import { UpsertSingleStructuredDataResponse } from '../model/upsertSingleStructuredDataResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class ConventionsService {
    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;
    /**
     * [BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present.
     * Delete the specified CDS Flow Conventions from a single scope.  The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.  It is important to always check for any unsuccessful response.
     * @param scope The scope of the CDS Flow Conventions to delete.
     * @param code The CDS Flow Conventions to delete.
     * @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.
     */
    deleteCdsFlowConventions(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<AnnulSingleStructuredDataResponse>;
    deleteCdsFlowConventions(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulSingleStructuredDataResponse>>;
    deleteCdsFlowConventions(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulSingleStructuredDataResponse>>;
    /**
     * [BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present.
     * Delete the specified conventions from a single scope.  The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.  It is important to always check for any unsuccessful response.
     * @param scope The scope of the Flow Conventions to delete.
     * @param code The Flow Conventions to delete.
     * @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.
     */
    deleteFlowConventions(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<AnnulSingleStructuredDataResponse>;
    deleteFlowConventions(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulSingleStructuredDataResponse>>;
    deleteFlowConventions(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulSingleStructuredDataResponse>>;
    /**
     * [BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present.
     * Delete the specified Index Convention from a single scope.  The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.  It is important to always check for any unsuccessful response.
     * @param scope The scope of the Index Convention to delete.
     * @param code The Index Convention to delete.
     * @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.
     */
    deleteIndexConvention(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<AnnulSingleStructuredDataResponse>;
    deleteIndexConvention(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulSingleStructuredDataResponse>>;
    deleteIndexConvention(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulSingleStructuredDataResponse>>;
    /**
     * [BETA] GetCdsFlowConventions: Get CDS Flow Conventions
     * Get a CDS Flow Conventions from a single scope.  The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful.  It is important to always check for any unsuccessful requests (failures).
     * @param scope The scope of the CDS Flow Conventions to retrieve.
     * @param code The name of the CDS Flow Conventions to retrieve the data for.
     * @param asAt The asAt datetime at which to retrieve the CDS Flow Conventions. Defaults to return 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.
     */
    getCdsFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<GetCdsFlowConventionsResponse>;
    getCdsFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetCdsFlowConventionsResponse>>;
    getCdsFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetCdsFlowConventionsResponse>>;
    /**
     * [BETA] GetFlowConventions: Get Flow Conventions
     * Get a Flow Conventions from a single scope.  The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful.  It is important to always check for any unsuccessful requests (failures).
     * @param scope The scope of the Flow Conventions to retrieve.
     * @param code The name of the Flow Conventions to retrieve the data for.
     * @param asAt The asAt datetime at which to retrieve the Flow Conventions. Defaults to return 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.
     */
    getFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<GetFlowConventionsResponse>;
    getFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetFlowConventionsResponse>>;
    getFlowConventions(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetFlowConventionsResponse>>;
    /**
     * [BETA] GetIndexConvention: Get Index Convention
     * Get a Index Convention from a single scope.  The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful.  It is important to always check for any unsuccessful requests (failures).
     * @param scope The scope of the Index Convention to retrieve.
     * @param code The name of the Index Convention to retrieve the data for.
     * @param asAt The asAt datetime at which to retrieve the Index Convention. Defaults to return 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.
     */
    getIndexConvention(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<GetIndexConventionResponse>;
    getIndexConvention(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetIndexConventionResponse>>;
    getIndexConvention(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetIndexConventionResponse>>;
    /**
     * [BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions
     * List the set of CDS Flow Conventions at the specified date/time
     * @param asAt The asAt datetime at which to list the conventions. Defaults to latest 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.
     */
    listCdsFlowConventions(asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfGetCdsFlowConventionsResponse>;
    listCdsFlowConventions(asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfGetCdsFlowConventionsResponse>>;
    listCdsFlowConventions(asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfGetCdsFlowConventionsResponse>>;
    /**
     * [BETA] ListFlowConventions: List the set of Flow Conventions
     * List the set of Flow Conventions at the specified date/time
     * @param asAt The asAt datetime at which to list the conventions. Defaults to latest 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.
     */
    listFlowConventions(asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfGetFlowConventionsResponse>;
    listFlowConventions(asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfGetFlowConventionsResponse>>;
    listFlowConventions(asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfGetFlowConventionsResponse>>;
    /**
     * [BETA] ListIndexConvention: List the set of Index Conventions
     * List the set of Index Conventions at the specified date/time
     * @param asAt The asAt datetime at which to list the conventions. Defaults to latest 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.
     */
    listIndexConvention(asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfGetIndexConventionResponse>;
    listIndexConvention(asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfGetIndexConventionResponse>>;
    listIndexConvention(asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfGetIndexConventionResponse>>;
    /**
     * [BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions. This creates or updates the data in Lusid.
     * Update or insert CDS Flow Conventions in a single scope. An item will be updated if it already exists  and inserted if it does not.                The response will return the successfully updated or inserted CDS Flow Conventions or failure message if unsuccessful                It is important to always check to verify success (or failure).
     * @param upsertCdsFlowConventionsRequest The CDS Flow Conventions to update or insert
     * @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.
     */
    upsertCdsFlowConventions(upsertCdsFlowConventionsRequest: UpsertCdsFlowConventionsRequest, observe?: 'body', reportProgress?: boolean): Observable<UpsertSingleStructuredDataResponse>;
    upsertCdsFlowConventions(upsertCdsFlowConventionsRequest: UpsertCdsFlowConventionsRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertSingleStructuredDataResponse>>;
    upsertCdsFlowConventions(upsertCdsFlowConventionsRequest: UpsertCdsFlowConventionsRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertSingleStructuredDataResponse>>;
    /**
     * [BETA] UpsertFlowConventions: Upsert Flow Conventions. This creates or updates the data in Lusid.
     * Update or insert Flow Conventions in a single scope. An item will be updated if it already exists  and inserted if it does not.                The response will return the successfully updated or inserted Flow Conventions or failure message if unsuccessful                It is important to always check to verify success (or failure).
     * @param upsertFlowConventionsRequest The Flow Conventions to update or insert
     * @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.
     */
    upsertFlowConventions(upsertFlowConventionsRequest: UpsertFlowConventionsRequest, observe?: 'body', reportProgress?: boolean): Observable<UpsertSingleStructuredDataResponse>;
    upsertFlowConventions(upsertFlowConventionsRequest: UpsertFlowConventionsRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertSingleStructuredDataResponse>>;
    upsertFlowConventions(upsertFlowConventionsRequest: UpsertFlowConventionsRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertSingleStructuredDataResponse>>;
    /**
     * [BETA] UpsertIndexConvention: Upsert a set of Index Convention. This creates or updates the data in Lusid.
     * Update or insert Index Convention in a single scope. An item will be updated if it already exists  and inserted if it does not.                The response will return the successfully updated or inserted Index Convention or failure message if unsuccessful                It is important to always check to verify success (or failure).
     * @param upsertIndexConventionRequest The Index Conventions to update or insert
     * @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.
     */
    upsertIndexConvention(upsertIndexConventionRequest: UpsertIndexConventionRequest, observe?: 'body', reportProgress?: boolean): Observable<UpsertSingleStructuredDataResponse>;
    upsertIndexConvention(upsertIndexConventionRequest: UpsertIndexConventionRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertSingleStructuredDataResponse>>;
    upsertIndexConvention(upsertIndexConventionRequest: UpsertIndexConventionRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertSingleStructuredDataResponse>>;
    static ɵfac: i0.ɵɵFactoryDef<ConventionsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDef<ConventionsService>;
}