@foru-ms/sdk 1.2.2 → 1.2.3

package/README.md

@@ -187,53 +187,66 @@ Check the `/examples` directory for detailed examples:
 
 ### Threads (`client.threads`)
 
-
-*   `list(params: { limit?: number; filter?: 'newest' | 'oldest'; tagId?: string; cursor?: string })`: List threads.
+**Thread Management**
+*   `list(params: { query?: string; tagId?: string; filter?: 'newest' | 'oldest'; type?: 'created' | 'liked' | 'disliked' | 'upvoted' | 'downvoted' | 'subscribed'; cursor?: string; userId?: string })`: List threads with filtering options.
 *   `create(payload: CreateThreadPayload)`: Create a new thread.
 *   `retrieve(id: string)`: Get a thread by ID.
 *   `update(id: string, payload: UpdateThreadPayload)`: Update a thread.
 *   `delete(id: string)`: Delete a thread.
-*   `getPosts(id: string, params: { cursor?: string; filter?: 'newest' | 'oldest' })`: Get posts in a thread.
-*   `like(id: string, userId: string, extendedData?: any)`: Like a thread.
-*   `unlike(id: string, userId: string)`: Unlike a thread.
-*   `getLikes(id: string, params?: { cursor?: string })`: Get users who liked a thread.
-*   `dislike(id: string, userId: string, extendedData?: any)`: Dislike a thread.
-*   `undislike(id: string, userId: string)`: Remove dislike from a thread.
-*   `getDislikes(id: string, params?: { cursor?: string })`: Get users who disliked a thread.
-*   `subscribe(id: string, userId: string)`: Subscribe to a thread.
-*   `unsubscribe(id: string, userId: string)`: Unsubscribe from a thread.
-*   `getSubscribers(id: string, params?: { cursor?: string })`: Get users subscribed to a thread.
-*   `upvote(id: string, userId: string, extendedData?: any)`: Upvote a thread.
-*   `unupvote(id: string, userId: string)`: Remove upvote from a thread.
-*   `getUpvotes(id: string, params?: { cursor?: string })`: Get users who upvoted a thread.
-*   `downvote(id: string, userId: string, extendedData?: any)`: Downvote a thread.
-*   `undownvote(id: string, userId: string)`: Remove downvote from a thread.
-*   `getDownvotes(id: string, params?: { cursor?: string })`: Get users who downvoted a thread.
-*   `getPoll(id: string, userId?: string)`: Get poll results.
-*   `vote(id: string, userId: string, optionId: string)`: Vote in a thread poll.
-*   `voteUpdate(id: string, userId: string, optionId: string)`: Change vote.
-*   `unvote(id: string, userId: string)`: Remove vote.
+*   `getPosts(id: string, params: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get posts in a thread.
+
+**Thread Interactions**
+*   `like(id: string, userId?: string, extendedData?: any)`: Like a thread.
+*   `unlike(id: string, userId?: string)`: Unlike a thread.
+*   `getLikes(id: string, params?: { cursor?: string })`: Get users who liked a thread with pagination.
+*   `dislike(id: string, userId?: string, extendedData?: any)`: Dislike a thread.
+*   `undislike(id: string, userId?: string)`: Remove dislike from a thread.
+*   `getDislikes(id: string, params?: { cursor?: string })`: Get users who disliked a thread with pagination.
+*   `upvote(id: string, userId?: string, extendedData?: any)`: Upvote a thread.
+*   `unupvote(id: string, userId?: string)`: Remove upvote from a thread.
+*   `getUpvotes(id: string, params?: { cursor?: string })`: Get users who upvoted a thread with pagination.
+*   `downvote(id: string, userId?: string, extendedData?: any)`: Downvote a thread.
+*   `undownvote(id: string, userId?: string)`: Remove downvote from a thread.
+*   `getDownvotes(id: string, params?: { cursor?: string })`: Get users who downvoted a thread with pagination.
+
+**Thread Subscriptions**
+*   `subscribe(id: string, userId?: string, extendedData?: any)`: Subscribe to a thread.
+*   `unsubscribe(id: string, userId?: string)`: Unsubscribe from a thread.
+*   `getSubscribers(id: string, params?: { cursor?: string })`: Get users subscribed to a thread with pagination.
+
+**Thread Polls**
+*   `createPoll(id: string, payload: { title?: string; expiresAt?: string; options: Array<{ title: string; color?: string; extendedData?: any }>, extendedData?: any })`: Create a poll for a thread.
+*   `getPoll(id: string)`: Get poll details and configuration.
+*   `updatePoll(id: string, payload: { title?: string; expiresAt?: string; closed?: boolean; options?: Array<{ id?: string; title?: string; color?: string; extendedData?: any }>; extendedData?: any })`: Update poll configuration.
+*   `deletePoll(id: string)`: Delete a poll from a thread.
+*   `getPollResults(id: string, userId?: string)`: Get poll results with vote counts.
+*   `vote(id: string, userId?: string, optionId: string)`: Cast a vote in a thread poll.
+*   `voteUpdate(id: string, userId?: string, optionId: string)`: Change an existing vote.
+*   `unvote(id: string, userId?: string)`: Remove your vote from a poll.
 
 ### Posts (`client.posts`)
 
-*   `list(params: { limit?: number; cursor?: string; filter?: 'newest' | 'oldest'; threadId?: string })`: List posts (flat).
-*   `create(payload: CreatePostPayload)`: Create a reply.
+**Post Management**
+*   `list(params: { query?: string; filter?: 'newest' | 'oldest'; type?: 'created' | 'liked' | 'disliked' | 'upvoted' | 'downvoted'; cursor?: string; userId?: string })`: List posts with filtering options.
+*   `create(payload: CreatePostPayload)`: Create a new post/reply.
 *   `retrieve(id: string)`: Get a post by ID.
 *   `update(id: string, payload: UpdatePostPayload)`: Update a post.
-*   `delete(id: string)`: Delete a post.
-*   `getChildren(id: string, params: { cursor?: string; filter?: 'newest' | 'oldest' })`: Get child posts (nested replies).
-*   `like(id: string, userId: string, extendedData?: any)`: Like a post.
-*   `unlike(id: string, userId: string)`: Unlike a post.
-*   `getLikes(id: string, params?: { cursor?: string })`: Get users who liked a post.
-*   `dislike(id: string, userId: string, extendedData?: any)`: Dislike a post.
-*   `undislike(id: string, userId: string)`: Remove dislike.
-*   `getDislikes(id: string, params?: { cursor?: string })`: Get users who disliked a post.
-*   `upvote(id: string, userId: string, extendedData?: any)`: Upvote a post.
-*   `unupvote(id: string, userId: string)`: Remove upvote.
-*   `getUpvotes(id: string, params?: { cursor?: string })`: Get users who upvoted a post.
-*   `downvote(id: string, userId: string, extendedData?: any)`: Downvote a post.
-*   `undownvote(id: string, userId: string)`: Remove downvote.
-*   `getDownvotes(id: string, params?: { cursor?: string })`: Get users who downvoted a post.
+*   `delete(id: string, payload?: { userId?: string })`: Delete a post.
+*   `getChildren(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get child posts (nested replies).
+
+**Post Interactions**
+*   `like(id: string, userId?: string, extendedData?: any)`: Like a post.
+*   `unlike(id: string, userId?: string)`: Unlike a post.
+*   `getLikes(id: string, params?: { cursor?: string })`: Get users who liked a post with pagination.
+*   `dislike(id: string, userId?: string, extendedData?: any)`: Dislike a post.
+*   `undislike(id: string, userId?: string)`: Remove dislike from a post.
+*   `getDislikes(id: string, params?: { cursor?: string })`: Get users who disliked a post with pagination.
+*   `upvote(id: string, userId?: string, extendedData?: any)`: Upvote a post.
+*   `unupvote(id: string, userId?: string)`: Remove upvote from a post.
+*   `getUpvotes(id: string, params?: { cursor?: string })`: Get users who upvoted a post with pagination.
+*   `downvote(id: string, userId?: string, extendedData?: any)`: Downvote a post.
+*   `undownvote(id: string, userId?: string)`: Remove downvote from a post.
+*   `getDownvotes(id: string, params?: { cursor?: string })`: Get users who downvoted a post with pagination.
 
 ### Users (`client.users`)
 
@@ -246,32 +259,32 @@ Check the `/examples` directory for detailed examples:
 *   `getPosts(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get all posts created by a user.
 *   `getFollowers(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get user's followers.
 *   `getFollowing(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get who a user follows.
-*   `follow(id: string, followerId: string, extendedData?: any)`: Follow a user.
-*   `unfollow(id: string, followerId: string)`: Unfollow a user.
+*   `follow(id: string, followerId?: string, extendedData?: any)`: Follow a user.
+*   `unfollow(id: string, followerId?: string)`: Unfollow a user.
 
 
 ### Tags (`client.tags`)
 
-*   `list(params?: { query?: string; cursor?: string })`: List tags.
+*   `list(params?: { query?: string; cursor?: string })`: List all tags.
+*   `listSubscribed(params: { userId?: string; query?: string; cursor?: string })`: List tags a user is subscribed to.
 *   `create(payload: { name: string; description?: string; color?: string; extendedData?: Record<string, any> })`: Create a tag.
-*   `retrieve(id: string, params?: { userId?: string })`: Get a tag.
+*   `retrieve(id: string, params?: { userId?: string })`: Get a tag with optional user context.
 *   `update(id: string, payload: { name?: string; description?: string; color?: string; extendedData?: Record<string, any> })`: Update a tag.
 *   `delete(id: string)`: Delete a tag.
 *   `getThreads(id: string, params?: { query?: string; cursor?: string; filter?: 'newest' | 'oldest' })`: Get all threads with a specific tag.
-*   `subscribe(id: string, userId: string)`: Subscribe to a tag.
-*   `unsubscribe(id: string, userId: string)`: Unsubscribe from a tag.
-*   `getSubscribers(id: string, params?: { cursor?: string })`: Get users subscribed to a tag.
-*   `listSubscribed(params: { userId: string; query?: string; cursor?: string })`: List tags a user is subscribed to.
+*   `subscribe(id: string, userId?: string)`: Subscribe to a tag.
+*   `unsubscribe(id: string, userId?: string)`: Unsubscribe from a tag.
+*   `getSubscribers(id: string, params?: { cursor?: string })`: Get users subscribed to a tag with pagination.
 
 
 ### Notifications (`client.notifications`)
 
-*   `list(params: { userId: string; read?: boolean; filter?: 'newest' | 'oldest'; cursor?: string })`: List notifications.
-*   `markAllAsRead(userId: string, read?: boolean)`: Bulk update read status. Default is `true`.
-*   `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)`: Get a notification.
-*   `update(id: string, payload: { read: boolean })`: Update a notification.
-*   `delete(id: string)`: Delete a notification.
+*   `list(params: { userId?: string; read?: boolean; filter?: 'newest' | 'oldest'; cursor?: string })`: List notifications for a user.
+*   `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.
+*   `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`.
 
 ### Search (`client.search`)
 
@@ -279,12 +292,13 @@ Check the `/examples` directory for detailed examples:
 
 ### Webhooks (`client.webhooks`)
 
-*   `list()`: List webhooks.
-*   `create(payload: { name: string; url: string; events: string[] })`: Create a webhook.
-*   `retrieve(id: string)`: Get a webhook.
-*   `update(id: string, payload: any)`: Update a webhook.
+*   `list()`: List all webhooks for your instance.
+*   `create(payload: { name: string; url: string; events: string[] })`: Create a new webhook subscription.
+*   `retrieve(id: string)`: Get a webhook by ID.
+*   `update(id: string, payload: { name?: string; url?: string; events?: string[]; active?: boolean })`: Update a webhook configuration.
 *   `delete(id: string)`: Delete a webhook.
-*   `getDeliveries(id: string, params: { cursor?: string })`: Get webhook delivery history.
+*   `getDeliveries(id: string, params?: { cursor?: string })`: Get webhook delivery history with pagination. Track successful and failed deliveries.
+*   `verifySignature(payload: any, signature: string, timestamp: string, secret: string, maxAge?: number)`: Verify webhook signature for security. Uses HMAC-SHA256. Default maxAge is 5 minutes to prevent replay attacks.
 
 ### Stats (`client.stats`)
 
@@ -292,46 +306,49 @@ Check the `/examples` directory for detailed examples:
 
 ### Integrations (`client.integrations`)
 
-*   `list()`: Get all configured integrations.
-*   `create(payload: { type: 'SLACK' | 'DISCORD' | 'SALESFORCE' | 'HUBSPOT' | 'OKTA' | 'AUTH0'; name: string; config: any })`: Configure an integration (Slack, Discord, etc.).
-*   `retrieve(id: string)`: Get integration details.
-*   `update(id: string, payload: { name?: string; config?: any; active?: boolean })`: Update an integration.
+*   `list()`: Get all configured integrations for your instance.
+*   `create(payload: { type: 'SLACK' | 'DISCORD' | 'SALESFORCE' | 'HUBSPOT' | 'OKTA' | 'AUTH0'; name: string; config: any })`: Configure a new integration (Slack, Discord, CRM, or SSO).
+*   `retrieve(id: string)`: Get integration details by ID.
+*   `update(id: string, payload: { name?: string; type?: string; enabled?: boolean; config?: any })`: Update an integration configuration.
 *   `delete(id: string)`: Remove an integration.
+*   `test(integrationId: string)`: Send a test message to verify integration is working correctly.
+*   `oauthAuthorize(provider: 'hubspot' | 'salesforce')`: Initiate OAuth flow for a provider (redirects to provider).
+*   `oauthCallback(provider: string, code: string, state: string)`: Handle OAuth callback from provider.
 
 ### Private Messages (`client.privateMessages`)
 
 *   `list(params?: { query?: string; userId?: string; filter?: 'newest' | 'oldest'; cursor?: string })`: List private messages.
-*   `create(payload: { title?: string; body: string; recipientId: string; senderId?: string; extendedData?: Record<string, any> })`: Send a direct message.
-*   `retrieve(id: string)`: Get a message thread.
-*   `reply(id: string, payload: { body: string; senderId: string; recipientId: string; extendedData?: Record<string, any> })`: Reply to a message.
-*   `update(id: string, payload: { read?: boolean; extendedData?: Record<string, any> })`: Update a message (e.g., mark as read).
-*   `delete(id: string)`: Delete a message.
+*   `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).
+*   `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' })`: List reports.
-*   `create(payload: { reporterId: string; reportedId?: string; threadId?: string; postId?: string; privateMessageId?: string; type?: string; description?: string; extendedData?: Record<string, any> })`: Submit a report.
-*   `batchUpdate(payload: { reportIds: string[]; read: boolean })`: Bulk update status.
-*   `retrieve(id: string)`: Get a report.
-*   `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.
+*   `list(params?: { reporterId?: string; reportedId?: string; read?: boolean; cursor?: string; filter?: 'newest' | 'oldest' })`: List reports with filtering options.
+*   `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.
 *   `delete(id: string)`: Delete a report.
-*   `updateStatus(id: string, read: boolean)`: Update read status of a report.
 
 ### Roles (`client.roles`)
 
 *   `list(params?: { filter?: 'newest' | 'oldest'; cursor?: string })`: List user roles.
 *   `create(payload: { name: string; description?: string; color?: string; extendedData?: Record<string, any> })`: Create a new role.
-*   `retrieve(id: string)`: Get a role.
+*   `retrieve(id: string)`: Get a role by ID.
 *   `update(id: string, payload: { name?: string; description?: string; color?: string; extendedData?: Record<string, any> })`: Update a role.
 *   `delete(id: string)`: Delete a role.
 
 ### SSO (`client.sso`)
 
-*   `list()`: List SSO providers.
-*   `create(payload: { provider: 'OKTA' | 'AUTH0' | 'SAML'; domain: string; config: any })`: Configure SSO.
-*   `retrieve(id: string)`: Get SSO provider details.
-*   `update(id: string, payload: { domain?: string; config?: any; active?: boolean })`: Update SSO configuration.
-*   `delete(id: string)`: Remove SSO provider.
+*   `list()`: List all SSO providers configured for your instance.
+*   `create(payload: { provider: 'OKTA' | 'AUTH0' | 'SAML'; domain: string; config: any })`: Configure a new SSO provider.
+*   `retrieve(id: string)`: Get SSO provider details by ID.
+*   `update(id: string, payload: { name?: string; type?: 'SAML' | 'OIDC' | 'OAUTH2'; enabled?: boolean; config?: any })`: Update SSO configuration.
+*   `delete(id: string)`: Remove an SSO provider.
 
 ## Types
 
@@ -513,6 +530,20 @@ We welcome contributions! Please see our contributing guidelines for more inform
 
 ## Changelog
 
+### v1.2.3
+- README documentation update
+- Enhanced all API reference sections with:
+  - Better organization with categorized subsections (Management, Interactions, Subscriptions, Polls)
+  - Corrected optional vs required parameters throughout
+  - Added missing methods documentation (poll CRUD, webhook deliveries, integration OAuth, etc.)
+  - Improved clarity and consistency across all resource sections
+  - Added detailed descriptions for complex operations
+
+### v1.2.2
+- Added Auth resource with authentication methods
+- Introduced comprehensive SDK type definitions
+- Updated documentation
+
 ### v1.2.1
 - README.md formatting and updates
 

package/package.json

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