ark-email 0.5.1

package/resources/suppressions.d.ts

@@ -0,0 +1,181 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageNumberPagination, type PageNumberPaginationParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Suppressions extends APIResource {
+    /**
+     * Add an email address to the suppression list. The address will not receive any
+     * emails until removed.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.create({
+     *   address: 'user@example.com',
+     *   reason: 'user requested removal',
+     * });
+     * ```
+     */
+    create(body: SuppressionCreateParams, options?: RequestOptions): APIPromise<SuppressionCreateResponse>;
+    /**
+     * Check if a specific email address is on the suppression list
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.retrieve(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    retrieve(email: string, options?: RequestOptions): APIPromise<SuppressionRetrieveResponse>;
+    /**
+     * Get all email addresses on the suppression list. These addresses will not
+     * receive any emails.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const suppressionListResponse of client.suppressions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: SuppressionListParams | null | undefined, options?: RequestOptions): PagePromise<SuppressionListResponsesPageNumberPagination, SuppressionListResponse>;
+    /**
+     * Remove an email address from the suppression list. The address will be able to
+     * receive emails again.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.delete(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    delete(email: string, options?: RequestOptions): APIPromise<SuppressionDeleteResponse>;
+    /**
+     * Add up to 1000 email addresses to the suppression list at once
+     *
+     * @example
+     * ```ts
+     * const response = await client.suppressions.bulkCreate({
+     *   suppressions: [{ address: 'dev@stainless.com' }],
+     * });
+     * ```
+     */
+    bulkCreate(body: SuppressionBulkCreateParams, options?: RequestOptions): APIPromise<SuppressionBulkCreateResponse>;
+}
+export type SuppressionListResponsesPageNumberPagination = PageNumberPagination<SuppressionListResponse>;
+export interface SuppressionCreateResponse {
+    data: SuppressionCreateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace SuppressionCreateResponse {
+    interface Data {
+        /**
+         * Suppression ID
+         */
+        id: string;
+        address: string;
+        createdAt: string;
+        /**
+         * Reason for suppression
+         */
+        reason?: string;
+    }
+}
+export interface SuppressionRetrieveResponse {
+    data: SuppressionRetrieveResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace SuppressionRetrieveResponse {
+    interface Data {
+        /**
+         * The email address that was checked
+         */
+        address: string;
+        /**
+         * Whether the address is currently suppressed
+         */
+        suppressed: boolean;
+        /**
+         * When the suppression was created (if suppressed)
+         */
+        createdAt?: string | null;
+        /**
+         * Reason for suppression (if suppressed)
+         */
+        reason?: string | null;
+    }
+}
+export interface SuppressionListResponse {
+    /**
+     * Suppression ID
+     */
+    id: string;
+    address: string;
+    createdAt: string;
+    reason?: string;
+}
+export interface SuppressionDeleteResponse {
+    data: SuppressionDeleteResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace SuppressionDeleteResponse {
+    interface Data {
+        message: string;
+    }
+}
+export interface SuppressionBulkCreateResponse {
+    data: SuppressionBulkCreateResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace SuppressionBulkCreateResponse {
+    interface Data {
+        /**
+         * Newly suppressed addresses
+         */
+        added: number;
+        /**
+         * Invalid addresses skipped
+         */
+        failed: number;
+        /**
+         * Total addresses in request
+         */
+        totalRequested: number;
+        /**
+         * Already suppressed addresses (updated reason)
+         */
+        updated: number;
+    }
+}
+export interface SuppressionCreateParams {
+    /**
+     * Email address to suppress
+     */
+    address: string;
+    /**
+     * Reason for suppression
+     */
+    reason?: string;
+}
+export interface SuppressionListParams extends PageNumberPaginationParams {
+}
+export interface SuppressionBulkCreateParams {
+    suppressions: Array<SuppressionBulkCreateParams.Suppression>;
+}
+export declare namespace SuppressionBulkCreateParams {
+    interface Suppression {
+        address: string;
+        reason?: string;
+    }
+}
+export declare namespace Suppressions {
+    export { type SuppressionCreateResponse as SuppressionCreateResponse, type SuppressionRetrieveResponse as SuppressionRetrieveResponse, type SuppressionListResponse as SuppressionListResponse, type SuppressionDeleteResponse as SuppressionDeleteResponse, type SuppressionBulkCreateResponse as SuppressionBulkCreateResponse, type SuppressionListResponsesPageNumberPagination as SuppressionListResponsesPageNumberPagination, type SuppressionCreateParams as SuppressionCreateParams, type SuppressionListParams as SuppressionListParams, type SuppressionBulkCreateParams as SuppressionBulkCreateParams, };
+}
+//# sourceMappingURL=suppressions.d.ts.map

package/resources/suppressions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.d.ts","sourceRoot":"","sources":["../src/resources/suppressions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,oBAAoB,EAAE,KAAK,0BAA0B,EAAE,WAAW,EAAE;OACtE,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAI1F;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4CAA4C,EAAE,uBAAuB,CAAC;IAOrF;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItF;;;;;;;;;OASG;IACH,UAAU,CACR,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAG7C;AAED,MAAM,MAAM,4CAA4C,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AAEzG,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;IAErC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;IAEvC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;IAErC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,0BAA0B;CAAG;AAE5E,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,KAAK,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAC;CAC9D;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,WAAW;QAC1B,OAAO,EAAE,MAAM,CAAC;QAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4CAA4C,IAAI,4CAA4C,EACjG,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/suppressions.js

@@ -0,0 +1,84 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Suppressions = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class Suppressions extends resource_1.APIResource {
+    /**
+     * Add an email address to the suppression list. The address will not receive any
+     * emails until removed.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.create({
+     *   address: 'user@example.com',
+     *   reason: 'user requested removal',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/suppressions', { body, ...options });
+    }
+    /**
+     * Check if a specific email address is on the suppression list
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.retrieve(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    retrieve(email, options) {
+        return this._client.get((0, path_1.path) `/suppressions/${email}`, options);
+    }
+    /**
+     * Get all email addresses on the suppression list. These addresses will not
+     * receive any emails.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const suppressionListResponse of client.suppressions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/suppressions', (pagination_1.PageNumberPagination), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Remove an email address from the suppression list. The address will be able to
+     * receive emails again.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.delete(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    delete(email, options) {
+        return this._client.delete((0, path_1.path) `/suppressions/${email}`, options);
+    }
+    /**
+     * Add up to 1000 email addresses to the suppression list at once
+     *
+     * @example
+     * ```ts
+     * const response = await client.suppressions.bulkCreate({
+     *   suppressions: [{ address: 'dev@stainless.com' }],
+     * });
+     * ```
+     */
+    bulkCreate(body, options) {
+        return this._client.post('/suppressions/bulk', { body, ...options });
+    }
+}
+exports.Suppressions = Suppressions;
+//# sourceMappingURL=suppressions.js.map

package/resources/suppressions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.js","sourceRoot":"","sources":["../src/resources/suppressions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAwG;AAExG,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,iCAA6C,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CACR,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AApFD,oCAoFC"}

package/resources/suppressions.mjs

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageNumberPagination } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Suppressions extends APIResource {
+    /**
+     * Add an email address to the suppression list. The address will not receive any
+     * emails until removed.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.create({
+     *   address: 'user@example.com',
+     *   reason: 'user requested removal',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/suppressions', { body, ...options });
+    }
+    /**
+     * Check if a specific email address is on the suppression list
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.retrieve(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    retrieve(email, options) {
+        return this._client.get(path `/suppressions/${email}`, options);
+    }
+    /**
+     * Get all email addresses on the suppression list. These addresses will not
+     * receive any emails.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const suppressionListResponse of client.suppressions.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/suppressions', (PageNumberPagination), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Remove an email address from the suppression list. The address will be able to
+     * receive emails again.
+     *
+     * @example
+     * ```ts
+     * const suppression = await client.suppressions.delete(
+     *   'dev@stainless.com',
+     * );
+     * ```
+     */
+    delete(email, options) {
+        return this._client.delete(path `/suppressions/${email}`, options);
+    }
+    /**
+     * Add up to 1000 email addresses to the suppression list at once
+     *
+     * @example
+     * ```ts
+     * const response = await client.suppressions.bulkCreate({
+     *   suppressions: [{ address: 'dev@stainless.com' }],
+     * });
+     * ```
+     */
+    bulkCreate(body, options) {
+        return this._client.post('/suppressions/bulk', { body, ...options });
+    }
+}
+//# sourceMappingURL=suppressions.mjs.map

package/resources/suppressions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.mjs","sourceRoot":"","sources":["../src/resources/suppressions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,oBAAoB,EAAgD;OAEtE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,oBAA6C,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CACR,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF"}

package/resources/tracking.d.mts

@@ -0,0 +1,288 @@
+import { APIResource } from "../core/resource.mjs";
+import * as TrackingAPI from "./tracking.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Tracking extends APIResource {
+    /**
+     * Create a new track domain for open/click tracking.
+     *
+     * After creation, you must configure a CNAME record pointing to the provided DNS
+     * value before tracking will work.
+     *
+     * @example
+     * ```ts
+     * const tracking = await client.tracking.create({
+     *   domainId: '123',
+     *   name: 'track',
+     * });
+     * ```
+     */
+    create(body: TrackingCreateParams, options?: RequestOptions): APIPromise<TrackingCreateResponse>;
+    /**
+     * Get details of a specific track domain including DNS configuration
+     *
+     * @example
+     * ```ts
+     * const tracking = await client.tracking.retrieve(
+     *   'trackingId',
+     * );
+     * ```
+     */
+    retrieve(trackingID: string, options?: RequestOptions): APIPromise<TrackingRetrieveResponse>;
+    /**
+     * Update track domain settings.
+     *
+     * Use this to:
+     *
+     * - Enable/disable click tracking
+     * - Enable/disable open tracking
+     * - Enable/disable SSL
+     * - Set excluded click domains
+     *
+     * @example
+     * ```ts
+     * const tracking = await client.tracking.update('trackingId');
+     * ```
+     */
+    update(trackingID: string, body: TrackingUpdateParams, options?: RequestOptions): APIPromise<TrackingUpdateResponse>;
+    /**
+     * List all track domains configured for your server. Track domains enable open and
+     * click tracking for your emails.
+     *
+     * @example
+     * ```ts
+     * const trackings = await client.tracking.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<TrackingListResponse>;
+    /**
+     * Delete a track domain. This will disable tracking for any emails using this
+     * domain.
+     *
+     * @example
+     * ```ts
+     * const tracking = await client.tracking.delete('trackingId');
+     * ```
+     */
+    delete(trackingID: string, options?: RequestOptions): APIPromise<TrackingDeleteResponse>;
+    /**
+     * Check DNS configuration for the track domain.
+     *
+     * The track domain requires a CNAME record to be configured before open and click
+     * tracking will work. Use this endpoint to verify the DNS is correctly set up.
+     *
+     * @example
+     * ```ts
+     * const response = await client.tracking.verify('trackingId');
+     * ```
+     */
+    verify(trackingID: string, options?: RequestOptions): APIPromise<TrackingVerifyResponse>;
+}
+export interface TrackDomain {
+    /**
+     * Track domain ID
+     */
+    id: string;
+    /**
+     * When the track domain was created
+     */
+    createdAt: string;
+    /**
+     * Whether DNS is correctly configured
+     */
+    dnsOk: boolean;
+    /**
+     * ID of the parent sending domain
+     */
+    domainId: string;
+    /**
+     * Full domain name
+     */
+    fullName: string;
+    /**
+     * Subdomain name
+     */
+    name: string;
+    /**
+     * Whether SSL is enabled for tracking URLs
+     */
+    sslEnabled: boolean;
+    /**
+     * Whether click tracking is enabled
+     */
+    trackClicks: boolean;
+    /**
+     * Whether open tracking is enabled
+     */
+    trackOpens: boolean;
+    /**
+     * When DNS was last checked
+     */
+    dnsCheckedAt?: string | null;
+    /**
+     * DNS error message if verification failed
+     */
+    dnsError?: string | null;
+    /**
+     * Required DNS record configuration
+     */
+    dnsRecord?: TrackDomain.DNSRecord | null;
+    /**
+     * Current DNS verification status
+     */
+    dnsStatus?: 'ok' | 'missing' | 'invalid' | null;
+    /**
+     * Domains excluded from click tracking
+     */
+    excludedClickDomains?: string | null;
+    /**
+     * When the track domain was last updated
+     */
+    updatedAt?: string | null;
+}
+export declare namespace TrackDomain {
+    /**
+     * Required DNS record configuration
+     */
+    interface DNSRecord {
+        /**
+         * DNS record name
+         */
+        name?: string;
+        /**
+         * DNS record type
+         */
+        type?: string;
+        /**
+         * DNS record value (target)
+         */
+        value?: string;
+    }
+}
+export interface TrackingCreateResponse {
+    data: TrackDomain;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export interface TrackingRetrieveResponse {
+    data: TrackDomain;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export interface TrackingUpdateResponse {
+    data: TrackDomain;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export interface TrackingListResponse {
+    data: TrackingListResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace TrackingListResponse {
+    interface Data {
+        trackDomains: Array<TrackingAPI.TrackDomain>;
+    }
+}
+export interface TrackingDeleteResponse {
+    data: TrackingDeleteResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace TrackingDeleteResponse {
+    interface Data {
+        message: string;
+    }
+}
+export interface TrackingVerifyResponse {
+    data: TrackingVerifyResponse.Data;
+    meta: Shared.APIMeta;
+    success: true;
+}
+export declare namespace TrackingVerifyResponse {
+    interface Data {
+        /**
+         * Track domain ID
+         */
+        id: string;
+        /**
+         * Whether DNS is correctly configured
+         */
+        dnsOk: boolean;
+        /**
+         * Current DNS verification status
+         */
+        dnsStatus: 'ok' | 'missing' | 'invalid' | null;
+        /**
+         * Full domain name
+         */
+        fullName: string;
+        /**
+         * When DNS was last checked
+         */
+        dnsCheckedAt?: string | null;
+        /**
+         * DNS error message if verification failed
+         */
+        dnsError?: string | null;
+        /**
+         * Required DNS record configuration
+         */
+        dnsRecord?: Data.DNSRecord | null;
+    }
+    namespace Data {
+        /**
+         * Required DNS record configuration
+         */
+        interface DNSRecord {
+            name?: string;
+            type?: string;
+            value?: string;
+        }
+    }
+}
+export interface TrackingCreateParams {
+    /**
+     * ID of the sending domain to attach this track domain to
+     */
+    domainId: string;
+    /**
+     * Subdomain name (e.g., 'track' for track.yourdomain.com)
+     */
+    name: string;
+    /**
+     * Enable SSL for tracking URLs (recommended)
+     */
+    sslEnabled?: boolean;
+    /**
+     * Enable click tracking
+     */
+    trackClicks?: boolean;
+    /**
+     * Enable open tracking (tracking pixel)
+     */
+    trackOpens?: boolean;
+}
+export interface TrackingUpdateParams {
+    /**
+     * Comma-separated list of domains to exclude from click tracking
+     */
+    excludedClickDomains?: string;
+    /**
+     * Enable or disable SSL for tracking URLs
+     */
+    sslEnabled?: boolean;
+    /**
+     * Enable or disable click tracking
+     */
+    trackClicks?: boolean;
+    /**
+     * Enable or disable open tracking
+     */
+    trackOpens?: boolean;
+}
+export declare namespace Tracking {
+    export { type TrackDomain as TrackDomain, type TrackingCreateResponse as TrackingCreateResponse, type TrackingRetrieveResponse as TrackingRetrieveResponse, type TrackingUpdateResponse as TrackingUpdateResponse, type TrackingListResponse as TrackingListResponse, type TrackingDeleteResponse as TrackingDeleteResponse, type TrackingVerifyResponse as TrackingVerifyResponse, type TrackingCreateParams as TrackingCreateParams, type TrackingUpdateParams as TrackingUpdateParams, };
+}
+//# sourceMappingURL=tracking.d.mts.map

package/resources/tracking.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking.d.mts","sourceRoot":"","sources":["../src/resources/tracking.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI5F;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhE;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIxF;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGzF;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,WAAW,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,WAAW,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,WAAW,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEhC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAElC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC;IAErB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,SAAS,EAAE,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;QAE/C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,SAAS;YACxB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}