@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
68 lines (67 loc) • 6.23 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AnnulSingleStructuredDataResponse } from '../model/annulSingleStructuredDataResponse';
import { GetRecipeResponse } from '../model/getRecipeResponse';
import { ResourceListOfGetRecipeResponse } from '../model/resourceListOfGetRecipeResponse';
import { UpsertRecipeRequest } from '../model/upsertRecipeRequest';
import { UpsertSingleStructuredDataResponse } from '../model/upsertSingleStructuredDataResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class ConfigurationRecipeService {
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;
/**
* DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.
* Delete the specified Configuration Recipe 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 Configuration Recipe to delete.
* @param code The Configuration Recipe 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.
*/
deleteConfigurationRecipe(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<AnnulSingleStructuredDataResponse>;
deleteConfigurationRecipe(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulSingleStructuredDataResponse>>;
deleteConfigurationRecipe(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulSingleStructuredDataResponse>>;
/**
* GetConfigurationRecipe: Get Configuration Recipe
* Get a Configuration Recipe from a single scope. The response will return either the recipe 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 Configuration Recipe to retrieve.
* @param code The name of the recipe to retrieve the data for.
* @param asAt The asAt datetime at which to retrieve the Configuration Recipe. 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.
*/
getConfigurationRecipe(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<GetRecipeResponse>;
getConfigurationRecipe(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetRecipeResponse>>;
getConfigurationRecipe(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetRecipeResponse>>;
/**
* ListConfigurationRecipes: List the set of Configuration Recipes
* List the set of configuration recipes at the specified date/time and scope
* @param asAt The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
* @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 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.
*/
listConfigurationRecipes(asAt?: Date, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfGetRecipeResponse>;
listConfigurationRecipes(asAt?: Date, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfGetRecipeResponse>>;
listConfigurationRecipes(asAt?: Date, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfGetRecipeResponse>>;
/**
* UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid.
* Update or insert one Configuration Recipe 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 Configuration Recipe or failure message if unsuccessful It is important to always check to verify success (or failure).
* @param upsertRecipeRequest The Configuration Recipe 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.
*/
upsertConfigurationRecipe(upsertRecipeRequest: UpsertRecipeRequest, observe?: 'body', reportProgress?: boolean): Observable<UpsertSingleStructuredDataResponse>;
upsertConfigurationRecipe(upsertRecipeRequest: UpsertRecipeRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertSingleStructuredDataResponse>>;
upsertConfigurationRecipe(upsertRecipeRequest: UpsertRecipeRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertSingleStructuredDataResponse>>;
static ɵfac: i0.ɵɵFactoryDef<ConfigurationRecipeService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<ConfigurationRecipeService>;
}