UNPKG

@finbourne/lusid-sdk-angular18

Version:

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

209 lines (208 loc) 11.9 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { PagedResourceListOfResourceRecord } from '../model/pagedResourceListOfResourceRecord'; import { ResourceListOfScopeDefinition } from '../model/resourceListOfScopeDefinition'; import { ResourceListOfString } from '../model/resourceListOfString'; import { ResourceRecord } from '../model/resourceRecord'; import { UpsertResourceRecordRequest } from '../model/upsertResourceRecordRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface DeleteResourceRecordRequestParams { /** The scope of the resource record. */ scope: string; /** The code of the resource record. */ code: string; /** The resource identifier of the resource record. */ resourceId: string; } export interface GetResourceRecordRequestParams { /** The scope of the resource record. */ scope: string; /** The code of the resource record. */ code: string; /** The resource identifier of the resource record. */ resourceId: string; /** The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. */ asAt?: string; } export interface ListResourceRecordCodesRequestParams { /** The scope of the resource record. */ scope: string; /** The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. */ asAt?: string; /** Order of the sort - either \&quot;ASC\&quot; or \&quot;DESC\&quot; */ sortOrder?: string; } export interface ListResourceRecordScopesRequestParams { /** The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. */ asAt?: string; /** The pagination token to use to continue listing resource records from a previous call. */ page?: string; /** When paginating, limit the number of returned results to this many. */ limit?: number; } export interface ListResourceRecordsRequestParams { /** The scope of the resource record. */ scope: string; /** The code of the resource record. */ code: string; /** The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified. */ asAt?: string; /** The pagination token to use to continue listing resource records from a previous call. */ page?: string; /** A list of field names to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot; */ 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 UpsertResourceRecordRequestParams { /** The resource record to upsert. */ upsertResourceRecordRequest: UpsertResourceRecordRequest; } export declare class ResourceRecordService { 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] DeleteResourceRecord: Delete a Resource Record * Delete a resource record. * @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. */ deleteResourceRecord(requestParameters?: DeleteResourceRecordRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteResourceRecord(requestParameters?: DeleteResourceRecordRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteResourceRecord(requestParameters?: DeleteResourceRecordRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] GetResourceRecord: Get a Resource Record * Retrieve a resource record 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. */ getResourceRecord(requestParameters?: GetResourceRecordRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceRecord>; getResourceRecord(requestParameters?: GetResourceRecordRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceRecord>>; getResourceRecord(requestParameters?: GetResourceRecordRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceRecord>>; /** * [EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope * List all resource records 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. */ listResourceRecordCodes(requestParameters?: ListResourceRecordCodesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfString>; listResourceRecordCodes(requestParameters?: ListResourceRecordCodesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfString>>; listResourceRecordCodes(requestParameters?: ListResourceRecordCodesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfString>>; /** * [EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes * List all resource records 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. */ listResourceRecordScopes(requestParameters?: ListResourceRecordScopesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfScopeDefinition>; listResourceRecordScopes(requestParameters?: ListResourceRecordScopesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfScopeDefinition>>; listResourceRecordScopes(requestParameters?: ListResourceRecordScopesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfScopeDefinition>>; /** * [EARLY ACCESS] ListResourceRecords: List Resource Records * List all resource records 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. */ listResourceRecords(requestParameters?: ListResourceRecordsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfResourceRecord>; listResourceRecords(requestParameters?: ListResourceRecordsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfResourceRecord>>; listResourceRecords(requestParameters?: ListResourceRecordsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfResourceRecord>>; /** * [EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record * Create or update a resource record. * @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. */ upsertResourceRecord(requestParameters?: UpsertResourceRecordRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceRecord>; upsertResourceRecord(requestParameters?: UpsertResourceRecordRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceRecord>>; upsertResourceRecord(requestParameters?: UpsertResourceRecordRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceRecord>>; static ɵfac: i0.ɵɵFactoryDeclaration<ResourceRecordService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<ResourceRecordService>; }