ts-mailcow-api/dist/endpoints/domain-endpoints.d.ts

TypeScript wrapper for the mailcow API.

import { DomainDeleteRequest, DomainEditRequest, DomainPostRequest, Domain, MailcowResponse } from '../types';
import MailcowClient from '../index';
/**
 * Interface for all Domain endpoints.
 */
export interface DomainEndpoints {
    /**
     * Endpoint for getting domains.
     * @param domain - Name of the domain to get.
     */
    get(domain: string): Promise<Domain[]>;
    /**
     * Endpoint for creating domains.
     * @param payload - The creation payload.
     */
    create(payload: DomainPostRequest): Promise<MailcowResponse>;
    /**
     * Endpoint for deleting a domain.
     * @param payload - The deletion payload.
     */
    delete(payload: DomainDeleteRequest): Promise<MailcowResponse>;
    /**
     * Endpoint for editing a domain.
     * @param payload - The edit payload.
     */
    edit(payload: DomainEditRequest): Promise<MailcowResponse>;
}
/**
 * Binder function between the MailcowClient class and the DomainEndpoints.
 * @param bind - The MailcowClient to bind.
 * @internal
 */
export declare function domainEndpoints(bind: MailcowClient): DomainEndpoints;