Interface DomainEndpoints

Interface for all Domain endpoints.

interface DomainEndpoints {
    create(payload: DomainPostRequest): Promise<MailcowResponse>;
    delete(payload: DomainDeleteRequest): Promise<MailcowResponse>;
    edit(payload: DomainEditRequest): Promise<MailcowResponse>;
    get(domain: string): Promise<Domain[]>;
}

Index

Methods

create delete edit get

Methods

create

create(payload: DomainPostRequest): Promise<MailcowResponse>
Endpoint for creating domains.
Parameters
- payload: DomainPostRequest
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:19

delete

delete(payload: DomainDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting a domain.
Parameters
- payload: DomainDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:25

edit

edit(payload: DomainEditRequest): Promise<MailcowResponse>
Endpoint for editing a domain.
Parameters
- payload: DomainEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:31

get

get(domain: string): Promise<Domain[]>
Endpoint for getting domains.
Parameters
- domain: string
  Name of the domain to get.
Returns Promise<Domain[]>
- Defined in src/endpoints/domain-endpoints.ts:13