@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
73 lines (72 loc) • 6.96 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } 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 declare class ParticipationsService {
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] DeleteParticipation: Delete participation
* Delete an participation. Deletion will be valid from the participation\'s creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param scope The participation scope.
* @param code The participation\'s code. This, together with the scope uniquely identifies the participation to delete.
* @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(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteParticipation(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteParticipation(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetParticipation: Get Participation
* Fetch a Participation that matches the specified identifier
* @param scope The scope to which the participation belongs.
* @param code The participation\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
* @param propertyKeys 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\".
* @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(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<Participation>;
getParticipation(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Participation>>;
getParticipation(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: 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 asAt The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
* @param page 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.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName.
* @param limit When paginating, limit the number of returned results to this many.
* @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 propertyKeys A list of property keys from the \"Participation\" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. \"Participation/system/Name\".
* @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(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfParticipation>;
listParticipations(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfParticipation>>;
listParticipations(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfParticipation>>;
/**
* [EARLY ACCESS] UpsertParticipations: Upsert Participation
* Upsert; update existing participations with given ids, or create new participations otherwise.
* @param participationSetRequest The collection of participation requests.
* @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(participationSetRequest?: ParticipationSetRequest, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfParticipation>;
upsertParticipations(participationSetRequest?: ParticipationSetRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfParticipation>>;
upsertParticipations(participationSetRequest?: ParticipationSetRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfParticipation>>;
static ɵfac: i0.ɵɵFactoryDef<ParticipationsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<ParticipationsService>;
}