silon-sdk 0.2.0

package/dist/types/otp.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the OTP resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=otp.js.map

package/dist/types/otp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otp.js","sourceRoot":"","sources":["../../src/types/otp.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/profile.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Types for the Profile resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/** Body of `GET /api/v1/profile/` — the authenticated user's own profile. */
+export interface UserProfile {
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone_number: string;
+    civil_id?: string | null;
+    /** Preferred language, e.g. `"en"`, `"ar"`. */
+    default_language: string;
+    /** The linked contact profile's client_id (read-only). */
+    client_id: string;
+}
+/** Parameters for {@link Profile.update} (`PATCH /api/v1/profile/`). */
+export interface ProfileUpdateParams {
+    email?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    phone_number?: string | null;
+    civil_id?: string | null;
+    default_language?: string | null;
+}
+/** Parameters for {@link Profile.replace} (`PUT /api/v1/profile/`). */
+export interface ProfileReplaceParams {
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone_number: string;
+    civil_id?: string | null;
+    default_language?: string | null;
+}
+//# sourceMappingURL=profile.d.ts.map

package/dist/types/profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../src/types/profile.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6EAA6E;AAC7E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,+CAA+C;IAC/C,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,uEAAuE;AACvE,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC"}

package/dist/types/profile.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Profile resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=profile.js.map

package/dist/types/profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.js","sourceRoot":"","sources":["../../src/types/profile.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/push.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Types for the Push resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/** Native platform selector for {@link Push.listNotifications}. */
+export type PushPlatform = "android" | "ios";
+/** Parameters for {@link Push.subscribeAndroid} (`POST /api/v1/subscribe/android/`). */
+export interface PushSubscribeAndroidParams {
+    /** Mobile application slug. */
+    slug: string;
+    /** FCM device token. */
+    token?: string | null;
+}
+/** Parameters for {@link Push.subscribeIos} (`POST /api/v1/subscribe/ios/`). */
+export interface PushSubscribeIosParams {
+    /** Mobile application slug. */
+    slug: string;
+    /** APNs device token. */
+    token?: string | null;
+    /** APNs environment: `"dev"` or `"prod"`. */
+    environment?: string | null;
+}
+/** Parameters for {@link Push.upsertDevices} (`POST /api/v1/push/client/`). */
+export interface PushUpsertDevicesParams {
+    /** The CRM contact the device belongs to. */
+    client_id: string;
+    /** Mobile application slug. */
+    slug: string;
+    /** `"android"`, `"ios"` or `"web"`. */
+    device_type: string;
+    /** Device token / registration id. */
+    device_id?: string | null;
+    /** `false` prunes the client's other registered devices. */
+    keep_devices?: boolean | null;
+}
+/** Parameters for {@link Push.markRead} (`POST /api/v1/push/read/`). */
+export interface PushMarkReadParams {
+    /** Mobile application slug. */
+    slug: string;
+}
+/** Options for the deprecated {@link Push.listNotifications}. */
+export interface PushListNotificationsOptions {
+    /**
+     * `"android"` or `"ios"` for the per-platform feed; omit (or `null`) for
+     * the combined list. Anything else throws a {@link SilonError}
+     * client-side.
+     */
+    platform?: PushPlatform | null;
+}
+/** Parameters for the deprecated {@link Push.subscribeWeb} (`POST /api/v1/webpush/client/`). */
+export interface PushSubscribeWebParams {
+    /** The CRM contact the subscription belongs to. */
+    client_id: string;
+    /** Web application (widget) slug. */
+    slug: string;
+    /** Serialized browser PushSubscription JSON. */
+    subscription_info?: string | null;
+}
+/** Body of `POST /api/v1/subscribe/android|ios/`. */
+export interface SubscribeResult {
+    success: number;
+}
+/** Body of `POST /api/v1/push/read/`. */
+export interface MarkReadResult {
+    affected_rows: number;
+}
+/** One native push notification row (legacy list endpoints). */
+export interface PushNotification {
+    message: string;
+    subject: string;
+    /** ISO-8601 date string. */
+    date: string;
+}
+/** Echo body of `POST /api/v1/push/client/`. */
+export interface PushClientDevices {
+    client_id: string;
+    slug: string;
+    device_id?: string;
+    device_type?: string;
+    keep_devices?: boolean | null;
+}
+/** Echo body of the legacy `POST /api/v1/webpush/client/`. */
+export interface WebPushSubscription {
+    client_id: string;
+    slug: string;
+    subscription_info?: string;
+}
+//# sourceMappingURL=push.d.ts.map

package/dist/types/push.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.d.ts","sourceRoot":"","sources":["../../src/types/push.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,KAAK,CAAC;AAE7C,wFAAwF;AACxF,MAAM,WAAW,0BAA0B;IACzC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IAEb,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,gFAAgF;AAChF,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IAEb,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,+EAA+E;AAC/E,MAAM,WAAW,uBAAuB;IACtC,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAElB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,4DAA4D;IAC5D,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED,wEAAwE;AACxE,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,iEAAiE;AACjE,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CAChC;AAED,gGAAgG;AAChG,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAElB,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IAEb,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,gDAAgD;AAChD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED,8DAA8D;AAC9D,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/types/push.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Push resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=push.js.map

package/dist/types/push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.js","sourceRoot":"","sources":["../../src/types/push.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/reports.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Types for the Reports resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/**
+ * Common envelope of every `POST /api/v1/reports/*` endpoint.
+ *
+ * Row columns in `report_data` vary per report (and per `report_type`), so
+ * rows stay plain objects.
+ */
+export interface Report {
+    report_data: Array<Record<string, unknown>>;
+    total_items: number;
+    total_pages: number;
+    page: number;
+    /** Echoed by the `report_type`-driven reports; absent/`null` elsewhere. */
+    report_type?: string | null;
+}
+/** Body of `GET /api/v1/reports/balance/{slug}/`. */
+export interface ProviderBalance {
+    /**
+     * Upstream provider balance (provider-specific format; may be a number).
+     * Empty string when the account has no balance lookup.
+     */
+    balance: string;
+}
+/** The date-range + search filter shared by the `users` / `bulks` reports. */
+export interface ReportDateRangeParams {
+    /** ISO-8601 date, e.g. `"2026-06-01"`. */
+    date_from?: string | null;
+    /** ISO-8601 date, e.g. `"2026-06-30"`. */
+    date_to?: string | null;
+    /** Free-text search over the report rows. */
+    search?: string | null;
+}
+/** Parameters for {@link Reports.messages} (`POST /api/v1/reports/messages/`). */
+export interface ReportMessagesParams extends ReportDateRangeParams {
+    /**
+     * `"phone"` (SMS/TTS/WhatsApp), `"email"`, `"mobile"` (push) or `"web"`
+     * (web push). Required.
+     */
+    report_type: string;
+    /** Device filters. */
+    device?: string[] | null;
+    /** Delivery-status filters, e.g. `["sent", "read"]`. */
+    status?: string[] | null;
+    /** Template ids. */
+    template?: number[] | null;
+    /** Source filters. */
+    source?: string[] | null;
+}
+/** Parameters for {@link Reports.channels} (`POST /api/v1/reports/channels/`). */
+export interface ReportChannelsParams {
+    /** ISO-8601 date, e.g. `"2026-06-01"`. */
+    date_from?: string | null;
+    /** ISO-8601 date, e.g. `"2026-06-30"`. */
+    date_to?: string | null;
+    /** Channel names to include, e.g. `["whatsapp"]`. */
+    channel_name?: string[] | null;
+}
+/** Parameters for {@link Reports.clients} (`POST /api/v1/reports/clients/`). */
+export interface ReportClientsParams extends ReportDateRangeParams {
+    /** Contact language filters, e.g. `["en", "ar"]`. */
+    language?: string[] | null;
+    /** Device filters. */
+    device?: string[] | null;
+    /** Web-push subscription filter. */
+    web_subscription?: string | null;
+}
+/**
+ * Parameters for {@link Reports.specificBulks}
+ * (`POST /api/v1/reports/specific-bulks/`).
+ */
+export interface ReportSpecificBulksParams extends ReportDateRangeParams {
+    /** The bulk batch id to report on. Required. */
+    bulks_file: number;
+    /** Mobile application filters. */
+    mobile_app?: string[] | null;
+    /** Web application filters. */
+    web_app?: string[] | null;
+    /** Delivery-status filters. */
+    status?: string[] | null;
+}
+/**
+ * Parameters for {@link Reports.subscriptions}
+ * (`POST /api/v1/reports/subscriptions/`).
+ */
+export interface ReportSubscriptionsParams extends ReportDateRangeParams {
+    /** `"mobile"` or `"web"`. Required. */
+    report_type: string;
+    /** Mobile application filters. */
+    mobile_app?: string[] | null;
+    /** Web application filters. */
+    web_app?: string[] | null;
+    /** Device-type filters, e.g. `["android"]`. */
+    device_type?: string[] | null;
+}
+/**
+ * Parameters for {@link Reports.awsUsage}
+ * (`POST /api/v1/reports/aws-usage-statistics/` — page is a query param;
+ * the request has no body).
+ */
+export interface ReportAwsUsageParams {
+    /** 1-based page number (query parameter). */
+    page?: number | null;
+}
+//# sourceMappingURL=reports.d.ts.map

package/dist/types/reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../src/types/reports.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,qBAAqB;IACpC,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,kFAAkF;AAClF,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzB,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE3B,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC1B;AAED,kFAAkF;AAClF,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC;AAED,gFAAgF;AAChF,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE3B,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzB,oCAAoC;IACpC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IAEnB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE1B,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAC;IAEpB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7B,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE1B,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB"}

package/dist/types/reports.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Reports resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=reports.js.map

package/dist/types/reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../src/types/reports.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/suppressions.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Types for the Suppressions resource — the workspace do-not-contact list.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/** Query parameters for {@link Suppressions.list}. */
+export interface SuppressionListParams {
+    /**
+     * Filter to one address. Normalized before matching, so any formatting of
+     * the same phone number / email finds its stored compact row.
+     */
+    address?: string | null;
+    /**
+     * Filter to suppressions scoped to one channel (e.g. `"sms"`). All-channel
+     * rows (`channel: null`) are NOT matched by this filter.
+     */
+    channel?: string | null;
+    /**
+     * Filter by reason: `"manual"`, `"unsubscribe"`, `"hard_bounce"` or
+     * `"stop"`.
+     */
+    reason?: string | null;
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size (default 50, max 100). */
+    limit?: number | null;
+}
+/** Parameters for {@link Suppressions.create} (`POST /api/v1/suppressions/`). */
+export interface SuppressionCreateParams {
+    /**
+     * The address to stop contacting: an E.164 phone number or an email.
+     * Stored normalized (compact E.164 / lowercase), so any formatting of the
+     * same address matches at enforcement time. Required.
+     */
+    address: string;
+    /**
+     * Restrict the suppression to one channel (e.g. `"sms"`). Omit (or pass
+     * `null`) to suppress the address across ALL channels.
+     */
+    channel?: string | null;
+    /**
+     * Why the address is suppressed: `"manual"` (default), `"unsubscribe"`,
+     * `"hard_bounce"` or `"stop"`.
+     */
+    reason?: string | null;
+}
+/** One do-not-contact row, as returned by the Suppressions API. */
+export interface Suppression {
+    /** Opaque suppression id, `sup_` prefixed. */
+    id: string;
+    /** Always `"suppression"`. */
+    object: string;
+    /** The suppressed address, normalized (compact E.164 / lowercase email). */
+    address: string;
+    /**
+     * The channel the suppression is scoped to, or `null` when it applies to
+     * every channel.
+     */
+    channel: string | null;
+    /** `"manual"`, `"unsubscribe"`, `"hard_bounce"` or `"stop"`. */
+    reason: string;
+    /**
+     * `false` when the row lives in test mode (created and enforced by
+     * `sk_test_` keys only); `true` for live rows. Suppressions are
+     * mode-scoped end to end.
+     */
+    livemode?: boolean;
+    /** ISO-8601 date-time string. */
+    created?: string | null;
+}
+//# sourceMappingURL=suppressions.d.ts.map

package/dist/types/suppressions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.d.ts","sourceRoot":"","sources":["../../src/types/suppressions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,sDAAsD;AACtD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,iFAAiF;AACjF,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,mEAAmE;AACnE,MAAM,WAAW,WAAW;IAC1B,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB"}

package/dist/types/suppressions.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the Suppressions resource — the workspace do-not-contact list.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=suppressions.js.map

package/dist/types/suppressions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.js","sourceRoot":"","sources":["../../src/types/suppressions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/types/templates.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Types for the Templates resource — slug-keyed message templates with an
+ * immutable version spine.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/**
+ * A template list row (`GET /api/v1/templates/`).
+ *
+ * The content fields (`body`, `body_md`) and the full `versions` list appear
+ * only on the detail shape ({@link TemplateDetail}).
+ */
+export interface TemplateRow {
+    /** Unique slug — the value sends reference via `template: {slug}`. */
+    slug: string;
+    /** Always `"template"`. */
+    object: string;
+    /**
+     * Optional channel hint (metadata only — never restricts rendering), or
+     * `null` when unset.
+     */
+    channel: string | null;
+    /** Optional subject line. */
+    subject?: string;
+    /** Latest version number (immutable ints starting at 1). */
+    version: number;
+    /** ISO-8601 date-time string. */
+    created?: string | null;
+    /** ISO-8601 date-time string. */
+    updated?: string | null;
+}
+/**
+ * A template detail (`GET/POST/PATCH /api/v1/templates/{slug}/`) — a
+ * {@link TemplateRow} plus the content fields and the full version history.
+ */
+export interface TemplateDetail extends TemplateRow {
+    /** Rendered HTML body. */
+    body?: string;
+    /** Markdown source body. */
+    body_md?: string;
+    /**
+     * All available version numbers, ascending. Pin one on a send via
+     * `template: {slug, version: N}`.
+     */
+    versions: number[];
+}
+/** Query filters for {@link Templates.list}. */
+export interface TemplateListParams {
+    /** Filter by the channel hint, e.g. `"email"`. */
+    channel?: string | null;
+    /** Slug-prefix search. */
+    q?: string | null;
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size. */
+    limit?: number | null;
+}
+/** Parameters for {@link Templates.create} (`POST /api/v1/templates/`). */
+export interface TemplateCreateParams {
+    /**
+     * Unique slug — lowercase letters, digits, hyphens and underscores.
+     * Required. A duplicate (including an archived) slug rejects
+     * `409 template-exists`.
+     */
+    slug: string;
+    /**
+     * Optional channel hint (metadata only — never restricts rendering); omit
+     * or pass `null` to leave it unset.
+     */
+    channel?: string | null;
+    /** Optional subject line. */
+    subject?: string | null;
+    /** Rendered HTML body. */
+    body?: string | null;
+    /** Markdown source body. */
+    body_md?: string | null;
+}
+/**
+ * Parameters for {@link Templates.update} (`PATCH /api/v1/templates/{slug}/`).
+ *
+ * Pass at least one field. Changing any CONTENT field (`subject`, `body`,
+ * `body_md`) mints a new immutable version; `channel` is metadata and never
+ * bumps the version; a no-op content PATCH mints nothing.
+ */
+export interface TemplateUpdateParams {
+    /** New channel hint (metadata only — does not bump the version). */
+    channel?: string | null;
+    /** New subject line (content — bumps the version when it changes). */
+    subject?: string | null;
+    /** New HTML body (content — bumps the version when it changes). */
+    body?: string | null;
+    /** New markdown body (content — bumps the version when it changes). */
+    body_md?: string | null;
+}
+//# sourceMappingURL=templates.d.ts.map

package/dist/types/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/types/templates.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,0BAA0B;IAC1B,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,2EAA2E;AAC3E,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB"}

package/dist/types/templates.js

@@ -0,0 +1,9 @@
+/**
+ * Types for the Templates resource — slug-keyed message templates with an
+ * immutable version spine.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=templates.js.map

package/dist/types/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/types/templates.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

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

@@ -0,0 +1,123 @@
+/**
+ * Types for the WebhookEndpoints resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+/**
+ * A webhook endpoint as returned by the API.
+ *
+ * The signing `secret` is never present here — it is revealed once, in the
+ * create response ({@link WebhookEndpointWithSecret}).
+ */
+export interface WebhookEndpoint {
+    /** Opaque endpoint id, `we_` prefixed. */
+    id: string;
+    object?: string;
+    url: string;
+    description?: string;
+    /** Event types delivered to this endpoint, or `["*"]` for all. */
+    enabled_events?: string[];
+    /**
+     * `true`: receives events from live sends; `false`: receives events from
+     * test-mode (`sk_test_`) sends. Fixed at create time.
+     */
+    livemode?: boolean;
+    /** `"enabled"` or `"disabled"`. */
+    status?: string;
+    /** ISO-8601 date-time string. */
+    created_at?: string | null;
+}
+/** Create response — includes the one-time signing `secret`. */
+export interface WebhookEndpointWithSecret extends WebhookEndpoint {
+    /**
+     * Signing secret (`whsec_` prefix). Shown **once**, only here. Use it to
+     * verify the `Silon-Signature` header on every delivery.
+     */
+    secret: string;
+}
+/** Parameters for {@link WebhookEndpoints.create}. */
+export interface WebhookEndpointCreateParams {
+    /** HTTPS URL event payloads are POSTed to. Required. */
+    url: string;
+    /** Free-form label for the endpoint. */
+    description?: string | null;
+    /** Event types to deliver; defaults server-side to `["*"]` (everything). */
+    enabled_events?: string[] | null;
+    /**
+     * Mode routing, fixed at create time. `true` (the server-side default)
+     * receives events from live sends only; `false` receives events from
+     * test-mode (`sk_test_`) sends only. Register one endpoint per mode to
+     * consume both streams.
+     */
+    livemode?: boolean | null;
+}
+/** Parameters for {@link WebhookEndpoints.update} (PATCH — partial). */
+export interface WebhookEndpointUpdateParams {
+    url?: string | null;
+    description?: string | null;
+    enabled_events?: string[] | null;
+    /** Set to `"disabled"` to pause deliveries, `"enabled"` to resume. */
+    status?: string | null;
+}
+/** Query parameters for {@link WebhookEndpoints.list}. */
+export interface WebhookEndpointListParams {
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size. */
+    limit?: number | null;
+}
+/**
+ * Result of {@link WebhookEndpoints.test} — the outcome of a single
+ * synchronous `ping` delivery.
+ *
+ * A failing sink is NOT an HTTP error: `delivered` is `false` with the reason
+ * in `error`, the call still resolves `200`.
+ */
+export interface WebhookEndpointTestResult {
+    /** `true` when the endpoint answered 2xx. */
+    delivered: boolean;
+    /** The endpoint's HTTP status, or `null` when the request never completed. */
+    response_status: number | null;
+    /** Round-trip time in milliseconds. */
+    latency_ms: number;
+    /** Failure reason when `delivered` is `false`, else `null`. */
+    error: string | null;
+}
+/**
+ * One recorded delivery attempt for an endpoint
+ * (`GET /api/v1/webhook_endpoints/{id}/attempts`). Test pings are never
+ * persisted and never appear here.
+ */
+export interface WebhookAttempt {
+    /** Opaque attempt id, `wha_` prefixed. */
+    id: string;
+    /** Always `"webhook_attempt"`. */
+    object: string;
+    /** The delivered event's id. */
+    event_id: string;
+    /** The delivered event's type, e.g. `"message.failed"`. */
+    event_type: string;
+    /** How many times delivery has been attempted so far. */
+    attempts: number;
+    /** The endpoint's last HTTP status, or `null` when it never responded. */
+    response_status: number | null;
+    /** `true` once a delivery attempt succeeded (2xx). */
+    ok: boolean;
+    /** The last failure reason, or `null`. */
+    error: string | null;
+    /** ISO-8601 date-time of the most recent attempt, or `null`. */
+    last_attempt_at?: string | null;
+    /** ISO-8601 date-time of the next scheduled retry, or `null` when done. */
+    next_attempt_at?: string | null;
+    /** ISO-8601 date-time string. */
+    created?: string | null;
+}
+/** Query parameters for {@link WebhookEndpoints.listAttempts}. */
+export interface WebhookEndpointAttemptsParams {
+    /** Opaque pagination cursor from a previous page. */
+    cursor?: string | null;
+    /** Page size. */
+    limit?: number | null;
+}
+//# sourceMappingURL=webhook-endpoints.d.ts.map

package/dist/types/webhook-endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-endpoints.d.ts","sourceRoot":"","sources":["../../src/types/webhook-endpoints.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,gEAAgE;AAChE,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,2BAA2B;IAC1C,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,4EAA4E;IAC5E,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED,wEAAwE;AACxE,MAAM,WAAW,2BAA2B;IAC1C,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACjC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,0DAA0D;AAC1D,MAAM,WAAW,yBAAyB;IACxC,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,6CAA6C;IAC7C,SAAS,EAAE,OAAO,CAAC;IACnB,8EAA8E;IAC9E,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,sDAAsD;IACtD,EAAE,EAAE,OAAO,CAAC;IACZ,0CAA0C;IAC1C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,gEAAgE;IAChE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,2EAA2E;IAC3E,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB"}

package/dist/types/webhook-endpoints.js

@@ -0,0 +1,8 @@
+/**
+ * Types for the WebhookEndpoints resource.
+ *
+ * Field names mirror the wire format exactly (snake_case) and date-times are
+ * ISO-8601 strings — this SDK performs no casing or date transformation.
+ */
+export {};
+//# sourceMappingURL=webhook-endpoints.js.map

package/dist/types/webhook-endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-endpoints.js","sourceRoot":"","sources":["../../src/types/webhook-endpoints.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}