@archastro/sdk 0.5.2 → 0.5.3

package/dist/v1/resources/kv.d.ts

@@ -3,6 +3,26 @@ import type { KeyValueStorageEntry, KeyValueStorageEntryPage } from "../../types
 export declare class KvResource {
     private http;
     constructor(http: HttpClient);
+    /**
+     * List key-value storage entries
+     * Returns key-value storage entries in one of two modes depending on the caller's
+     * auth scope.
+     * **User-JWT callers** receive a flat list of all their own entries with no
+     * pagination fields. The `page`, `page_size`, `user`, `user_search`, and `key`
+     * params are ignored.
+     * **Developer and server-to-server callers** receive a page-based paginated
+     * response across all users within the caller's app. Use `user` to scope results
+     * to a single user, `user_search` to do a substring match on email or full name,
+     * and `key` to filter entries whose key starts with the given prefix. Results are
+     * ordered by creation time descending.
+     * @param params - Query parameters.
+     * @param params.page - Page number to retrieve. Applies to developer and server-to-server callers only. Defaults to 1.
+     * @param params.pageSize - Number of entries per page. Applies to developer and server-to-server callers only. Defaults to 25; maximum is 100.
+     * @param params.user - Filter results to entries belonging to this user ID. Applies to developer and server-to-server callers only.
+     * @param params.userSearch - Substring match against user email address and full name. Applies to developer and server-to-server callers only.
+     * @param params.key - Prefix filter on the storage key. Returns only entries whose key starts with this string. Applies to developer and server-to-server callers only.
+     * @returns Key-value storage entries for the current page, with pagination metadata for developer and server-to-server callers.
+     */
     list(params?: {
         page?: number;
         pageSize?: number;
@@ -10,15 +30,68 @@ export declare class KvResource {
         userSearch?: string;
         key?: string;
     }): Promise<KeyValueStorageEntryPage>;
+    /**
+     * Create a key-value storage entry
+     * Creates a new key-value storage entry for the target user under the given key.
+     * The key must not already exist for this user; use the upsert endpoint to create
+     * or overwrite in a single call.
+     * End-user (user-JWT) callers always write to their own storage. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope. Attempting to write for a user in a different app
+     * returns 404.
+     * @param input - Request body.
+     * @param input.key - Storage key for the entry. Must be a non-empty string unique to this user.
+     * @param input.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @param input.value - Value to store under `key`. Must be a non-empty string.
+     * @returns The newly created key-value storage entry.
+     */
     create(input: {
         key: string;
         user?: string | undefined;
         value: string;
     }): Promise<KeyValueStorageEntry>;
+    /**
+     * Delete a key-value storage entry
+     * Permanently deletes the key-value storage entry identified by `key` for the
+     * target user. Returns 204 No Content on success and 404 if the entry does not
+     * exist.
+     * End-user (user-JWT) callers can only delete entries they own. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope.
+     * @param key - Storage key of the entry to delete. Must be a non-empty string.
+     * @returns Empty response body. HTTP 204 No Content on success.
+     */
     delete(key: string): Promise<void>;
+    /**
+     * Retrieve a key-value storage entry
+     * Returns the key-value storage entry identified by `key` for the target user.
+     * Returns 404 if no entry exists for that key.
+     * End-user (user-JWT) callers retrieve entries from their own storage. Developer
+     * and server-to-server callers must supply a `user` param identifying the target
+     * user within their app's scope.
+     * @param key - Storage key of the entry to retrieve. Must be a non-empty string.
+     * @param params - Query parameters.
+     * @param params.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @returns The key-value storage entry for the given key.
+     */
     get(key: string, params?: {
         user?: string;
     }): Promise<KeyValueStorageEntry>;
+    /**
+     * Create or update a key-value storage entry
+     * Creates a new key-value storage entry for the given `key`, or overwrites the
+     * value if an entry already exists. This is the idempotent alternative to the
+     * create endpoint: safe to call regardless of whether the key already exists.
+     * End-user (user-JWT) callers always write to their own storage. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope. Attempting to write for a user in a different app
+     * returns 404.
+     * @param key - Storage key to create or overwrite. Must be a non-empty string.
+     * @param input - Request body.
+     * @param input.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @param input.value - New value to store under `key`. Must be a non-empty string. Replaces any existing value.
+     * @returns The created or updated key-value storage entry.
+     */
     upsert(key: string, input: {
         user?: string | undefined;
         value: string;

package/dist/v1/resources/kv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/kv.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAE5F,qBAAa,UAAU;IACT,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE9B,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIxI,MAAM,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIvG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI3E,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG9G"}
+{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/kv.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAE5F,qBAAa,UAAU;IACT,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAqB9I;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7G;;;;;;;;;;OAUG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC;;;;;;;;;;;OAWG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASjF;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG9G"}

package/dist/v1/resources/kv.js

@@ -1,23 +1,116 @@
 // Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
 // This file is auto-generated by @archastro/sdk-generator. Do not edit.
-// Content hash: 7672a8f64869
+// Content hash: e121fa00429e
 export class KvResource {
     http;
     constructor(http) {
         this.http = http;
     }
+    /**
+     * List key-value storage entries
+     * Returns key-value storage entries in one of two modes depending on the caller's
+     * auth scope.
+     * **User-JWT callers** receive a flat list of all their own entries with no
+     * pagination fields. The `page`, `page_size`, `user`, `user_search`, and `key`
+     * params are ignored.
+     * **Developer and server-to-server callers** receive a page-based paginated
+     * response across all users within the caller's app. Use `user` to scope results
+     * to a single user, `user_search` to do a substring match on email or full name,
+     * and `key` to filter entries whose key starts with the given prefix. Results are
+     * ordered by creation time descending.
+     * @param params - Query parameters.
+     * @param params.page - Page number to retrieve. Applies to developer and server-to-server callers only. Defaults to 1.
+     * @param params.pageSize - Number of entries per page. Applies to developer and server-to-server callers only. Defaults to 25; maximum is 100.
+     * @param params.user - Filter results to entries belonging to this user ID. Applies to developer and server-to-server callers only.
+     * @param params.userSearch - Substring match against user email address and full name. Applies to developer and server-to-server callers only.
+     * @param params.key - Prefix filter on the storage key. Returns only entries whose key starts with this string. Applies to developer and server-to-server callers only.
+     * @returns Key-value storage entries for the current page, with pagination metadata for developer and server-to-server callers.
+     */
     async list(params) {
-        return this.http.request(`/api/v1/kv`, { query: params });
+        const query = {};
+        if (params?.page !== undefined) {
+            query["page"] = params?.page;
+        }
+        if (params?.pageSize !== undefined) {
+            query["page_size"] = params?.pageSize;
+        }
+        if (params?.user !== undefined) {
+            query["user"] = params?.user;
+        }
+        if (params?.userSearch !== undefined) {
+            query["user_search"] = params?.userSearch;
+        }
+        if (params?.key !== undefined) {
+            query["key"] = params?.key;
+        }
+        return this.http.request(`/api/v1/kv`, { query });
     }
+    /**
+     * Create a key-value storage entry
+     * Creates a new key-value storage entry for the target user under the given key.
+     * The key must not already exist for this user; use the upsert endpoint to create
+     * or overwrite in a single call.
+     * End-user (user-JWT) callers always write to their own storage. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope. Attempting to write for a user in a different app
+     * returns 404.
+     * @param input - Request body.
+     * @param input.key - Storage key for the entry. Must be a non-empty string unique to this user.
+     * @param input.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @param input.value - Value to store under `key`. Must be a non-empty string.
+     * @returns The newly created key-value storage entry.
+     */
     async create(input) {
         return this.http.request(`/api/v1/kv`, { method: "POST", body: input });
     }
+    /**
+     * Delete a key-value storage entry
+     * Permanently deletes the key-value storage entry identified by `key` for the
+     * target user. Returns 204 No Content on success and 404 if the entry does not
+     * exist.
+     * End-user (user-JWT) callers can only delete entries they own. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope.
+     * @param key - Storage key of the entry to delete. Must be a non-empty string.
+     * @returns Empty response body. HTTP 204 No Content on success.
+     */
     async delete(key) {
         await this.http.request(`/api/v1/kv/${key}`, { method: "DELETE" });
     }
+    /**
+     * Retrieve a key-value storage entry
+     * Returns the key-value storage entry identified by `key` for the target user.
+     * Returns 404 if no entry exists for that key.
+     * End-user (user-JWT) callers retrieve entries from their own storage. Developer
+     * and server-to-server callers must supply a `user` param identifying the target
+     * user within their app's scope.
+     * @param key - Storage key of the entry to retrieve. Must be a non-empty string.
+     * @param params - Query parameters.
+     * @param params.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @returns The key-value storage entry for the given key.
+     */
     async get(key, params) {
-        return this.http.request(`/api/v1/kv/${key}`, { query: params });
+        const query = {};
+        if (params?.user !== undefined) {
+            query["user"] = params?.user;
+        }
+        return this.http.request(`/api/v1/kv/${key}`, { query });
     }
+    /**
+     * Create or update a key-value storage entry
+     * Creates a new key-value storage entry for the given `key`, or overwrites the
+     * value if an entry already exists. This is the idempotent alternative to the
+     * create endpoint: safe to call regardless of whether the key already exists.
+     * End-user (user-JWT) callers always write to their own storage. Developer and
+     * server-to-server callers must supply a `user` param identifying the target user
+     * within their app's scope. Attempting to write for a user in a different app
+     * returns 404.
+     * @param key - Storage key to create or overwrite. Must be a non-empty string.
+     * @param input - Request body.
+     * @param input.user - Target user ID. Required when calling as a developer or with a server-to-server key; ignored for end-user callers.
+     * @param input.value - New value to store under `key`. Must be a non-empty string. Replaces any existing value.
+     * @returns The created or updated key-value storage entry.
+     */
     async upsert(key, input) {
         return this.http.request(`/api/v1/kv/${key}`, { method: "PUT", body: input });
     }

package/dist/v1/resources/kv.js.map

@@ -1 +1 @@
-{"version":3,"file":"kv.js","sourceRoot":"","sources":["../../../src/v1/resources/kv.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,UAAU;IACD;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC,KAAK,CAAC,IAAI,CAAC,MAA+F;QACxG,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,MAAkG,EAAE,CAAC,CAAC;IACxJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAgE;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,MAA0B;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAkG,EAAE,CAAC,CAAC;IAC/J,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,KAAmD;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
+{"version":3,"file":"kv.js","sourceRoot":"","sources":["../../../src/v1/resources/kv.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,UAAU;IACD;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,IAAI,CAAC,MAA+F;QACxG,MAAM,KAAK,GAA6F,EAAE,CAAC;QAC3G,IAAI,MAAM,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC;QAC/B,CAAC;QACD,IAAI,MAAM,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,CAAC,GAAG,MAAM,EAAE,QAAQ,CAAC;QACxC,CAAC;QACD,IAAI,MAAM,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC;QAC/B,CAAC;QACD,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,UAAU,CAAC;QAC5C,CAAC;QACD,IAAI,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE,CAAC;YAC9B,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,KAAgE;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,MAA0B;QAC/C,MAAM,KAAK,GAA6F,EAAE,CAAC;QAC3G,IAAI,MAAM,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,KAAmD;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}

package/dist/v1/resources/notification_preferences.d.ts

@@ -0,0 +1,61 @@
+import { HttpClient } from "../../runtime/http-client.js";
+import type { NotificationPreference, NotificationPreferenceList } from "../../types/notifications.js";
+export declare class NotificationPreferenceResource {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Delete a notification preference
+     * Removes the authenticated user's explicit notification preference for a
+     * given `(type, channel)` combination, reverting that slot to the type's
+     * default channel set.
+     * The `app_id` param scopes the deletion to a specific app's preference
+     * row. Omit `app_id` to target the system-level (no-app) slot. Because
+     * the two slots are stored independently, omitting `app_id` will not
+     * match a row that has one set, and vice versa.
+     * Returns `204 No Content` on success. Returns `404` if no preference
+     * exists for the given composite key.
+     * @returns Empty response body. A `204 No Content` status indicates the preference was deleted successfully.
+     */
+    remove(): Promise<void>;
+    /**
+     * List notification preferences
+     * Returns all explicit notification preferences belonging to the authenticated
+     * user. Preferences are returned for every `(type, channel)` combination the
+     * user has explicitly configured; slots that have not been overridden are not
+     * included and fall back to the type's defaults.
+     * The recipient is derived from the authenticated viewer. You cannot retrieve
+     * preferences for any other user through this endpoint. All configured
+     * preferences — system-level and app-scoped — are returned together in the
+     * `data` array.
+     * @returns An object with a `data` array containing all explicit notification preferences for the authenticated user.
+     */
+    list(): Promise<NotificationPreferenceList>;
+    /**
+     * Create or update a notification preference
+     * Creates or replaces the authenticated user's notification preference for a
+     * given `(type, channel)` combination. This is an idempotent PUT: if no
+     * preference exists for the composite key, a new row is created; if one
+     * already exists, its `enabled` flag is updated to the value you provide.
+     * The recipient is derived from the authenticated viewer. You cannot set
+     * preferences for another user through this endpoint.
+     * Pass `app_id` to scope the preference to a specific app's notifications —
+     * most useful for the `app_*` notification type family. Omit `app_id` to
+     * configure the system-level (no-app) slot. System-level and app-scoped
+     * preferences are stored independently and do not overwrite each other.
+     * The `in_app` channel is not configurable and will be rejected with a
+     * validation error if supplied.
+     * @param input - Request body.
+     * @param input.app_id - App to scope this preference to. Omit to configure the system-level (no-app) slot. App-scoped and system-level preferences are stored separately and do not affect each other.
+     * @param input.channel - Delivery channel to configure (e.g., `"email"`, `"sms"`). The `in_app` channel is not configurable and will be rejected with a validation error.
+     * @param input.enabled - Whether the specified channel should be enabled for this notification type and scope. Set to `false` to suppress delivery on this channel.
+     * @param input.type - Notification type to configure. Use a builtin name (e.g., `"app_info"`, `"billing_alert"`) or a `"custom:<lookup_key>"` identifier matching a NotificationType config registered in your app's bundle. Unknown type identifiers are rejected with a validation error.
+     * @returns The created or updated notification preference reflecting the new `enabled` state.
+     */
+    replace(input: {
+        app_id?: string | undefined;
+        channel: string;
+        enabled: boolean;
+        type: string;
+    }): Promise<NotificationPreference>;
+}
+//# sourceMappingURL=notification_preferences.d.ts.map

package/dist/v1/resources/notification_preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification_preferences.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/notification_preferences.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAEvG,qBAAa,8BAA8B;IAC7B,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;OAYG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;;;;;;;OAWG;IACG,IAAI,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAIjD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,OAAO,CAAC,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAGxI"}

package/dist/v1/resources/notification_preferences.js

@@ -0,0 +1,65 @@
+// Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
+// This file is auto-generated by @archastro/sdk-generator. Do not edit.
+// Content hash: 56f6e81ca367
+export class NotificationPreferenceResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Delete a notification preference
+     * Removes the authenticated user's explicit notification preference for a
+     * given `(type, channel)` combination, reverting that slot to the type's
+     * default channel set.
+     * The `app_id` param scopes the deletion to a specific app's preference
+     * row. Omit `app_id` to target the system-level (no-app) slot. Because
+     * the two slots are stored independently, omitting `app_id` will not
+     * match a row that has one set, and vice versa.
+     * Returns `204 No Content` on success. Returns `404` if no preference
+     * exists for the given composite key.
+     * @returns Empty response body. A `204 No Content` status indicates the preference was deleted successfully.
+     */
+    async remove() {
+        await this.http.request(`/api/v1/notification_preferences`, { method: "DELETE" });
+    }
+    /**
+     * List notification preferences
+     * Returns all explicit notification preferences belonging to the authenticated
+     * user. Preferences are returned for every `(type, channel)` combination the
+     * user has explicitly configured; slots that have not been overridden are not
+     * included and fall back to the type's defaults.
+     * The recipient is derived from the authenticated viewer. You cannot retrieve
+     * preferences for any other user through this endpoint. All configured
+     * preferences — system-level and app-scoped — are returned together in the
+     * `data` array.
+     * @returns An object with a `data` array containing all explicit notification preferences for the authenticated user.
+     */
+    async list() {
+        return this.http.request(`/api/v1/notification_preferences`);
+    }
+    /**
+     * Create or update a notification preference
+     * Creates or replaces the authenticated user's notification preference for a
+     * given `(type, channel)` combination. This is an idempotent PUT: if no
+     * preference exists for the composite key, a new row is created; if one
+     * already exists, its `enabled` flag is updated to the value you provide.
+     * The recipient is derived from the authenticated viewer. You cannot set
+     * preferences for another user through this endpoint.
+     * Pass `app_id` to scope the preference to a specific app's notifications —
+     * most useful for the `app_*` notification type family. Omit `app_id` to
+     * configure the system-level (no-app) slot. System-level and app-scoped
+     * preferences are stored independently and do not overwrite each other.
+     * The `in_app` channel is not configurable and will be rejected with a
+     * validation error if supplied.
+     * @param input - Request body.
+     * @param input.app_id - App to scope this preference to. Omit to configure the system-level (no-app) slot. App-scoped and system-level preferences are stored separately and do not affect each other.
+     * @param input.channel - Delivery channel to configure (e.g., `"email"`, `"sms"`). The `in_app` channel is not configurable and will be rejected with a validation error.
+     * @param input.enabled - Whether the specified channel should be enabled for this notification type and scope. Set to `false` to suppress delivery on this channel.
+     * @param input.type - Notification type to configure. Use a builtin name (e.g., `"app_info"`, `"billing_alert"`) or a `"custom:<lookup_key>"` identifier matching a NotificationType config registered in your app's bundle. Unknown type identifiers are rejected with a validation error.
+     * @returns The created or updated notification preference reflecting the new `enabled` state.
+     */
+    async replace(input) {
+        return this.http.request(`/api/v1/notification_preferences`, { method: "PUT", body: input });
+    }
+}
+//# sourceMappingURL=notification_preferences.js.map

package/dist/v1/resources/notification_preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification_preferences.js","sourceRoot":"","sources":["../../../src/v1/resources/notification_preferences.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,wEAAwE;AACxE,6BAA6B;AAK7B,MAAM,OAAO,8BAA8B;IACrB;IAApB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,OAAO,CAAC,KAAuF;QACnG,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/F,CAAC;CACF"}

package/dist/v1/resources/notifications.d.ts

@@ -0,0 +1,133 @@
+import { HttpClient } from "../../runtime/http-client.js";
+import type { Notification } from "../../types/notifications.js";
+export declare class NotificationResource {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List a user's notifications
+     * Returns a cursor-paginated list of inbox notifications for the authenticated
+     * user, ordered by creation time descending (newest first). All status groups
+     * are included by default; pass `status` to narrow results to a specific group.
+     * Each notification's `rendered` field contains type-specific display data
+     * resolved at request time. Notifications whose type is no longer registered
+     * in the platform are rendered with `kind: "unknown"` rather than being omitted.
+     * Pagination is forward-only: supply `after_cursor` from a previous response to
+     * fetch the next (older) page. The `before_cursor` field is always `null` for
+     * this endpoint. Requires an app-scoped token.
+     * @param params - Query parameters.
+     * @param params.status - Filter by notification status. One of `"all"`, `"active"`, `"unread"`, `"read"`, or `"archived"`. Defaults to `"all"` when omitted.
+     * @param params.limit - Maximum number of notifications to return per page. Defaults to 20; maximum is 100.
+     * @param params.afterCursor - Opaque pagination cursor from a previous response's `after_cursor` field. Omit to fetch the most recent notifications.
+     * @returns Successful response
+     */
+    list(params?: {
+        status?: string;
+        limit?: number;
+        afterCursor?: string;
+    }): Promise<{
+        after_cursor?: string | undefined;
+        before_cursor?: string | undefined;
+        data: {
+            archived_at?: string | undefined;
+            created_at: string;
+            id: string;
+            read_at?: string | undefined;
+            rendered: Record<string, unknown>;
+            status: string;
+            type: string;
+        }[];
+        has_more: boolean;
+    }>;
+    /**
+     * Mark all notifications as read
+     * Marks every `"unread"` notification belonging to the authenticated user as
+     * `"read"` in a single operation. Notifications that are already `"read"` or
+     * `"archived"` are not affected.
+     * This call is safe to retry — if there are no unread notifications, it
+     * succeeds without error. Requires an app-scoped token. Returns 204 No Content
+     * on success.
+     * @returns No content
+     */
+    readAll(): Promise<void>;
+    /**
+     * Send a custom notification to a user
+     * Delivers a custom-typed notification to one of the calling app's users.
+     * Apps define notification types by declaring `NotificationType` config objects
+     * in their bundle (one per `lookup_key`). Supply the type as
+     * `"custom:<lookup_key>"` and provide a `data` map that is merged with
+     * platform-provided context to render the notification's display fields.
+     * Only app-scoped tokens may call this endpoint — user tokens are rejected with
+     * 403. The app scope is stamped onto the notification automatically; an app
+     * cannot target recipients outside its tenant. Built-in platform types such as
+     * `"app_info"` and `"billing_alert"` are not accepted here.
+     * Pass `idempotency_key` to deduplicate sends. If you call this endpoint twice
+     * with the same `idempotency_key` for the same recipient, the second call
+     * returns the original notification without creating a duplicate. The key is
+     * scoped to the calling app, so the same raw key used by different apps cannot
+     * collide.
+     * @param input - Request body.
+     * @param input.data - Arbitrary key-value payload merged with platform-provided context (recipient, app, org, brand) when rendering the notification's display fields. Defaults to an empty object when omitted.
+     * @param input.idempotency_key - Optional deduplication key. A second call with the same `idempotency_key` for the same recipient returns the originally-created notification without inserting a new record. Scoped per calling app.
+     * @param input.type - Custom notification type identifier in the form `"custom:<lookup_key>"`, where `<lookup_key>` matches a `NotificationType` config declared in the calling app's bundle.
+     * @param input.user - Recipient user ID (`usr_...`). Must be a member of the calling app's tenant.
+     * @returns The created notification, or the existing notification when deduplicated by `idempotency_key`.
+     */
+    send(input: {
+        data?: Record<string, unknown> | undefined;
+        idempotency_key?: string | undefined;
+        type: string;
+        user: string;
+    }): Promise<Notification>;
+    /**
+     * Get the unread notification count
+     * Returns the total number of `"unread"` notifications for the authenticated
+     * user. Useful for displaying a badge or indicator in your UI without
+     * fetching the full notification list.
+     * Notifications with `"read"` or `"archived"` status are not included in the
+     * count. Requires an app-scoped token.
+     * @returns Successful response
+     */
+    unreadCount(): Promise<{
+        count: number;
+    }>;
+    /**
+     * Archive a notification
+     * Moves a notification to `"archived"` status regardless of whether it is
+     * currently `"unread"` or `"read"`. Archived notifications are excluded from
+     * the default inbox view but remain retrievable by passing `status: "archived"`
+     * to the list endpoint.
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. If the notification is
+     * already archived this call succeeds without error (idempotent).
+     * Requires an app-scoped token. Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to archive. Must belong to the authenticated user.
+     * @returns No content
+     */
+    archive(notification: string): Promise<void>;
+    /**
+     * Mark a notification as read
+     * Transitions a notification from `"unread"` to `"read"` status. If the
+     * notification is already `"read"` or `"archived"`, the call succeeds without
+     * changing its status (idempotent).
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. Requires an app-scoped token.
+     * Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to mark as read. Must belong to the authenticated user.
+     * @returns No content
+     */
+    read(notification: string): Promise<void>;
+    /**
+     * Unarchive a notification
+     * Restores an `"archived"` notification to its previous active status:
+     * `"read"` if the notification had been read before archiving, or `"unread"`
+     * otherwise. The notification will appear again in the default inbox view.
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. If the notification is not
+     * currently archived this call succeeds without changing its status (idempotent).
+     * Requires an app-scoped token. Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to unarchive. Must belong to the authenticated user.
+     * @returns No content
+     */
+    unarchive(notification: string): Promise<void>;
+}
+//# sourceMappingURL=notifications.d.ts.map

package/dist/v1/resources/notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../../src/v1/resources/notifications.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAEjE,qBAAa,oBAAoB;IACnB,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,IAAI,EAAE;YAAE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,UAAU,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAelW;;;;;;;;;OASG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAI1J;;;;;;;;OAQG;IACG,WAAW,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAI/C;;;;;;;;;;;;OAYG;IACG,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;;;;;;;;;OAUG;IACG,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrD"}

package/dist/v1/resources/notifications.js

@@ -0,0 +1,136 @@
+// Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
+// This file is auto-generated by @archastro/sdk-generator. Do not edit.
+// Content hash: 23416df03aaa
+export class NotificationResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * List a user's notifications
+     * Returns a cursor-paginated list of inbox notifications for the authenticated
+     * user, ordered by creation time descending (newest first). All status groups
+     * are included by default; pass `status` to narrow results to a specific group.
+     * Each notification's `rendered` field contains type-specific display data
+     * resolved at request time. Notifications whose type is no longer registered
+     * in the platform are rendered with `kind: "unknown"` rather than being omitted.
+     * Pagination is forward-only: supply `after_cursor` from a previous response to
+     * fetch the next (older) page. The `before_cursor` field is always `null` for
+     * this endpoint. Requires an app-scoped token.
+     * @param params - Query parameters.
+     * @param params.status - Filter by notification status. One of `"all"`, `"active"`, `"unread"`, `"read"`, or `"archived"`. Defaults to `"all"` when omitted.
+     * @param params.limit - Maximum number of notifications to return per page. Defaults to 20; maximum is 100.
+     * @param params.afterCursor - Opaque pagination cursor from a previous response's `after_cursor` field. Omit to fetch the most recent notifications.
+     * @returns Successful response
+     */
+    async list(params) {
+        const query = {};
+        if (params?.status !== undefined) {
+            query["status"] = params?.status;
+        }
+        if (params?.limit !== undefined) {
+            query["limit"] = params?.limit;
+        }
+        if (params?.afterCursor !== undefined) {
+            query["after_cursor"] = params?.afterCursor;
+        }
+        return this.http.request(`/api/v1/notifications`, { query });
+    }
+    /**
+     * Mark all notifications as read
+     * Marks every `"unread"` notification belonging to the authenticated user as
+     * `"read"` in a single operation. Notifications that are already `"read"` or
+     * `"archived"` are not affected.
+     * This call is safe to retry — if there are no unread notifications, it
+     * succeeds without error. Requires an app-scoped token. Returns 204 No Content
+     * on success.
+     * @returns No content
+     */
+    async readAll() {
+        await this.http.request(`/api/v1/notifications/read_all`, { method: "POST" });
+    }
+    /**
+     * Send a custom notification to a user
+     * Delivers a custom-typed notification to one of the calling app's users.
+     * Apps define notification types by declaring `NotificationType` config objects
+     * in their bundle (one per `lookup_key`). Supply the type as
+     * `"custom:<lookup_key>"` and provide a `data` map that is merged with
+     * platform-provided context to render the notification's display fields.
+     * Only app-scoped tokens may call this endpoint — user tokens are rejected with
+     * 403. The app scope is stamped onto the notification automatically; an app
+     * cannot target recipients outside its tenant. Built-in platform types such as
+     * `"app_info"` and `"billing_alert"` are not accepted here.
+     * Pass `idempotency_key` to deduplicate sends. If you call this endpoint twice
+     * with the same `idempotency_key` for the same recipient, the second call
+     * returns the original notification without creating a duplicate. The key is
+     * scoped to the calling app, so the same raw key used by different apps cannot
+     * collide.
+     * @param input - Request body.
+     * @param input.data - Arbitrary key-value payload merged with platform-provided context (recipient, app, org, brand) when rendering the notification's display fields. Defaults to an empty object when omitted.
+     * @param input.idempotency_key - Optional deduplication key. A second call with the same `idempotency_key` for the same recipient returns the originally-created notification without inserting a new record. Scoped per calling app.
+     * @param input.type - Custom notification type identifier in the form `"custom:<lookup_key>"`, where `<lookup_key>` matches a `NotificationType` config declared in the calling app's bundle.
+     * @param input.user - Recipient user ID (`usr_...`). Must be a member of the calling app's tenant.
+     * @returns The created notification, or the existing notification when deduplicated by `idempotency_key`.
+     */
+    async send(input) {
+        return this.http.request(`/api/v1/notifications/send`, { method: "POST", body: input });
+    }
+    /**
+     * Get the unread notification count
+     * Returns the total number of `"unread"` notifications for the authenticated
+     * user. Useful for displaying a badge or indicator in your UI without
+     * fetching the full notification list.
+     * Notifications with `"read"` or `"archived"` status are not included in the
+     * count. Requires an app-scoped token.
+     * @returns Successful response
+     */
+    async unreadCount() {
+        return this.http.request(`/api/v1/notifications/unread_count`);
+    }
+    /**
+     * Archive a notification
+     * Moves a notification to `"archived"` status regardless of whether it is
+     * currently `"unread"` or `"read"`. Archived notifications are excluded from
+     * the default inbox view but remain retrievable by passing `status: "archived"`
+     * to the list endpoint.
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. If the notification is
+     * already archived this call succeeds without error (idempotent).
+     * Requires an app-scoped token. Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to archive. Must belong to the authenticated user.
+     * @returns No content
+     */
+    async archive(notification) {
+        await this.http.request(`/api/v1/notifications/${notification}/archive`, { method: "POST" });
+    }
+    /**
+     * Mark a notification as read
+     * Transitions a notification from `"unread"` to `"read"` status. If the
+     * notification is already `"read"` or `"archived"`, the call succeeds without
+     * changing its status (idempotent).
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. Requires an app-scoped token.
+     * Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to mark as read. Must belong to the authenticated user.
+     * @returns No content
+     */
+    async read(notification) {
+        await this.http.request(`/api/v1/notifications/${notification}/read`, { method: "POST" });
+    }
+    /**
+     * Unarchive a notification
+     * Restores an `"archived"` notification to its previous active status:
+     * `"read"` if the notification had been read before archiving, or `"unread"`
+     * otherwise. The notification will appear again in the default inbox view.
+     * The authenticated user must own the notification. Passing a notification ID
+     * that belongs to a different user returns a 404. If the notification is not
+     * currently archived this call succeeds without changing its status (idempotent).
+     * Requires an app-scoped token. Returns 204 No Content on success.
+     * @param notification - Notification ID (`ntf_...`) to unarchive. Must belong to the authenticated user.
+     * @returns No content
+     */
+    async unarchive(notification) {
+        await this.http.request(`/api/v1/notifications/${notification}/unarchive`, { method: "POST" });
+    }
+}
+//# sourceMappingURL=notifications.js.map