Skip to content

Commit

Permalink
other: Check domains docs and update accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
olexandr-mazepa committed Jan 8, 2025
1 parent 77a0966 commit 6709877
Show file tree
Hide file tree
Showing 15 changed files with 1,348 additions and 470 deletions.
520 changes: 374 additions & 146 deletions README.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion dist/Classes/Domains/domain.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default class Domain implements TDomain {
state: string;
wildcard: boolean;
spam_action: string;
created_at: string;
created_at: Date;
smtp_password: string;
smtp_login: string;
type: string;
Expand All @@ -17,5 +17,7 @@ export default class Domain implements TDomain {
web_prefix: string;
web_scheme: string;
use_automatic_sender_security: boolean;
dkim_host?: string;
mailfrom_host?: string;
constructor(data: DomainData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
}
7 changes: 4 additions & 3 deletions dist/Classes/Domains/domainsClient.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Request from '../common/Request';
import DomainCredentialsClient from './domainsCredentials';
import DomainTemplatesClient from './domainsTemplates';
import DomainTagsClient from './domainsTags';
import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo } from '../../Types/Domains';
import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo, DomainGetQuery, UpdatedDKIMSelectorResult } from '../../Types/Domains';
import { ILogger } from '../../Interfaces';
export default class DomainsClient implements IDomainsClient {
request: Request;
Expand All @@ -19,8 +19,9 @@ export default class DomainsClient implements IDomainsClient {
private _parseDomain;
private _parseTrackingSettings;
private _parseTrackingUpdate;
private _isOpenTrackingInfoWitPlace;
list(query?: DomainsQuery): Promise<TDomain[]>;
get(domain: string): Promise<TDomain>;
get(domain: string, query?: DomainGetQuery): Promise<TDomain>;
create(data: DomainInfo): Promise<TDomain>;
update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
verify(domain: string): Promise<TDomain>;
Expand Down Expand Up @@ -52,7 +53,7 @@ export default class DomainsClient implements IDomainsClient {
*/
unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
/**
* @deprecated "domains.updateWebPrefix" method is deprecated.
* Please use domains.update to set new "web_prefix".
Expand Down
6 changes: 3 additions & 3 deletions dist/Interfaces/Domains/DomainsClient.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
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 { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainGetQuery, DomainInfo, DomainsQuery, DomainTrackingData, DomainUpdateInfo, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResult, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
import { IDomainCredentials } from './DomainCredentials';
import { IDomainTagsClient } from './DomainTags';
import { IDomainTemplatesClient } from './DomainTemplates';
Expand All @@ -8,7 +8,7 @@ export interface IDomainsClient {
domainTemplates: IDomainTemplatesClient;
domainTags: IDomainTagsClient;
list(query?: DomainsQuery): Promise<TDomain[]>;
get(domain: string): Promise<TDomain>;
get(domain: string, query?: DomainGetQuery): Promise<TDomain>;
create(data: DomainInfo): Promise<TDomain>;
update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
verify(domain: string): Promise<TDomain>;
Expand All @@ -23,6 +23,6 @@ export interface IDomainsClient {
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>;
updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResult>;
updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
}
Loading

0 comments on commit 6709877

Please sign in to comment.