@finbourne/lusid-sdk-angular18/lib/.generated/api/sequences.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 { CreateSequenceRequest } from '../model/createSequenceRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
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 interface CreateSequenceRequestParams {
    /** Scope of the sequence. */
    scope: string;
    /** Request to create sequence */
    createSequenceRequest: CreateSequenceRequest;
}
export interface DeleteSequenceRequestParams {
    /** Scope of the sequence. */
    scope: string;
    /** Code of the sequence. This together with stated scope uniquely identifies the sequence. */
    code: string;
}
export interface GetSequenceRequestParams {
    /** Scope of the sequence. */
    scope: string;
    /** Code of the sequence. This together with stated scope uniquely              identifies the sequence. */
    code: string;
}
export interface ListSequencesRequestParams {
    /** The pagination token to use to continue listing sequences from a previous call to list sequences. This  value is returned from the previous call. */
    page?: string;
    /** When paginating, limit the number of returned results to this many. Defaults to 500 if not specified. */
    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;
}
export interface NextRequestParams {
    /** Scope of the sequence. */
    scope: string;
    /** Code of the sequence. This together with stated scope uniquely              identifies the sequence. */
    code: string;
    /** Number of sequences items to return for the specified sequence. Default to 1 if not specified. */
    batch?: number;
}
export declare class SequencesService {
    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] CreateSequence: Create a new sequence
     * Create a new sequence
     * @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.
     */
    createSequence(requestParameters?: CreateSequenceRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<SequenceDefinition>;
    createSequence(requestParameters?: CreateSequenceRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<SequenceDefinition>>;
    createSequence(requestParameters?: CreateSequenceRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<SequenceDefinition>>;
    /**
     * [EARLY ACCESS] DeleteSequence: Delete a sequence
     * Delete a specific sequence                WARNING! Deleting a sequence is an inherently unsafe operation. It would allow a new sequence using the same pattern to be created, which may result in existing values being returned.
     * @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.
     */
    deleteSequence(requestParameters?: DeleteSequenceRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteSequence(requestParameters?: DeleteSequenceRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteSequence(requestParameters?: DeleteSequenceRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EARLY ACCESS] GetSequence: Get a specified sequence
     * Return the details of a specified sequence
     * @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.
     */
    getSequence(requestParameters?: GetSequenceRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<SequenceDefinition>;
    getSequence(requestParameters?: GetSequenceRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<SequenceDefinition>>;
    getSequence(requestParameters?: GetSequenceRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<SequenceDefinition>>;
    /**
     * [EARLY ACCESS] ListSequences: List Sequences
     * List sequences which satisfies filtering criteria.
     * @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.
     */
    listSequences(requestParameters?: ListSequencesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfSequenceDefinition>;
    listSequences(requestParameters?: ListSequencesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfSequenceDefinition>>;
    listSequences(requestParameters?: ListSequencesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfSequenceDefinition>>;
    /**
     * [EARLY ACCESS] Next: Get next values from sequence
     * Get the next set of values from a specified sequence
     * @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.
     */
    next(requestParameters?: NextRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<NextValueInSequenceResponse>;
    next(requestParameters?: NextRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<NextValueInSequenceResponse>>;
    next(requestParameters?: NextRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<NextValueInSequenceResponse>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<SequencesService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<SequencesService>;
}