@finbourne/lusid-sdk-angular18

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { Package } from '../model/package'; import { PackageSetRequest } from '../model/packageSetRequest'; import { PagedResourceListOfPackage } from '../model/pagedResourceListOfPackage'; import { ResourceListOfPackage } from '../model/resourceListOfPackage'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface DeletePackageRequestParams { /** The package scope. */ scope: string; /** The package\'s code. This, together with the scope uniquely identifies the package to delete. */ code: string; } export interface GetPackageRequestParams { /** The scope to which the package belongs. */ scope: string; /** The package\'s unique identifier. */ code: string; /** The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. */ asAt?: string; /** A list of property keys from the \"Package\" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". */ propertyKeys?: Array<string>; } export interface ListPackagesRequestParams { /** The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. */ asAt?: string; /** The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. */ page?: string; /** A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; /** A list of property keys from the \"Package\" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. \"Package/system/Name\". All properties, except derived properties, are returned by default, without specifying here. */ propertyKeys?: Array<string>; } export interface UpsertPackagesRequestParams { /** The collection of package requests. */ packageSetRequest?: PackageSetRequest; } export declare class PackagesService { 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] DeletePackage: Delete package * Delete an package. Deletion will be valid from the package\'s creation datetime. This means that the package will no longer exist at any effective datetime from the asAt datetime of deletion. * @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. */ deletePackage(requestParameters?: DeletePackageRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<DeletedEntityResponse>; deletePackage(requestParameters?: DeletePackageRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<DeletedEntityResponse>>; deletePackage(requestParameters?: DeletePackageRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetPackage: Get Package * Fetch a Package that matches the specified 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. */ getPackage(requestParameters?: GetPackageRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<Package>; getPackage(requestParameters?: GetPackageRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<Package>>; getPackage(requestParameters?: GetPackageRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<Package>>; /** * [EXPERIMENTAL] ListPackages: List Packages * Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). * @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. */ listPackages(requestParameters?: ListPackagesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfPackage>; listPackages(requestParameters?: ListPackagesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfPackage>>; listPackages(requestParameters?: ListPackagesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfPackage>>; /** * [EXPERIMENTAL] UpsertPackages: Upsert Package * Upsert; update existing packages with given ids, or create new packages otherwise. * @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. */ upsertPackages(requestParameters?: UpsertPackagesRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfPackage>; upsertPackages(requestParameters?: UpsertPackagesRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfPackage>>; upsertPackages(requestParameters?: UpsertPackagesRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfPackage>>; static ɵfac: i0.ɵɵFactoryDeclaration<PackagesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<PackagesService>; }