@finbourne/lusid-sdk-angular18/lib/.generated/api/relationshipDefinitions.service.d.ts

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } 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 interface CreateRelationshipDefinitionRequestParams {
    /** The definition of the new relationship. */
    createRelationshipDefinitionRequest: CreateRelationshipDefinitionRequest;
}
export interface DeleteRelationshipDefinitionRequestParams {
    /** The scope of the relationship definition to be deleted. */
    scope: string;
    /** The code of the relationship definition to be deleted. Together with the domain and scope this uniquely              identifies the relationship. */
    code: string;
}
export interface GetRelationshipDefinitionRequestParams {
    /** The scope of the specified relationship definition. */
    scope: string;
    /** The code of the specified relationship definition. Together with the domain and scope this uniquely              identifies the relationship definition. */
    code: string;
    /** The asAt datetime at which to retrieve the relationship definition. Defaults to return              the latest version of the definition if not specified. */
    asAt?: string;
}
export interface ListRelationshipDefinitionsRequestParams {
    /** The asAt datetime at which to retrieve the relationship definitions. Defaults to return              the latest version of each definition if not specified. */
    asAt?: string;
    /** 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, sortBy and asAt field  must not have changed since the original request. */
    page?: string;
    /** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */
    limit?: number;
    /** 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. */
    filter?: string;
    /** A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" */
    sortBy?: Array<string>;
}
export interface UpdateRelationshipDefinitionRequestParams {
    /** The scope of the relationship definition being updated. */
    scope: string;
    /** The code of the relationship definition being updated. Together with the scope this uniquely              identifies the relationship definition. */
    code: string;
    /** The details of relationship definition to update. */
    updateRelationshipDefinitionRequest: UpdateRelationshipDefinitionRequest;
}
export declare class RelationshipDefinitionsService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * [EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition
     * Create a new relationship definition to be used for creating relationships between entities.
     * @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.
     */
    createRelationshipDefinition(requestParameters?: CreateRelationshipDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<RelationshipDefinition>;
    createRelationshipDefinition(requestParameters?: CreateRelationshipDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<RelationshipDefinition>>;
    createRelationshipDefinition(requestParameters?: CreateRelationshipDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<RelationshipDefinition>>;
    /**
     * [EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition
     * Delete the definition of the specified relationship.
     * @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.
     */
    deleteRelationshipDefinition(requestParameters?: DeleteRelationshipDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<DeletedEntityResponse>;
    deleteRelationshipDefinition(requestParameters?: DeleteRelationshipDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteRelationshipDefinition(requestParameters?: DeleteRelationshipDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EARLY ACCESS] GetRelationshipDefinition: Get relationship definition
     * Retrieve the specified relationship definition
     * @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.
     */
    getRelationshipDefinition(requestParameters?: GetRelationshipDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<RelationshipDefinition>;
    getRelationshipDefinition(requestParameters?: GetRelationshipDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<RelationshipDefinition>>;
    getRelationshipDefinition(requestParameters?: GetRelationshipDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<RelationshipDefinition>>;
    /**
     * [EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions
     * Retrieve one or more specified relationship definitions.
     * @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.
     */
    listRelationshipDefinitions(requestParameters?: ListRelationshipDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfRelationshipDefinition>;
    listRelationshipDefinitions(requestParameters?: ListRelationshipDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfRelationshipDefinition>>;
    listRelationshipDefinitions(requestParameters?: ListRelationshipDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: 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 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.
     */
    updateRelationshipDefinition(requestParameters?: UpdateRelationshipDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<RelationshipDefinition>;
    updateRelationshipDefinition(requestParameters?: UpdateRelationshipDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<RelationshipDefinition>>;
    updateRelationshipDefinition(requestParameters?: UpdateRelationshipDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<RelationshipDefinition>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<RelationshipDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<RelationshipDefinitionsService>;
}