@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
104 lines (103 loc) • 6.12 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateRelationDefinitionRequest } from '../model/createRelationDefinitionRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { RelationDefinition } from '../model/relationDefinition';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateRelationDefinitionRequestParams {
/** The definition of the new relation. */
createRelationDefinitionRequest: CreateRelationDefinitionRequest;
}
export interface DeleteRelationDefinitionRequestParams {
/** The scope of the relation to be deleted. */
scope: string;
/** The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. */
code: string;
}
export interface GetRelationDefinitionRequestParams {
/** The scope of the specified relation. */
scope: string;
/** The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. */
code: string;
/** The asAt datetime at which to retrieve the relation definition. Defaults to return the latest version of the definition if not specified. */
asAt?: string;
}
export declare class RelationDefinitionsService {
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] CreateRelationDefinition: Create a relation definition
* Define a new relation.
* @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.
*/
createRelationDefinition(requestParameters?: CreateRelationDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RelationDefinition>;
createRelationDefinition(requestParameters?: CreateRelationDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RelationDefinition>>;
createRelationDefinition(requestParameters?: CreateRelationDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RelationDefinition>>;
/**
* [EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition
* Delete the definition of the specified relation.
* @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.
*/
deleteRelationDefinition(requestParameters?: DeleteRelationDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteRelationDefinition(requestParameters?: DeleteRelationDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteRelationDefinition(requestParameters?: DeleteRelationDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetRelationDefinition: Get relation definition
* Retrieve the definition of a specified relation.
* @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.
*/
getRelationDefinition(requestParameters?: GetRelationDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<RelationDefinition>;
getRelationDefinition(requestParameters?: GetRelationDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<RelationDefinition>>;
getRelationDefinition(requestParameters?: GetRelationDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<RelationDefinition>>;
static ɵfac: i0.ɵɵFactoryDeclaration<RelationDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<RelationDefinitionsService>;
}