sequenzy 2.1.35 → 2.1.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,7 +11,7 @@ export declare class WebsitesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<WebsitesClient.Options>;
12
12
  constructor(options?: WebsitesClient.Options);
13
13
  /**
14
- * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
14
+ * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
15
15
  *
16
16
  * @param {Sequenzy.AddWebsitesRequest} request
17
17
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -39,7 +39,7 @@ class WebsitesClient {
39
39
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
40
40
  }
41
41
  /**
42
- * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
42
+ * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
43
43
  *
44
44
  * @param {Sequenzy.AddWebsitesRequest} request
45
45
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -9,6 +9,6 @@ export interface AddWebsitesRequest {
9
9
  domain: string;
10
10
  /** Return-path (MAIL FROM) subdomain label. Defaults to rp. New domains also get a second return path, usually <label>2 (rp2 by default); publish the returned names. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records. */
11
11
  mailFromPrefix?: string;
12
- /** Label of the company tracking domain created on the domain's root (<label>.<root>) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
12
+ /** Label of the company tracking domain created under the domain (<label>.<domain>, or <label>.<root> when it equals mailFromPrefix) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
13
13
  trackingPrefix?: string;
14
14
  }
@@ -11,7 +11,7 @@ export declare class WebsitesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<WebsitesClient.Options>;
12
12
  constructor(options?: WebsitesClient.Options);
13
13
  /**
14
- * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
14
+ * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
15
15
  *
16
16
  * @param {Sequenzy.AddWebsitesRequest} request
17
17
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -13,7 +13,7 @@ export class WebsitesClient {
13
13
  this._options = normalizeClientOptionsWithAuth(options);
14
14
  }
15
15
  /**
16
- * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it on its root (links.<root>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
16
+ * Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
17
17
  *
18
18
  * @param {Sequenzy.AddWebsitesRequest} request
19
19
  * @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -9,6 +9,6 @@ export interface AddWebsitesRequest {
9
9
  domain: string;
10
10
  /** Return-path (MAIL FROM) subdomain label. Defaults to rp. New domains also get a second return path, usually <label>2 (rp2 by default); publish the returned names. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records. */
11
11
  mailFromPrefix?: string;
12
- /** Label of the company tracking domain created on the domain's root (<label>.<root>) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
12
+ /** Label of the company tracking domain created under the domain (<label>.<domain>, or <label>.<root> when it equals mailFromPrefix) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
13
13
  trackingPrefix?: string;
14
14
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sequenzy",
3
- "version": "2.1.35",
3
+ "version": "2.1.36",
4
4
  "description": "Official TypeScript SDK for the Sequenzy API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.sequenzy.com",