@finbourne/lusid-sdk-angular18/lib/.generated/api/participations.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 { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfParticipation } from '../model/pagedResourceListOfParticipation';
import { Participation } from '../model/participation';
import { ParticipationSetRequest } from '../model/participationSetRequest';
import { ResourceListOfParticipation } from '../model/resourceListOfParticipation';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface DeleteParticipationRequestParams {
    /** The participation scope. */
    scope: string;
    /** The participation\'s code. This, together with the scope uniquely identifies the participation to delete. */
    code: string;
}
export interface GetParticipationRequestParams {
    /** The scope to which the participation belongs. */
    scope: string;
    /** The participation\'s unique identifier. */
    code: string;
    /** The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. */
    asAt?: string;
    /** A list of property keys from the \"Participation\" domain to decorate onto the participation.              These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\". */
    propertyKeys?: Array<string>;
}
export interface ListParticipationsRequestParams {
    /** The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. */
    asAt?: string;
    /** The pagination token to use to continue listing participations from a previous call to list participations.              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 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;Participation\&quot; domain to decorate onto each participation.                  These take the format {domain}/{scope}/{code} e.g. \&quot;Participation/system/Name\&quot;.                  All properties, except derived properties, are returned by default, without specifying here. */
    propertyKeys?: Array<string>;
}
export interface UpsertParticipationsRequestParams {
    /** The collection of participation requests. */
    participationSetRequest?: ParticipationSetRequest;
}
export declare class ParticipationsService {
    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] DeleteParticipation: Delete participation
     * Delete an participation. Deletion will be valid from the participation\&#39;s creation datetime.  This means that the participation 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.
     */
    deleteParticipation(requestParameters?: DeleteParticipationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteParticipation(requestParameters?: DeleteParticipationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteParticipation(requestParameters?: DeleteParticipationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EARLY ACCESS] GetParticipation: Get Participation
     * Fetch a Participation 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.
     */
    getParticipation(requestParameters?: GetParticipationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<Participation>;
    getParticipation(requestParameters?: GetParticipationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<Participation>>;
    getParticipation(requestParameters?: GetParticipationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<Participation>>;
    /**
     * [EARLY ACCESS] ListParticipations: List Participations
     * Fetch the last pre-AsAt date version of each Participation 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.
     */
    listParticipations(requestParameters?: ListParticipationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfParticipation>;
    listParticipations(requestParameters?: ListParticipationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfParticipation>>;
    listParticipations(requestParameters?: ListParticipationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfParticipation>>;
    /**
     * [EARLY ACCESS] UpsertParticipations: Upsert Participation
     * Upsert; update existing participations with given ids, or create new participations 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.
     */
    upsertParticipations(requestParameters?: UpsertParticipationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfParticipation>;
    upsertParticipations(requestParameters?: UpsertParticipationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfParticipation>>;
    upsertParticipations(requestParameters?: UpsertParticipationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfParticipation>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<ParticipationsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ParticipationsService>;
}