@finbourne/lusid-sdk-angular18/lib/.generated/api/cutLabelDefinitions.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 { CreateCutLabelDefinitionRequest } from '../model/createCutLabelDefinitionRequest';
import { CutLabelDefinition } from '../model/cutLabelDefinition';
import { PagedResourceListOfCutLabelDefinition } from '../model/pagedResourceListOfCutLabelDefinition';
import { UpdateCutLabelDefinitionRequest } from '../model/updateCutLabelDefinitionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateCutLabelDefinitionRequestParams {
    /** The cut label definition */
    createCutLabelDefinitionRequest?: CreateCutLabelDefinitionRequest;
}
export interface DeleteCutLabelDefinitionRequestParams {
    /** The Code of the Cut Label that is being Deleted */
    code: string;
}
export interface GetCutLabelDefinitionRequestParams {
    /** The Code of the Cut Label that is being queried */
    code: string;
    /** The time at which to get the Cut Label */
    asAt?: string;
}
export interface ListCutLabelDefinitionsRequestParams {
    /** Optional. The As At time at which listed Cut Labels are valid */
    asAt?: string;
    /** Optional. Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName */
    sortBy?: Array<string>;
    /** Optional. When paginating, limit the number of returned results to this many. */
    limit?: number;
    /** Optional. Expression to filter the result set.              For example, to filter on code, use \&quot;code eq \&#39;string\&#39;\&quot;              Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */
    filter?: string;
    /** The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call.  If a pagination token is provided the sortBy, filter, and asAt fields  must not have changed since the original request. */
    page?: string;
}
export interface UpdateCutLabelDefinitionRequestParams {
    /** The Code of the Cut Label that is being updated */
    code: string;
    /** The cut label update definition */
    updateCutLabelDefinitionRequest?: UpdateCutLabelDefinitionRequest;
}
export declare class CutLabelDefinitionsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * CreateCutLabelDefinition: Create a Cut Label
     * Create a Cut Label valid in all scopes
     * @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.
     */
    createCutLabelDefinition(requestParameters?: CreateCutLabelDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CutLabelDefinition>;
    createCutLabelDefinition(requestParameters?: CreateCutLabelDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CutLabelDefinition>>;
    createCutLabelDefinition(requestParameters?: CreateCutLabelDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CutLabelDefinition>>;
    /**
     * DeleteCutLabelDefinition: Delete a Cut Label
     * Delete a specified cut label
     * @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.
     */
    deleteCutLabelDefinition(requestParameters?: DeleteCutLabelDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<string>;
    deleteCutLabelDefinition(requestParameters?: DeleteCutLabelDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<string>>;
    deleteCutLabelDefinition(requestParameters?: DeleteCutLabelDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<string>>;
    /**
     * GetCutLabelDefinition: Get a Cut Label
     * Get a specified cut label at a given time
     * @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.
     */
    getCutLabelDefinition(requestParameters?: GetCutLabelDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CutLabelDefinition>;
    getCutLabelDefinition(requestParameters?: GetCutLabelDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CutLabelDefinition>>;
    getCutLabelDefinition(requestParameters?: GetCutLabelDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CutLabelDefinition>>;
    /**
     * ListCutLabelDefinitions: List Existing Cut Labels
     * List all the Cut Label Definitions that are valid at the given AsAt time
     * @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.
     */
    listCutLabelDefinitions(requestParameters?: ListCutLabelDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfCutLabelDefinition>;
    listCutLabelDefinitions(requestParameters?: ListCutLabelDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfCutLabelDefinition>>;
    listCutLabelDefinitions(requestParameters?: ListCutLabelDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfCutLabelDefinition>>;
    /**
     * UpdateCutLabelDefinition: Update a Cut Label
     * Update a specified cut label
     * @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.
     */
    updateCutLabelDefinition(requestParameters?: UpdateCutLabelDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CutLabelDefinition>;
    updateCutLabelDefinition(requestParameters?: UpdateCutLabelDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CutLabelDefinition>>;
    updateCutLabelDefinition(requestParameters?: UpdateCutLabelDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CutLabelDefinition>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<CutLabelDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<CutLabelDefinitionsService>;
}