@foru-ms/sdk 1.3.0 → 1.3.2

package/README.md

@@ -301,12 +301,12 @@ Check the `/examples` directory for detailed examples:
 
 ### Notifications (`client.notifications`)
 
-*   `list(params?: { userId?: string; read?: boolean; filter?: 'newest' | 'oldest'; cursor?: string; limit?: number })`: List notifications for a user. `limit` controls page size (1-50, default: 15).
+*   `list(params?: { userId?: string; status?: string; filter?: 'newest' | 'oldest'; cursor?: string; limit?: number })`: List notifications for a user. `limit` controls page size (1-50, default: 15).
 *   `create(payload: { threadId?: string; postId?: string; privateMessageId?: string; notifierId?: string; notifiedId: string; type: string; description?: string; extendedData?: Record<string, any> })`: Create a notification manually.
 *   `retrieve(id: string, userId?: string)`: Get a notification by ID.
-*   `update(id: string, payload: { userId?: string; read: boolean })`: Update a notification's read status.
+*   `update(id: string, payload: { userId?: string; status?: string })`: Update a notification's status.
 *   `delete(id: string, userId?: string)`: Delete a notification.
-*   `markAllAsRead(userId?: string, read?: boolean)`: Bulk update read status for all of a user's notifications. Default read status is `true`.
+*   `markAllAsRead(userId?: string, status?: string)`: Bulk update status for all of a user's notifications. Default status is `'read'`.
 
 ### Search (`client.search`)
 
@@ -343,17 +343,17 @@ Check the `/examples` directory for detailed examples:
 *   `create(payload: { title?: string; body: string; recipientId: string; senderId?: string; extendedData?: Record<string, any> })`: Send a new private message.
 *   `retrieve(id: string, userId?: string)`: Get a message by ID.
 *   `reply(id: string, payload: { body: string; senderId?: string; title?: string; extendedData?: Record<string, any> })`: Reply to a message thread.
-*   `update(id: string, payload: { body?: string; extendedData?: Record<string, any> })`: Update a message (only sender can update).
+*   `update(id: string, payload: { status?: string; body?: string; extendedData?: Record<string, any> })`: Update a message (only sender can update).
 *   `delete(id: string)`: Delete a message (participants can delete).
 
 ### Reports (`client.reports`)
 
-*   `list(params?: { reporterId?: string; reportedId?: string; read?: boolean; cursor?: string; filter?: 'newest' | 'oldest'; limit?: number })`: List reports with filtering options. `limit` controls page size (1-50, default: 15).
+*   `list(params?: { reporterId?: string; reportedId?: string; status?: string; cursor?: string; filter?: 'newest' | 'oldest'; limit?: number })`: List reports with filtering options. `limit` controls page size (1-50, default: 15).
 *   `create(payload: { reporterId?: string; reportedId?: string; threadId?: string; postId?: string; privateMessageId?: string; type?: string; description?: string; extendedData?: Record<string, any> })`: Submit a new report.
 *   `retrieve(id: string)`: Get a report by ID.
-*   `update(id: string, payload: { threadId?: string; postId?: string; privateMessageId?: string; reportedId?: string; reporterId?: string; type?: string; description?: string; read?: boolean; extendedData?: Record<string, any> })`: Update report details (full update).
-*   `updateStatus(id: string, read: boolean)`: Update read status of a report (partial update).
-*   `batchUpdate(payload: { reportIds: string[]; read: boolean })`: Bulk update read status for multiple reports.
+*   `update(id: string, payload: { threadId?: string; postId?: string; privateMessageId?: string; reportedId?: string; reporterId?: string; type?: string; description?: string; status?: string; extendedData?: Record<string, any> })`: Update report details (full update).
+*   `updateStatus(id: string, status?: string)`: Update status of a report (partial update).
+*   `batchUpdate(payload: { reportIds: string[]; status?: string })`: Bulk update status for multiple reports.
 *   `delete(id: string)`: Delete a report.
 
 ### Roles (`client.roles`)
@@ -553,6 +553,12 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Changelog
 
+### v1.3.2
+- Fixed issue with optional parameters not being optional in typescript
+
+### v1.3.1
+- Updated Notifications, PrivateMessages, Reports to use `status` (string) instead of `read` (boolean)
+
 ### v1.3.0
 - Added Auth resource, authentication example, and related types
 

package/dist/resources/Notifications.d.ts

@@ -5,17 +5,17 @@ export declare class NotificationsResource {
     constructor(client: ForumClient);
     list(params?: {
         userId?: string;
-        read?: boolean;
+        status?: string;
         filter?: 'newest' | 'oldest';
         cursor?: string;
         limit?: number;
     }): Promise<NotificationListResponse>;
-    markAllAsRead(userId?: string, read?: boolean): Promise<{
+    markAllAsRead(userId?: string, status?: string): Promise<{
         count: number;
     }>;
     retrieve(id: string): Promise<Notification>;
     update(id: string, payload: {
-        read: boolean;
+        status: string;
     }): Promise<Notification>;
     delete(id: string): Promise<Notification & {
         deleted: boolean;

package/dist/resources/Notifications.js

@@ -18,10 +18,10 @@ class NotificationsResource {
             method: 'GET',
         });
     }
-    async markAllAsRead(userId, read = true) {
+    async markAllAsRead(userId, status = 'read') {
         return this.client.request('/notifications', {
             method: 'PATCH',
-            body: JSON.stringify({ userId, read }),
+            body: JSON.stringify({ userId, status }),
         });
     }
     async retrieve(id) {

package/dist/resources/PrivateMessages.d.ts

@@ -25,7 +25,7 @@ export declare class PrivateMessagesResource {
         extendedData?: Record<string, any>;
     }): Promise<PrivateMessage>;
     update(id: string, payload: {
-        read?: boolean;
+        status?: string;
         extendedData?: Record<string, any>;
     }): Promise<PrivateMessage>;
     delete(id: string): Promise<PrivateMessage & {

package/dist/resources/Reports.d.ts

@@ -6,7 +6,7 @@ export declare class ReportsResource {
     list(params?: {
         reporterId?: string;
         reportedId?: string;
-        read?: boolean;
+        status?: string;
         cursor?: string;
         filter?: 'newest' | 'oldest';
         limit?: number;
@@ -23,7 +23,7 @@ export declare class ReportsResource {
     }): Promise<Report>;
     batchUpdate(payload: {
         reportIds: string[];
-        read: boolean;
+        status: string;
     }): Promise<{
         count?: number;
         message?: string;
@@ -37,11 +37,11 @@ export declare class ReportsResource {
         reporterId?: string;
         type?: string;
         description?: string;
-        read?: boolean;
+        status?: string;
         extendedData?: Record<string, any>;
     }): Promise<Report>;
     delete(id: string): Promise<Report & {
         deleted: boolean;
     }>;
-    updateStatus(id: string, read: boolean): Promise<Report>;
+    updateStatus(id: string, status: string): Promise<Report>;
 }

package/dist/resources/Reports.js

@@ -46,10 +46,10 @@ class ReportsResource {
             method: 'DELETE',
         });
     }
-    async updateStatus(id, read) {
+    async updateStatus(id, status) {
         return this.client.request(`/report/${id}`, {
             method: 'PATCH',
-            body: JSON.stringify({ read }),
+            body: JSON.stringify({ status }),
         });
     }
 }

package/dist/types.d.ts

@@ -160,7 +160,7 @@ export interface Notification {
     notifiedId: string;
     type: string;
     description?: string;
-    read: boolean;
+    status?: string;
     createdAt: string;
     extendedData?: Record<string, any>;
     post?: Post;
@@ -237,7 +237,7 @@ export interface PrivateMessage {
     recipientId: string;
     title?: string;
     body: string;
-    read: boolean;
+    status?: string;
     parentId?: string;
     children?: PrivateMessage[];
     sender?: User;
@@ -260,7 +260,7 @@ export interface Report {
     privateMessageId?: string;
     type: string;
     description?: string;
-    read: boolean;
+    status?: string;
     createdAt: string;
     post?: Post;
     thread?: Thread;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@foru-ms/sdk",
-    "version": "1.3.0",
+    "version": "1.3.2",
     "description": "JavaScript SDK for Foru.ms",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/resources/Notifications.ts

@@ -10,7 +10,7 @@ export class NotificationsResource {
 
     async list(params?: {
         userId?: string;
-        read?: boolean;
+        status?: string;
         filter?: 'newest' | 'oldest';
         cursor?: string;
         limit?: number;
@@ -29,10 +29,10 @@ export class NotificationsResource {
         });
     }
 
-    async markAllAsRead(userId?: string, read: boolean = true): Promise<{ count: number }> {
+    async markAllAsRead(userId?: string, status: string = 'read'): Promise<{ count: number }> {
         return this.client.request<{ count: number }>('/notifications', {
             method: 'PATCH',
-            body: JSON.stringify({ userId, read }),
+            body: JSON.stringify({ userId, status }),
         });
     }
 
@@ -42,7 +42,7 @@ export class NotificationsResource {
         });
     }
 
-    async update(id: string, payload: { read: boolean }): Promise<Notification> {
+    async update(id: string, payload: { status: string }): Promise<Notification> {
         return this.client.request<Notification>(`/notification/${id}`, {
             method: 'PATCH',
             body: JSON.stringify(payload),

package/src/resources/PrivateMessages.ts

@@ -61,7 +61,7 @@ export class PrivateMessagesResource {
     }
 
     async update(id: string, payload: {
-        read?: boolean;
+        status?: string;
         extendedData?: Record<string, any>;
     }): Promise<PrivateMessage> {
         return this.client.request<PrivateMessage>(`/private-message/${id}`, {

package/src/resources/Reports.ts

@@ -11,7 +11,7 @@ export class ReportsResource {
     async list(params?: {
         reporterId?: string;
         reportedId?: string;
-        read?: boolean;
+        status?: string;
         cursor?: string;
         filter?: 'newest' | 'oldest';
         limit?: number;
@@ -48,7 +48,7 @@ export class ReportsResource {
 
     async batchUpdate(payload: {
         reportIds: string[];
-        read: boolean;
+        status: string;
     }): Promise<{ count?: number; message?: string }> {
         return this.client.request<{ count?: number; message?: string }>('/reports', {
             method: 'PATCH',
@@ -70,7 +70,7 @@ export class ReportsResource {
         reporterId?: string;
         type?: string;
         description?: string;
-        read?: boolean;
+        status?: string;
         extendedData?: Record<string, any>;
     }): Promise<Report> {
         return this.client.request<Report>(`/report/${id}`, {
@@ -85,10 +85,10 @@ export class ReportsResource {
         });
     }
 
-    async updateStatus(id: string, read: boolean): Promise<Report> {
+    async updateStatus(id: string, status: string): Promise<Report> {
         return this.client.request<Report>(`/report/${id}`, {
             method: 'PATCH',
-            body: JSON.stringify({ read }),
+            body: JSON.stringify({ status }),
         });
     }
 }

package/src/types.ts

@@ -181,7 +181,7 @@ export interface Notification {
     notifiedId: string;
     type: string;
     description?: string;
-    read: boolean;
+    status?: string;
     createdAt: string;
     extendedData?: Record<string, any>;
     post?: Post;
@@ -264,7 +264,7 @@ export interface PrivateMessage {
     recipientId: string;
     title?: string;
     body: string;
-    read: boolean;
+    status?: string;
     parentId?: string;
     children?: PrivateMessage[];
     sender?: User;
@@ -289,7 +289,7 @@ export interface Report {
     privateMessageId?: string;
     type: string;
     description?: string;
-    read: boolean;
+    status?: string;
     createdAt: string;
     post?: Post;
     thread?: Thread;