@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CreateRelationalDatasetDefinitionRequest } from '../model/createRelationalDatasetDefinitionRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { PagedResourceListOfRelationalDatasetDefinition } from '../model/pagedResourceListOfRelationalDatasetDefinition'; import { RelationalDatasetDefinition } from '../model/relationalDatasetDefinition'; import { UpdateRelationalDatasetDefinitionRequest } from '../model/updateRelationalDatasetDefinitionRequest'; import { UpdateRelationalDatasetDetails } from '../model/updateRelationalDatasetDetails'; import { UpdateRelationalDatasetFieldSchema } from '../model/updateRelationalDatasetFieldSchema'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface CreateRelationalDatasetDefinitionRequestParams { /** The relational dataset definition to create. */ createRelationalDatasetDefinitionRequest: CreateRelationalDatasetDefinitionRequest; } export interface DeleteRelationalDatasetDefinitionRequestParams { /** The scope of the relational dataset definition. */ scope: string; /** The code of the relational dataset definition. */ code: string; } export interface GetRelationalDatasetDefinitionRequestParams { /** The scope of the relational dataset definition. */ scope: string; /** The code of the relational dataset definition. */ code: string; /** The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified. */ asAt?: string; } export interface ListRelationalDatasetDefinitionsRequestParams { /** The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified. */ asAt?: string; /** The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions. */ page?: string; /** A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" */ sortBy?: Array<string>; /** When paginating, limit the number of returned results to this many. */ limit?: number; /** Expression to filter the result set. */ filter?: string; } export interface UpdateRelationalDatasetDefinitionRequestParams { /** The scope of the relational dataset definition. */ scope: string; /** The code of the relational dataset definition. */ code: string; /** The updated relational dataset definition. */ updateRelationalDatasetDefinitionRequest?: UpdateRelationalDatasetDefinitionRequest; } export interface UpdateRelationalDatasetDetailsRequestParams { /** The scope of the relational dataset definition. */ scope: string; /** The code of the relational dataset definition. */ code: string; /** The updated details of the relational dataset. */ updateRelationalDatasetDetails?: UpdateRelationalDatasetDetails; } export interface UpdateRelationalDatasetFieldSchemaRequestParams { /** The scope of the relational dataset definition. */ scope: string; /** The code of the relational dataset definition. */ code: string; /** Relational dataset fields to add, update or remove. */ updateRelationalDatasetFieldSchema?: UpdateRelationalDatasetFieldSchema; } export declare class RelationalDatasetDefinitionService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * CreateRelationalDatasetDefinition: Create a Relational Dataset Definition * Create a new relational dataset 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. */ createRelationalDatasetDefinition(requestParameters?: CreateRelationalDatasetDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RelationalDatasetDefinition>; createRelationalDatasetDefinition(requestParameters?: CreateRelationalDatasetDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RelationalDatasetDefinition>>; createRelationalDatasetDefinition(requestParameters?: CreateRelationalDatasetDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RelationalDatasetDefinition>>; /** * DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition * Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. * @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. */ deleteRelationalDatasetDefinition(requestParameters?: DeleteRelationalDatasetDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteRelationalDatasetDefinition(requestParameters?: DeleteRelationalDatasetDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteRelationalDatasetDefinition(requestParameters?: DeleteRelationalDatasetDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * GetRelationalDatasetDefinition: Get a Relational Dataset Definition * Retrieve a relational dataset definition by its identifier. * @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. */ getRelationalDatasetDefinition(requestParameters?: GetRelationalDatasetDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RelationalDatasetDefinition>; getRelationalDatasetDefinition(requestParameters?: GetRelationalDatasetDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RelationalDatasetDefinition>>; getRelationalDatasetDefinition(requestParameters?: GetRelationalDatasetDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RelationalDatasetDefinition>>; /** * ListRelationalDatasetDefinitions: List Relational Dataset Definitions * List all relational dataset definitions matching particular criteria. * @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. */ listRelationalDatasetDefinitions(requestParameters?: ListRelationalDatasetDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfRelationalDatasetDefinition>; listRelationalDatasetDefinitions(requestParameters?: ListRelationalDatasetDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfRelationalDatasetDefinition>>; listRelationalDatasetDefinitions(requestParameters?: ListRelationalDatasetDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfRelationalDatasetDefinition>>; /** * UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition * Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this 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. */ updateRelationalDatasetDefinition(requestParameters?: UpdateRelationalDatasetDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RelationalDatasetDefinition>; updateRelationalDatasetDefinition(requestParameters?: UpdateRelationalDatasetDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RelationalDatasetDefinition>>; updateRelationalDatasetDefinition(requestParameters?: UpdateRelationalDatasetDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RelationalDatasetDefinition>>; /** * UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes * Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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. */ updateRelationalDatasetDetails(requestParameters?: UpdateRelationalDatasetDetailsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RelationalDatasetDefinition>; updateRelationalDatasetDetails(requestParameters?: UpdateRelationalDatasetDetailsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RelationalDatasetDefinition>>; updateRelationalDatasetDetails(requestParameters?: UpdateRelationalDatasetDetailsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RelationalDatasetDefinition>>; /** * UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema * Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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. */ updateRelationalDatasetFieldSchema(requestParameters?: UpdateRelationalDatasetFieldSchemaRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<RelationalDatasetDefinition>; updateRelationalDatasetFieldSchema(requestParameters?: UpdateRelationalDatasetFieldSchemaRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<RelationalDatasetDefinition>>; updateRelationalDatasetFieldSchema(requestParameters?: UpdateRelationalDatasetFieldSchemaRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<RelationalDatasetDefinition>>; static ɵfac: i0.ɵɵFactoryDeclaration<RelationalDatasetDefinitionService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<RelationalDatasetDefinitionService>; }