@finbourne/lusid-sdk-angular18/lib/.generated/api/addressKeyAlias.service.d.ts

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

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AnnulSingleStructuredDataResponse } from '../model/annulSingleStructuredDataResponse';
import { GetAddressKeyAliasResponse } from '../model/getAddressKeyAliasResponse';
import { PagedResourceListOfGetAddressKeyAliasResponse } from '../model/pagedResourceListOfGetAddressKeyAliasResponse';
import { UpsertAddressKeyAliasRequest } from '../model/upsertAddressKeyAliasRequest';
import { UpsertSingleStructuredDataResponse } from '../model/upsertSingleStructuredDataResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface DeleteAddressKeyAliasRequestParams {
    /** The scope of the Address Key Alias to delete. */
    scope: string;
    /** The Address Key Alias to delete. */
    code: string;
}
export interface GetAddressKeyAliasRequestParams {
    /** The scope of the Address Key Alias to retrieve. */
    scope: string;
    /** The code of the alias to retrieve. */
    code: string;
    /** The asAt datetime at which to retrieve the alias. Defaults to return the latest version if not specified. */
    asAt?: string;
}
export interface ListAddressKeyAliasesRequestParams {
    /** The scope to list aliases for. */
    scope: string;
    /** The asAt datetime at which to list the aliases. Defaults to latest if not specified. */
    asAt?: string;
    /** Expression to filter the result set. */
    filter?: string;
    /** Maximum number of results to return. Defaults to 100. */
    limit?: number;
    /** Pagination token from a previous result to fetch the next page. */
    page?: string;
}
export interface UpsertAddressKeyAliasRequestParams {
    /** The Address Key Alias to update or insert */
    upsertAddressKeyAliasRequest: UpsertAddressKeyAliasRequest;
}
export declare class AddressKeyAliasService {
    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] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present.
     * Delete the specified Address Key Alias from a single scope.                The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed.
     * @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.
     */
    deleteAddressKeyAlias(requestParameters?: DeleteAddressKeyAliasRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<AnnulSingleStructuredDataResponse>;
    deleteAddressKeyAlias(requestParameters?: DeleteAddressKeyAliasRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<AnnulSingleStructuredDataResponse>>;
    deleteAddressKeyAlias(requestParameters?: DeleteAddressKeyAliasRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<AnnulSingleStructuredDataResponse>>;
    /**
     * [EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias
     * Get an Address Key Alias from a single scope.                The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful.
     * @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.
     */
    getAddressKeyAlias(requestParameters?: GetAddressKeyAliasRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<GetAddressKeyAliasResponse>;
    getAddressKeyAlias(requestParameters?: GetAddressKeyAliasRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<GetAddressKeyAliasResponse>>;
    getAddressKeyAlias(requestParameters?: GetAddressKeyAliasRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<GetAddressKeyAliasResponse>>;
    /**
     * [EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases
     * List the set of address key aliases at the specified date/time and scope.
     * @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.
     */
    listAddressKeyAliases(requestParameters?: ListAddressKeyAliasesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PagedResourceListOfGetAddressKeyAliasResponse>;
    listAddressKeyAliases(requestParameters?: ListAddressKeyAliasesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PagedResourceListOfGetAddressKeyAliasResponse>>;
    listAddressKeyAliases(requestParameters?: ListAddressKeyAliasesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PagedResourceListOfGetAddressKeyAliasResponse>>;
    /**
     * [EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID.
     * Update or insert one Address Key Alias. An item will be updated if it already exists  and inserted if it does not.                The response will return the successfully updated or inserted alias or failure message if unsuccessful.
     * @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.
     */
    upsertAddressKeyAlias(requestParameters?: UpsertAddressKeyAliasRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<UpsertSingleStructuredDataResponse>;
    upsertAddressKeyAlias(requestParameters?: UpsertAddressKeyAliasRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<UpsertSingleStructuredDataResponse>>;
    upsertAddressKeyAlias(requestParameters?: UpsertAddressKeyAliasRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<UpsertSingleStructuredDataResponse>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<AddressKeyAliasService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<AddressKeyAliasService>;
}