@nurama/sdk 0.0.0-stage → 1.4.0

package/dist/routes/membership.js

@@ -0,0 +1,183 @@
+/**
+ * Defines membership-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the membership-related methods.
+ */
+export default function createMembershipMethods(client) {
+    return {
+        /**
+             * Retrieves the membership records for the currently authenticated user.
+             * @returns {Promise<MembershipResponse[]>} An array of the user's membership records.
+             */
+        async getMyMemberships() {
+            return client._request({
+                method: 'GET',
+                endpoint: '/v1/memberships/',
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves memberships associated with a specific workspace.
+             * Requires permission to get workspace members.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @param {GetWorkspaceMembershipParams} [params] - Query parameters for pagination, sorting, filtering.
+             * @returns {Promise<PaginatedMembershipResponse>} Paginated list of workspace memberships.
+             */
+        async getWorkspaceMemberships(workspaceId, params) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/memberships/workspace/${workspaceId}`,
+                params: params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves memberships associated with a specific project.
+             * Requires permission based on user's role in the project/workspace.
+             * @param {string} projectId - The ID of the project.
+             * @param {GetProjectMembershipParams} [params] - Query parameters for pagination, sorting, filtering.
+             * @returns {Promise<PaginatedMembershipResponse>} Paginated list of project memberships.
+             */
+        async getProjectMemberships(projectId, params) {
+            if (!projectId)
+                throw new Error('projectId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/memberships/project/${projectId}`,
+                params: params,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Deletes a specific membership record by its ID.
+             * Requires specific permissions to delete others' memberships.
+             * @param {string} membershipId - The ID of the membership record to delete.
+             * @returns {Promise<void>}
+             */
+        async deleteMembership(membershipId) {
+            if (!membershipId)
+                throw new Error('membershipId is required.');
+            return client._request({
+                method: 'DELETE',
+                endpoint: `/v1/memberships/${membershipId}`,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Allows the authenticated user to leave a resource (delete their own membership).
+             * Cannot be used to remove ownership roles.
+             * @param {string} resourceId - The ID of the resource (workspace or project) to leave.
+             * @returns {Promise<void>}
+             */
+        async leaveResource(resourceId) {
+            if (!resourceId)
+                throw new Error('resourceId is required.');
+            return client._request({
+                method: 'DELETE',
+                endpoint: `/v1/memberships/leave/${resourceId}`,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Adds a role to an existing membership record.
+             * Requires permission to add roles.
+             * @param {AddRemoveRoleData} data - Object containing membershipId and the role to add.
+             * @returns {Promise<MembershipResponse>} The updated membership object.
+             */
+        async addRole(data) {
+            if (!data || !data.membershipId || !data.role) {
+                throw new Error('membershipId and role are required.');
+            }
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/memberships/add-role',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Removes a role from an existing membership record.
+             * Requires permission to remove roles. Cannot remove ownership roles.
+             * @param {AddRemoveRoleData} data - Object containing membershipId and the role to remove.
+             * @returns {Promise<MembershipResponse>} The updated membership object.
+             */
+        async removeRole(data) {
+            if (!data || !data.membershipId || !data.role) {
+                throw new Error('membershipId and role are required.');
+            }
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/memberships/remove-role',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves a list of users mentionable within a project based on visibility.
+             * Requires permission to get mentionable users.
+             * @param {string} projectId - The ID of the project.
+             * @param {'creator' | 'reviewer' | 'all'} visibility - The visibility scope. Pass 'all' to get users from both creator and reviewer visibilities (e.g. for boards visible to both).
+             * @returns {Promise<MentionableUserResponse[]>} An array of mentionable user objects.
+             */
+        async getProjectMentionableUsers(projectId, visibility) {
+            if (!projectId)
+                throw new Error('projectId is required.');
+            if (!visibility)
+                throw new Error('visibility is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/memberships/mentionable/project/${projectId}/${visibility}`,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves resource-specific last seen timestamps for multiple users in a workspace.
+             * Requires permission to get workspace members.
+             * @param {string} workspaceId - The ID of the workspace.
+             * @param {GetLastSeenData} data - Object containing array of user IDs (1-100).
+             * @returns {Promise<GetLastSeenResponse>} Object with results array containing last seen data.
+             */
+        async getWorkspaceLastSeen(workspaceId, data) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            if (!data || !data.userIds || !Array.isArray(data.userIds) || data.userIds.length === 0) {
+                throw new Error('userIds array is required and must contain at least one user ID.');
+            }
+            if (data.userIds.length > 100) {
+                throw new Error('userIds array cannot contain more than 100 user IDs.');
+            }
+            return client._request({
+                method: 'POST',
+                endpoint: `/v1/memberships/workspace/${workspaceId}/last-seen`,
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves resource-specific last seen timestamps for multiple users in a project.
+             * Requires permission to get project members.
+             * @param {string} projectId - The ID of the project.
+             * @param {GetLastSeenData} data - Object containing array of user IDs (1-100).
+             * @returns {Promise<GetLastSeenResponse>} Object with results array containing last seen data.
+             */
+        async getProjectLastSeen(projectId, data) {
+            if (!projectId)
+                throw new Error('projectId is required.');
+            if (!data || !data.userIds || !Array.isArray(data.userIds) || data.userIds.length === 0) {
+                throw new Error('userIds array is required and must contain at least one user ID.');
+            }
+            if (data.userIds.length > 100) {
+                throw new Error('userIds array cannot contain more than 100 user IDs.');
+            }
+            return client._request({
+                method: 'POST',
+                endpoint: `/v1/memberships/project/${projectId}/last-seen`,
+                body: data,
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=membership.js.map

package/dist/routes/membership.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"membership.js","sourceRoot":"","sources":["../../src/routes/membership.ts"],"names":[],"mappings":"AAsDA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,MAAoB;IAClE,OAAO;QACL;;;eAGO;QACP,KAAK,CAAC,gBAAgB;YACpB,OAAO,MAAM,CAAC,QAAQ,CAAuB;gBAC3C,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,kBAAkB;gBAC5B,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,uBAAuB,CAAC,WAAmB,EAAE,MAAqC;YACtF,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAA8B;gBAClD,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,6BAA6B,WAAW,EAAE;gBACpD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,qBAAqB,CAAC,SAAiB,EAAE,MAAmC;YAChF,IAAI,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC,QAAQ,CAA8B;gBAClD,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,2BAA2B,SAAS,EAAE;gBAChD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,gBAAgB,CAAC,YAAoB;YACzC,IAAI,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC,QAAQ,CAAC;gBACrB,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,mBAAmB,YAAY,EAAE;gBAC3C,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,aAAa,CAAC,UAAkB;YACpC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAAC;gBACrB,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,yBAAyB,UAAU,EAAE;gBAC/C,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,OAAO,CAAC,IAAuB;YACnC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAqB;gBACzC,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,0BAA0B;gBACpC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,UAAU,CAAC,IAAuB;YACtC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAqB;gBACzC,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,6BAA6B;gBACvC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,0BAA0B,CAAC,SAAiB,EAAE,UAA0C;YAC5F,IAAI,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC1D,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5D,OAAO,MAAM,CAAC,QAAQ,CAA4B;gBAChD,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,uCAAuC,SAAS,IAAI,UAAU,EAAE;gBAC1E,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,IAAqB;YACnE,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxF,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAsB;gBAC1C,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,6BAA6B,WAAW,YAAY;gBAC9D,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;eAMO;QACP,KAAK,CAAC,kBAAkB,CAAC,SAAiB,EAAE,IAAqB;YAC/D,IAAI,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC1D,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxF,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,CAAsB;gBAC1C,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,2BAA2B,SAAS,YAAY;gBAC1D,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/notification.d.ts

@@ -0,0 +1,103 @@
+import NuramaClient from '../NuramaClient.js';
+import { type Notification, type PaginatedResult, type CursorPaginatedResult } from '@nurama/types';
+export type PaginatedResponse<T> = (PaginatedResult | CursorPaginatedResult) & {
+    results?: T[];
+};
+export interface PaginationParams {
+    limit?: number;
+    cursor?: string;
+    paginateReverse?: boolean;
+    includeCounts?: boolean;
+    includeCursorRecord?: boolean;
+    startAt?: string;
+    includeStartAtRecord?: boolean;
+    page?: number;
+}
+export interface SortParams {
+    sort?: Record<string, 1 | -1>;
+}
+export interface BaseNotificationParams {
+    channels: string[];
+    types?: string[];
+}
+export interface GetNotificationsData extends BaseNotificationParams, PaginationParams, SortParams {
+    paginate?: 'cursor' | 'index';
+    createdAfter?: number;
+    createdBefore?: number;
+}
+export interface GetNewNotificationsData extends BaseNotificationParams, PaginationParams {
+    paginate?: 'cursor' | 'index';
+    updateLastSeen?: boolean;
+}
+export interface GetNewNotificationCountData extends BaseNotificationParams {
+}
+export interface ChannelQuery {
+    channels: string[];
+    types?: string[];
+}
+export interface GetNewNotificationCountBulkData {
+    channelQueries: ChannelQuery[];
+}
+export interface GetUsersLastNotificationsSeenData extends BaseNotificationParams {
+}
+export interface UpdateUsersLastSeenData extends BaseNotificationParams {
+}
+export type PaginatedNotificationResponse = PaginatedResponse<Notification>;
+export type NotificationCountResponse = {
+    count: number;
+};
+export type NotificationCountBulkResponse = ({
+    channels: string[];
+    types?: string[];
+    count: number;
+})[];
+export type LastSeenResponse = {
+    channels: string[];
+    lastSeen: number;
+    types?: string[];
+};
+/**
+ * Defines notification-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the notification-related methods.
+ */
+export default function createNotificationMethods(client: NuramaClient): {
+    /**
+         * Retrieves notifications for specified channels, with optional filtering and pagination.
+         * @param {GetNotificationsData} data - Request body containing channels, types, and pagination/sorting options.
+         * @returns {Promise<PaginatedNotificationResponse>} Paginated list of notifications.
+         */
+    getNotifications(data: GetNotificationsData): Promise<PaginatedNotificationResponse>;
+    /**
+         * Retrieves new notifications since the user's last viewed timestamp for the specified channels.
+         * Optionally updates the last viewed timestamp.
+         * @param {GetNewNotificationsData} data - Request body containing channels, types, pagination, and update flag.
+         * @returns {Promise<PaginatedNotificationResponse>} Paginated list of new notifications.
+         */
+    getNewNotifications(data: GetNewNotificationsData): Promise<PaginatedNotificationResponse>;
+    /**
+         * Gets the count of new (unread) notifications for the specified channels.
+         * @param {GetNewNotificationCountData} data - Request body containing channels and optional types.
+         * @returns {Promise<NotificationCountResponse>} Object containing the count of new notifications.
+         */
+    getNewNotificationCount(data: GetNewNotificationCountData): Promise<NotificationCountResponse>;
+    /**
+         * Gets the count of new notifications for multiple channel/type queries in a single request.
+         * @param {GetNewNotificationCountBulkData} data - Request body containing an array of channel queries.
+         * @returns {Promise<NotificationCountBulkResponse>} Array of objects, each containing channels, types (if provided), and count.
+         */
+    getNewNotificationCountBulk(data: GetNewNotificationCountBulkData): Promise<NotificationCountBulkResponse>;
+    /**
+         * Retrieves the last seen timestamp record for the specified channels and optional types.
+         * @param {GetUsersLastNotificationsSeenData} data - Request body containing channels and optional types.
+         * @returns {Promise<LastSeenResponse>} The last seen record object.
+         */
+    getUsersLastNotificationsSeen(data: GetUsersLastNotificationsSeenData): Promise<LastSeenResponse>;
+    /**
+         * Updates (or creates) the last seen timestamp for the user for the specified channels and optional types.
+         * @param {UpdateUsersLastSeenData} data - Request body containing channels and optional types.
+         * @returns {Promise<LastSeenResponse>} The updated (or created) last seen record object.
+         */
+    updateUsersLastSeen(data: UpdateUsersLastSeenData): Promise<LastSeenResponse>;
+};
+//# sourceMappingURL=notification.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/routes/notification.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC3B,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,eAAe,GAAG,qBAAqB,CAAC,GAAG;IAC7E,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;CACf,CAAC;AAGF,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjC;AAGD,MAAM,WAAW,sBAAsB;IACnC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB,EAAE,gBAAgB,EAAE,UAAU;IAC9F,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB,EAAE,gBAAgB;IACpF,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA4B,SAAQ,sBAAsB;CAAG;AAE9E,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC5C,cAAc,EAAE,YAAY,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;CAAG;AAEpF,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;CAAG;AAK1E,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC5E,MAAM,MAAM,yBAAyB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAC1D,MAAM,MAAM,6BAA6B,GAAG,CAAC;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,EAAE,CAAC;AACxG,MAAM,MAAM,gBAAgB,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAG1F;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,MAAM,EAAE,YAAY;IAElE;;;;WAIO;2BACsB,oBAAoB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAS1F;;;;;WAKO;8BACyB,uBAAuB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAShG;;;;WAIO;kCAC6B,2BAA2B,GAAG,OAAO,CAAC,yBAAyB,CAAC;IASpG;;;;WAIO;sCACiC,+BAA+B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAShH;;;;WAIO;wCACmC,iCAAiC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASvG;;;;WAIO;8BACyB,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC;EAStF"}

package/dist/routes/notification.js

@@ -0,0 +1,89 @@
+/**
+ * Defines notification-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the notification-related methods.
+ */
+export default function createNotificationMethods(client) {
+    return {
+        /**
+             * Retrieves notifications for specified channels, with optional filtering and pagination.
+             * @param {GetNotificationsData} data - Request body containing channels, types, and pagination/sorting options.
+             * @returns {Promise<PaginatedNotificationResponse>} Paginated list of notifications.
+             */
+        async getNotifications(data) {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/notifications/',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves new notifications since the user's last viewed timestamp for the specified channels.
+             * Optionally updates the last viewed timestamp.
+             * @param {GetNewNotificationsData} data - Request body containing channels, types, pagination, and update flag.
+             * @returns {Promise<PaginatedNotificationResponse>} Paginated list of new notifications.
+             */
+        async getNewNotifications(data) {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/notifications/new',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Gets the count of new (unread) notifications for the specified channels.
+             * @param {GetNewNotificationCountData} data - Request body containing channels and optional types.
+             * @returns {Promise<NotificationCountResponse>} Object containing the count of new notifications.
+             */
+        async getNewNotificationCount(data) {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/notifications/count',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Gets the count of new notifications for multiple channel/type queries in a single request.
+             * @param {GetNewNotificationCountBulkData} data - Request body containing an array of channel queries.
+             * @returns {Promise<NotificationCountBulkResponse>} Array of objects, each containing channels, types (if provided), and count.
+             */
+        async getNewNotificationCountBulk(data) {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/notifications/count/bulk',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Retrieves the last seen timestamp record for the specified channels and optional types.
+             * @param {GetUsersLastNotificationsSeenData} data - Request body containing channels and optional types.
+             * @returns {Promise<LastSeenResponse>} The last seen record object.
+             */
+        async getUsersLastNotificationsSeen(data) {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/notifications/last-seen',
+                body: data,
+                sendJWT: true,
+            });
+        },
+        /**
+             * Updates (or creates) the last seen timestamp for the user for the specified channels and optional types.
+             * @param {UpdateUsersLastSeenData} data - Request body containing channels and optional types.
+             * @returns {Promise<LastSeenResponse>} The updated (or created) last seen record object.
+             */
+        async updateUsersLastSeen(data) {
+            return client._request({
+                method: 'PUT',
+                endpoint: '/v1/notifications/last-seen',
+                body: data,
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=notification.js.map

package/dist/routes/notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../src/routes/notification.ts"],"names":[],"mappings":"AAyEA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,MAAoB;IACpE,OAAO;QACL;;;;eAIO;QACP,KAAK,CAAC,gBAAgB,CAAC,IAA0B;YAC/C,OAAO,MAAM,CAAC,QAAQ,CAAgC;gBACpD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,oBAAoB;gBAC9B,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;eAKO;QACP,KAAK,CAAC,mBAAmB,CAAC,IAA6B;YACrD,OAAO,MAAM,CAAC,QAAQ,CAAgC;gBACpD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,uBAAuB;gBACjC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;eAIO;QACP,KAAK,CAAC,uBAAuB,CAAC,IAAiC;YAC7D,OAAO,MAAM,CAAC,QAAQ,CAA4B;gBAChD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,yBAAyB;gBACnC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;eAIO;QACP,KAAK,CAAC,2BAA2B,CAAC,IAAqC;YACrE,OAAO,MAAM,CAAC,QAAQ,CAAgC;gBACpD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,8BAA8B;gBACxC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;eAIO;QACP,KAAK,CAAC,6BAA6B,CAAC,IAAuC;YACzE,OAAO,MAAM,CAAC,QAAQ,CAAmB;gBACvC,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,6BAA6B;gBACvC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;eAIO;QACP,KAAK,CAAC,mBAAmB,CAAC,IAA6B;YACrD,OAAO,MAAM,CAAC,QAAQ,CAAmB;gBACvC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,6BAA6B;gBACvC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/payment.d.ts

@@ -0,0 +1,56 @@
+import NuramaClient from '../NuramaClient.js';
+export interface StripeCheckoutRequest {
+    resourceId: string;
+    productId: string;
+    currency: 'usd' | 'gbp';
+    billingPeriod: 'month' | 'year';
+}
+export interface ManualCheckoutRequest {
+    resourceId: string;
+    productId: string;
+    currency: 'usd' | 'gbp';
+    billingPeriod: 'month' | 'year';
+}
+export interface StripeCheckoutResponse {
+    url: string;
+}
+export interface StripeCustomerResponse {
+    customerId: string;
+}
+export interface StripePortalResponse {
+    url: string;
+}
+/**
+ * Defines payment-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the payment-related methods.
+ */
+export default function createPaymentMethods(client: NuramaClient): {
+    /**
+     * Create a Stripe subscription checkout session.
+     * Requires authentication and permission.
+     * @param {StripeCheckoutRequest} checkoutData - The checkout request data.
+     * @returns {Promise<StripeCheckoutResponse>} Object containing the Stripe checkout session URL.
+     */
+    createStripeCheckout(checkoutData: StripeCheckoutRequest): Promise<StripeCheckoutResponse>;
+    /**
+     * Create a manual subscription without Stripe processing.
+     * Requires authentication and permission.
+     * @param {ManualCheckoutRequest} checkoutData - The manual checkout request data.
+     * @returns {Promise<any>} The created subscription object.
+     */
+    createManualCheckout(checkoutData: ManualCheckoutRequest): Promise<any>;
+    /**
+     * Create a new Stripe customer for the authenticated user.
+     * Requires authentication and permission.
+     * @returns {Promise<StripeCustomerResponse>} Object containing the Stripe customer ID.
+     */
+    createStripeCustomer(): Promise<StripeCustomerResponse>;
+    /**
+     * Generate a URL for the Stripe customer portal for subscription management.
+     * Requires authentication and permission.
+     * @returns {Promise<StripePortalResponse>} Object containing the Stripe portal session URL.
+     */
+    getStripePortalUrl(): Promise<StripePortalResponse>;
+};
+//# sourceMappingURL=payment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/routes/payment.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAG9C,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,KAAK,GAAG,KAAK,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,KAAK,GAAG,KAAK,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,MAAM,CAAC;CACjC;AAGD,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,MAAM,EAAE,YAAY;IAE7D;;;;;OAKG;uCACsC,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAchG;;;;;OAKG;uCACsC,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAc7E;;;;OAIG;4BAC2B,OAAO,CAAC,sBAAsB,CAAC;IAQ7D;;;;OAIG;0BACyB,OAAO,CAAC,oBAAoB,CAAC;EAQ5D"}

package/dist/routes/payment.js

@@ -0,0 +1,78 @@
+/**
+ * Defines payment-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the payment-related methods.
+ */
+export default function createPaymentMethods(client) {
+    return {
+        /**
+         * Create a Stripe subscription checkout session.
+         * Requires authentication and permission.
+         * @param {StripeCheckoutRequest} checkoutData - The checkout request data.
+         * @returns {Promise<StripeCheckoutResponse>} Object containing the Stripe checkout session URL.
+         */
+        async createStripeCheckout(checkoutData) {
+            if (!checkoutData.resourceId)
+                throw new Error('resourceId is required.');
+            if (!checkoutData.productId)
+                throw new Error('productId is required.');
+            if (!checkoutData.currency)
+                throw new Error('currency is required.');
+            if (!checkoutData.billingPeriod)
+                throw new Error('billingPeriod is required.');
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/payments/stripe/checkout',
+                body: checkoutData,
+                sendJWT: true,
+            });
+        },
+        /**
+         * Create a manual subscription without Stripe processing.
+         * Requires authentication and permission.
+         * @param {ManualCheckoutRequest} checkoutData - The manual checkout request data.
+         * @returns {Promise<any>} The created subscription object.
+         */
+        async createManualCheckout(checkoutData) {
+            if (!checkoutData.resourceId)
+                throw new Error('resourceId is required.');
+            if (!checkoutData.productId)
+                throw new Error('productId is required.');
+            if (!checkoutData.currency)
+                throw new Error('currency is required.');
+            if (!checkoutData.billingPeriod)
+                throw new Error('billingPeriod is required.');
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/payments/manual/checkout',
+                body: checkoutData,
+                sendJWT: true,
+            });
+        },
+        /**
+         * Create a new Stripe customer for the authenticated user.
+         * Requires authentication and permission.
+         * @returns {Promise<StripeCustomerResponse>} Object containing the Stripe customer ID.
+         */
+        async createStripeCustomer() {
+            return client._request({
+                method: 'POST',
+                endpoint: '/v1/payments/stripe/customer',
+                sendJWT: true,
+            });
+        },
+        /**
+         * Generate a URL for the Stripe customer portal for subscription management.
+         * Requires authentication and permission.
+         * @returns {Promise<StripePortalResponse>} Object containing the Stripe portal session URL.
+         */
+        async getStripePortalUrl() {
+            return client._request({
+                method: 'GET',
+                endpoint: '/v1/payments/stripe/portal',
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=payment.js.map

package/dist/routes/payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../../src/routes/payment.ts"],"names":[],"mappings":"AA8BA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,MAAoB;IAC/D,OAAO;QACL;;;;;WAKG;QACH,KAAK,CAAC,oBAAoB,CAAC,YAAmC;YAC5D,IAAI,CAAC,YAAY,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACvE,IAAI,CAAC,YAAY,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAE/E,OAAO,MAAM,CAAC,QAAQ,CAAyB;gBAC7C,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,8BAA8B;gBACxC,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,oBAAoB,CAAC,YAAmC;YAC5D,IAAI,CAAC,YAAY,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACvE,IAAI,CAAC,YAAY,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAE/E,OAAO,MAAM,CAAC,QAAQ,CAAM;gBAC1B,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,8BAA8B;gBACxC,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,oBAAoB;YACxB,OAAO,MAAM,CAAC,QAAQ,CAAyB;gBAC7C,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,8BAA8B;gBACxC,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,kBAAkB;YACtB,OAAO,MAAM,CAAC,QAAQ,CAAuB;gBAC3C,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,4BAA4B;gBACtC,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/routes/product.d.ts

@@ -0,0 +1,43 @@
+import NuramaClient from '../NuramaClient.js';
+import { type Product } from '@nurama/types';
+export interface GetWorkspaceProductsParams {
+    productType?: 'basePlan' | 'addSeat' | 'addStorage' | 'addCredits' | 'enableBoards';
+    paymentProvider?: 'stripe' | 'manualInvoice';
+}
+export type ProductResponse = Product;
+/**
+ * Defines product-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the product-related methods.
+ */
+export default function createProductMethods(client: NuramaClient): {
+    /**
+     * Retrieves available products for a specific workspace, considering restrictions.
+     * Requires authentication and permission.
+     * @param {string} workspaceId - The ID of the workspace.
+     * @param {GetWorkspaceProductsParams} [params] - Optional query parameters.
+     * @returns {Promise<ProductResponse[]>} An array of available product objects.
+     */
+    getWorkspaceProducts(workspaceId: string, params?: GetWorkspaceProductsParams): Promise<ProductResponse[]>;
+    /**
+     * List active starter-package "plans" available to the caller,
+     * scoped by user-level restrictions but NOT bound to a workspace.
+     * Used by the post-signup plan-selection overlay before any
+     * workspace exists.
+     * @returns {Promise<ProductResponse[]>} Active starter-package plans.
+     */
+    listPlans(): Promise<ProductResponse[]>;
+    /**
+     * Suggested billing currency for the caller, derived server-side from
+     * the CDN geo header. A *default* for the currency selector only — the
+     * user can override. Falls back to `usd` with no geo header.
+     */
+    getSuggestedCurrency(): Promise<{
+        currency: SupportedCurrency;
+        country: string | null;
+        locked?: boolean;
+        supported: SupportedCurrency[];
+    }>;
+};
+export type SupportedCurrency = 'gbp' | 'usd' | 'eur';
+//# sourceMappingURL=product.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../../src/routes/product.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAG7C,MAAM,WAAW,0BAA0B;IACzC,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,CAAC;IACpF,eAAe,CAAC,EAAE,QAAQ,GAAG,eAAe,CAAC;CAC9C;AAGD,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC;AAEtC;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,MAAM,EAAE,YAAY;IAE7D;;;;;;OAMG;sCACqC,MAAM,WAAW,0BAA0B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAUhH;;;;;;OAMG;iBACgB,OAAO,CAAC,eAAe,EAAE,CAAC;IAQ7C;;;;OAIG;4BAC2B,OAAO,CAAC;QAAE,QAAQ,EAAE,iBAAiB,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,iBAAiB,EAAE,CAAA;KAAE,CAAC;EAQnJ;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC"}

package/dist/routes/product.js

@@ -0,0 +1,53 @@
+/**
+ * Defines product-related methods for the NuramaClient.
+ * @param {NuramaClient} client - The NuramaClient instance.
+ * @returns {object} An object containing the product-related methods.
+ */
+export default function createProductMethods(client) {
+    return {
+        /**
+         * Retrieves available products for a specific workspace, considering restrictions.
+         * Requires authentication and permission.
+         * @param {string} workspaceId - The ID of the workspace.
+         * @param {GetWorkspaceProductsParams} [params] - Optional query parameters.
+         * @returns {Promise<ProductResponse[]>} An array of available product objects.
+         */
+        async getWorkspaceProducts(workspaceId, params) {
+            if (!workspaceId)
+                throw new Error('workspaceId is required.');
+            return client._request({
+                method: 'GET',
+                endpoint: `/v1/products/workspace/${workspaceId}`,
+                params,
+                sendJWT: true,
+            });
+        },
+        /**
+         * List active starter-package "plans" available to the caller,
+         * scoped by user-level restrictions but NOT bound to a workspace.
+         * Used by the post-signup plan-selection overlay before any
+         * workspace exists.
+         * @returns {Promise<ProductResponse[]>} Active starter-package plans.
+         */
+        async listPlans() {
+            return client._request({
+                method: 'GET',
+                endpoint: '/v1/products/plans',
+                sendJWT: true,
+            });
+        },
+        /**
+         * Suggested billing currency for the caller, derived server-side from
+         * the CDN geo header. A *default* for the currency selector only — the
+         * user can override. Falls back to `usd` with no geo header.
+         */
+        async getSuggestedCurrency() {
+            return client._request({
+                method: 'GET',
+                endpoint: '/v1/products/suggested-currency',
+                sendJWT: true,
+            });
+        },
+    };
+}
+//# sourceMappingURL=product.js.map

package/dist/routes/product.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.js","sourceRoot":"","sources":["../../src/routes/product.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,MAAoB;IAC/D,OAAO;QACL;;;;;;WAMG;QACH,KAAK,CAAC,oBAAoB,CAAC,WAAmB,EAAE,MAAmC;YACjF,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9D,OAAO,MAAM,CAAC,QAAQ,CAAoB;gBACxC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,0BAA0B,WAAW,EAAE;gBACjD,MAAM;gBACN,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;;;WAMG;QACH,KAAK,CAAC,SAAS;YACb,OAAO,MAAM,CAAC,QAAQ,CAAoB;gBACxC,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,oBAAoB;gBAC9B,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,oBAAoB;YACxB,OAAO,MAAM,CAAC,QAAQ,CAA0F;gBAC9G,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,iCAAiC;gBAC3C,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}