@finbourne/lusid-sdk-angular18/lib/.generated/api/blocks.service.d.ts

An Angular (18) 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 { 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 interface DeleteBlockRequestParams {
    /** The block scope. */
    scope: string;
    /** The block\'s code. This, together with the scope uniquely identifies the block to delete. */
    code: string;
}
export interface GetBlockRequestParams {
    /** The scope to which the block belongs. */
    scope: string;
    /** The block\'s unique identifier. */
    code: string;
    /** The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. */
    asAt?: string;
    /** 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\". */
    propertyKeys?: Array<string>;
}
export interface ListBlocksRequestParams {
    /** The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. */
    asAt?: string;
    /** 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. */
    page?: string;
    /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */
    sortBy?: Array<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 property keys from the \&quot;Block\&quot; domain to decorate onto each block.                  These take the format {domain}/{scope}/{code} e.g. \&quot;Block/system/Name\&quot;.                  All properties, except derived properties, are returned by default, without specifying here. */
    propertyKeys?: Array<string>;
}
export interface UpsertBlocksRequestParams {
    /** The collection of block requests. */
    blockSetRequest?: BlockSetRequest;
}
export declare class BlocksService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * [EARLY ACCESS] DeleteBlock: Delete block
     * Delete an block. Deletion will be valid from the block\&#39;s creation datetime.  This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
     * @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.
     */
    deleteBlock(requestParameters?: DeleteBlockRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteBlock(requestParameters?: DeleteBlockRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteBlock(requestParameters?: DeleteBlockRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EARLY ACCESS] GetBlock: Get Block
     * Fetch a Block that matches the specified identifier
     * @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.
     */
    getBlock(requestParameters?: GetBlockRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<Block>;
    getBlock(requestParameters?: GetBlockRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<Block>>;
    getBlock(requestParameters?: GetBlockRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: 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 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.
     */
    listBlocks(requestParameters?: ListBlocksRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfBlock>;
    listBlocks(requestParameters?: ListBlocksRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfBlock>>;
    listBlocks(requestParameters?: ListBlocksRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfBlock>>;
    /**
     * [EARLY ACCESS] UpsertBlocks: Upsert Block
     * Upsert; update existing blocks with given ids, or create new blocks otherwise.
     * @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.
     */
    upsertBlocks(requestParameters?: UpsertBlocksRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfBlock>;
    upsertBlocks(requestParameters?: UpsertBlocksRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfBlock>>;
    upsertBlocks(requestParameters?: UpsertBlocksRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfBlock>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<BlocksService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<BlocksService>;
}