@tratto/angular 0.1.0

package/types/tratto-angular.d.ts

@@ -0,0 +1,1028 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, ModuleWithProviders, EnvironmentProviders } from '@angular/core';
+import { OperatorFunction, Observable } from 'rxjs';
+import * as _tratto_angular from '@tratto/angular';
+import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
+
+/**
+ * Configuration options for the Tratto Angular SDK.
+ *
+ * Provide it once at the root level via {@link provideTratt} (standalone apps)
+ * or {@link TrattoModule.forRoot} (NgModule apps).
+ */
+interface TrattoConfig {
+    /**
+     * API key used to authenticate every request.
+     * Obtain one at https://app.tratto.email/settings/api-keys.
+     * Supports both live (`tratto_live_...`) and test (`tratto_test_...`) keys.
+     */
+    apiKey: string;
+    /**
+     * Base URL of the Tratto REST API.
+     * @default 'https://api.tratto.email'
+     */
+    baseUrl?: string;
+}
+/** DI injection token that holds the {@link TrattoConfig}. */
+declare const TRATTO_CONFIG: InjectionToken<TrattoConfig>;
+
+/**
+ * Provides all Tratto services for **standalone** Angular applications.
+ *
+ * Add this to your `ApplicationConfig` providers array alongside
+ * `provideHttpClient()`. The SDK uses `HttpClient` internally; if your app
+ * has not already provided it, include `provideHttpClient()` as well.
+ *
+ * @example
+ * ```ts
+ * // app.config.ts
+ * import { provideHttpClient } from '@angular/common/http';
+ * import { provideTratt } from '@tratto/angular';
+ *
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideHttpClient(),
+ *     provideTratt({ apiKey: 'tratto_live_...' }),
+ *   ],
+ * };
+ * ```
+ */
+declare function provideTratt(config: TrattoConfig): EnvironmentProviders;
+/**
+ * Angular module that registers all Tratto services.
+ *
+ * For Angular 14+ **standalone** applications prefer {@link provideTratt}.
+ * For **NgModule**-based applications use `TrattoModule.forRoot()`.
+ *
+ * > **Note:** `HttpClientModule` (or `provideHttpClient()`) must be imported
+ * > in your application before importing `TrattoModule`.
+ *
+ * @example
+ * ```ts
+ * // app.module.ts
+ * import { HttpClientModule } from '@angular/common/http';
+ * import { TrattoModule } from '@tratto/angular';
+ *
+ * @NgModule({
+ *   imports: [
+ *     HttpClientModule,
+ *     TrattoModule.forRoot({ apiKey: 'tratto_live_...' }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
+declare class TrattoModule {
+    static forRoot(config: TrattoConfig): ModuleWithProviders<TrattoModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TrattoModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TrattoModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<TrattoModule>;
+}
+
+/**
+ * Abstract base class shared by all Tratto resource services.
+ * Provides the `HttpClient`, config injection, and auth-header helpers.
+ */
+declare abstract class BaseService {
+    protected readonly http: HttpClient;
+    protected readonly config: _tratto_angular.TrattoConfig;
+    /** Root API URL without trailing slash (e.g. `https://api.tratto.email`). */
+    protected readonly apiBaseUrl: string;
+    /**
+     * Returns an `HttpHeaders` instance pre-populated with the `Authorization` header.
+     * Pass `extra` to merge additional headers (e.g. `Idempotency-Key`).
+     */
+    protected authHeaders(extra?: Record<string, string>): HttpHeaders;
+    /**
+     * Builds an `HttpParams` object from a plain object, skipping `null`/`undefined` values.
+     * `Date` values are serialised to ISO strings.
+     */
+    protected buildParams(params: Record<string, string | number | boolean | Date | null | undefined>): HttpParams;
+    /**
+     * RxJS operator that unwraps the `{ data: T }` envelope returned by every
+     * Tratto API endpoint.
+     */
+    protected unwrap<T>(): OperatorFunction<{
+        data: T;
+    }, T>;
+    /**
+     * Sends a DELETE/PATCH/POST that returns HTTP 204 (no body).
+     * Uses `responseType: 'text'` to avoid JSON-parse errors on an empty body.
+     */
+    protected voidRequest(method: 'DELETE' | 'PATCH' | 'POST', url: string, body?: unknown): Observable<void>;
+}
+
+/** Pagination metadata included in every list response. */
+interface Pagination {
+    hasMore: boolean;
+    nextCursor: string | null;
+}
+/** Wrapper returned by every paginated list endpoint. */
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: Pagination;
+}
+/** Parameters accepted by `POST /v1/emails`. */
+interface SendEmailParams {
+    /** Sender address. Must match a verified domain. Accepts `"Name <addr>"` or plain `"addr"`. */
+    from: string;
+    /** One or more recipient email addresses. */
+    to: string | string[];
+    /** Subject line (max 998 characters). */
+    subject: string;
+    /** HTML body. At least one of `html`, `text`, or `templateId` is required. */
+    html?: string;
+    /** Plain-text body. At least one of `html`, `text`, or `templateId` is required. */
+    text?: string;
+    /** Carbon-copy recipients. */
+    cc?: string[];
+    /** Blind carbon-copy recipients. */
+    bcc?: string[];
+    /** Reply-to address. */
+    replyTo?: string;
+    /** ID of a saved template. At least one of `html`, `text`, or `templateId` is required. */
+    templateId?: string;
+    /** Variables interpolated inside the template. */
+    variables?: Record<string, unknown>;
+    /** Custom tags for filtering and analytics. */
+    tags?: string[];
+    /** Schedule the email for a future time. Sends immediately if omitted or in the past. */
+    scheduledAt?: Date | string;
+    /** Extra SMTP headers forwarded verbatim. */
+    headers?: Record<string, string>;
+}
+/** Query parameters for `GET /v1/emails`. */
+interface ListEmailsParams {
+    after?: string;
+    limit?: number;
+    /** Comma-separated status values, e.g. `"sent,delivered"`. */
+    status?: string;
+    domainId?: string;
+    /** Comma-separated tag names. */
+    tags?: string;
+    dateFrom?: Date | string;
+    dateTo?: Date | string;
+}
+/** Compact email representation used in list responses. */
+interface EmailSummary {
+    id: string;
+    from: string;
+    to: string[];
+    subject: string;
+    status: string;
+    createdAt: string;
+    sentAt: string | null;
+    scheduledAt: string | null;
+    tags?: string[];
+}
+/** A single delivery event recorded for an email. */
+interface EmailEvent {
+    type: string;
+    occurredAt: string;
+    data?: Record<string, unknown>;
+}
+/** Full email detail including body and inline events. */
+interface EmailDetail extends EmailSummary {
+    html?: string;
+    text?: string;
+    cc?: string[];
+    bcc?: string[];
+    replyTo?: string;
+    templateId?: string;
+    headers?: Record<string, string>;
+    events: EmailEvent[];
+}
+type ContactStatus = 'subscribed' | 'unsubscribed' | 'bounced' | 'complained';
+interface Contact {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    status: ContactStatus;
+    tags: string[];
+    customFields: Record<string, unknown>;
+    createdAt: string;
+}
+interface CreateContactParams {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    status?: ContactStatus;
+    tags?: string[];
+    customFields?: Record<string, unknown>;
+}
+interface UpdateContactParams {
+    firstName?: string;
+    lastName?: string;
+    status?: ContactStatus;
+    tags?: string[];
+    customFields?: Record<string, unknown>;
+}
+interface ListContactsParams {
+    status?: ContactStatus;
+    audienceId?: string;
+    tag?: string;
+    after?: string;
+    limit?: number;
+}
+/** Status snapshot of an async CSV import job. */
+interface ImportJobStatus {
+    jobId: string;
+    status: 'processing' | 'completed' | 'failed';
+    totalRows: number;
+    processedRows: number;
+    failedRows: number;
+    errors: string[];
+    completedAt: string | null;
+}
+type AudienceRuleOperator = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'array_contains';
+interface AudienceRule {
+    field: string;
+    operator: AudienceRuleOperator;
+    value: string | number | boolean;
+}
+interface Audience {
+    id: string;
+    name: string;
+    description: string;
+    contactCount: number;
+    rules: AudienceRule[];
+    createdAt: string;
+}
+interface CreateAudienceParams {
+    name: string;
+    description?: string;
+    rules?: AudienceRule[];
+}
+interface ListAudiencesParams {
+    after?: string;
+    limit?: number;
+}
+interface AddContactsToAudienceResult {
+    added: number;
+    alreadyInAudience: number;
+    notFound: number;
+}
+type CampaignStatus = 'draft' | 'sending' | 'scheduled' | 'paused' | 'completed';
+interface CampaignStats {
+    total: number;
+    sent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+}
+interface Campaign {
+    id: string;
+    name: string;
+    status: CampaignStatus;
+    templateId: string;
+    audienceId: string;
+    fromName: string;
+    fromEmail: string;
+    subjectA: string;
+    subjectB: string | null;
+    scheduledAt: string | null;
+    sentAt: string | null;
+    stats: CampaignStats;
+    createdAt: string;
+}
+interface CampaignStatsDetail {
+    campaignId: string;
+    status: CampaignStatus;
+    stats: CampaignStats;
+    rates: {
+        deliveryRate: number;
+        openRate: number;
+        clickRate: number;
+        bounceRate: number;
+    };
+}
+interface CreateCampaignParams {
+    name: string;
+    templateId: string;
+    audienceId: string;
+    fromName: string;
+    fromEmail: string;
+    subjectA: string;
+    /** Optional subject for A/B testing. */
+    subjectB?: string;
+}
+interface ListCampaignsParams {
+    status?: CampaignStatus;
+    after?: string;
+    limit?: number;
+}
+interface SendCampaignParams {
+    /** Schedule the campaign for a future date. Omit to send immediately. */
+    scheduledAt?: Date | string;
+}
+type TemplateStatus = 'draft' | 'published';
+interface TemplateSummary {
+    id: string;
+    name: string;
+    status: TemplateStatus;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Template extends TemplateSummary {
+    html: string;
+}
+interface CreateTemplateParams {
+    name: string;
+    /** Initial HTML content. Defaults to an empty string. */
+    html?: string;
+}
+interface UpdateTemplateParams {
+    name?: string;
+    html?: string;
+    status?: TemplateStatus;
+}
+interface ListTemplatesParams {
+    limit?: number;
+    after?: string;
+    status?: TemplateStatus;
+}
+interface TemplateVersionSummary {
+    version: number;
+    savedAt: string;
+}
+interface TemplateVersion extends TemplateVersionSummary {
+    html: string;
+}
+type WebhookEventType = 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed';
+type WebhookStatus = 'active' | 'disabled';
+type WebhookDeliveryStatus = 'success' | 'failed' | 'scheduled';
+interface Webhook {
+    id: string;
+    url: string;
+    events: WebhookEventType[];
+    status: WebhookStatus;
+    /** First 12 characters of the signing secret followed by `…`. The full secret is never re-exposed. */
+    secretPrefix: string;
+    failureCount: number;
+    createdAt: string;
+}
+interface WebhookDelivery {
+    id: string;
+    webhookId: string;
+    eventType: string;
+    status: WebhookDeliveryStatus;
+    httpStatus: number | null;
+    responseBody: string | null;
+    retryCount: number;
+    attemptedAt: string;
+}
+interface CreateWebhookParams {
+    url: string;
+    events: WebhookEventType[];
+}
+interface ListWebhookDeliveriesParams {
+    after?: string;
+    limit?: number;
+}
+type DomainStatus = 'pending' | 'verified' | 'failed';
+interface DomainRecord {
+    type: string;
+    host: string;
+    value: string;
+    verified: boolean;
+}
+interface DomainSummary {
+    id: string;
+    domain: string;
+    status: DomainStatus;
+    dkimSelector: string;
+    createdAt: string;
+    updatedAt: string;
+    verifiedAt: string | null;
+}
+interface Domain extends DomainSummary {
+    records: DomainRecord[];
+}
+interface ListDomainsParams {
+    after?: string;
+    limit?: number;
+}
+type ApiKeyEnv = 'live' | 'test';
+interface ApiKey {
+    id: string;
+    name: string;
+    /** First 16 characters of the raw key followed by `...`. */
+    prefix: string;
+    env: ApiKeyEnv;
+    permissions: string[];
+    createdAt: string;
+    lastUsedAt: string | null;
+    revokedAt: string | null;
+}
+interface ApiKeyCreated extends ApiKey {
+    /** Full raw key value — returned only at creation time. Store it securely; it cannot be retrieved again. */
+    key: string;
+}
+interface CreateApiKeyParams {
+    name: string;
+    env: ApiKeyEnv;
+    permissions: string[];
+}
+interface ListApiKeysParams {
+    after?: string;
+    limit?: number;
+}
+type AnalyticsPeriod = '7d' | '30d' | '90d';
+interface AnalyticsSummary {
+    period: AnalyticsPeriod;
+    totalSent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+    /** Percentage: `(delivered / totalSent) * 100`. */
+    deliveryRate: number;
+    /** Percentage: `(opened / delivered) * 100`. */
+    openRate: number;
+    /** Percentage: `(clicked / opened) * 100`. */
+    clickRate: number;
+    /** Percentage: `(bounced / totalSent) * 100`. */
+    bounceRate: number;
+}
+interface TimeseriesPoint {
+    /** ISO date string, e.g. `"2025-06-01"`. */
+    date: string;
+    sent: number;
+    delivered: number;
+    opened: number;
+    bounced: number;
+}
+type FlowStatus = 'draft' | 'active' | 'inactive';
+type FlowTriggerType = 'contact_joins_audience' | 'contact_tag_added' | 'contact_tag_removed' | 'email_event' | 'manual';
+type FlowStepType = 'send_email' | 'wait' | 'branch' | 'update_contact' | 'webhook_call';
+interface FlowTrigger {
+    type: FlowTriggerType;
+    config: Record<string, string>;
+}
+interface FlowStep {
+    id: string;
+    type: FlowStepType;
+    config: Record<string, string>;
+}
+interface Flow {
+    id: string;
+    name: string;
+    status: FlowStatus;
+    trigger: FlowTrigger;
+    steps: FlowStep[];
+    enrollments: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateFlowParams {
+    name: string;
+}
+interface UpdateFlowParams {
+    name?: string;
+    trigger?: FlowTrigger;
+    /** Max 20 steps. Cannot be changed while the flow is active — deactivate first. */
+    steps?: FlowStep[];
+}
+interface ListFlowsParams {
+    after?: string;
+    limit?: number;
+}
+type WorkspacePlan = 'free' | 'starter' | 'growth';
+type WorkspaceMemberRole = 'owner' | 'admin' | 'member';
+type WorkspaceLocale = 'it' | 'en';
+interface Workspace {
+    id: string;
+    name: string;
+    slug: string;
+    timezone: string;
+    locale: WorkspaceLocale;
+    plan: WorkspacePlan;
+    createdAt: string;
+}
+interface WorkspaceMember {
+    userId: string;
+    email: string;
+    displayName: string | null;
+    role: WorkspaceMemberRole;
+    joinedAt: string;
+}
+interface WorkspacePreferences {
+    locale: WorkspaceLocale;
+    emailNotifications: {
+        bounces: boolean;
+        weeklyReport: boolean;
+        billingAlerts: boolean;
+    };
+}
+interface UpdateWorkspaceParams {
+    name?: string;
+    /** URL slug — lowercase letters, digits and hyphens only (2–50 chars). Must be globally unique. */
+    slug?: string;
+    timezone?: string;
+    locale?: WorkspaceLocale;
+}
+interface UpdateWorkspacePreferencesParams {
+    locale?: WorkspaceLocale;
+    emailNotifications?: {
+        bounces?: boolean;
+        weeklyReport?: boolean;
+        billingAlerts?: boolean;
+    };
+}
+interface InviteMemberParams {
+    email: string;
+    role: 'admin' | 'member';
+}
+interface UpdateMemberParams {
+    role: WorkspaceMemberRole;
+}
+
+/** Service for sending transactional emails and inspecting their delivery. */
+declare class EmailsService extends BaseService {
+    private readonly url;
+    /**
+     * Send a transactional email (`POST /v1/emails`).
+     * At least one of `html`, `text`, or `templateId` is required.
+     *
+     * @param params Email parameters.
+     * @param idempotencyKey Optional key that guarantees exactly-once delivery.
+     *   If the same key is re-used within 24 hours the original response is returned.
+     * @returns Observable that emits the created email `id`.
+     */
+    send(params: SendEmailParams, idempotencyKey?: string): Observable<{
+        id: string;
+    }>;
+    /**
+     * List emails with optional filters (`GET /v1/emails`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListEmailsParams): Observable<PaginatedResponse<EmailSummary>>;
+    /**
+     * Get a single email with full details and inline events (`GET /v1/emails/:id`).
+     */
+    get(id: string): Observable<EmailDetail>;
+    /**
+     * List all delivery events for a specific email (`GET /v1/emails/:id/events`).
+     */
+    listEvents(id: string): Observable<EmailEvent[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EmailsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EmailsService>;
+}
+
+/** Service for managing contacts and running CSV imports. */
+declare class ContactsService extends BaseService {
+    private readonly url;
+    /**
+     * Create a single contact (`POST /v1/contacts`).
+     * Returns a conflict error if the email address is already registered.
+     */
+    create(params: CreateContactParams): Observable<{
+        id: string;
+    }>;
+    /**
+     * List contacts with optional filters (`GET /v1/contacts`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListContactsParams): Observable<PaginatedResponse<Contact>>;
+    /**
+     * Update a contact's details (`PATCH /v1/contacts/:id`).
+     * Only supplied fields are updated.
+     */
+    update(id: string, params: UpdateContactParams): Observable<{
+        id: string;
+    }>;
+    /**
+     * Start an asynchronous CSV import job (`POST /v1/contacts/import`).
+     *
+     * The CSV must have an `email` column. Optional columns:
+     * `first_name` / `firstname`, `last_name` / `lastname`, `status`,
+     * `tags` (semicolon-separated values).
+     *
+     * Maximum 50 000 rows per import. Poll {@link getImportJob} to track progress.
+     *
+     * @returns Observable that emits the new `jobId` and total row count.
+     */
+    importCsv(csvText: string): Observable<{
+        jobId: string;
+        totalRows: number;
+    }>;
+    /**
+     * Poll the status of a CSV import job (`GET /v1/contacts/import/:jobId`).
+     */
+    getImportJob(jobId: string): Observable<ImportJobStatus>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ContactsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ContactsService>;
+}
+
+/** Service for managing contact audiences. */
+declare class AudiencesService extends BaseService {
+    private readonly url;
+    /**
+     * Create an audience (`POST /v1/audiences`).
+     * Optionally supply filter `rules` to make it a dynamic segment.
+     */
+    create(params: CreateAudienceParams): Observable<{
+        id: string;
+    }>;
+    /**
+     * List audiences (`GET /v1/audiences`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListAudiencesParams): Observable<PaginatedResponse<Audience>>;
+    /**
+     * Get a single audience by ID (`GET /v1/audiences/:id`).
+     */
+    get(id: string): Observable<Audience>;
+    /**
+     * Add contacts to an audience (`POST /v1/audiences/:id/contacts`).
+     * Accepts up to 500 contact IDs per call.
+     */
+    addContacts(audienceId: string, contactIds: string[]): Observable<AddContactsToAudienceResult>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AudiencesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AudiencesService>;
+}
+
+/** Service for managing and sending email campaigns. */
+declare class CampaignsService extends BaseService {
+    private readonly url;
+    /**
+     * Create a campaign in `draft` status (`POST /v1/campaigns`).
+     * Call {@link send} to dispatch it.
+     */
+    create(params: CreateCampaignParams): Observable<{
+        id: string;
+    }>;
+    /**
+     * List campaigns with optional status filter (`GET /v1/campaigns`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListCampaignsParams): Observable<PaginatedResponse<Campaign>>;
+    /**
+     * Get a single campaign by ID (`GET /v1/campaigns/:id`).
+     */
+    get(id: string): Observable<Campaign>;
+    /**
+     * Get delivery statistics for a campaign (`GET /v1/campaigns/:id/stats`).
+     */
+    getStats(id: string): Observable<CampaignStatsDetail>;
+    /**
+     * Send or schedule a campaign (`POST /v1/campaigns/:id/send`).
+     * Only `draft` or `paused` campaigns can be sent.
+     *
+     * @param id Campaign ID.
+     * @param params Optional `scheduledAt` to defer sending.
+     * @returns Observable emitting the new campaign status.
+     */
+    send(id: string, params?: SendCampaignParams): Observable<{
+        status: string;
+    }>;
+    /**
+     * Pause a `sending` or `scheduled` campaign (`POST /v1/campaigns/:id/pause`).
+     */
+    pause(id: string): Observable<{
+        status: string;
+    }>;
+    /**
+     * Send a test email for this campaign to a specific address
+     * (`POST /v1/campaigns/:id/test-send`).
+     *
+     * @param id Campaign ID.
+     * @param to Recipient email address for the test.
+     * @returns Observable emitting the created test email ID.
+     */
+    testSend(id: string, to: string): Observable<{
+        emailId: string;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CampaignsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CampaignsService>;
+}
+
+/** Service for managing email templates and their version history. */
+declare class TemplatesService extends BaseService {
+    private readonly url;
+    /**
+     * List templates (`GET /v1/templates`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListTemplatesParams): Observable<PaginatedResponse<TemplateSummary>>;
+    /**
+     * Create a new template (`POST /v1/templates`).
+     * The template starts in `draft` status.
+     */
+    create(params: CreateTemplateParams): Observable<Template>;
+    /**
+     * Get a single template by ID (`GET /v1/templates/:id`).
+     */
+    get(id: string): Observable<Template>;
+    /**
+     * Update a template's name, HTML, or status (`PATCH /v1/templates/:id`).
+     * Changing `html` automatically creates a new version entry.
+     */
+    update(id: string, params: UpdateTemplateParams): Observable<Template>;
+    /**
+     * Permanently delete a template (`DELETE /v1/templates/:id`).
+     */
+    delete(id: string): Observable<void>;
+    /**
+     * List the version history of a template (`GET /v1/templates/:id/versions`).
+     * Returns up to the 20 most recent versions, newest first.
+     */
+    listVersions(id: string): Observable<TemplateVersionSummary[]>;
+    /**
+     * Get the HTML of a specific template version (`GET /v1/templates/:id/versions/:version`).
+     */
+    getVersion(id: string, version: number): Observable<TemplateVersion>;
+    /**
+     * Send a test email using this template (`POST /v1/templates/:id/test-send`).
+     *
+     * @param id Template ID.
+     * @param to Recipient address for the test.
+     * @param variables Variables to substitute inside the template.
+     */
+    testSend(id: string, to: string, variables?: Record<string, string>): Observable<{
+        queued: boolean;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TemplatesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TemplatesService>;
+}
+
+/** Service for managing webhook endpoints and inspecting delivery history. */
+declare class WebhooksService extends BaseService {
+    private readonly url;
+    /**
+     * Register a new webhook endpoint (`POST /v1/webhooks`).
+     *
+     * The returned `secret` is shown only once — store it securely and use it
+     * to verify the `X-Tratto-Signature` header on incoming events.
+     *
+     * @returns Observable emitting the new webhook `id` and HMAC signing `secret`.
+     */
+    create(params: CreateWebhookParams): Observable<{
+        id: string;
+        secret: string;
+    }>;
+    /**
+     * List all registered webhooks (`GET /v1/webhooks`).
+     * Results are ordered by creation date descending.
+     */
+    list(): Observable<Webhook[]>;
+    /**
+     * Delete a webhook endpoint (`DELETE /v1/webhooks/:id`).
+     */
+    delete(id: string): Observable<void>;
+    /**
+     * List delivery attempts for a webhook (`GET /v1/webhooks/:id/deliveries`).
+     * Results are ordered by attempt date descending.
+     */
+    listDeliveries(id: string, params?: ListWebhookDeliveriesParams): Observable<PaginatedResponse<WebhookDelivery>>;
+    /**
+     * Send a test event to a webhook endpoint (`POST /v1/webhooks/:id/test`).
+     * Useful for verifying connectivity and signature verification logic.
+     */
+    test(id: string): Observable<{
+        queued: boolean;
+    }>;
+    /**
+     * Rotate the signing secret for a webhook (`POST /v1/webhooks/:id/rotate-secret`).
+     * The new secret is returned once — store it securely.
+     * Also resets the failure counter and re-enables a disabled webhook.
+     */
+    rotateSecret(id: string): Observable<{
+        secret: string;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WebhooksService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WebhooksService>;
+}
+
+/** Service for adding and verifying sender domains. */
+declare class DomainsService extends BaseService {
+    private readonly url;
+    /**
+     * Add a domain and generate its DKIM keypair (`POST /v1/domains`).
+     * The response contains the DNS records that must be published before calling {@link verify}.
+     *
+     * @param domain Bare domain name, e.g. `"mail.acme.com"`.
+     */
+    add(domain: string): Observable<Domain>;
+    /**
+     * List domains (`GET /v1/domains`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListDomainsParams): Observable<PaginatedResponse<DomainSummary>>;
+    /**
+     * Get full domain details including DNS records (`GET /v1/domains/:id`).
+     */
+    get(id: string): Observable<Domain>;
+    /**
+     * Trigger DNS verification for a domain (`POST /v1/domains/:id/verify`).
+     * Checks SPF, DKIM, and DMARC records in real time and updates the domain status.
+     * The domain must be `verified` before it can be used as a sender.
+     */
+    verify(id: string): Observable<Domain>;
+    /**
+     * Remove a domain and delete its DKIM private key (`DELETE /v1/domains/:id`).
+     *
+     * @returns Observable emitting the deleted domain `id` and `deletedAt` timestamp.
+     */
+    delete(id: string): Observable<{
+        id: string;
+        deletedAt: string;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DomainsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DomainsService>;
+}
+
+/** Service for creating and revoking API keys. */
+declare class ApiKeysService extends BaseService {
+    private readonly url;
+    /**
+     * Create a new API key (`POST /v1/api-keys`).
+     *
+     * The full raw key in the response is shown **only once** — store it securely.
+     *
+     * @param params Key name, environment and permission scopes.
+     * @param idempotencyKey Optional key to prevent accidental duplicates.
+     * @returns Observable emitting the created key including the raw token.
+     */
+    create(params: CreateApiKeyParams, idempotencyKey?: string): Observable<ApiKeyCreated>;
+    /**
+     * List API keys (without the raw token) (`GET /v1/api-keys`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListApiKeysParams): Observable<PaginatedResponse<ApiKey>>;
+    /**
+     * Revoke (soft-delete) an API key (`DELETE /v1/api-keys/:id`).
+     * Revoked keys are immediately rejected by the API.
+     *
+     * @returns Observable emitting the key `id` and `revokedAt` timestamp.
+     */
+    revoke(id: string): Observable<{
+        id: string;
+        revokedAt: string;
+    }>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiKeysService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiKeysService>;
+}
+
+/** Service for querying email analytics and delivery metrics. */
+declare class AnalyticsService extends BaseService {
+    private readonly url;
+    /**
+     * Get aggregated email metrics for a time period (`GET /v1/analytics/summary`).
+     * Results are cached server-side for one hour.
+     *
+     * @param period Lookback window. Defaults to `'30d'`.
+     */
+    getSummary(period?: AnalyticsPeriod): Observable<AnalyticsSummary>;
+    /**
+     * Get daily email metrics for a time period (`GET /v1/analytics/timeseries`).
+     * Returns one data point per day for the chosen window.
+     * Results are cached server-side for one hour.
+     *
+     * @param period Lookback window. Defaults to `'30d'`.
+     */
+    getTimeseries(period?: AnalyticsPeriod): Observable<TimeseriesPoint[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AnalyticsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AnalyticsService>;
+}
+
+/** Service for managing email automation flows. */
+declare class FlowsService extends BaseService {
+    private readonly url;
+    /**
+     * List automation flows (`GET /v1/flows`).
+     * Results are ordered by creation date descending.
+     */
+    list(params?: ListFlowsParams): Observable<PaginatedResponse<Flow>>;
+    /**
+     * Create a flow in `draft` status (`POST /v1/flows`).
+     * Configure the trigger and steps via {@link update} before activating.
+     */
+    create(params: CreateFlowParams): Observable<{
+        id: string;
+    }>;
+    /**
+     * Get a single flow by ID (`GET /v1/flows/:id`).
+     */
+    get(id: string): Observable<Flow>;
+    /**
+     * Update a flow's name, trigger, or steps (`PATCH /v1/flows/:id`).
+     * Steps cannot be changed while the flow is active — call {@link deactivate} first.
+     */
+    update(id: string, params: UpdateFlowParams): Observable<Flow>;
+    /**
+     * Delete a flow (`DELETE /v1/flows/:id`).
+     * Only `draft` or `inactive` flows can be deleted.
+     */
+    delete(id: string): Observable<{
+        id: string;
+    }>;
+    /**
+     * Activate a flow, enabling it to enroll contacts (`POST /v1/flows/:id/activate`).
+     */
+    activate(id: string): Observable<Flow>;
+    /**
+     * Deactivate a flow (`POST /v1/flows/:id/deactivate`).
+     * Contacts already enrolled continue through their current steps.
+     * No new enrollments are accepted until the flow is re-activated.
+     */
+    deactivate(id: string): Observable<Flow>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FlowsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FlowsService>;
+}
+
+/** Service for managing workspace settings and team members. */
+declare class WorkspaceService extends BaseService {
+    private readonly url;
+    /**
+     * Get the current workspace (`GET /v1/workspace`).
+     * Creates a workspace with default settings on first access if none exists.
+     */
+    get(): Observable<Workspace>;
+    /**
+     * Update workspace settings (`PATCH /v1/workspace`).
+     * Only supplied fields are changed.
+     */
+    update(params: UpdateWorkspaceParams): Observable<Workspace>;
+    /**
+     * Schedule the workspace for deletion (`DELETE /v1/workspace`).
+     * Only the workspace owner can perform this action.
+     */
+    delete(): Observable<void>;
+    /**
+     * Update workspace preferences such as locale and notification settings
+     * (`PATCH /v1/workspace/preferences`).
+     */
+    updatePreferences(params: UpdateWorkspacePreferencesParams): Observable<WorkspacePreferences>;
+    /**
+     * Invite a new member to the workspace (`POST /v1/workspace/members/invite`).
+     * The invite is accepted automatically when the user first logs in.
+     */
+    inviteMember(params: InviteMemberParams): Observable<WorkspaceMember>;
+    /**
+     * Update a member's role (`PATCH /v1/workspace/members/:userId`).
+     */
+    updateMember(userId: string, params: UpdateMemberParams): Observable<WorkspaceMember>;
+    /**
+     * Remove a member from the workspace (`DELETE /v1/workspace/members/:userId`).
+     * The workspace owner cannot be removed.
+     */
+    removeMember(userId: string): Observable<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkspaceService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkspaceService>;
+}
+
+/**
+ * Top-level facade that aggregates all Tratto resource services.
+ *
+ * Inject `TrattoService` for a single entry-point into the SDK, or inject
+ * individual resource services (e.g. `EmailsService`) directly for
+ * better tree-shaking in large applications.
+ *
+ * @example
+ * ```ts
+ * // app.component.ts
+ * export class AppComponent {
+ *   private tratto = inject(TrattoService);
+ *
+ *   sendWelcome() {
+ *     this.tratto.emails
+ *       .send({ from: 'hello@acme.com', to: 'user@example.com', subject: 'Welcome!' })
+ *       .subscribe(({ id }) => console.log('Sent:', id));
+ *   }
+ * }
+ * ```
+ */
+declare class TrattoService {
+    /** Access email sending and inspection methods. */
+    readonly emails: EmailsService;
+    /** Access contact management and CSV import methods. */
+    readonly contacts: ContactsService;
+    /** Access audience creation and membership methods. */
+    readonly audiences: AudiencesService;
+    /** Access campaign creation, scheduling, and statistics methods. */
+    readonly campaigns: CampaignsService;
+    /** Access template CRUD and version history methods. */
+    readonly templates: TemplatesService;
+    /** Access webhook registration and delivery history methods. */
+    readonly webhooks: WebhooksService;
+    /** Access domain onboarding and DNS verification methods. */
+    readonly domains: DomainsService;
+    /** Access API key creation and revocation methods. */
+    readonly apiKeys: ApiKeysService;
+    /** Access email analytics summary and time-series methods. */
+    readonly analytics: AnalyticsService;
+    /** Access automation flow management methods. */
+    readonly flows: FlowsService;
+    /** Access workspace settings and team member methods. */
+    readonly workspace: WorkspaceService;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TrattoService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TrattoService>;
+}
+
+export { AnalyticsService, ApiKeysService, AudiencesService, CampaignsService, ContactsService, DomainsService, EmailsService, FlowsService, TRATTO_CONFIG, TemplatesService, TrattoModule, TrattoService, WebhooksService, WorkspaceService, provideTratt };
+export type { AddContactsToAudienceResult, AnalyticsPeriod, AnalyticsSummary, ApiKey, ApiKeyCreated, ApiKeyEnv, Audience, AudienceRule, AudienceRuleOperator, Campaign, CampaignStats, CampaignStatsDetail, CampaignStatus, Contact, ContactStatus, CreateApiKeyParams, CreateAudienceParams, CreateCampaignParams, CreateContactParams, CreateFlowParams, CreateTemplateParams, CreateWebhookParams, Domain, DomainRecord, DomainStatus, DomainSummary, EmailDetail, EmailEvent, EmailSummary, Flow, FlowStatus, FlowStep, FlowStepType, FlowTrigger, FlowTriggerType, ImportJobStatus, InviteMemberParams, ListApiKeysParams, ListAudiencesParams, ListCampaignsParams, ListContactsParams, ListDomainsParams, ListEmailsParams, ListFlowsParams, ListTemplatesParams, ListWebhookDeliveriesParams, PaginatedResponse, Pagination, SendCampaignParams, SendEmailParams, Template, TemplateStatus, TemplateSummary, TemplateVersion, TemplateVersionSummary, TimeseriesPoint, TrattoConfig, UpdateContactParams, UpdateFlowParams, UpdateMemberParams, UpdateTemplateParams, UpdateWorkspaceParams, UpdateWorkspacePreferencesParams, Webhook, WebhookDelivery, WebhookDeliveryStatus, WebhookEventType, WebhookStatus, Workspace, WorkspaceLocale, WorkspaceMember, WorkspaceMemberRole, WorkspacePlan, WorkspacePreferences };