ministry-platform-provider/dist/services/domainService.d.ts

TypeScript client library for Ministry Platform API integration

import { MinistryPlatformClient } from "../core/ministryPlatformClient.js";
import { DomainInfo, GlobalFilterItem, GlobalFilterParams } from "../Interfaces/mpProviderInterfaces.js";
export declare class DomainService {
    private client;
    constructor(client: MinistryPlatformClient);
    /**
     * Returns the basic information about the current domain.
     * @returns Promise with the domain information
     */
    getDomainInfo(): Promise<DomainInfo>;
    /**
     * Returns the lookup values to be used as global filters. The key corresponds to
     * an identifier and the value corresponds to a friendly name (description). Zero (0)
     * identifier corresponds to records with not assigned filters.
     * @param params Optional parameters for the global filters request
     * @returns Promise with an array of global filter items
     */
    getGlobalFilters(params?: GlobalFilterParams): Promise<GlobalFilterItem[]>;
}