@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
73 lines (72 loc) • 6.53 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } 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 declare class PackagesService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
/**
* @param consumes string[] mime-types
* @return true: consumes contains 'multipart/form-data', false: otherwise
*/
private canConsumeForm;
/**
* [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 scope The package scope.
* @param code The package\'s code. This, together with the scope uniquely identifies the package to delete.
* @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(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deletePackage(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deletePackage(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetPackage: Get Package
* Fetch a Package that matches the specified identifier
* @param scope The scope to which the package belongs.
* @param code The package\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
* @param propertyKeys 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\".
* @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(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<Package>;
getPackage(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Package>>;
getPackage(scope: string, code: string, asAt?: Date, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: 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 asAt The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified.
* @param page 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.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName.
* @param limit When paginating, limit the number of returned results to this many.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
* @param propertyKeys 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\".
* @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(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfPackage>;
listPackages(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfPackage>>;
listPackages(asAt?: Date, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfPackage>>;
/**
* [EXPERIMENTAL] UpsertPackages: Upsert Package
* Upsert; update existing packages with given ids, or create new packages otherwise.
* @param packageSetRequest The collection of package requests.
* @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(packageSetRequest?: PackageSetRequest, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfPackage>;
upsertPackages(packageSetRequest?: PackageSetRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfPackage>>;
upsertPackages(packageSetRequest?: PackageSetRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfPackage>>;
static ɵfac: i0.ɵɵFactoryDef<PackagesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<PackagesService>;
}