ts-mailcow-api
Version:
TypeScript wrapper for the mailcow API.
25 lines (24 loc) • 870 B
TypeScript
import MailcowClient from '../index';
import { MailcowResponse, Syncjob, SyncjobDeleteRequest, SyncjobPostRequest, SyncjobUpdateRequest } from '../types';
export interface SyncjobEndpoints {
/**
* Endpoint for creating sync jobs.
* @param payload - The creation payload.
*/
create(payload: SyncjobPostRequest): Promise<MailcowResponse>;
/**
* Endpoint for editing sync jobs.
* @param payload - The edit payload.
*/
edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>;
/**
* Endpoint for deleting sync jobs
* @param payload - The deletion payload.
*/
delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>;
/**
* Endpoint for getting all sync jobs.
*/
getAll(): Promise<Syncjob[]>;
}
export declare function syncjobEndpoints(bind: MailcowClient): SyncjobEndpoints;