@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
82 lines (81 loc) • 8.15 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateRelationshipDefinitionRequest } from '../model/createRelationshipDefinitionRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfRelationshipDefinition } from '../model/pagedResourceListOfRelationshipDefinition';
import { RelationshipDefinition } from '../model/relationshipDefinition';
import { UpdateRelationshipDefinitionRequest } from '../model/updateRelationshipDefinitionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class RelationshipDefinitionsService {
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] CreateRelationshipDefinition: Create Relationship Definition
* Create a new relationship definition to be used for creating relationships between entities.
* @param createRelationshipDefinitionRequest The definition of the new relationship.
* @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.
*/
createRelationshipDefinition(createRelationshipDefinitionRequest: CreateRelationshipDefinitionRequest, observe?: 'body', reportProgress?: boolean): Observable<RelationshipDefinition>;
createRelationshipDefinition(createRelationshipDefinitionRequest: CreateRelationshipDefinitionRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<RelationshipDefinition>>;
createRelationshipDefinition(createRelationshipDefinitionRequest: CreateRelationshipDefinitionRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<RelationshipDefinition>>;
/**
* [EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition
* Delete the definition of the specified relationship.
* @param scope The scope of the relationship definition to be deleted.
* @param code The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.
* @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.
*/
deleteRelationshipDefinition(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteRelationshipDefinition(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteRelationshipDefinition(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetRelationshipDefinition: Get relationship definition
* Retrieve the specified relationship definition
* @param scope The scope of the specified relationship definition.
* @param code The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
* @param asAt The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition 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.
*/
getRelationshipDefinition(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<RelationshipDefinition>;
getRelationshipDefinition(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<RelationshipDefinition>>;
getRelationshipDefinition(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<RelationshipDefinition>>;
/**
* [EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions
* Retrieve one or more specified relationship definitions.
* @param asAt The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.
* @param page The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, asAt field must not have changed since the original request.
* @param limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
* @param filter Expression to filter the result set. For example, to filter on the Scope, use \"scope eq \'ExampleScope\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @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.
*/
listRelationshipDefinitions(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfRelationshipDefinition>;
listRelationshipDefinitions(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfRelationshipDefinition>>;
listRelationshipDefinitions(asAt?: Date, page?: string, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfRelationshipDefinition>>;
/**
* [EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition
* Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.
* @param scope The scope of the relationship definition being updated.
* @param code The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
* @param updateRelationshipDefinitionRequest The details of relationship definition to update.
* @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.
*/
updateRelationshipDefinition(scope: string, code: string, updateRelationshipDefinitionRequest: UpdateRelationshipDefinitionRequest, observe?: 'body', reportProgress?: boolean): Observable<RelationshipDefinition>;
updateRelationshipDefinition(scope: string, code: string, updateRelationshipDefinitionRequest: UpdateRelationshipDefinitionRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<RelationshipDefinition>>;
updateRelationshipDefinition(scope: string, code: string, updateRelationshipDefinitionRequest: UpdateRelationshipDefinitionRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<RelationshipDefinition>>;
static ɵfac: i0.ɵɵFactoryDef<RelationshipDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<RelationshipDefinitionsService>;
}