@smess/networking 1.2.0 → 2.1.0

package/dist/modules/authentication/index.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Authentication module (`src/Microservice/Authentication`, host `app.authentication_host` → auth.smess.vn).
+ *
+ * Token lifecycle on the wire:
+ * - `login_check` and `token/refresh` return `{token, refresh_token}`. Refresh tokens do not rotate and
+ *   their TTL slides on each use; the access JWT lives 3600 s.
+ * - OTP verify and password reset return `{data: {token, refreshToken}}` (camelCase), and `{data: null}`
+ *   with HTTP 200 when the code or reset token is wrong.
+ * - Every anonymous call here uses `auth: 'none'`: a stale Bearer would 401 them (Lexik `supports()`).
+ */
+import type { SmessClient } from '../../core/client.js';
+import type { RefreshStrategy } from '../../session/auth-middleware.js';
+import type { Session } from '../../session/types.js';
+/** `login_check` / `token/refresh` success body (Lexik + gesdinet). */
+export interface TokenPair {
+    token: string;
+    refresh_token: string;
+}
+/** `AuthenticationSucceedDTO`, plain `json_encode` (camelCase). */
+export interface AuthenticationSucceeded {
+    token: string;
+    refreshToken: string;
+}
+export interface LoginInput {
+    /** Email or phone; `email`, `phone_number` and `phone` are also accepted by the server. */
+    identifier: string;
+    password: string;
+}
+export interface IdentifierInput {
+    identifier: string;
+}
+export interface OtpVerifyInput {
+    identifier: string;
+    /** Exactly 6 characters. */
+    code: string;
+}
+export interface ResetPasswordInput {
+    token: string;
+    new_password: string;
+}
+export interface ChangePasswordInput {
+    old_password: string;
+    password: string;
+    /** Also revokes every refresh token of the user. */
+    disconnect_from_all_devices?: boolean;
+}
+export declare const authenticationEndpoints: {
+    readonly login: import("../../core/endpoint.js").Endpoint<"/v1/authentication/login_check", LoginInput, never, TokenPair>;
+    readonly refresh: import("../../core/endpoint.js").Endpoint<"/v1/authentication/token/refresh", {
+        refresh_token: string;
+    }, never, TokenPair>;
+    readonly otpRequest: import("../../core/endpoint.js").Endpoint<"/v1/authentication/otp/request", IdentifierInput, never, undefined>;
+    readonly otpVerify: import("../../core/endpoint.js").Endpoint<"/v1/authentication/otp/verify", OtpVerifyInput, never, {
+        data: AuthenticationSucceeded | null;
+    }>;
+    readonly forgotPassword: import("../../core/endpoint.js").Endpoint<"/v1/authentication/forgot-password", IdentifierInput, never, undefined>;
+    readonly resetPassword: import("../../core/endpoint.js").Endpoint<"/v1/authentication/verify-reset-password-token", ResetPasswordInput, never, {
+        data: AuthenticationSucceeded | null;
+    }>;
+    readonly changePassword: import("../../core/endpoint.js").Endpoint<"/v1/authentication/change-password", ChangePasswordInput, never, undefined>;
+    readonly logout: import("../../core/endpoint.js").Endpoint<"/v1/authentication/logout", never, never, undefined>;
+};
+/** Renews sessions through `POST /v1/authentication/token/refresh`. Pass as `refresh` to `createSmessClient`. */
+export declare function authenticationRefresh(): RefreshStrategy;
+/** Sign-in flows. Successful logins are saved to the client's session store (when it has a writable one). */
+export declare function authentication(client: SmessClient): {
+    /** Password login. */
+    login: (input: LoginInput) => Promise<Session>;
+    /** Renews the session now (normally automatic). Uses the stored refresh token unless one is given. */
+    refresh: (refreshToken?: string) => Promise<Session>;
+    otp: {
+        /** Emails or texts a 6-digit code. Always succeeds (it never reveals whether the account exists). */
+        request: (input: IdentifierInput) => Promise<undefined>;
+        /** Exchanges the code for a session. A wrong or expired code fails with `validation` / `invalid_code`. */
+        verify: (input: OtpVerifyInput) => Promise<Session>;
+    };
+    /** Sends a reset link. Always succeeds. */
+    forgotPassword: (input: IdentifierInput) => Promise<undefined>;
+    /** Sets a new password from a reset-link token and signs in. A bad token fails with `invalid_reset_token`. */
+    resetPassword: (input: ResetPasswordInput) => Promise<Session>;
+    changePassword: (input: ChangePasswordInput) => Promise<undefined>;
+    /**
+     * Server logout, then clears the local session. The server revokes every refresh token of the user
+     * (all devices). To sign out of this device only, call `client.session.clear()`.
+     */
+    logout: () => Promise<void>;
+};
+export type AuthenticationModule = ReturnType<typeof authentication>;
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/authentication/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/authentication/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAIxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAItD,uEAAuE;AACvE,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,mEAAmE;AACnE,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,2FAA2F;IAC3F,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAMD,eAAO,MAAM,uBAAuB;;;uBAOkB,MAAM;;;;cAaxB,uBAAuB,GAAG,IAAI;;;;cAa1B,uBAAuB,GAAG,IAAI;;;;CAoB5D,CAAC;AAoBX,iHAAiH;AACjH,wBAAgB,qBAAqB,IAAI,eAAe,CAQvD;AAID,6GAA6G;AAC7G,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW;IAQ9C,sBAAsB;mBACD,UAAU;IAE/B,sGAAsG;6BACvE,MAAM;;QAOnC,qGAAqG;yBACpF,eAAe;QAChC,0GAA0G;wBACpF,cAAc;;IAItC,2CAA2C;4BACnB,eAAe;IAEvC,8GAA8G;2BACjF,kBAAkB;4BAGvB,mBAAmB;IAE3C;;;OAGG;;EASN;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/modules/authentication/index.js

@@ -0,0 +1,128 @@
+import { ignoreBody } from '../../core/decoders.js';
+import { defineEndpoint } from '../../core/endpoint.js';
+import { SmessApiError } from '../../errors/smess-api-error.js';
+// ── Endpoints ─────────────────────────────────────────────────────────
+const AUTH = 'authentication';
+export const authenticationEndpoints = {
+    login: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/login_check',
+        auth: 'none',
+    }),
+    refresh: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/token/refresh',
+        auth: 'none',
+    }),
+    otpRequest: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/otp/request',
+        auth: 'none',
+        decode: ignoreBody,
+    }),
+    otpVerify: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/otp/verify',
+        auth: 'none',
+    }),
+    forgotPassword: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/forgot-password',
+        auth: 'none',
+        decode: ignoreBody,
+    }),
+    resetPassword: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/verify-reset-password-token',
+        auth: 'none',
+    }),
+    changePassword: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/change-password',
+        auth: 'required',
+        decode: ignoreBody,
+    }),
+    logout: defineEndpoint()({
+        service: AUTH,
+        method: 'POST',
+        path: '/v1/authentication/logout',
+        auth: 'required',
+        decode: ignoreBody,
+    }),
+};
+// ── Session mapping ───────────────────────────────────────────────────
+function fromTokenPair(body, previousRefresh) {
+    if (!body || typeof body.token !== 'string' || body.token === '') {
+        throw new SmessApiError({ kind: 'invalid_response', status: 200, message: 'The token response has no token.', body });
+    }
+    return { accessToken: body.token, refreshToken: body.refresh_token || previousRefresh || null };
+}
+function fromSucceeded(body, code, message) {
+    const data = body?.data;
+    if (!data?.token) {
+        // The handler swallows every failure into HTTP 200 {"data": null}.
+        throw new SmessApiError({ kind: 'validation', status: 200, code, message, body });
+    }
+    return { accessToken: data.token, refreshToken: data.refreshToken || null };
+}
+/** Renews sessions through `POST /v1/authentication/token/refresh`. Pass as `refresh` to `createSmessClient`. */
+export function authenticationRefresh() {
+    return async ({ session, client }) => {
+        if (!session.refreshToken) {
+            throw new SmessApiError({ kind: 'unauthenticated', status: 401, code: 'no_refresh_token' });
+        }
+        const body = await client.call(authenticationEndpoints.refresh, { body: { refresh_token: session.refreshToken } });
+        return fromTokenPair(body, session.refreshToken);
+    };
+}
+// ── Module ────────────────────────────────────────────────────────────
+/** Sign-in flows. Successful logins are saved to the client's session store (when it has a writable one). */
+export function authentication(client) {
+    const e = authenticationEndpoints;
+    const save = async (session) => {
+        await client.session.set(session);
+        return session;
+    };
+    return {
+        /** Password login. */
+        login: async (input) => save(fromTokenPair(await client.call(e.login, { body: input }))),
+        /** Renews the session now (normally automatic). Uses the stored refresh token unless one is given. */
+        refresh: async (refreshToken) => {
+            const token = refreshToken ?? (await client.session.get())?.refreshToken;
+            if (!token)
+                throw new SmessApiError({ kind: 'unauthenticated', code: 'no_refresh_token', message: 'There is no refresh token.' });
+            return save(fromTokenPair(await client.call(e.refresh, { body: { refresh_token: token } }), token));
+        },
+        otp: {
+            /** Emails or texts a 6-digit code. Always succeeds (it never reveals whether the account exists). */
+            request: (input) => client.call(e.otpRequest, { body: input }),
+            /** Exchanges the code for a session. A wrong or expired code fails with `validation` / `invalid_code`. */
+            verify: async (input) => save(fromSucceeded(await client.call(e.otpVerify, { body: input }), 'invalid_code', 'The code is invalid or has expired.')),
+        },
+        /** Sends a reset link. Always succeeds. */
+        forgotPassword: (input) => client.call(e.forgotPassword, { body: input }),
+        /** Sets a new password from a reset-link token and signs in. A bad token fails with `invalid_reset_token`. */
+        resetPassword: async (input) => save(fromSucceeded(await client.call(e.resetPassword, { body: input }), 'invalid_reset_token', 'This reset link is invalid or has expired.')),
+        changePassword: (input) => client.call(e.changePassword, { body: input }),
+        /**
+         * Server logout, then clears the local session. The server revokes every refresh token of the user
+         * (all devices). To sign out of this device only, call `client.session.clear()`.
+         */
+        logout: async () => {
+            try {
+                await client.call(e.logout);
+            }
+            finally {
+                await client.session.clear();
+            }
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/modules/authentication/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/modules/authentication/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AA8ChE,yEAAyE;AAEzE,MAAM,IAAI,GAAG,gBAAyB,CAAC;AAEvC,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,KAAK,EAAE,cAAc,EAAyB,CAAC;QAC7C,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,MAAM;KACb,CAAC;IACF,OAAO,EAAE,cAAc,EAAwC,CAAC;QAC9D,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,kCAAkC;QACxC,IAAI,EAAE,MAAM;KACb,CAAC;IACF,UAAU,EAAE,cAAc,EAA8B,CAAC;QACvD,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,SAAS,EAAE,cAAc,EAA4D,CAAC;QACpF,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,+BAA+B;QACrC,IAAI,EAAE,MAAM;KACb,CAAC;IACF,cAAc,EAAE,cAAc,EAA8B,CAAC;QAC3D,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,oCAAoC;QAC1C,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,aAAa,EAAE,cAAc,EAAgE,CAAC;QAC5F,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,gDAAgD;QACtD,IAAI,EAAE,MAAM;KACb,CAAC;IACF,cAAc,EAAE,cAAc,EAAkC,CAAC;QAC/D,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,oCAAoC;QAC1C,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,MAAM,EAAE,cAAc,EAAa,CAAC;QAClC,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,2BAA2B;QACjC,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;CACM,CAAC;AAEX,yEAAyE;AAEzE,SAAS,aAAa,CAAC,IAAe,EAAE,eAA+B;IACrE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;QACjE,MAAM,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,kCAAkC,EAAE,IAAI,EAAE,CAAC,CAAC;IACxH,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;AAClG,CAAC;AAED,SAAS,aAAa,CAAC,IAA0D,EAAE,IAAY,EAAE,OAAe;IAC9G,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,CAAC;IACxB,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QACjB,mEAAmE;QACnE,MAAM,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;AAC9E,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,qBAAqB;IACnC,OAAO,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;QACnC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;YAC1B,MAAM,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACnH,OAAO,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC,CAAC;AACJ,CAAC;AAED,yEAAyE;AAEzE,6GAA6G;AAC7G,MAAM,UAAU,cAAc,CAAC,MAAmB;IAChD,MAAM,CAAC,GAAG,uBAAuB,CAAC;IAClC,MAAM,IAAI,GAAG,KAAK,EAAE,OAAgB,EAAE,EAAE;QACtC,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,OAAO;QACL,sBAAsB;QACtB,KAAK,EAAE,KAAK,EAAE,KAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAEpG,sGAAsG;QACtG,OAAO,EAAE,KAAK,EAAE,YAAqB,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,YAAY,IAAI,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,YAAY,CAAC;YACzE,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC,CAAC;YAClI,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACtG,CAAC;QAED,GAAG,EAAE;YACH,qGAAqG;YACrG,OAAO,EAAE,CAAC,KAAsB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC/E,0GAA0G;YAC1G,MAAM,EAAE,KAAK,EAAE,KAAqB,EAAE,EAAE,CACtC,IAAI,CAAC,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,cAAc,EAAE,qCAAqC,CAAC,CAAC;SAC9H;QAED,2CAA2C;QAC3C,cAAc,EAAE,CAAC,KAAsB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAE1F,8GAA8G;QAC9G,aAAa,EAAE,KAAK,EAAE,KAAyB,EAAE,EAAE,CACjD,IAAI,CAAC,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,qBAAqB,EAAE,4CAA4C,CAAC,CAAC;QAE/I,cAAc,EAAE,CAAC,KAA0B,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAE9F;;;WAGG;QACH,MAAM,EAAE,KAAK,IAAI,EAAE;YACjB,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC;oBAAS,CAAC;gBACT,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/modules/campaign/index.d.ts

@@ -0,0 +1,212 @@
+/**
+ * Campaign module, email channel: the smeup.email app API (`/v1/campaigns/email/*`).
+ * Host `app.campaign_api_host` → api.smess.vn. Every route needs a signed-in staff member of the account
+ * (403 otherwise); approve/decline and SSO settings are owner-only.
+ *
+ * - The tenant comes from the JWT; do not send `X-Client-Id` from smeup.email (several handlers ignore it,
+ *   others honour it, so a header would mix two tenants).
+ * - Updates are `POST /{id}`, deletes answer 204 (except `DELETE /sender/default`, which returns the Sender).
+ * - User-facing errors (400/403/409/422/503) are `{code, message}` with the message written for the end
+ *   user; it lands in `SmessApiError.serverMessage`.
+ */
+import type { SmessClient } from '../../core/client.js';
+import type { CallOptions } from '../../core/endpoint.js';
+import type { ApiList } from '../../core/pagination.js';
+import type { AbTest, AddressDefaultsInput, ApiCredential, Audience, AudienceContact, AudienceInput, Automation, AutomationInput, Campaign, CampaignRecipient, CampaignReport, ComposeInput, ContactInput, ContactUpdateInput, ContactsQuery, EmailAddress, EmailDomain, HtmlCheck, ImportResult, LinkCheck, Plan, RecipientsQuery, Segment, SegmentInput, SegmentPreview, SegmentRules, Sender, SetDefaultSenderInput, ShortLink, ShortLinkClicks, ShortLinkInput, SpamCheck, SsoConnectAuthorization, SsoStatus, Target, Template, TemplateCheckInput, TemplateInput, TemplatePreview, Webhook, WebhookInput, WebhookTest } from './types.js';
+export type * from './types.js';
+export declare const campaignEmailEndpoints: {
+    readonly sender: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sender", never, never, Sender>;
+    readonly setDefaultSender: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sender/default", SetDefaultSenderInput, never, Sender>;
+    readonly clearDefaultSender: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sender/default", never, never, Sender>;
+    readonly targets: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/targets", never, never, ApiList<Target>>;
+    readonly templates: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates", never, never, ApiList<Template>>;
+    readonly createTemplate: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates", TemplateInput, never, Template>;
+    readonly updateTemplate: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/{id}", TemplateInput, never, Template>;
+    readonly deleteTemplate: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/{id}", never, never, undefined>;
+    readonly previewTemplate: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/preview", TemplateCheckInput, never, TemplatePreview>;
+    readonly checkTemplateHtml: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/check-html", TemplateCheckInput, never, HtmlCheck>;
+    readonly checkTemplateLinks: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/check-links", TemplateCheckInput, never, LinkCheck>;
+    readonly checkTemplateSpam: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/check-spam", TemplateCheckInput, never, SpamCheck>;
+    readonly testSendTemplate: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/templates/test-send", TemplateCheckInput, never, Campaign>;
+    readonly campaigns: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns", never, never, ApiList<Campaign>>;
+    readonly compose: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns", ComposeInput, never, Campaign>;
+    readonly report: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns/{id}/report", never, never, CampaignReport>;
+    readonly recipients: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns/{id}/recipients", never, RecipientsQuery, ApiList<CampaignRecipient>>;
+    readonly approve: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns/{id}/approve", never, never, Campaign>;
+    readonly decline: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/campaigns/{id}/decline", never, never, Campaign>;
+    readonly plan: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/plan", never, never, Plan>;
+    readonly audiences: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences", never, never, ApiList<Audience>>;
+    readonly createAudience: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences", AudienceInput, never, Audience>;
+    readonly updateAudience: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}", AudienceInput, never, Audience>;
+    readonly deleteAudience: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}", never, never, undefined>;
+    readonly contacts: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}/contacts", never, ContactsQuery, ApiList<AudienceContact>>;
+    readonly importContacts: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}/contacts", {
+        contacts: ContactInput[];
+    }, never, ImportResult>;
+    readonly updateContact: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}/contacts/{contactId}", ContactUpdateInput, never, AudienceContact>;
+    readonly deleteContact: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/audiences/{id}/contacts/{contactId}", never, never, undefined>;
+    readonly domains: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/domains", never, never, ApiList<EmailDomain>>;
+    readonly createDomain: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/domains", {
+        domain: string;
+    }, never, EmailDomain>;
+    readonly checkDomain: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/domains/{id}/check", never, never, EmailDomain>;
+    readonly deleteDomain: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/domains/{id}", never, never, undefined>;
+    readonly addresses: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/addresses", never, never, ApiList<EmailAddress>>;
+    readonly createAddress: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/addresses", {
+        email: string;
+    }, never, EmailAddress>;
+    readonly setAddressDefaults: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/addresses/defaults", AddressDefaultsInput, never, ApiList<EmailAddress>>;
+    readonly resendAddress: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/addresses/{id}/resend", never, never, EmailAddress>;
+    readonly deleteAddress: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/addresses/{id}", never, never, undefined>;
+    readonly shortLinks: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/short-links", never, never, ApiList<ShortLink>>;
+    readonly createShortLink: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/short-links", ShortLinkInput, never, ShortLink>;
+    readonly updateShortLink: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/short-links/{id}", ShortLinkInput, never, ShortLink>;
+    readonly shortLinkClicks: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/short-links/{id}/clicks", never, never, ApiList<ShortLinkClicks>>;
+    readonly deleteShortLink: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/short-links/{id}", never, never, undefined>;
+    readonly segments: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/segments", never, never, ApiList<Segment>>;
+    readonly previewSegment: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/segments/preview", {
+        rules: SegmentRules;
+    }, never, SegmentPreview>;
+    readonly createSegment: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/segments", SegmentInput, never, Segment>;
+    readonly updateSegment: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/segments/{id}", SegmentInput, never, Segment>;
+    readonly deleteSegment: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/segments/{id}", never, never, undefined>;
+    readonly automations: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations", never, never, ApiList<Automation>>;
+    readonly automation: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations/{id}", never, never, Automation>;
+    readonly createAutomation: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations", AutomationInput, never, Automation>;
+    readonly updateAutomation: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations/{id}", AutomationInput, never, Automation>;
+    readonly setAutomationStatus: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations/{id}/status", {
+        status: "active" | "paused";
+    }, never, Automation>;
+    readonly deleteAutomation: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/automations/{id}", never, never, undefined>;
+    readonly abTests: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/ab-tests", never, never, ApiList<AbTest>>;
+    readonly abTest: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/ab-tests/{id}", never, never, AbTest>;
+    readonly apiCredentials: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/api_credentials", never, never, ApiList<ApiCredential>>;
+    readonly createApiCredential: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/api_credentials", {
+        name: string;
+    }, never, ApiCredential>;
+    readonly deleteApiCredential: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/api_credentials/{id}", never, never, undefined>;
+    readonly webhooks: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/webhooks", never, never, ApiList<Webhook>>;
+    readonly createWebhook: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/webhooks", WebhookInput, never, Webhook>;
+    readonly testWebhook: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/webhooks/{id}/test", never, never, WebhookTest>;
+    readonly deleteWebhook: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/webhooks/{id}", never, never, undefined>;
+    readonly ssoStatus: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sso", never, never, SsoStatus>;
+    readonly connectSso: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sso/{provider}/connect", never, never, SsoConnectAuthorization>;
+    readonly disconnectSso: import("../../core/endpoint.js").Endpoint<"/v1/campaigns/email/sso/{provider}", never, never, undefined>;
+};
+type Id = number | string;
+/** `campaign(client).email.templates.list()` and so on, one group per backend resource. */
+export declare function campaign(client: SmessClient): {
+    email: {
+        sender: {
+            get: (o?: CallOptions) => Promise<Sender>;
+            setDefault: (input: SetDefaultSenderInput, o?: CallOptions) => Promise<Sender>;
+            clearDefault: (o?: CallOptions) => Promise<Sender>;
+        };
+        targets: {
+            list: (o?: CallOptions) => Promise<ApiList<Target>>;
+        };
+        templates: {
+            list: (o?: CallOptions) => Promise<ApiList<Template>>;
+            create: (input: TemplateInput, o?: CallOptions) => Promise<Template>;
+            update: (id: Id, input: TemplateInput, o?: CallOptions) => Promise<Template>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+            preview: (input: TemplateCheckInput, o?: CallOptions) => Promise<TemplatePreview>;
+            checkHtml: (input: TemplateCheckInput, o?: CallOptions) => Promise<HtmlCheck>;
+            checkLinks: (input: TemplateCheckInput, o?: CallOptions) => Promise<LinkCheck>;
+            checkSpam: (input: TemplateCheckInput, o?: CallOptions) => Promise<SpamCheck>;
+            /** Mails the email to the signed-in user's own address (the server never takes a recipient). */
+            testSend: (input: TemplateCheckInput, o?: CallOptions) => Promise<Campaign>;
+        };
+        campaigns: {
+            /** The newest 50; `has_more` tells whether there are older ones. */
+            list: (o?: CallOptions) => Promise<ApiList<Campaign>>;
+            compose: (input: ComposeInput, o?: CallOptions) => Promise<Campaign>;
+            report: (id: Id, o?: CallOptions) => Promise<CampaignReport>;
+            /** Cursor-paginated, oldest first. */
+            recipients: (id: Id, query?: RecipientsQuery, o?: CallOptions) => Promise<ApiList<CampaignRecipient>>;
+            /** Owner only. */
+            approve: (id: Id, o?: CallOptions) => Promise<Campaign>;
+            /** Owner only. */
+            decline: (id: Id, o?: CallOptions) => Promise<Campaign>;
+        };
+        plan: {
+            get: (o?: CallOptions) => Promise<Plan>;
+        };
+        audiences: {
+            list: (o?: CallOptions) => Promise<ApiList<Audience>>;
+            create: (input: AudienceInput, o?: CallOptions) => Promise<Audience>;
+            update: (id: Id, input: AudienceInput, o?: CallOptions) => Promise<Audience>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+            contacts: {
+                /** Page-numbered (50 per page); `total_count` is the real total. */
+                list: (id: Id, query?: ContactsQuery, o?: CallOptions) => Promise<ApiList<AudienceContact>>;
+                /** Bulk upsert, 1–1000 contacts. */
+                import: (id: Id, contacts: ContactInput[], o?: CallOptions) => Promise<ImportResult>;
+                update: (id: Id, contactId: Id, input: ContactUpdateInput, o?: CallOptions) => Promise<AudienceContact>;
+                delete: (id: Id, contactId: Id, o?: CallOptions) => Promise<undefined>;
+            };
+        };
+        domains: {
+            list: (o?: CallOptions) => Promise<ApiList<EmailDomain>>;
+            create: (domain: string, o?: CallOptions) => Promise<EmailDomain>;
+            check: (id: Id, o?: CallOptions) => Promise<EmailDomain>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        addresses: {
+            list: (o?: CallOptions) => Promise<ApiList<EmailAddress>>;
+            create: (emailAddress: string, o?: CallOptions) => Promise<EmailAddress>;
+            setDefaults: (input: AddressDefaultsInput, o?: CallOptions) => Promise<ApiList<EmailAddress>>;
+            /** 429 when a confirmation was sent in the last minute. */
+            resend: (id: Id, o?: CallOptions) => Promise<EmailAddress>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        shortLinks: {
+            list: (o?: CallOptions) => Promise<ApiList<ShortLink>>;
+            create: (input: ShortLinkInput, o?: CallOptions) => Promise<ShortLink>;
+            update: (id: Id, input: ShortLinkInput, o?: CallOptions) => Promise<ShortLink>;
+            clicks: (id: Id, o?: CallOptions) => Promise<ApiList<ShortLinkClicks>>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        segments: {
+            list: (o?: CallOptions) => Promise<ApiList<Segment>>;
+            preview: (rules: SegmentRules, o?: CallOptions) => Promise<SegmentPreview>;
+            create: (input: SegmentInput, o?: CallOptions) => Promise<Segment>;
+            update: (id: Id, input: SegmentInput, o?: CallOptions) => Promise<Segment>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        automations: {
+            list: (o?: CallOptions) => Promise<ApiList<Automation>>;
+            get: (id: Id, o?: CallOptions) => Promise<Automation>;
+            create: (input: AutomationInput, o?: CallOptions) => Promise<Automation>;
+            update: (id: Id, input: AutomationInput, o?: CallOptions) => Promise<Automation>;
+            /** Activating needs the automation feature on the plan (422 otherwise). */
+            setStatus: (id: Id, status: "active" | "paused", o?: CallOptions) => Promise<Automation>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        abTests: {
+            list: (o?: CallOptions) => Promise<ApiList<AbTest>>;
+            get: (id: Id, o?: CallOptions) => Promise<AbTest>;
+        };
+        apiCredentials: {
+            list: (o?: CallOptions) => Promise<ApiList<ApiCredential>>;
+            /** The response is the only time `api_key` is shown. Needs the API feature on the plan. */
+            create: (name: string, o?: CallOptions) => Promise<ApiCredential>;
+            delete: (id: string, o?: CallOptions) => Promise<undefined>;
+        };
+        webhooks: {
+            list: (o?: CallOptions) => Promise<ApiList<Webhook>>;
+            /** The response is the only time the full `secret` is shown. */
+            create: (input: WebhookInput, o?: CallOptions) => Promise<Webhook>;
+            test: (id: Id, o?: CallOptions) => Promise<WebhookTest>;
+            delete: (id: Id, o?: CallOptions) => Promise<undefined>;
+        };
+        sso: {
+            status: (o?: CallOptions) => Promise<SsoStatus>;
+            /** Owner only: the provider URL to link the company organisation. */
+            connect: (provider: string, o?: CallOptions) => Promise<SsoConnectAuthorization>;
+            disconnect: (provider: string, o?: CallOptions) => Promise<undefined>;
+        };
+    };
+};
+export type CampaignModule = ReturnType<typeof campaign>;
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/campaign/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/campaign/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,KAAK,EAAE,WAAW,EAAQ,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,KAAK,EACV,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,QAAQ,EACR,eAAe,EACf,aAAa,EACb,UAAU,EACV,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,IAAI,EACJ,eAAe,EACf,OAAO,EACP,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,MAAM,EACN,qBAAqB,EACrB,SAAS,EACT,eAAe,EACf,cAAc,EACd,SAAS,EACT,uBAAuB,EACvB,SAAS,EACT,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,OAAO,EACP,YAAY,EACZ,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB,mBAAmB,YAAY,CAAC;AAchC,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA+Be,YAAY,EAAE;;;;;;gBAKnB,MAAM;;;;;;eAKL,MAAM;;;;;;;;;;;;eAYH,YAAY;;;;;;;;;;gBASV,QAAQ,GAAG,QAAQ;;;;;;;cAOlB,MAAM;;;;;;;;;;CAWhD,CAAC;AAEX,KAAK,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1B,2FAA2F;AAC3F,wBAAgB,QAAQ,CAAC,MAAM,EAAE,WAAW;;;sBAM1B,WAAW;gCACD,qBAAqB,MAAM,WAAW;+BACvC,WAAW;;;uBAGnB,WAAW;;;uBAGX,WAAW;4BACN,aAAa,MAAM,WAAW;yBACjC,EAAE,SAAS,aAAa,MAAM,WAAW;yBACzC,EAAE,MAAM,WAAW;6BACf,kBAAkB,MAAM,WAAW;+BACjC,kBAAkB,MAAM,WAAW;gCAClC,kBAAkB,MAAM,WAAW;+BACpC,kBAAkB,MAAM,WAAW;YACtD,gGAAgG;8BAC9E,kBAAkB,MAAM,WAAW;;;YAGrD,oEAAoE;uBACzD,WAAW;6BACL,YAAY,MAAM,WAAW;yBACjC,EAAE,MAAM,WAAW;YAChC,sCAAsC;6BACrB,EAAE,UAAU,eAAe,MAAM,WAAW;YAC7D,kBAAkB;0BACJ,EAAE,MAAM,WAAW;YACjC,kBAAkB;0BACJ,EAAE,MAAM,WAAW;;;sBAGvB,WAAW;;;uBAGV,WAAW;4BACN,aAAa,MAAM,WAAW;yBACjC,EAAE,SAAS,aAAa,MAAM,WAAW;yBACzC,EAAE,MAAM,WAAW;;gBAE9B,oEAAoE;2BACzD,EAAE,UAAU,aAAa,MAAM,WAAW;gBACrD,oCAAoC;6BACvB,EAAE,YAAY,YAAY,EAAE,MAAM,WAAW;6BAC7C,EAAE,aAAa,EAAE,SAAS,kBAAkB,MAAM,WAAW;6BAE7D,EAAE,aAAa,EAAE,MAAM,WAAW;;;;uBAItC,WAAW;6BACL,MAAM,MAAM,WAAW;wBAC5B,EAAE,MAAM,WAAW;yBAClB,EAAE,MAAM,WAAW;;;uBAGrB,WAAW;mCACC,MAAM,MAAM,WAAW;iCACzB,oBAAoB,MAAM,WAAW;YAC1D,2DAA2D;yBAC9C,EAAE,MAAM,WAAW;yBACnB,EAAE,MAAM,WAAW;;;uBAGrB,WAAW;4BACN,cAAc,MAAM,WAAW;yBAClC,EAAE,SAAS,cAAc,MAAM,WAAW;yBAC1C,EAAE,MAAM,WAAW;yBACnB,EAAE,MAAM,WAAW;;;uBAGrB,WAAW;6BACL,YAAY,MAAM,WAAW;4BAC9B,YAAY,MAAM,WAAW;yBAChC,EAAE,SAAS,YAAY,MAAM,WAAW;yBACxC,EAAE,MAAM,WAAW;;;uBAGrB,WAAW;sBACZ,EAAE,MAAM,WAAW;4BACb,eAAe,MAAM,WAAW;yBACnC,EAAE,SAAS,eAAe,MAAM,WAAW;YACxD,2EAA2E;4BAC3D,EAAE,UAAU,QAAQ,GAAG,QAAQ,MAAM,WAAW;yBAEnD,EAAE,MAAM,WAAW;;;uBAGrB,WAAW;sBACZ,EAAE,MAAM,WAAW;;;uBAGlB,WAAW;YACtB,2FAA2F;2BAC5E,MAAM,MAAM,WAAW;yBACzB,MAAM,MAAM,WAAW;;;uBAGzB,WAAW;YACtB,gEAAgE;4BAChD,YAAY,MAAM,WAAW;uBAClC,EAAE,MAAM,WAAW;yBACjB,EAAE,MAAM,WAAW;;;yBAGnB,WAAW;YACxB,qEAAqE;gCACjD,MAAM,MAAM,WAAW;mCACpB,MAAM,MAAM,WAAW;;;EAIrD;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC"}