@tangany/waas/dist/monitor.d.ts

node.js SDK for Tangany Wallet as a Service API

import { ISearchOptions } from "./interfaces/common";
import { IMonitor, IMonitorCreationProperties, IMonitorSearchParams } from "./interfaces/monitor";
import { MonitorIterable } from "./iterables/auto-pagination/monitor-iterable";
import { MonitorPageIterable } from "./iterables/pagewise/monitor-page-iterable";
import { AtLeastOne } from "./types/common";
import { Waas } from "./waas";
import { IWaasMethod } from "./waas-method";
/** Custom type for partial wallet updates that requires at least one property */
declare type MonitorUpdateValues = AtLeastOne<Omit<IMonitorCreationProperties, "target">>;
/** Custom type for search parameters in this wallet-based context */
declare type SearchParams = Omit<IMonitorSearchParams, "wallet">;
export declare class Monitor implements IWaasMethod {
    waas: Waas;
    private readonly _monitorId?;
    private readonly _wallet?;
    constructor(waas: Waas, _monitorId?: string | undefined, _wallet?: string | undefined);
    /**
     * Returns the monitor id or throws an error if this optional property is not set.
     */
    get monitorId(): string;
    /**
     * Returns the wallet name or throws an error if this optional property is not set.
     */
    get wallet(): string;
    /**
     * Returns the URL of the endpoint that represents a single monitor resource
     */
    private get baseUrlSingleResource();
    /**
     * Returns the URL of the endpoint that represents the list of all monitors of the given wallet
     */
    private get baseUrlResourceList();
    /**
     * Returns an asynchronous iterable to iterate **page by page** through the monitors that matched the search parameters.
     * @param [params] - Optional search parameters
     * @see [docs]{@link https://docs.tangany.com/#25362117-57b0-4c46-9e40-0e8e119a17b5}
     */
    list(params?: SearchParams): MonitorPageIterable;
    /**
     * Returns an asynchronous iterable that yields **one monitor object per iteration**.
     * A page of monitors that match the search parameters is fetched and saved once, so that all items can be returned one by one.
     * After that, the next page is loaded from the API and processed item by item again.
     * @param [params] - Optional search parameters
     * @param [options] - Additional options that do not affect the API request but the SDK-side processing
     * @see [docs]{@link https://docs.tangany.com/#25362117-57b0-4c46-9e40-0e8e119a17b5}
     */
    list(params?: SearchParams, options?: {
        autoPagination: true;
    }): MonitorIterable;
    /**
     * Returns an asynchronous iterable to iterate **page by page** through the monitors that matched the search parameters.
     * @param [params] - Optional search parameters
     * @param [options] - Additional options that do not affect the API request but the SDK-side processing
     * @see [docs]{@link https://docs.tangany.com/#25362117-57b0-4c46-9e40-0e8e119a17b5}
     */
    list(params?: SearchParams, options?: ISearchOptions): MonitorPageIterable;
    /**
     * Creates a new monitor based on the passed data.
     * @param [monitor] - Values to configure the monitor to create
     * @see [docs]{@link https://docs.tangany.com/#122ab4fc-d567-4fe9-aef0-7b3c332cd595}
     */
    create(monitor: IMonitorCreationProperties): Promise<IMonitor>;
    /**
     * Requests details for the given monitor id.
     * @see [docs]{@link https://docs.tangany.com/#6eba3872-6c54-4168-adf8-eda38e072e25}
     */
    get(): Promise<IMonitor>;
    /**
     * Updates the given monitor partially.
     * @param newValues - Subset of properties that are allowed to be updated. Non-primitive properties like arrays or objects replace the previous value and therefore need to contain all desired values.
     * @see [docs]{@link https://docs.tangany.com/#13aa3fb9-a43d-42eb-83ce-fe7c1e17d021}
     */
    update(newValues: MonitorUpdateValues): Promise<IMonitor>;
    /**
     * Replaces the entire monitor.
     * @param newMonitorObj - Entire monitor configuration that will replace the previous resource
     * @see [docs]{@link https://docs.tangany.com/#b31f3bd1-26d2-48ef-b0da-aebcdc39b521}
     */
    replace(newMonitorObj: IMonitorCreationProperties): Promise<IMonitor>;
    /**
     * Deletes the current monitor.
     * @see [docs]{@link https://docs.tangany.com/#c53538bb-e6fd-4948-bcb7-cc917eab7da0}
     */
    delete(): Promise<IMonitor>;
}
export {};