ark-email 0.5.1

package/src/resources/index.ts

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export {
+  Domains,
+  type DNSRecord,
+  type DomainCreateResponse,
+  type DomainRetrieveResponse,
+  type DomainListResponse,
+  type DomainDeleteResponse,
+  type DomainVerifyResponse,
+  type DomainCreateParams,
+} from './domains';
+export {
+  Emails,
+  type EmailRetrieveResponse,
+  type EmailListResponse,
+  type EmailRetrieveDeliveriesResponse,
+  type EmailRetryResponse,
+  type EmailSendResponse,
+  type EmailSendBatchResponse,
+  type EmailSendRawResponse,
+  type EmailRetrieveParams,
+  type EmailListParams,
+  type EmailSendParams,
+  type EmailSendBatchParams,
+  type EmailSendRawParams,
+  type EmailListResponsesPageNumberPagination,
+} from './emails';
+export {
+  Suppressions,
+  type SuppressionCreateResponse,
+  type SuppressionRetrieveResponse,
+  type SuppressionListResponse,
+  type SuppressionDeleteResponse,
+  type SuppressionBulkCreateResponse,
+  type SuppressionCreateParams,
+  type SuppressionListParams,
+  type SuppressionBulkCreateParams,
+  type SuppressionListResponsesPageNumberPagination,
+} from './suppressions';
+export {
+  Tracking,
+  type TrackDomain,
+  type TrackingCreateResponse,
+  type TrackingRetrieveResponse,
+  type TrackingUpdateResponse,
+  type TrackingListResponse,
+  type TrackingDeleteResponse,
+  type TrackingVerifyResponse,
+  type TrackingCreateParams,
+  type TrackingUpdateParams,
+} from './tracking';
+export {
+  Webhooks,
+  type WebhookCreateResponse,
+  type WebhookRetrieveResponse,
+  type WebhookUpdateResponse,
+  type WebhookListResponse,
+  type WebhookDeleteResponse,
+  type WebhookTestResponse,
+  type WebhookCreateParams,
+  type WebhookUpdateParams,
+  type WebhookTestParams,
+} from './webhooks';

package/src/resources/shared.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export interface APIMeta {
+  /**
+   * Unique request identifier for debugging and support
+   */
+  requestId: string;
+}

package/src/resources/suppressions.ts

@@ -0,0 +1,253 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { PageNumberPagination, type PageNumberPaginationParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+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: SuppressionCreateParams, options?: RequestOptions): APIPromise<SuppressionCreateResponse> {
+    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: string, options?: RequestOptions): APIPromise<SuppressionRetrieveResponse> {
+    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: SuppressionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SuppressionListResponsesPageNumberPagination, SuppressionListResponse> {
+    return this._client.getAPIList('/suppressions', PageNumberPagination<SuppressionListResponse>, {
+      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: string, options?: RequestOptions): APIPromise<SuppressionDeleteResponse> {
+    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: SuppressionBulkCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SuppressionBulkCreateResponse> {
+    return this._client.post('/suppressions/bulk', { body, ...options });
+  }
+}
+
+export type SuppressionListResponsesPageNumberPagination = PageNumberPagination<SuppressionListResponse>;
+
+export interface SuppressionCreateResponse {
+  data: SuppressionCreateResponse.Data;
+
+  meta: Shared.APIMeta;
+
+  success: true;
+}
+
+export namespace SuppressionCreateResponse {
+  export 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 namespace SuppressionRetrieveResponse {
+  export 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 namespace SuppressionDeleteResponse {
+  export interface Data {
+    message: string;
+  }
+}
+
+export interface SuppressionBulkCreateResponse {
+  data: SuppressionBulkCreateResponse.Data;
+
+  meta: Shared.APIMeta;
+
+  success: true;
+}
+
+export namespace SuppressionBulkCreateResponse {
+  export 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 namespace SuppressionBulkCreateParams {
+  export 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,
+  };
+}

package/src/resources/tracking.ts

@@ -0,0 +1,380 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as TrackingAPI from './tracking';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export 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> {
+    return this._client.post('/tracking', { body, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.get(path`/tracking/${trackingID}`, options);
+  }
+
+  /**
+   * 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> {
+    return this._client.patch(path`/tracking/${trackingID}`, { body, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.get('/tracking', options);
+  }
+
+  /**
+   * 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> {
+    return this._client.delete(path`/tracking/${trackingID}`, options);
+  }
+
+  /**
+   * 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> {
+    return this._client.post(path`/tracking/${trackingID}/verify`, options);
+  }
+}
+
+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 namespace TrackDomain {
+  /**
+   * Required DNS record configuration
+   */
+  export 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 namespace TrackingListResponse {
+  export interface Data {
+    trackDomains: Array<TrackingAPI.TrackDomain>;
+  }
+}
+
+export interface TrackingDeleteResponse {
+  data: TrackingDeleteResponse.Data;
+
+  meta: Shared.APIMeta;
+
+  success: true;
+}
+
+export namespace TrackingDeleteResponse {
+  export interface Data {
+    message: string;
+  }
+}
+
+export interface TrackingVerifyResponse {
+  data: TrackingVerifyResponse.Data;
+
+  meta: Shared.APIMeta;
+
+  success: true;
+}
+
+export namespace TrackingVerifyResponse {
+  export 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;
+  }
+
+  export namespace Data {
+    /**
+     * Required DNS record configuration
+     */
+    export 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,
+  };
+}