@stackshift-cloud/sdk 0.1.0 → 0.1.2

package/dist/mail-reputation-types.d.ts

@@ -0,0 +1,55 @@
+export type MailReputationStatus = 'healthy' | 'watch' | 'throttled' | 'disabled';
+export type MailReputationTier = 'sandbox' | 'starter' | 'verified' | 'trusted' | 'custom';
+export type MailManualReviewStatus = 'not_required' | 'pending' | 'approved' | 'rejected';
+export type MailReputationEventSeverity = 'info' | 'warning' | 'critical';
+export interface MailLimits {
+    tier: MailReputationTier;
+    status: MailReputationStatus;
+    dailyLimit: number;
+    dailyUsed: number;
+    hourlyLimit: number;
+    hourlyUsed: number;
+    perMinuteLimit: number;
+    currentWarmupStage: number;
+    manualReviewStatus: MailManualReviewStatus;
+}
+export interface MailReputationWorkspace {
+    status: MailReputationStatus;
+    score: number;
+    tier: MailReputationTier;
+    bounceRate: number;
+    deferralRate: number;
+    suppressionRate: number;
+    complaintRate: number | null;
+}
+export interface MailDomainReputation {
+    domain: string;
+    status: MailReputationStatus;
+    score: number;
+    bounceRate: number;
+    deferralRate: number;
+    complaintRate: number | null;
+    currentWarmupStage: number;
+}
+export interface MailReputation {
+    workspace: MailReputationWorkspace;
+    domains: MailDomainReputation[];
+}
+export interface MailReputationEvent {
+    id: string;
+    type: string;
+    severity: MailReputationEventSeverity;
+    message: string;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+}
+export interface MailReputationEventListOptions {
+    severity?: MailReputationEventSeverity;
+    type?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface MailReputationEventListResult {
+    data: MailReputationEvent[];
+    nextCursor?: string | null;
+}

package/dist/mail-reputation-types.js

@@ -0,0 +1 @@
+export {};

package/dist/mail-template-types.d.ts

@@ -0,0 +1,96 @@
+import type { JsonValue, MailAddressInput, MailIdempotencyStatus, MailStatus } from './types.js';
+export type MailTemplateStatus = 'active' | 'archived' | 'deleted';
+export interface MailTemplateCreateInput {
+    name: string;
+    slug: string;
+    description?: string;
+    subject: string;
+    html?: string;
+    text?: string;
+}
+export interface MailTemplateUpdateInput {
+    name?: string;
+    description?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+}
+export interface MailTemplateListOptions {
+    status?: MailTemplateStatus;
+    limit?: number;
+    cursor?: string;
+    search?: string;
+}
+export interface MailTemplate {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string | null;
+    status: MailTemplateStatus;
+    activeVersionId?: string | null;
+    variables: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MailTemplateVersion {
+    id: string;
+    templateId: string;
+    versionNumber: number;
+    subject: string;
+    html?: string | null;
+    text?: string | null;
+    variables: string[];
+    createdAt: string;
+}
+export interface MailTemplateDetail extends MailTemplate {
+    activeVersion?: MailTemplateVersion | null;
+    versions?: MailTemplateVersion[];
+}
+export interface MailTemplateListResult {
+    data: MailTemplate[];
+    nextCursor?: string | null;
+}
+export interface MailTemplatePreview {
+    subject: string;
+    html?: string | null;
+    text?: string | null;
+    missingVariables: string[];
+}
+export interface MailTemplatePreviewInput {
+    data: Record<string, JsonValue>;
+    versionId?: string;
+}
+export interface MailTemplateTestSendInput {
+    to: MailAddressInput;
+    from?: MailAddressInput;
+    data: Record<string, JsonValue>;
+    versionId?: string;
+}
+export interface MailTemplateTestSendResponse {
+    messageId: string;
+    status: MailStatus;
+}
+export interface MailSendTemplateInput {
+    template: string;
+    versionId?: string;
+    to: MailAddressInput;
+    from?: MailAddressInput;
+    cc?: MailAddressInput;
+    bcc?: MailAddressInput;
+    replyTo?: MailAddressInput;
+    data: Record<string, JsonValue>;
+    idempotencyKey?: string;
+    attachments?: Array<{
+        assetId?: string;
+        uploadId?: string;
+        filename: string;
+        contentType?: string;
+    }>;
+}
+export interface MailSendTemplateResponse {
+    id: string;
+    status: MailStatus;
+    templateId: string;
+    templateVersionId: string;
+    idempotencyStatus: MailIdempotencyStatus;
+}

package/dist/mail-template-types.js

@@ -0,0 +1 @@
+export {};

package/dist/mail-webhook-types.d.ts

@@ -0,0 +1,96 @@
+import type { JsonValue } from './types.js';
+export type MailEventType = 'mail.message.queued' | 'mail.message.sending' | 'mail.message.sent' | 'mail.message.deferred' | 'mail.message.failed' | 'mail.message.bounced' | 'mail.message.suppressed' | 'mail.suppression.created' | 'mail.suppression.deleted' | 'mail.otp.created' | 'mail.otp.sent' | 'mail.otp.verified' | 'mail.otp.failed_attempt' | 'mail.otp.failed' | 'mail.otp.expired' | 'mail.otp.canceled' | 'mail.template.created' | 'mail.template.updated' | 'mail.template.deleted' | 'mail.template.version.created' | 'mail.template.test_sent' | 'mail.domain.created' | 'mail.domain.verified' | 'mail.domain.failed' | 'mail.domain.deleted' | 'mail.webhook.created' | 'mail.webhook.updated' | 'mail.webhook.disabled' | 'mail.webhook.delivery.succeeded' | 'mail.webhook.delivery.failed';
+export interface MailEvent {
+    id: string;
+    type: MailEventType | string;
+    resourceType?: string | null;
+    resourceId?: string | null;
+    messageId?: string | null;
+    payload: JsonValue;
+    occurredAt: string;
+    createdAt: string;
+}
+export interface MailEventListOptions {
+    type?: MailEventType | string;
+    resourceType?: string;
+    resourceId?: string;
+    messageId?: string;
+    limit?: number;
+    cursor?: string;
+    from?: string;
+    to?: string;
+}
+export interface MailEventListResult {
+    data: MailEvent[];
+    nextCursor?: string | null;
+}
+export interface MailTimelineItem {
+    type: string;
+    label: string;
+    createdAt: string;
+    metadata?: Record<string, JsonValue>;
+}
+export interface MailWebhook {
+    id: string;
+    url: string;
+    description?: string | null;
+    status: 'active' | 'disabled' | 'deleted' | string;
+    eventTypes: Array<MailEventType | string>;
+    failureCount?: number;
+    lastSuccessAt?: string | null;
+    lastFailureAt?: string | null;
+    createdAt: string;
+}
+export interface MailWebhookCreateInput {
+    url: string;
+    description?: string;
+    eventTypes: Array<MailEventType | string>;
+}
+export interface MailWebhookCreateResponse extends MailWebhook {
+    secret: string;
+}
+export interface MailWebhookUpdateInput {
+    url?: string;
+    description?: string;
+    eventTypes?: Array<MailEventType | string>;
+    status?: 'active' | 'disabled';
+}
+export interface MailWebhookListOptions {
+    limit?: number;
+    cursor?: string;
+}
+export interface MailWebhookListResult {
+    data: MailWebhook[];
+    nextCursor?: string | null;
+}
+export interface MailWebhookDelivery {
+    id: string;
+    endpointId: string;
+    eventId: string;
+    status: 'pending' | 'delivering' | 'succeeded' | 'failed' | 'abandoned' | string;
+    attemptCount: number;
+    nextAttemptAt?: string | null;
+    lastAttemptAt?: string | null;
+    responseStatus?: number | null;
+    responseBodySnippet?: string | null;
+    errorMessage?: string | null;
+    createdAt: string;
+    completedAt?: string | null;
+}
+export interface MailWebhookDeliveryAttempt {
+    id: string;
+    attemptNumber: number;
+    responseStatus?: number | null;
+    responseBodySnippet?: string | null;
+    errorMessage?: string | null;
+    durationMs?: number | null;
+    createdAt: string;
+}
+export interface MailWebhookDeliveryDetail extends MailWebhookDelivery {
+    attempts: MailWebhookDeliveryAttempt[];
+}
+export interface MailWebhookDeliveryListOptions {
+    status?: string;
+    limit?: number;
+    cursor?: string;
+}

package/dist/mail-webhook-types.js

@@ -0,0 +1 @@
+export {};

package/dist/mail.d.ts

@@ -0,0 +1,115 @@
+import type { StackShift } from './client.js';
+import type { MailLog, MailDomain, MailDomainListResult, MailMessage, MailMessageListOptions, MailMessageListResult, MailSendAttempt, MailSendInput, MailSendResponse } from './types.js';
+import type { MailBounce, MailBounceListOptions, MailBounceListResult, MailSuppression, MailSuppressionCreateInput, MailSuppressionListOptions, MailSuppressionListResult } from './mail-phase4-types.js';
+import type { MailOtpChallenge, MailOtpChallengeListOptions, MailOtpChallengeListResult, MailOtpSendInput, MailOtpSendResponse, MailOtpVerifyInput, MailOtpVerifyResponse } from './mail-otp-types.js';
+import type { MailSendTemplateInput, MailSendTemplateResponse, MailTemplate, MailTemplateCreateInput, MailTemplateDetail, MailTemplateListOptions, MailTemplateListResult, MailTemplatePreview, MailTemplatePreviewInput, MailTemplateTestSendInput, MailTemplateTestSendResponse, MailTemplateUpdateInput, MailTemplateVersion } from './mail-template-types.js';
+import { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
+export { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
+import type { MailLimits, MailReputation, MailReputationEventListOptions, MailReputationEventListResult } from './mail-reputation-types.js';
+export { MailEventsClient, MailWebhooksClient, verifyWebhookSignature } from './mail-events-webhooks.js';
+import { MailEventsClient, MailWebhooksClient } from './mail-events-webhooks.js';
+export declare class MailClient {
+    private readonly client;
+    readonly domains: MailDomainsClient;
+    readonly messages: MailMessagesClient;
+    readonly suppressions: MailSuppressionsClient;
+    readonly bounces: MailBouncesClient;
+    readonly otp: MailOtpClient;
+    readonly templates: MailTemplatesClient;
+    readonly events: MailEventsClient;
+    readonly webhooks: MailWebhooksClient;
+    readonly limits: MailLimitsClient;
+    readonly reputation: MailReputationClient;
+    readonly scheduled: MailScheduledClient;
+    readonly batch: MailBatchClient;
+    readonly inbound: MailInboundClient;
+    readonly analytics: MailAnalyticsClient;
+    constructor(client: StackShift);
+    send(input: MailSendInput): Promise<MailSendResponse>;
+    sendTemplate(input: MailSendTemplateInput): Promise<MailSendTemplateResponse>;
+}
+export declare class MailLimitsClient {
+    private readonly client;
+    constructor(client: StackShift);
+    get(): Promise<MailLimits>;
+}
+export declare class MailReputationClient {
+    private readonly client;
+    readonly events: MailReputationEventsClient;
+    constructor(client: StackShift);
+    get(): Promise<MailReputation>;
+}
+export declare class MailReputationEventsClient {
+    private readonly client;
+    constructor(client: StackShift);
+    list(options?: MailReputationEventListOptions): Promise<MailReputationEventListResult>;
+}
+export declare class MailTemplatesClient {
+    private readonly client;
+    constructor(client: StackShift);
+    create(input: MailTemplateCreateInput): Promise<MailTemplate>;
+    list(options?: MailTemplateListOptions): Promise<MailTemplateListResult>;
+    get(templateIdOrSlug: string): Promise<MailTemplateDetail>;
+    update(templateId: string, input: MailTemplateUpdateInput): Promise<MailTemplate>;
+    delete(templateId: string): Promise<void>;
+    versions(templateId: string): Promise<{
+        data: MailTemplateVersion[];
+    }>;
+    getVersion(templateId: string, versionId: string): Promise<MailTemplateVersion>;
+    activateVersion(templateId: string, versionId: string): Promise<MailTemplate>;
+    preview(templateId: string, input: MailTemplatePreviewInput): Promise<MailTemplatePreview>;
+    testSend(templateId: string, input: MailTemplateTestSendInput): Promise<MailTemplateTestSendResponse>;
+}
+export declare class MailDomainsClient {
+    private readonly client;
+    constructor(client: StackShift);
+    create(domain: string): Promise<MailDomain>;
+    list(): Promise<MailDomainListResult>;
+    get(domainId: string): Promise<MailDomain>;
+    verify(domainId: string): Promise<MailDomain>;
+    delete(domainId: string): Promise<void>;
+}
+export declare class MailMessagesClient {
+    private readonly client;
+    constructor(client: StackShift);
+    list(options?: MailMessageListOptions): Promise<MailMessageListResult>;
+    get(messageId: string): Promise<MailMessage>;
+    attempts(messageId: string): Promise<{
+        data: MailSendAttempt[];
+    }>;
+    logs(messageId: string): Promise<{
+        data: MailLog[];
+    }>;
+    bounces(messageId: string): Promise<{
+        data: MailBounce[];
+    }>;
+    timeline(messageId: string): Promise<{
+        data: import("./mail-webhook-types.js").MailTimelineItem[];
+    }>;
+}
+export declare class MailSuppressionsClient {
+    private readonly client;
+    constructor(client: StackShift);
+    list(options?: MailSuppressionListOptions): Promise<MailSuppressionListResult>;
+    create(input: MailSuppressionCreateInput): Promise<MailSuppression>;
+    delete(suppressionId: string): Promise<void>;
+}
+export declare class MailBouncesClient {
+    private readonly client;
+    constructor(client: StackShift);
+    list(options?: MailBounceListOptions): Promise<MailBounceListResult>;
+}
+export declare class MailOtpClient {
+    private readonly client;
+    readonly challenges: MailOtpChallengesClient;
+    constructor(client: StackShift);
+    send(input: MailOtpSendInput): Promise<MailOtpSendResponse>;
+    verify(input: MailOtpVerifyInput): Promise<MailOtpVerifyResponse>;
+}
+export declare class MailOtpChallengesClient {
+    private readonly client;
+    constructor(client: StackShift);
+    list(options?: MailOtpChallengeListOptions): Promise<MailOtpChallengeListResult>;
+    get(challengeId: string): Promise<MailOtpChallenge>;
+    cancel(challengeId: string): Promise<MailOtpChallenge>;
+}

package/dist/mail.js

@@ -0,0 +1,293 @@
+import { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
+export { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
+export { MailEventsClient, MailWebhooksClient, verifyWebhookSignature } from './mail-events-webhooks.js';
+import { MailEventsClient, MailWebhooksClient, timeline } from './mail-events-webhooks.js';
+export class MailClient {
+    client;
+    domains;
+    messages;
+    suppressions;
+    bounces;
+    otp;
+    templates;
+    events;
+    webhooks;
+    limits;
+    reputation;
+    scheduled;
+    batch;
+    inbound;
+    analytics;
+    constructor(client) {
+        this.client = client;
+        this.domains = new MailDomainsClient(client);
+        this.messages = new MailMessagesClient(client);
+        this.suppressions = new MailSuppressionsClient(client);
+        this.bounces = new MailBouncesClient(client);
+        this.otp = new MailOtpClient(client);
+        this.templates = new MailTemplatesClient(client);
+        this.events = new MailEventsClient(client);
+        this.webhooks = new MailWebhooksClient(client);
+        this.limits = new MailLimitsClient(client);
+        this.reputation = new MailReputationClient(client);
+        this.scheduled = new MailScheduledClient(client);
+        this.batch = new MailBatchClient(client);
+        this.inbound = new MailInboundClient(client);
+        this.analytics = new MailAnalyticsClient(client);
+    }
+    send(input) {
+        return this.client.mailRequest('/mail/send', {
+            method: 'POST',
+            body: input,
+        });
+    }
+    sendTemplate(input) {
+        return this.client.mailRequest('/mail/send-template', {
+            method: 'POST',
+            body: input,
+        });
+    }
+}
+export class MailLimitsClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    get() {
+        return this.client.mailRequest('/mail/limits');
+    }
+}
+export class MailReputationClient {
+    client;
+    events;
+    constructor(client) {
+        this.client = client;
+        this.events = new MailReputationEventsClient(client);
+    }
+    get() {
+        return this.client.mailRequest('/mail/reputation');
+    }
+}
+export class MailReputationEventsClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'severity', options.severity);
+        append(query, 'type', options.type);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/reputation/events${suffix ? `?${suffix}` : ''}`);
+    }
+}
+export class MailTemplatesClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    create(input) {
+        return this.client.mailRequest('/mail/templates', {
+            method: 'POST',
+            body: input,
+        });
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'status', options.status);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        append(query, 'search', options.search);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/templates${suffix ? `?${suffix}` : ''}`);
+    }
+    get(templateIdOrSlug) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateIdOrSlug)}`);
+    }
+    update(templateId, input) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}`, {
+            method: 'PATCH',
+            body: input,
+        });
+    }
+    delete(templateId) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}`, {
+            method: 'DELETE',
+        });
+    }
+    versions(templateId) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}/versions`);
+    }
+    getVersion(templateId, versionId) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}/versions/${encodeURIComponent(versionId)}`);
+    }
+    activateVersion(templateId, versionId) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}/versions/${encodeURIComponent(versionId)}/activate`, {
+            method: 'POST',
+        });
+    }
+    preview(templateId, input) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}/preview`, {
+            method: 'POST',
+            body: input,
+        });
+    }
+    testSend(templateId, input) {
+        return this.client.mailRequest(`/mail/templates/${encodeURIComponent(templateId)}/test-send`, {
+            method: 'POST',
+            body: input,
+        });
+    }
+}
+export class MailDomainsClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    create(domain) {
+        return this.client.mailRequest('/mail/domains', {
+            method: 'POST',
+            body: { domain },
+        });
+    }
+    list() {
+        return this.client.mailRequest('/mail/domains');
+    }
+    get(domainId) {
+        return this.client.mailRequest(`/mail/domains/${encodeURIComponent(domainId)}`);
+    }
+    verify(domainId) {
+        return this.client.mailRequest(`/mail/domains/${encodeURIComponent(domainId)}/verify`, {
+            method: 'POST',
+        });
+    }
+    delete(domainId) {
+        return this.client.mailRequest(`/mail/domains/${encodeURIComponent(domainId)}`, {
+            method: 'DELETE',
+        });
+    }
+}
+export class MailMessagesClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'status', options.status);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        append(query, 'to', options.to);
+        append(query, 'from', options.from);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/messages${suffix ? `?${suffix}` : ''}`);
+    }
+    get(messageId) {
+        return this.client.mailRequest(`/mail/messages/${encodeURIComponent(messageId)}`);
+    }
+    attempts(messageId) {
+        return this.client.mailRequest(`/mail/messages/${encodeURIComponent(messageId)}/attempts`);
+    }
+    logs(messageId) {
+        return this.client.mailRequest(`/mail/messages/${encodeURIComponent(messageId)}/logs`);
+    }
+    bounces(messageId) {
+        return this.client.mailRequest(`/mail/messages/${encodeURIComponent(messageId)}/bounces`);
+    }
+    timeline(messageId) {
+        return timeline(this.client, messageId);
+    }
+}
+export class MailSuppressionsClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'email', options.email);
+        append(query, 'reason', options.reason);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/suppressions${suffix ? `?${suffix}` : ''}`);
+    }
+    create(input) {
+        return this.client.mailRequest('/mail/suppressions', {
+            method: 'POST',
+            body: input,
+        });
+    }
+    delete(suppressionId) {
+        return this.client.mailRequest(`/mail/suppressions/${encodeURIComponent(suppressionId)}`, {
+            method: 'DELETE',
+        });
+    }
+}
+export class MailBouncesClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'email', options.email);
+        append(query, 'type', options.type);
+        append(query, 'messageId', options.messageId);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/bounces${suffix ? `?${suffix}` : ''}`);
+    }
+}
+export class MailOtpClient {
+    client;
+    challenges;
+    constructor(client) {
+        this.client = client;
+        this.challenges = new MailOtpChallengesClient(client);
+    }
+    send(input) {
+        return this.client.mailRequest('/mail/otp/send', {
+            method: 'POST',
+            body: input,
+        });
+    }
+    verify(input) {
+        return this.client.mailRequest('/mail/otp/verify', {
+            method: 'POST',
+            body: input,
+        });
+    }
+}
+export class MailOtpChallengesClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    list(options = {}) {
+        const query = new URLSearchParams();
+        append(query, 'to', options.to);
+        append(query, 'purpose', options.purpose);
+        append(query, 'status', options.status);
+        append(query, 'limit', options.limit);
+        append(query, 'cursor', options.cursor);
+        const suffix = query.toString();
+        return this.client.mailRequest(`/mail/otp/challenges${suffix ? `?${suffix}` : ''}`);
+    }
+    get(challengeId) {
+        return this.client.mailRequest(`/mail/otp/challenges/${encodeURIComponent(challengeId)}`);
+    }
+    cancel(challengeId) {
+        return this.client.mailRequest(`/mail/otp/challenges/${encodeURIComponent(challengeId)}/cancel`, {
+            method: 'POST',
+        });
+    }
+}
+function append(target, key, value) {
+    if (value !== undefined && value !== null && value !== '') {
+        target.append(key, String(value));
+    }
+}

package/dist/projects.d.ts

@@ -1,5 +1,5 @@
-import type { StackShift } from './client';
-import type { Project, ProjectListOptions } from './types';
+import type { StackShift } from './client.js';
+import type { Project, ProjectListOptions } from './types.js';
 export declare class ProjectsClient {
     private readonly client;
     constructor(client: StackShift);