@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
73 lines (72 loc) • 6.38 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { Block } from '../model/block';
import { BlockSetRequest } from '../model/blockSetRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfBlock } from '../model/pagedResourceListOfBlock';
import { ResourceListOfBlock } from '../model/resourceListOfBlock';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class BlocksService {
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;
/**
* [EARLY ACCESS] DeleteBlock: Delete block
* Delete an block. Deletion will be valid from the block\'s creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param scope The block scope.
* @param code The block\'s code. This, together with the scope uniquely identifies the block 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.
*/
deleteBlock(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteBlock(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteBlock(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetBlock: Get Block
* Fetch a Block that matches the specified identifier
* @param scope The scope to which the block belongs.
* @param code The block\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
* @param propertyKeys A list of property keys from the \"Block\" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".
* @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.
*/
getBlock(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<Block>;
getBlock(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Block>>;
getBlock(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Block>>;
/**
* [EARLY ACCESS] ListBlocks: List Blocks
* Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).
* @param asAt The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
* @param page The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName.
* @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 propertyKeys A list of property keys from the \"Block\" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. \"Block/system/Name\".
* @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.
*/
listBlocks(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfBlock>;
listBlocks(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfBlock>>;
listBlocks(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfBlock>>;
/**
* [EARLY ACCESS] UpsertBlocks: Upsert Block
* Upsert; update existing blocks with given ids, or create new blocks otherwise.
* @param blockSetRequest The collection of block requests.
* @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.
*/
upsertBlocks(blockSetRequest?: BlockSetRequest, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfBlock>;
upsertBlocks(blockSetRequest?: BlockSetRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfBlock>>;
upsertBlocks(blockSetRequest?: BlockSetRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfBlock>>;
static ɵfac: i0.ɵɵFactoryDef<BlocksService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<BlocksService>;
}