UNPKG

@finbourne/lusid-sdk-angular18

Version:

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

215 lines (214 loc) 15 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AborConfiguration } from '../model/aborConfiguration'; import { AborConfigurationProperties } from '../model/aborConfigurationProperties'; import { AborConfigurationRequest } from '../model/aborConfigurationRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { PagedResourceListOfAborConfiguration } from '../model/pagedResourceListOfAborConfiguration'; import { Property } from '../model/property'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface CreateAborConfigurationRequestParams { /** The scope of the AborConfiguration. */ scope: string; /** The definition of the AborConfiguration. */ aborConfigurationRequest: AborConfigurationRequest; } export interface DeleteAborConfigurationRequestParams { /** The scope of the AborConfiguration to be deleted. */ scope: string; /** The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration. */ code: string; } export interface GetAborConfigurationRequestParams { /** The scope of the AborConfiguration. */ scope: string; /** The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. */ code: string; /** The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified. */ asAt?: string; /** A list of property keys from the \&#39;AborConfiguration\&#39; domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example \&#39;AborConfiguration/Manager/Id\&#39;. If no properties are specified, then no properties will be returned. */ propertyKeys?: Array<string>; } export interface GetAborConfigurationPropertiesRequestParams { /** The scope of the Abor Configuration to list the properties for. */ scope: string; /** The code of the Abor Configuration to list the properties for. Together with the scope this uniquely identifies the Abor Configuration. */ code: string; /** The effective datetime or cut label at which to list the Abor Configuration\&#39;s properties. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to list the Abor Configuration\&#39;s properties. Defaults to return the latest version of each property if not specified. */ asAt?: string; } export interface ListAborConfigurationsRequestParams { /** The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified. */ effectiveAt?: string; /** The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified. */ asAt?: string; /** The pagination token to use to continue listing AborConfiguration; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. */ page?: string; /** When paginating, limit the results to this number. Defaults to 100 if not specified. */ limit?: number; /** Expression to filter the results. For example, to filter on the AborConfiguration type, specify \&quot;id.Code eq \&#39;AborConfiguration1\&#39;\&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */ filter?: string; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */ sortBy?: Array<string>; /** A list of property keys from the \&#39;AborConfiguration\&#39; domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example \&#39;AborConfiguration/Manager/Id\&#39;. */ propertyKeys?: Array<string>; } export interface UpsertAborConfigurationPropertiesRequestParams { /** The scope of the AborConfiguration to update or insert the properties onto. */ scope: string; /** The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. */ code: string; /** The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \&quot;AborConfiguration/Manager/Id\&quot;. */ requestBody?: { [key: string]: Property; }; } export declare class AborConfigurationService { 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] CreateAborConfiguration: Create an AborConfiguration. * Create the given AborConfiguration. * @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. */ createAborConfiguration(requestParameters?: CreateAborConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AborConfiguration>; createAborConfiguration(requestParameters?: CreateAborConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AborConfiguration>>; createAborConfiguration(requestParameters?: CreateAborConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AborConfiguration>>; /** * [EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. * Delete the given AborConfiguration. * @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. */ deleteAborConfiguration(requestParameters?: DeleteAborConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deleteAborConfiguration(requestParameters?: DeleteAborConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteAborConfiguration(requestParameters?: DeleteAborConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. * Retrieve the definition of a particular AborConfiguration. * @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. */ getAborConfiguration(requestParameters?: GetAborConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AborConfiguration>; getAborConfiguration(requestParameters?: GetAborConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AborConfiguration>>; getAborConfiguration(requestParameters?: GetAborConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AborConfiguration>>; /** * [EXPERIMENTAL] GetAborConfigurationProperties: Get Abor Configuration properties * Get all the properties of a single abor Configuration. * @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. */ getAborConfigurationProperties(requestParameters?: GetAborConfigurationPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AborConfigurationProperties>; getAborConfigurationProperties(requestParameters?: GetAborConfigurationPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AborConfigurationProperties>>; getAborConfigurationProperties(requestParameters?: GetAborConfigurationPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AborConfigurationProperties>>; /** * [EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. * List all the AborConfiguration 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. */ listAborConfigurations(requestParameters?: ListAborConfigurationsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfAborConfiguration>; listAborConfigurations(requestParameters?: ListAborConfigurationsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfAborConfiguration>>; listAborConfigurations(requestParameters?: ListAborConfigurationsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfAborConfiguration>>; /** * [EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties * Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain \&#39;AborConfiguration\&#39;. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an &lt;i&gt;effectiveFrom&lt;/i&gt; datetime for which the property is valid, and an &lt;i&gt;effectiveUntil&lt;/i&gt; datetime until which the property is valid. Not supplying an &lt;i&gt;effectiveUntil&lt;/i&gt; datetime results in the property being valid indefinitely, or until the next &lt;i&gt;effectiveFrom&lt;/i&gt; datetime of the property. * @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. */ upsertAborConfigurationProperties(requestParameters?: UpsertAborConfigurationPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<AborConfigurationProperties>; upsertAborConfigurationProperties(requestParameters?: UpsertAborConfigurationPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<AborConfigurationProperties>>; upsertAborConfigurationProperties(requestParameters?: UpsertAborConfigurationPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<AborConfigurationProperties>>; static ɵfac: i0.ɵɵFactoryDeclaration<AborConfigurationService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<AborConfigurationService>; }