@poststack.dev/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,420 @@
+declare class PostStackClient {
+    private readonly baseUrl;
+    private readonly headers;
+    constructor(apiKey: string, baseUrl: string);
+    get<T>(path: string, params?: Record<string, string | number | undefined>): Promise<T>;
+    post<T>(path: string, body?: unknown): Promise<T>;
+    patch<T>(path: string, body: unknown): Promise<T>;
+    delete<T>(path: string): Promise<T>;
+    private handleResponse;
+}
+
+interface Attachment {
+    filename: string;
+    content: string;
+    content_type?: string;
+}
+interface SendEmailInput {
+    from: string;
+    to: string[];
+    cc?: string[];
+    bcc?: string[];
+    reply_to?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+    headers?: Record<string, string>;
+    tags?: string[];
+    attachments?: Attachment[];
+    idempotency_key?: string;
+    scheduled_at?: string;
+    template_id?: string;
+    variables?: Record<string, string>;
+}
+interface BatchSendInput {
+    emails: SendEmailInput[];
+}
+interface CreateDomainInput {
+    name: string;
+    region?: 'eu-west-1' | 'us-east-1' | 'sa-east-1' | 'ap-northeast-1';
+    custom_return_path?: string;
+    open_tracking?: boolean;
+    click_tracking?: boolean;
+    tls_mode?: 'opportunistic' | 'enforced';
+}
+interface UpdateDomainInput {
+    open_tracking?: boolean;
+    click_tracking?: boolean;
+    tls_mode?: 'opportunistic' | 'enforced';
+}
+interface CreateContactInput {
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    unsubscribed?: boolean;
+    properties?: Record<string, unknown>;
+}
+interface UpdateContactInput {
+    first_name?: string;
+    last_name?: string;
+    unsubscribed?: boolean;
+    properties?: Record<string, unknown>;
+}
+interface CreateSegmentInput {
+    name: string;
+}
+interface UpdateSegmentInput {
+    name: string;
+}
+interface AddContactsInput {
+    contact_ids: string[];
+}
+interface CreateTemplateInput {
+    name: string;
+    subject: string;
+    html: string;
+    text?: string;
+    variables?: string[];
+}
+interface UpdateTemplateInput {
+    name?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+    variables?: string[];
+}
+interface CreateWebhookInput {
+    url: string;
+    events: string[];
+}
+interface UpdateWebhookInput {
+    url?: string;
+    events?: string[];
+    enabled?: boolean;
+}
+type ApiKeyPermission = 'full_access' | 'sending_access';
+type ApiKeyMode = 'live' | 'test';
+interface CreateApiKeyInput {
+    name: string;
+    permission: ApiKeyPermission;
+    mode?: ApiKeyMode;
+    domain_id?: string;
+}
+type EmailStatus = 'queued' | 'sending' | 'delivered' | 'bounced' | 'complained' | 'failed';
+type EmailEventType = 'queued' | 'sent' | 'delivered' | 'bounced' | 'soft_bounced' | 'opened' | 'clicked' | 'complained' | 'unsubscribed' | 'failed';
+type DomainStatus = 'pending' | 'verified' | 'failed';
+type TlsMode = 'opportunistic' | 'enforced';
+type Region = 'eu-west-1' | 'us-east-1' | 'sa-east-1' | 'ap-northeast-1';
+type DnsRecordType = 'TXT' | 'CNAME' | 'MX';
+type DnsPurpose = 'spf' | 'dkim' | 'dmarc' | 'return_path' | 'mx';
+interface EmailEvent {
+    type: EmailEventType;
+    timestamp: string;
+}
+interface Email {
+    id: string;
+    publicId: string;
+    from: string;
+    to: string[];
+    subject: string;
+    status: EmailStatus;
+    createdAt: string;
+    sentAt?: string;
+    events?: EmailEvent[];
+}
+interface DnsRecord {
+    type: DnsRecordType;
+    name: string;
+    value: string;
+    purpose: DnsPurpose;
+    verified: boolean;
+}
+interface Domain {
+    id: number;
+    name: string;
+    status: DomainStatus;
+    region: Region;
+    dnsRecords: DnsRecord[];
+    openTracking: boolean;
+    clickTracking: boolean;
+    tlsMode: TlsMode;
+    verifiedAt?: string;
+    createdAt: string;
+}
+interface Contact {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    unsubscribed: boolean;
+    properties?: Record<string, unknown>;
+    createdAt: string;
+}
+interface Segment {
+    id: string;
+    name: string;
+    contactCount: number;
+    createdAt: string;
+}
+interface Template {
+    id: number;
+    publicId: string;
+    name: string;
+    subject: string;
+    htmlBody?: string;
+    textBody?: string;
+    variables?: string[];
+    published: boolean;
+    version: number;
+    createdAt: string;
+}
+interface Webhook {
+    id: number;
+    url: string;
+    events: string[];
+    active: boolean;
+    createdAt: string;
+}
+interface ApiKey {
+    id: number;
+    name: string;
+    keyPrefix: string;
+    permission: ApiKeyPermission;
+    mode: ApiKeyMode;
+    domainId: number | null;
+    lastUsedAt?: string | null;
+    expiresAt?: string | null;
+    createdAt: string;
+}
+interface PaginationMeta {
+    page: number;
+    perPage: number;
+    total: number;
+    totalPages: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+interface ListParams {
+    page?: number;
+    per_page?: number;
+}
+interface ListContactsParams extends ListParams {
+    search?: string;
+    segment_id?: string;
+}
+type BroadcastStatus = 'draft' | 'queued' | 'sending' | 'sent' | 'cancelled';
+interface CreateBroadcastInput {
+    segment_id: string;
+    from: string;
+    subject: string;
+    html?: string;
+    text?: string;
+    reply_to?: string;
+    name?: string;
+    scheduled_at?: string;
+    topic_id?: number;
+}
+interface UpdateBroadcastInput {
+    segment_id?: string;
+    from?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+    reply_to?: string;
+    name?: string;
+    scheduled_at?: string;
+    topic_id?: number;
+}
+interface TestBroadcastInput {
+    email: string;
+}
+interface Broadcast {
+    id: number;
+    publicId: string;
+    subject: string;
+    status: BroadcastStatus;
+    totalRecipients: number;
+    deliveredCount: number;
+    openedCount: number;
+    clickedCount: number;
+    bouncedCount: number;
+    createdAt: string;
+    sentAt?: string;
+    scheduledAt?: string;
+}
+type SuppressionReason = 'hard_bounce' | 'complaint' | 'manual' | 'unsubscribe';
+interface AddSuppressionInput {
+    email: string;
+    reason?: SuppressionReason;
+}
+interface Suppression {
+    id: number;
+    email: string;
+    reason: SuppressionReason;
+    createdAt: string;
+}
+
+declare class ApiKeysResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateApiKeyInput): Promise<ApiKey>;
+    list(params?: ListParams): Promise<{
+        keys: ApiKey[];
+    }>;
+    get(id: number): Promise<ApiKey>;
+    revoke(id: number): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class BroadcastsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateBroadcastInput): Promise<{
+        broadcast: Broadcast;
+    }>;
+    list(params?: ListParams): Promise<PaginatedResponse<Broadcast>>;
+    get(id: string): Promise<{
+        broadcast: Broadcast;
+    }>;
+    update(id: string, input: UpdateBroadcastInput): Promise<{
+        broadcast: Broadcast;
+    }>;
+    send(id: string): Promise<{
+        success: boolean;
+    }>;
+    cancel(id: string): Promise<{
+        success: boolean;
+    }>;
+    sendTest(id: string, input: TestBroadcastInput): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class ContactsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateContactInput): Promise<Contact>;
+    list(params?: ListContactsParams): Promise<PaginatedResponse<Contact>>;
+    get(id: string): Promise<Contact>;
+    update(id: string, input: UpdateContactInput): Promise<Contact>;
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    unsubscribe(id: string): Promise<Contact>;
+}
+
+declare class DomainsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateDomainInput): Promise<Domain>;
+    list(params?: ListParams): Promise<PaginatedResponse<Domain>>;
+    get(id: number): Promise<Domain>;
+    verify(id: number): Promise<Domain>;
+    update(id: number, input: UpdateDomainInput): Promise<Domain>;
+    delete(id: number): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class EmailsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    send(input: SendEmailInput): Promise<{
+        id: string;
+    }>;
+    batch(input: BatchSendInput): Promise<{
+        data: {
+            id: string;
+        }[];
+    }>;
+    get(id: string): Promise<Email>;
+    list(params?: ListParams): Promise<PaginatedResponse<Email>>;
+    cancel(id: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class SegmentsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateSegmentInput): Promise<Segment>;
+    list(params?: ListParams): Promise<PaginatedResponse<Segment>>;
+    get(id: string): Promise<Segment>;
+    update(id: string, input: UpdateSegmentInput): Promise<Segment>;
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    addContacts(id: string, input: AddContactsInput): Promise<{
+        success: boolean;
+    }>;
+    removeContact(id: string, contactId: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class SuppressionsResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    list(params?: ListParams): Promise<PaginatedResponse<Suppression>>;
+    add(input: AddSuppressionInput): Promise<{
+        success: boolean;
+    }>;
+    remove(email: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class TemplatesResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateTemplateInput): Promise<Template>;
+    list(params?: ListParams): Promise<PaginatedResponse<Template>>;
+    get(id: string): Promise<Template>;
+    update(id: string, input: UpdateTemplateInput): Promise<Template>;
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    publish(id: string): Promise<Template>;
+    unpublish(id: string): Promise<Template>;
+}
+
+declare class WebhooksResource {
+    private readonly client;
+    constructor(client: PostStackClient);
+    create(input: CreateWebhookInput): Promise<Webhook>;
+    get(id: number): Promise<Webhook>;
+    list(params?: ListParams): Promise<PaginatedResponse<Webhook>>;
+    update(id: number, input: UpdateWebhookInput): Promise<Webhook>;
+    delete(id: number): Promise<{
+        success: boolean;
+    }>;
+    test(id: number): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class PostStackError extends Error {
+    readonly statusCode: number;
+    readonly code?: string | undefined;
+    constructor(statusCode: number, message: string, code?: string | undefined);
+}
+
+declare class PostStack {
+    readonly emails: EmailsResource;
+    readonly domains: DomainsResource;
+    readonly contacts: ContactsResource;
+    readonly segments: SegmentsResource;
+    readonly templates: TemplatesResource;
+    readonly webhooks: WebhooksResource;
+    readonly broadcasts: BroadcastsResource;
+    readonly suppressions: SuppressionsResource;
+    readonly apiKeys: ApiKeysResource;
+    constructor(apiKey: string, options?: {
+        baseUrl?: string;
+    });
+}
+
+export { type AddContactsInput, type AddSuppressionInput, type ApiKey, type ApiKeyMode, type ApiKeyPermission, type Attachment, type BatchSendInput, type Broadcast, type BroadcastStatus, type Contact, type CreateApiKeyInput, type CreateBroadcastInput, type CreateContactInput, type CreateDomainInput, type CreateSegmentInput, type CreateTemplateInput, type CreateWebhookInput, type DnsPurpose, type DnsRecord, type DnsRecordType, type Domain, type DomainStatus, type Email, type EmailEvent, type EmailEventType, type EmailStatus, type ListContactsParams, type ListParams, type PaginatedResponse, type PaginationMeta, PostStack, PostStackError, type Region, type Segment, type SendEmailInput, type Suppression, type SuppressionReason, type Template, type TestBroadcastInput, type TlsMode, type UpdateBroadcastInput, type UpdateContactInput, type UpdateDomainInput, type UpdateSegmentInput, type UpdateTemplateInput, type UpdateWebhookInput, type Webhook };