rittenhop-ghost/versions/5.94.2/node_modules/mailgun.js/Interfaces/Domains/DomainsClient.d.ts

29 lines
2.1 KiB
TypeScript
Raw Normal View History

import { APIResponse } from '../../Types/Common';
import { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainInfo, DomainsQuery, DomainTrackingData, DomainUpdateInfo, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResponse, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
import { IDomainCredentials } from './DomainCredentials';
import { IDomainTagsClient } from './DomainTags';
import { IDomainTemplatesClient } from './DomainTemplates';
export interface IDomainsClient {
domainCredentials: IDomainCredentials;
domainTemplates: IDomainTemplatesClient;
domainTags: IDomainTagsClient;
list(query?: DomainsQuery): Promise<TDomain[]>;
get(domain: string): Promise<TDomain>;
create(data: DomainInfo): Promise<TDomain>;
update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
verify(domain: string): Promise<TDomain>;
destroy(domain: string): Promise<MessageResponse>;
getConnection(domain: string): Promise<ConnectionSettings>;
updateConnection(domain: string, data: ConnectionSettings): Promise<UpdatedConnectionSettings>;
getTracking(domain: string): Promise<DomainTrackingData>;
updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
getIps(domain: string): Promise<string[]>;
assignIp(domain: string, ip: string): Promise<APIResponse>;
deleteIp(domain: string, ip: string): Promise<APIResponse>;
linkIpPool(domain: string, pool_id: string): Promise<APIResponse>;
unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
}