@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
47 lines (46 loc) • 3.4 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CompleteRelationship } from '../model/completeRelationship';
import { CreateRelationshipRequest } from '../model/createRelationshipRequest';
import { DeleteRelationshipRequest } from '../model/deleteRelationshipRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class RelationshipsService {
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] CreateRelationship: Create Relationship
* Create a relationship between two entity objects by their identifiers
* @param scope The scope of the relationship
* @param code The code of the relationship
* @param createRelationshipRequest The details of the relationship to create.
* @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.
*/
createRelationship(scope: string, code: string, createRelationshipRequest: CreateRelationshipRequest, observe?: 'body', reportProgress?: boolean): Observable<CompleteRelationship>;
createRelationship(scope: string, code: string, createRelationshipRequest: CreateRelationshipRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<CompleteRelationship>>;
createRelationship(scope: string, code: string, createRelationshipRequest: CreateRelationshipRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<CompleteRelationship>>;
/**
* [EARLY ACCESS] DeleteRelationship: Delete Relationship
* Delete a relationship between two entity objects represented by their identifiers
* @param scope The scope of the relationship
* @param code The code of the relationship
* @param deleteRelationshipRequest The details of the relationship 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.
*/
deleteRelationship(scope: string, code: string, deleteRelationshipRequest: DeleteRelationshipRequest, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteRelationship(scope: string, code: string, deleteRelationshipRequest: DeleteRelationshipRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteRelationship(scope: string, code: string, deleteRelationshipRequest: DeleteRelationshipRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
static ɵfac: i0.ɵɵFactoryDef<RelationshipsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<RelationshipsService>;
}