@finbourne/lusid-sdk-angular8/lib/generated/api/sequences.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 { CreateSequenceRequest } from '../model/createSequenceRequest';
import { NextValueInSequenceResponse } from '../model/nextValueInSequenceResponse';
import { PagedResourceListOfSequenceDefinition } from '../model/pagedResourceListOfSequenceDefinition';
import { SequenceDefinition } from '../model/sequenceDefinition';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class SequencesService {
    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] CreateSequence: Create a new sequence
     * Create a new sequence
     * @param scope Scope of the sequence.
     * @param createSequenceRequest Request to create sequence
     * @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.
     */
    createSequence(scope: string, createSequenceRequest: CreateSequenceRequest, observe?: 'body', reportProgress?: boolean): Observable<SequenceDefinition>;
    createSequence(scope: string, createSequenceRequest: CreateSequenceRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SequenceDefinition>>;
    createSequence(scope: string, createSequenceRequest: CreateSequenceRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SequenceDefinition>>;
    /**
     * [EARLY ACCESS] GetSequence: Get a specified sequence
     * Return the details of a specified sequence
     * @param scope Scope of the sequence.
     * @param code Code of the sequence. This together with stated scope uniquely              identifies the sequence.
     * @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.
     */
    getSequence(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<SequenceDefinition>;
    getSequence(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SequenceDefinition>>;
    getSequence(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SequenceDefinition>>;
    /**
     * [EARLY ACCESS] ListSequences: List Sequences
     * List sequences which satisfies filtering criteria.
     * @param page The pagination token to use to continue listing sequences from a previous call to list sequences. This  value is returned from the previous call.
     * @param limit When paginating, limit the number of returned results to this many. Defaults to 500 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.
     */
    listSequences(page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfSequenceDefinition>;
    listSequences(page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfSequenceDefinition>>;
    listSequences(page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfSequenceDefinition>>;
    /**
     * [EARLY ACCESS] Next: Get next values from sequence
     * Get the next set of values from a specified sequence
     * @param scope Scope of the sequence.
     * @param code Code of the sequence. This together with stated scope uniquely              identifies the sequence.
     * @param batch Number of sequences items to return for the specified sequence. Default to 1 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.
     */
    next(scope: string, code: string, batch?: number, observe?: 'body', reportProgress?: boolean): Observable<NextValueInSequenceResponse>;
    next(scope: string, code: string, batch?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<NextValueInSequenceResponse>>;
    next(scope: string, code: string, batch?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<NextValueInSequenceResponse>>;
    static ɵfac: i0.ɵɵFactoryDef<SequencesService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDef<SequencesService>;
}