@nurama/sdk 0.0.0-stage → 1.4.0

package/dist/routes/storage.js

@@ -0,0 +1,49 @@
+// --- Method Definitions ---
+/**
+ * Defines storage-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the storage-related methods.
+ */
+export default function createStorageMethods(client) {
+    return {
+        /**
+             * Retrieves storage usage chart data for a specific resource.
+             * Requires authentication and permission.
+             * @param {ResourceType} resourceType - The type of the resource.
+             * @param {string} resourceId - The ID of the resource.
+             * @param {GetStorageChartParams} [params] - Optional query parameters for date range and aggregation.
+             * @returns {Promise<ChartDataResponse>} An array of chart data entries.
+             */
+        async getStorageChart(resourceType, resourceId, params) {
+            if (!resourceType)
+                throw new Error('resourceType is required.');
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/storage/chart/${resourceType}/${resourceId}`,
+                params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the latest storage record for a specific resource.
+             * Requires authentication and permission.
+             * @param {ResourceType} resourceType - The type of the resource.
+             * @param {string} resourceId - The ID of the resource.
+             * @returns {Promise<StorageRecord>} The latest storage record for the resource.
+             */
+        async getStorageRecord(resourceType, resourceId) {
+            if (!resourceType)
+                throw new Error('resourceType is required.');
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/storage/${resourceType}/${resourceId}`,
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=storage.js.map

package/dist/routes/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/routes/storage.ts"],"names":[],"mappings":"AA2BA,6BAA6B;AAE7B;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,MAAoB;IAC/D,OAAO;QACL;;;;;;;eAOO;QACP,KAAK,CAAC,eAAe,CACnB,YAA0B,EAC1B,UAAkB,EAClB,MAA8B;YAE9B,IAAI,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAChE,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAoB;gBACxC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,qBAAqB,YAAY,IAAI,UAAU,EAAE;gBAC3D,MAAM;gBACN,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,gBAAgB,CACpB,YAA0B,EAC1B,UAAkB;YAElB,IAAI,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAChE,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAgB;gBACpC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,eAAe,YAAY,IAAI,UAAU,EAAE;gBACrD,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/subscription.d.ts

@@ -0,0 +1,184 @@
+import NuramaClient from '../NuramaClient.js';
+import { type Subscription } from '@nurama/types';
+export interface SortParams {
+    sort?: Record<string, 1 | -1>;
+}
+export type SubscriptionStatus = 'active' | 'pending' | 'canceled' | 'expired' | 'pastDue' | 'paused' | 'paymentFailed' | 'unpaid';
+/**
+ * Soft warnings returned by a plan swap / dry-run. STRUCTURED (not localized
+ * strings) so the multi-lingual FE renders the copy from these values.
+ */
+export type PlanChangeWarning = {
+    type: 'capabilityRemoved';
+    capability: string;
+} | {
+    type: 'seatMigration';
+    currentSeats: number;
+    unitPrice: number | null;
+    total: number | null;
+    currency: string;
+    period: 'month' | 'year';
+};
+export interface GetSubscriptionsParams extends SortParams {
+    status?: SubscriptionStatus;
+    limit?: number;
+    page?: number;
+}
+export interface CreateWorkspaceOrderParams {
+    productId: string;
+    quantity: number;
+    /**
+     * Customer-chosen purchase amount in the subscription's currency MINOR
+     * unit (pence for GBP, cents for USD, yen for JPY, etc.). Required for
+     * variable-amount products (currently only the AI add-on, `productType:
+     * 'enableAi'`). Server enforces a per-currency minimum.
+     */
+    amountInMinor?: number;
+}
+export interface GetSubscriptionOrdersParams {
+    limit?: number;
+    page?: number;
+    sortBy?: string;
+}
+export interface ResourceLimits {
+    totalStorageInBytes: number;
+    totalSeats: number;
+    totalCredits: number;
+}
+export interface SeatUsage {
+    totalSeats: number;
+    usedSeats: number;
+    availableSeats: number;
+}
+export interface RoleSeatUsage {
+    /** Distinct users occupying this seat type across the workspace + projects. */
+    used: number;
+    /** Plan cap for this seat type, or `null` when the plan is unlimited for it. */
+    limit: number | null;
+}
+export interface RoleUsage {
+    creators: RoleSeatUsage;
+    reviewers: RoleSeatUsage;
+}
+export interface StorageUsage {
+    totalStorageInBytes: number;
+    usedStorageInBytes: number;
+    availableStorageInBytes: number;
+}
+/**
+ * Defines subscription-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the subscription-related methods.
+ */
+export default function createSubscriptionMethods(client: NuramaClient): {
+    /**
+         * Retrieves the active subscription for a specific workspace.
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @returns {Promise<Subscription>} The workspace subscription object.
+         */
+    getWorkspaceSubscription(workspaceId: string): Promise<Subscription>;
+    /**
+         * Cancels the subscription for a specific workspace.
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @returns {Promise<any>} The cancellation response.
+         */
+    cancelWorkspaceSubscription(workspaceId: string): Promise<any>;
+    /**
+     * Reverse a scheduled (period-end) cancellation, keeping the workspace's
+     * subscription on its normal renewal cycle. Only valid while the
+     * subscription is still active with a pending cancellation; a fully
+     * lapsed subscription can't be resumed (the owner must re-subscribe).
+     * Requires authentication and permission.
+     * @param {string} workspaceId - The ID of the workspace.
+     * @returns {Promise<any>} The resume response.
+     */
+    resumeWorkspaceSubscription(workspaceId: string): Promise<any>;
+    /**
+     * Swap the workspace's active basePlan line for a different basePlan product.
+     * Same code path both upgrades and downgrades; the API's pre-flight
+     * capacity check is what distinguishes a permitted change from a refused
+     * one. Pass `dryRun: true` to get the pre-flight verdict without mutating.
+     *
+     * On over-allocation the API returns 400 `planCapacityInsufficient` with
+     * `errorData.violations: [{ resource, current, newLimit }]`, surfaced via
+     * the SDK's normal error path.
+     *
+     * On success, returns the updated subscription plus a `warnings[]` array
+     * of feature-gate capabilities the destination plan does NOT include (the
+     * FE renders these as a confirmation notice).
+     */
+    swapWorkspacePlan(workspaceId: string, params: {
+        newProductId: string;
+        currency: string;
+        billingPeriod: "month" | "year";
+        dryRun?: boolean;
+    }): Promise<{
+        subscription: Subscription | null;
+        warnings: PlanChangeWarning[];
+    }>;
+    /**
+         * Retrieves subscription orders for a specific workspace.
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @param {GetSubscriptionOrdersParams} [params] - Optional query parameters.
+         * @returns {Promise<any[]>} An array of subscription order objects.
+         */
+    getWorkspaceOrders(workspaceId: string, params?: GetSubscriptionOrdersParams): Promise<any[]>;
+    /**
+         * Creates a subscription order for a specific workspace.
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @param {CreateWorkspaceOrderParams} orderData - The order data.
+         * @returns {Promise<any>} The created order response.
+         */
+    createWorkspaceOrder(workspaceId: string, orderData: CreateWorkspaceOrderParams): Promise<any>;
+    /**
+         * Retrieves all subscriptions owned by the currently authenticated user.
+         * Requires authentication.
+         * @param {GetSubscriptionsParams} [params] - Optional query parameters for status and sorting.
+         * @returns {Promise<Subscription[]>} An array of subscription objects.
+         */
+    getUserSubscriptions(params?: GetSubscriptionsParams): Promise<Subscription[]>;
+    /**
+         * Retrieves the resource limits (e.g., storage, seats) for a specific resource (typically workspace).
+         * Requires authentication.
+         * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+         * @returns {Promise<ResourceLimits>} An object containing the resource limits.
+         */
+    getResourceLimits(resourceId: string): Promise<ResourceLimits>;
+    /**
+         * Retrieves the seat usage for a specific resource (typically workspace).
+         * Requires authentication.
+         * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+         * @returns {Promise<SeatUsage>} An object containing seat usage details.
+         */
+    getSeatUsage(resourceId: string): Promise<SeatUsage>;
+    /**
+         * Retrieves per-role (creator / reviewer) seat usage and caps for a
+         * workspace. `limit` is `null` when the plan is unlimited for that
+         * seat type. Requires authentication.
+         * @param {string} resourceId - The workspace ID.
+         * @returns {Promise<RoleUsage>} Creator- and reviewer-side seat usage.
+         */
+    getRoleUsage(resourceId: string): Promise<RoleUsage>;
+    /**
+         * Retrieves the storage usage for a specific resource (typically workspace).
+         * Requires authentication.
+         * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+         * @returns {Promise<StorageUsage>} An object containing storage usage details.
+         */
+    getStorageUsage(resourceId: string): Promise<StorageUsage>;
+    /**
+         * Retrieves the workspace usage summary (billable seats and storage used).
+         * Requires authentication and subscription management permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @returns {Promise<{billableSeatCount: number; storageUsedInBytes: number}>} Usage summary.
+         */
+    getWorkspaceUsageSummary(workspaceId: string): Promise<{
+        billableSeatCount: number;
+        storageUsedInBytes: number;
+    }>;
+};
+//# sourceMappingURL=subscription.d.ts.map

package/dist/routes/subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../src/routes/subscription.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAGlD,MAAM,WAAW,UAAU;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,eAAe,GAAG,QAAQ,CAAC;AAEnI;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACjD;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B,CAAC;AAGN,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACtD,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD,MAAM,WAAW,cAAc;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC1B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,EAAE,aAAa,CAAC;IACxB,SAAS,EAAE,aAAa,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,MAAM,CAAC;CACnC;AAID;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,MAAM,EAAE,YAAY;IAElE;;;;;WAKO;0CACqC,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAS1E;;;;;WAKO;6CACwC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IASpE;;;;;;;;OAQG;6CAC4C,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IASpE;;;;;;;;;;;;;OAaG;mCACkC,MAAM,UAAU;QACnD,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,OAAO,GAAG,MAAM,CAAC;QAChC,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;QAAC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;KAAE,CAAC;IAajF;;;;;;WAMO;oCAC+B,MAAM,WAAW,2BAA2B,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAUnG;;;;;;WAMO;sCACiC,MAAM,aAAa,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAapG;;;;;WAKO;kCAC6B,sBAAsB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IASpF;;;;;WAKO;kCAC6B,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAWpE;;;;;WAKO;6BACwB,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D;;;;;;WAMO;6BACwB,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAS1D;;;;;WAKO;gCAC2B,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAShE;;;;;WAKO;0CACqC,MAAM,GAAG,OAAO,CAAC;QAC3D,iBAAiB,EAAE,MAAM,CAAC;QAC1B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;EASL"}

package/dist/routes/subscription.js

@@ -0,0 +1,219 @@
+// --- Method Definitions ---
+/**
+ * Defines subscription-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the subscription-related methods.
+ */
+export default function createSubscriptionMethods(client) {
+    return {
+        /**
+             * Retrieves the active subscription for a specific workspace.
+             * Requires authentication and permission.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @returns {Promise<Subscription>} The workspace subscription object.
+             */
+        async getWorkspaceSubscription(workspaceId) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}`,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Cancels the subscription for a specific workspace.
+             * Requires authentication and permission.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @returns {Promise<any>} The cancellation response.
+             */
+        async cancelWorkspaceSubscription(workspaceId) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'DELETE',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}`,
+                sendJWT: true,
+            });
+        },
+        /**
+         * Reverse a scheduled (period-end) cancellation, keeping the workspace's
+         * subscription on its normal renewal cycle. Only valid while the
+         * subscription is still active with a pending cancellation; a fully
+         * lapsed subscription can't be resumed (the owner must re-subscribe).
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @returns {Promise<any>} The resume response.
+         */
+        async resumeWorkspaceSubscription(workspaceId) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'POST',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}/resume`,
+                sendJWT: true,
+            });
+        },
+        /**
+         * Swap the workspace's active basePlan line for a different basePlan product.
+         * Same code path both upgrades and downgrades; the API's pre-flight
+         * capacity check is what distinguishes a permitted change from a refused
+         * one. Pass `dryRun: true` to get the pre-flight verdict without mutating.
+         *
+         * On over-allocation the API returns 400 `planCapacityInsufficient` with
+         * `errorData.violations: [{ resource, current, newLimit }]`, surfaced via
+         * the SDK's normal error path.
+         *
+         * On success, returns the updated subscription plus a `warnings[]` array
+         * of feature-gate capabilities the destination plan does NOT include (the
+         * FE renders these as a confirmation notice).
+         */
+        async swapWorkspacePlan(workspaceId, params) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            if (!params.newProductId)
+                throw new Error('newProductId is required.');
+            if (!params.currency)
+                throw new Error('currency is required.');
+            if (!params.billingPeriod)
+                throw new Error('billingPeriod is required.');
+            return client._request({
+                method: 'PUT',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}/plan`,
+                body: params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves subscription orders for a specific workspace.
+             * Requires authentication and permission.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @param {GetSubscriptionOrdersParams} [params] - Optional query parameters.
+             * @returns {Promise<any[]>} An array of subscription order objects.
+             */
+        async getWorkspaceOrders(workspaceId, params) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}/orders`,
+                params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Creates a subscription order for a specific workspace.
+             * Requires authentication and permission.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @param {CreateWorkspaceOrderParams} orderData - The order data.
+             * @returns {Promise<any>} The created order response.
+             */
+        async createWorkspaceOrder(workspaceId, orderData) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            if (!orderData.productId)
+                throw new Error('productId is required.');
+            if (typeof orderData.quantity !== 'number')
+                throw new Error('quantity is required and must be a number.');
+            return client._request({
+                method: 'POST',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}/order`,
+                body: orderData,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves all subscriptions owned by the currently authenticated user.
+             * Requires authentication.
+             * @param {GetSubscriptionsParams} [params] - Optional query parameters for status and sorting.
+             * @returns {Promise<Subscription[]>} An array of subscription objects.
+             */
+        async getUserSubscriptions(params) {
+            return client._request({
+                method: 'GET',
+                endpoint: '/v1/subscriptions/',
+                params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the resource limits (e.g., storage, seats) for a specific resource (typically workspace).
+             * Requires authentication.
+             * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+             * @returns {Promise<ResourceLimits>} An object containing the resource limits.
+             */
+        async getResourceLimits(resourceId) {
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            // Note: Backend route uses /limits/:resourceId, validation uses resourceId
+            // Endpoint in test file is not hit for limits directly, assuming workspace ID based on context
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/limits/${resourceId}`, // Assuming resourceId here is workspaceId
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the seat usage for a specific resource (typically workspace).
+             * Requires authentication.
+             * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+             * @returns {Promise<SeatUsage>} An object containing seat usage details.
+             */
+        async getSeatUsage(resourceId) {
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/usage/seats/${resourceId}`, // Assuming resourceId here is workspaceId
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves per-role (creator / reviewer) seat usage and caps for a
+             * workspace. `limit` is `null` when the plan is unlimited for that
+             * seat type. Requires authentication.
+             * @param {string} resourceId - The workspace ID.
+             * @returns {Promise<RoleUsage>} Creator- and reviewer-side seat usage.
+             */
+        async getRoleUsage(resourceId) {
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/usage/roles/${resourceId}`,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the storage usage for a specific resource (typically workspace).
+             * Requires authentication.
+             * @param {string} resourceId - The ID of the resource (e.g., workspaceId).
+             * @returns {Promise<StorageUsage>} An object containing storage usage details.
+             */
+        async getStorageUsage(resourceId) {
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/usage/storage/${resourceId}`, // Assuming resourceId here is workspaceId
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the workspace usage summary (billable seats and storage used).
+             * Requires authentication and subscription management permission.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @returns {Promise<{billableSeatCount: number; storageUsedInBytes: number}>} Usage summary.
+             */
+        async getWorkspaceUsageSummary(workspaceId) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/subscriptions/workspace/${workspaceId}/usage-summary`,
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=subscription.js.map

package/dist/routes/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../src/routes/subscription.ts"],"names":[],"mappings":"AAoFA,6BAA6B;AAE7B;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,MAAoB;IACpE,OAAO;QACL;;;;;eAKO;QACP,KAAK,CAAC,wBAAwB,CAAC,WAAmB;YAChD,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAe;gBACnC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,+BAA+B,WAAW,EAAE;gBACtD,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,2BAA2B,CAAC,WAAmB;YACnD,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAM;gBAC1B,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,+BAA+B,WAAW,EAAE;gBACtD,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;;;WAQG;QACH,KAAK,CAAC,2BAA2B,CAAC,WAAmB;YACnD,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAM;gBAC1B,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,+BAA+B,WAAW,SAAS;gBAC7D,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;;;;;;;;WAaG;QACH,KAAK,CAAC,iBAAiB,CAAC,WAAmB,EAAE,MAK5C;YACC,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,IAAI,CAAC,MAAM,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YACvE,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC/D,IAAI,CAAC,MAAM,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YACzE,OAAO,MAAM,CAAC,QAAQ,CAAuE;gBAC3F,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,+BAA+B,WAAW,OAAO;gBAC3D,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,kBAAkB,CAAC,WAAmB,EAAE,MAAoC;YAChF,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAQ;gBAC5B,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,+BAA+B,WAAW,SAAS;gBAC7D,MAAM;gBACN,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,SAAqC;YACnF,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACpE,IAAI,OAAO,SAAS,CAAC,QAAQ,KAAK,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAE1G,OAAO,MAAM,CAAC,QAAQ,CAAM;gBAC1B,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,+BAA+B,WAAW,QAAQ;gBAC5D,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,oBAAoB,CAAC,MAA+B;YACxD,OAAO,MAAM,CAAC,QAAQ,CAAiB;gBACrC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,oBAAoB;gBAC9B,MAAM;gBACN,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,iBAAiB,CAAC,UAAkB;YACxC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,2EAA2E;YAC3E,+FAA+F;YAC/F,OAAO,MAAM,CAAC,QAAQ,CAAiB;gBACrC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,4BAA4B,UAAU,EAAE,EAAE,0CAA0C;gBAC9F,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,YAAY,CAAC,UAAkB;YACnC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAY;gBAChC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,iCAAiC,UAAU,EAAE,EAAE,0CAA0C;gBACnG,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,YAAY,CAAC,UAAkB;YACnC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAY;gBAChC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,iCAAiC,UAAU,EAAE;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,eAAe,CAAC,UAAkB;YACtC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAe;gBACnC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,mCAAmC,UAAU,EAAE,EAAE,0CAA0C;gBACrG,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,wBAAwB,CAAC,WAAmB;YAIhD,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAC;gBACrB,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,+BAA+B,WAAW,gBAAgB;gBACpE,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/supportChat.d.ts

@@ -0,0 +1,40 @@
+import NuramaClient from '../NuramaClient.js';
+import type { SupportChatGetTopicResponse, SupportChatCreateAttachmentRequest, SupportChatCreateAttachmentResponse } from '@nurama/types';
+/**
+ * Nurama Support chat — one topic per user on the `/news` page.
+ *
+ * The surface is intentionally tiny: one endpoint that lazily creates
+ * the user's support topic on first call and returns the existing row
+ * on every subsequent call. There is no list / archive / delete — each
+ * user has exactly one support conversation that persists across visits.
+ *
+ * Messages flow through the regular chat endpoints on
+ * `nuramaClient.chat`:
+ *
+ *   - send: `nuramaClient.chat.createMessage(topic.chatId, { content })`
+ *   - list: `nuramaClient.chat.getMessages(topic.chatId, …)`
+ *
+ * Backend gates: `auth → requireGlobalSupportChatEnabled → supportChatLimiter`.
+ * Unmetered (no credit deduction) — abuse is bounded by the per-user
+ * per-day rate limiter, not a credit balance check.
+ */
+export default function createSupportChatMethods(client: NuramaClient): {
+    /**
+     * Get-or-create the caller's Support topic. Idempotent: re-calling
+     * returns the same row, so this is safe to invoke on every page mount.
+     */
+    getTopic(): Promise<SupportChatGetTopicResponse>;
+    /**
+     * Mint a Scratch upload bundle for one image attachment. The bytes
+     * land in a Scratch row with a 72-hour TTL and are read by the
+     * orchestrator's vision pass on the next user message — never
+     * promoted to a permanent Asset.
+     *
+     * Same upload protocol as every other multipart upload on the
+     * platform: call this, multipart-upload the bytes to `urls`, then
+     * call `nuramaClient.scratch.completeUpload(scratchId, { uploadId, parts })`.
+     * Send the message with `attachments: [{ scratchId, name }]`.
+     */
+    createAttachment(data: SupportChatCreateAttachmentRequest): Promise<SupportChatCreateAttachmentResponse>;
+};
+//# sourceMappingURL=supportChat.d.ts.map

package/dist/routes/supportChat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportChat.d.ts","sourceRoot":"","sources":["../../src/routes/supportChat.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EACV,2BAA2B,EAC3B,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,MAAM,EAAE,YAAY;IAEjE;;;OAGG;gBACe,OAAO,CAAC,2BAA2B,CAAC;IAQtD;;;;;;;;;;OAUG;2BAEK,kCAAkC,GACvC,OAAO,CAAC,mCAAmC,CAAC;EASlD"}

package/dist/routes/supportChat.js

@@ -0,0 +1,53 @@
+/**
+ * Nurama Support chat — one topic per user on the `/news` page.
+ *
+ * The surface is intentionally tiny: one endpoint that lazily creates
+ * the user's support topic on first call and returns the existing row
+ * on every subsequent call. There is no list / archive / delete — each
+ * user has exactly one support conversation that persists across visits.
+ *
+ * Messages flow through the regular chat endpoints on
+ * `nuramaClient.chat`:
+ *
+ *   - send: `nuramaClient.chat.createMessage(topic.chatId, { content })`
+ *   - list: `nuramaClient.chat.getMessages(topic.chatId, …)`
+ *
+ * Backend gates: `auth → requireGlobalSupportChatEnabled → supportChatLimiter`.
+ * Unmetered (no credit deduction) — abuse is bounded by the per-user
+ * per-day rate limiter, not a credit balance check.
+ */
+export default function createSupportChatMethods(client) {
+    return {
+        /**
+         * Get-or-create the caller's Support topic. Idempotent: re-calling
+         * returns the same row, so this is safe to invoke on every page mount.
+         */
+        async getTopic() {
+            return client._request({
+                endpoint: '/v1/ai/support-chat/topic',
+                method: 'GET',
+                sendJWT: true,
+            });
+        },
+        /**
+         * Mint a Scratch upload bundle for one image attachment. The bytes
+         * land in a Scratch row with a 72-hour TTL and are read by the
+         * orchestrator's vision pass on the next user message — never
+         * promoted to a permanent Asset.
+         *
+         * Same upload protocol as every other multipart upload on the
+         * platform: call this, multipart-upload the bytes to `urls`, then
+         * call `nuramaClient.scratch.completeUpload(scratchId, { uploadId, parts })`.
+         * Send the message with `attachments: [{ scratchId, name }]`.
+         */
+        async createAttachment(data) {
+            return client._request({
+                endpoint: '/v1/ai/support-chat/attachments',
+                method: 'POST',
+                body: data,
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=supportChat.js.map

package/dist/routes/supportChat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportChat.js","sourceRoot":"","sources":["../../src/routes/supportChat.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,MAAoB;IACnE,OAAO;QACL;;;WAGG;QACH,KAAK,CAAC,QAAQ;YACZ,OAAO,MAAM,CAAC,QAAQ,CAAC;gBACrB,QAAQ,EAAE,2BAA2B;gBACrC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;;;;;WAUG;QACH,KAAK,CAAC,gBAAgB,CACpB,IAAwC;YAExC,OAAO,MAAM,CAAC,QAAQ,CAAC;gBACrB,QAAQ,EAAE,iCAAiC;gBAC3C,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/supportTicket.d.ts

@@ -0,0 +1,89 @@
+import NuramaClient from '../NuramaClient.js';
+export type SupportTicketScope = 'user' | 'workspace' | 'project';
+export type SupportTicketStatus = 'open' | 'pending' | 'resolved' | 'closed';
+export interface CreateSupportTicketRequest {
+    scopeType: SupportTicketScope;
+    /** Required for workspace/project scope; ignored for user scope. */
+    scopeId?: string;
+    subject: string;
+    body: string;
+    /** Browser/app/device snapshot collected at submit time. */
+    deviceInfo?: Record<string, unknown>;
+    /**
+     * `true` when the ticket was drafted by Nu via the
+     * `create_support_ticket` chat tool and submitted by the user from
+     * the pre-populated SupportTicketCreateModal. Stamped onto the
+     * `SupportTicket` row for ops analytics; the FE sets this when the
+     * modal was opened by an AI-draft CTA.
+     */
+    aiGenerated?: boolean;
+}
+export interface SupportTicket {
+    id: string;
+    ticketNumber: number;
+    subject: string;
+    scopeType: SupportTicketScope;
+    scopeId: string | null;
+    creatorId: string;
+    status: SupportTicketStatus;
+    priority: string;
+    chatId: string;
+    deviceInfo: Record<string, unknown>;
+    /** True for tickets drafted by Nu's `create_support_ticket` tool. */
+    aiGenerated: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SupportTicketListParams {
+    status?: SupportTicketStatus;
+    page?: number;
+    limit?: number;
+}
+export interface SupportTicketListResponse {
+    results: SupportTicket[];
+    page: number;
+    limit: number;
+    totalPages: number;
+    totalResults: number;
+}
+/** A logo asset (thumbnail-ready) attached to a scope for avatar rendering. */
+export type SupportTicketScopeLogo = {
+    files?: unknown[];
+    [key: string]: unknown;
+} | null;
+export interface SupportTicketScopeOptions {
+    workspaces: {
+        id: string;
+        name: string;
+        slug: string;
+        color?: string | null;
+        logo?: SupportTicketScopeLogo;
+    }[];
+    projects: {
+        id: string;
+        name: string;
+        slug: string | null;
+        workspaceId: string;
+        color?: string | null;
+        logo?: SupportTicketScopeLogo;
+    }[];
+}
+/**
+ * Support tickets. A ticket carries the metadata + a backing Chat thread; the
+ * conversation itself is sent/read through the regular chat endpoints:
+ *
+ *   - send: `nuramaClient.chat.createMessage(ticket.chatId, …)`
+ *   - read: `nuramaClient.chat.getMessages(ticket.chatId, …)`
+ *
+ * Nurama customer service replies (as the support persona) from the admin site.
+ */
+export default function createSupportTicketMethods(client: NuramaClient): {
+    /** Create a ticket. The opening message body becomes the first thread entry. */
+    createSupportTicket(data: CreateSupportTicketRequest): Promise<SupportTicket>;
+    /** List the caller's own tickets + (for resource admins) tickets in their scope. */
+    listSupportTickets(params?: SupportTicketListParams): Promise<SupportTicketListResponse>;
+    getSupportTicket(ticketId: string): Promise<SupportTicket>;
+    /** Workspaces/projects the caller may scope a new ticket to. */
+    getSupportTicketScopeOptions(): Promise<SupportTicketScopeOptions>;
+};
+//# sourceMappingURL=supportTicket.d.ts.map