Interface SyncjobEndpoints

interface SyncjobEndpoints {
    create(payload: SyncjobAttributes): Promise<MailcowResponse>;
    delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>;
    edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>;
    getAll(): Promise<Syncjob[]>;
}

Index

Methods

create delete edit getAll

Methods

create

create(payload: SyncjobAttributes): Promise<MailcowResponse>
Endpoint for creating sync jobs.
Parameters
- payload: SyncjobAttributes
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/syncjob-endpoints.ts:9

delete

delete(payload: SyncjobDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting sync jobs
Parameters
- payload: SyncjobDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/syncjob-endpoints.ts:21

edit

edit(payload: SyncjobUpdateRequest): Promise<MailcowResponse>
Endpoint for editing sync jobs.
Parameters
- payload: SyncjobUpdateRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/syncjob-endpoints.ts:15

getAll

getAll(): Promise<Syncjob[]>
Endpoint for getting all sync jobs.

Returns Promise<Syncjob[]>
- Defined in src/endpoints/syncjob-endpoints.ts:26