@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
81 lines (80 loc) • 4.42 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } 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 interface CreateRelationshipRequestParams {
/** The scope of the relationship */
scope: string;
/** The code of the relationship */
code: string;
/** The details of the relationship to create. */
createRelationshipRequest: CreateRelationshipRequest;
}
export interface DeleteRelationshipRequestParams {
/** The scope of the relationship */
scope: string;
/** The code of the relationship */
code: string;
/** The details of the relationship to delete. */
deleteRelationshipRequest: DeleteRelationshipRequest;
}
export declare class RelationshipsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* CreateRelationship: Create Relationship
* Create a relationship between two entity objects by their identifiers
* @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.
*/
createRelationship(requestParameters?: CreateRelationshipRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CompleteRelationship>;
createRelationship(requestParameters?: CreateRelationshipRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CompleteRelationship>>;
createRelationship(requestParameters?: CreateRelationshipRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CompleteRelationship>>;
/**
* [EARLY ACCESS] DeleteRelationship: Delete Relationship
* Delete a relationship between two entity objects represented by their identifiers
* @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.
*/
deleteRelationship(requestParameters?: DeleteRelationshipRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteRelationship(requestParameters?: DeleteRelationshipRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteRelationship(requestParameters?: DeleteRelationshipRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<RelationshipsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<RelationshipsService>;
}