@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
106 lines (105 loc) • 6.86 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AddressKeyDefinition } from '../model/addressKeyDefinition';
import { CreateAddressKeyDefinitionRequest } from '../model/createAddressKeyDefinitionRequest';
import { PagedResourceListOfAddressKeyDefinition } from '../model/pagedResourceListOfAddressKeyDefinition';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateAddressKeyDefinitionRequestParams {
/** The request used to create the address key definition. */
createAddressKeyDefinitionRequest: CreateAddressKeyDefinitionRequest;
}
export interface GetAddressKeyDefinitionRequestParams {
/** The address key of the address key definition. */
key: string;
/** The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. */
asAt?: string;
}
export interface ListAddressKeyDefinitionsRequestParams {
/** The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. */
asAt?: string;
/** The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. 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;
/** 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;
}
export declare class AddressKeyDefinitionService {
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] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
* Create the given address key 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.
*/
createAddressKeyDefinition(requestParameters?: CreateAddressKeyDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AddressKeyDefinition>;
createAddressKeyDefinition(requestParameters?: CreateAddressKeyDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AddressKeyDefinition>>;
createAddressKeyDefinition(requestParameters?: CreateAddressKeyDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AddressKeyDefinition>>;
/**
* [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
* Get the address key definition with the given address key at the specific asAt time.
* @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.
*/
getAddressKeyDefinition(requestParameters?: GetAddressKeyDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AddressKeyDefinition>;
getAddressKeyDefinition(requestParameters?: GetAddressKeyDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AddressKeyDefinition>>;
getAddressKeyDefinition(requestParameters?: GetAddressKeyDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AddressKeyDefinition>>;
/**
* [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
* Fetch the last pre-AsAt date version of each address key 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.
*/
listAddressKeyDefinitions(requestParameters?: ListAddressKeyDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfAddressKeyDefinition>;
listAddressKeyDefinitions(requestParameters?: ListAddressKeyDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfAddressKeyDefinition>>;
listAddressKeyDefinitions(requestParameters?: ListAddressKeyDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfAddressKeyDefinition>>;
static ɵfac: i0.ɵɵFactoryDeclaration<AddressKeyDefinitionService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<AddressKeyDefinitionService>;
}