@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
65 lines (64 loc) • 4.52 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CompleteRelation } from '../model/completeRelation';
import { CreateRelationRequest } from '../model/createRelationRequest';
import { DeleteRelationRequest } from '../model/deleteRelationRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class RelationsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EXPERIMENTAL] CreateRelation: Create Relation
* Create a relation between two entity objects by their identifiers
* @param scope The scope of the relation definition
* @param code The code of the relation definition
* @param createRelationRequest The details of the relation to create.
* @param effectiveAt The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime 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.
*/
createRelation(scope: string, code: string, createRelationRequest: CreateRelationRequest, effectiveAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CompleteRelation>;
createRelation(scope: string, code: string, createRelationRequest: CreateRelationRequest, effectiveAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CompleteRelation>>;
createRelation(scope: string, code: string, createRelationRequest: CreateRelationRequest, effectiveAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CompleteRelation>>;
/**
* [EXPERIMENTAL] DeleteRelation: Delete a relation
* Delete a relation between two entity objects represented by their identifiers
* @param scope The scope of the relation definition
* @param code The code of the relation definition
* @param deleteRelationRequest The details of the relation to delete.
* @param effectiveAt The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime 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.
*/
deleteRelation(scope: string, code: string, deleteRelationRequest: DeleteRelationRequest, effectiveAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<DeletedEntityResponse>;
deleteRelation(scope: string, code: string, deleteRelationRequest: DeleteRelationRequest, effectiveAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteRelation(scope: string, code: string, deleteRelationRequest: DeleteRelationRequest, effectiveAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<DeletedEntityResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<RelationsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<RelationsService>;
}