@foru-ms/sdk 2.0.8 → 2.1.1

package/dist/cjs/api/resources/notifications/client/requests/CreateNotificationsRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @example
+ *     {
+ *         userId: "userId",
+ *         type: "type"
+ *     }
+ */
+export interface CreateNotificationsRequest {
+    /** Target user ID to receive notification (maps to userId) */
+    userId: string;
+    /** User ID who triggered the notification (optional, defaults to authenticated user) */
+    notifierId?: string;
+    /** Notification type (e.g. mention, reply, follow) */
+    type: string;
+    /** Notification text content */
+    description?: string;
+    /** Related thread ID */
+    threadId?: string;
+    /** Related post ID */
+    postId?: string;
+    /** Related private message ID */
+    privateMessageId?: string;
+    /** Initial notification status */
+    status?: CreateNotificationsRequest.Status;
+    /** Additional notification data */
+    extendedData?: Record<string, unknown>;
+}
+export declare namespace CreateNotificationsRequest {
+    /** Initial notification status */
+    const Status: {
+        readonly Read: "read";
+        readonly Unread: "unread";
+        readonly Dismissed: "dismissed";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/resources/notifications/client/requests/CreateNotificationsRequest.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateNotificationsRequest = void 0;
+var CreateNotificationsRequest;
+(function (CreateNotificationsRequest) {
+    /** Initial notification status */
+    CreateNotificationsRequest.Status = {
+        Read: "read",
+        Unread: "unread",
+        Dismissed: "dismissed",
+        Archived: "archived",
+    };
+})(CreateNotificationsRequest || (exports.CreateNotificationsRequest = CreateNotificationsRequest = {}));

package/dist/cjs/api/resources/notifications/client/requests/DeleteNotificationsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteNotificationsRequest {
+    /** Notification ID */
+    id: string;
+}

package/dist/cjs/api/resources/notifications/client/requests/ListNotificationsRequest.d.ts

@@ -0,0 +1,15 @@
+import type * as Forum from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface ListNotificationsRequest {
+    /** Items per page (max 75) */
+    limit?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+    /** Filter by notification status */
+    status?: Forum.ListNotificationsRequestStatus;
+    /** Filter by recipient user ID (admin only) */
+    userId?: string;
+}

package/dist/cjs/api/resources/notifications/client/requests/RetrieveNotificationsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface RetrieveNotificationsRequest {
+    /** Notification ID */
+    id: string;
+}

package/dist/cjs/api/resources/notifications/client/requests/UpdateNotificationsRequest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface UpdateNotificationsRequest {
+    /** Notification ID */
+    id: string;
+    /** Notification status */
+    status?: UpdateNotificationsRequest.Status;
+    /** Update extended data */
+    extendedData?: Record<string, unknown>;
+}
+export declare namespace UpdateNotificationsRequest {
+    /** Notification status */
+    const Status: {
+        readonly Read: "read";
+        readonly Unread: "unread";
+        readonly Dismissed: "dismissed";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/resources/notifications/client/requests/UpdateNotificationsRequest.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateNotificationsRequest = void 0;
+var UpdateNotificationsRequest;
+(function (UpdateNotificationsRequest) {
+    /** Notification status */
+    UpdateNotificationsRequest.Status = {
+        Read: "read",
+        Unread: "unread",
+        Dismissed: "dismissed",
+        Archived: "archived",
+    };
+})(UpdateNotificationsRequest || (exports.UpdateNotificationsRequest = UpdateNotificationsRequest = {}));

package/dist/cjs/api/resources/notifications/client/requests/index.d.ts

@@ -1,5 +1,5 @@
-export type { DeleteNotificationsIdRequest } from "./DeleteNotificationsIdRequest.js";
-export type { GetNotificationsIdRequest } from "./GetNotificationsIdRequest.js";
-export type { GetNotificationsRequest } from "./GetNotificationsRequest.js";
-export type { PatchNotificationsIdRequest } from "./PatchNotificationsIdRequest.js";
-export type { PostNotificationsRequest } from "./PostNotificationsRequest.js";
+export { CreateNotificationsRequest } from "./CreateNotificationsRequest.js";
+export type { DeleteNotificationsRequest } from "./DeleteNotificationsRequest.js";
+export type { ListNotificationsRequest } from "./ListNotificationsRequest.js";
+export type { RetrieveNotificationsRequest } from "./RetrieveNotificationsRequest.js";
+export { UpdateNotificationsRequest } from "./UpdateNotificationsRequest.js";

package/dist/cjs/api/resources/notifications/client/requests/index.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateNotificationsRequest = exports.CreateNotificationsRequest = void 0;
+var CreateNotificationsRequest_js_1 = require("./CreateNotificationsRequest.js");
+Object.defineProperty(exports, "CreateNotificationsRequest", { enumerable: true, get: function () { return CreateNotificationsRequest_js_1.CreateNotificationsRequest; } });
+var UpdateNotificationsRequest_js_1 = require("./UpdateNotificationsRequest.js");
+Object.defineProperty(exports, "UpdateNotificationsRequest", { enumerable: true, get: function () { return UpdateNotificationsRequest_js_1.UpdateNotificationsRequest; } });

package/dist/cjs/api/resources/notifications/types/ListNotificationsRequestStatus.d.ts

@@ -0,0 +1,7 @@
+export declare const ListNotificationsRequestStatus: {
+    readonly Read: "read";
+    readonly Unread: "unread";
+    readonly Dismissed: "dismissed";
+    readonly Archived: "archived";
+};
+export type ListNotificationsRequestStatus = (typeof ListNotificationsRequestStatus)[keyof typeof ListNotificationsRequestStatus];

package/dist/cjs/api/resources/notifications/types/ListNotificationsRequestStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListNotificationsRequestStatus = void 0;
+exports.ListNotificationsRequestStatus = {
+    Read: "read",
+    Unread: "unread",
+    Dismissed: "dismissed",
+    Archived: "archived",
+};

package/dist/cjs/api/resources/notifications/types/UpdateNotificationsResponse.d.ts

@@ -0,0 +1,30 @@
+export interface UpdateNotificationsResponse {
+    data?: UpdateNotificationsResponse.Data;
+}
+export declare namespace UpdateNotificationsResponse {
+    interface Data {
+        id: string;
+        /** Recipient user ID */
+        userId: string;
+        /** User ID who triggered the notification */
+        notifierId: string;
+        /** Notification type */
+        type: string | null;
+        /** Notification text content */
+        description: string | null;
+        /** Notification status (read, unread, dismissed, archived) */
+        status: string | null;
+        /** Related thread ID */
+        threadId: string | null;
+        /** Related post ID */
+        postId: string | null;
+        /** Related private message ID */
+        privateMessageId: string | null;
+        /** Additional notification data */
+        extendedData: Record<string, unknown> | null;
+        /** Notification creation timestamp */
+        createdAt: string;
+        /** Notification last update timestamp */
+        updatedAt: string;
+    }
+}

package/dist/cjs/api/resources/notifications/types/index.d.ts

@@ -1,5 +1,2 @@
-export * from "./DeleteNotificationsIdResponse.js";
-export * from "./GetNotificationsIdResponse.js";
-export * from "./GetNotificationsResponse.js";
-export * from "./PatchNotificationsIdResponse.js";
-export * from "./PostNotificationsResponse.js";
+export * from "./ListNotificationsRequestStatus.js";
+export * from "./UpdateNotificationsResponse.js";

package/dist/cjs/api/resources/notifications/types/index.js

@@ -14,8 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./DeleteNotificationsIdResponse.js"), exports);
-__exportStar(require("./GetNotificationsIdResponse.js"), exports);
-__exportStar(require("./GetNotificationsResponse.js"), exports);
-__exportStar(require("./PatchNotificationsIdResponse.js"), exports);
-__exportStar(require("./PostNotificationsResponse.js"), exports);
+__exportStar(require("./ListNotificationsRequestStatus.js"), exports);
+__exportStar(require("./UpdateNotificationsResponse.js"), exports);

package/dist/cjs/api/resources/posts/client/Client.d.ts

@@ -7,11 +7,16 @@ export declare namespace PostsClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
+/**
+ * Operations for posts
+ */
 export declare class PostsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PostsClient.Options>;
-    constructor(options: PostsClient.Options);
+    constructor(options?: PostsClient.Options);
     /**
-     * @param {Forum.GetPostsRequest} request
+     * Retrieve a paginated list of posts. Use cursor for pagination.
+     *
+     * @param {Forum.ListPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -20,12 +25,14 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.listAllPosts()
+     *     await client.posts.list()
      */
-    listAllPosts(request?: Forum.GetPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsResponse>;
-    private __listAllPosts;
+    list(request?: Forum.ListPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostListResponse>;
+    private __list;
     /**
-     * @param {Forum.PostPostsRequest} request
+     * Create a new post.
+     *
+     * @param {Forum.CreatePostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -35,15 +42,17 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.createAPost({
+     *     await client.posts.create({
      *         threadId: "threadId",
      *         body: "body"
      *     })
      */
-    createAPost(request: Forum.PostPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostPostsResponse>;
-    private __createAPost;
+    create(request: Forum.CreatePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostResponse>;
+    private __create;
     /**
-     * @param {Forum.GetPostsIdRequest} request
+     * Retrieve a post by ID or slug (if supported).
+     *
+     * @param {Forum.RetrievePostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -53,14 +62,16 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.getAPost({
+     *     await client.posts.retrieve({
      *         id: "id"
      *     })
      */
-    getAPost(request: Forum.GetPostsIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsIdResponse>;
-    private __getAPost;
+    retrieve(request: Forum.RetrievePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostResponse>;
+    private __retrieve;
     /**
-     * @param {Forum.DeletePostsIdRequest} request
+     * Permanently delete a post.
+     *
+     * @param {Forum.DeletePostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -70,14 +81,16 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.deleteAPost({
+     *     await client.posts.delete({
      *         id: "id"
      *     })
      */
-    deleteAPost(request: Forum.DeletePostsIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePostsIdResponse>;
-    private __deleteAPost;
+    delete(request: Forum.DeletePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __delete;
     /**
-     * @param {Forum.PatchPostsIdRequest} request
+     * Update an existing post. Only provided fields will be modified.
+     *
+     * @param {Forum.UpdatePostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -88,14 +101,16 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.updateAPost({
+     *     await client.posts.update({
      *         id: "id"
      *     })
      */
-    updateAPost(request: Forum.PatchPostsIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PatchPostsIdResponse>;
-    private __updateAPost;
+    update(request: Forum.UpdatePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.UpdatePostsResponse>;
+    private __update;
     /**
-     * @param {Forum.GetPostsIdReactionsRequest} request
+     * Retrieve a paginated list of reactions for Post.
+     *
+     * @param {Forum.ListReactionsPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -104,14 +119,16 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.listPostReactions({
+     *     await client.posts.listReactions({
      *         id: "id"
      *     })
      */
-    listPostReactions(request: Forum.GetPostsIdReactionsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsIdReactionsResponse>;
-    private __listPostReactions;
+    listReactions(request: Forum.ListReactionsPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostReactionListResponse>;
+    private __listReactions;
     /**
-     * @param {Forum.PostPostsIdReactionsRequest} request
+     * Create a Reaction in Post.
+     *
+     * @param {Forum.CreateReactionPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -121,17 +138,15 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.createAReactionInPost({
+     *     await client.posts.createReaction({
      *         id: "id",
      *         type: "LIKE"
      *     })
      */
-    createAReactionInPost(request: Forum.PostPostsIdReactionsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostPostsIdReactionsResponse>;
-    private __createAReactionInPost;
+    createReaction(request: Forum.CreateReactionPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostReactionResponse>;
+    private __createReaction;
     /**
-     * Removes the authenticated user's reaction. No subId needed.
-     *
-     * @param {Forum.DeletePostsIdReactionsRequest} request
+     * @param {Forum.DeleteReactionPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -140,31 +155,15 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.removeYourReactionFromPost({
-     *         id: "id"
-     *     })
-     */
-    removeYourReactionFromPost(request: Forum.DeletePostsIdReactionsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePostsIdReactionsResponse>;
-    private __removeYourReactionFromPost;
-    /**
-     * @param {Forum.GetPostsIdReactionsSubIdRequest} request
-     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Forum.UnauthorizedError}
-     * @throws {@link Forum.NotFoundError}
-     * @throws {@link Forum.TooManyRequestsError}
-     * @throws {@link Forum.InternalServerError}
-     *
-     * @example
-     *     await client.posts.getAReactionFromPost({
+     *     await client.posts.deleteReaction({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAReactionFromPost(request: Forum.GetPostsIdReactionsSubIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsIdReactionsSubIdResponse>;
-    private __getAReactionFromPost;
+    deleteReaction(request: Forum.DeleteReactionPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteReaction;
     /**
-     * @param {Forum.DeletePostsIdReactionsSubIdRequest} request
+     * @param {Forum.RetrieveReactionPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -173,15 +172,17 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.deleteAReactionFromPost({
+     *     await client.posts.retrieveReaction({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAReactionFromPost(request: Forum.DeletePostsIdReactionsSubIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePostsIdReactionsSubIdResponse>;
-    private __deleteAReactionFromPost;
+    retrieveReaction(request: Forum.RetrieveReactionPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveReactionPostsResponse>;
+    private __retrieveReaction;
     /**
-     * @param {Forum.GetPostsIdPostsRequest} request
+     * Retrieve a paginated list of posts for Post.
+     *
+     * @param {Forum.ListPostsPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -190,14 +191,14 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.listPostPosts({
+     *     await client.posts.listPosts({
      *         id: "id"
      *     })
      */
-    listPostPosts(request: Forum.GetPostsIdPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsIdPostsResponse>;
-    private __listPostPosts;
+    listPosts(request: Forum.ListPostsPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.PostPostListResponse>;
+    private __listPosts;
     /**
-     * @param {Forum.GetPostsIdPostsSubIdRequest} request
+     * @param {Forum.RetrievePostPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -206,15 +207,15 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.getAPostFromPost({
+     *     await client.posts.retrievePost({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAPostFromPost(request: Forum.GetPostsIdPostsSubIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.GetPostsIdPostsSubIdResponse>;
-    private __getAPostFromPost;
+    retrievePost(request: Forum.RetrievePostPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrievePostPostsResponse>;
+    private __retrievePost;
     /**
-     * @param {Forum.DeletePostsIdPostsSubIdRequest} request
+     * @param {Forum.DeletePostPostsRequest} request
      * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -223,11 +224,11 @@ export declare class PostsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.posts.deleteAPostFromPost({
+     *     await client.posts.deletePost({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAPostFromPost(request: Forum.DeletePostsIdPostsSubIdRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePostsIdPostsSubIdResponse>;
-    private __deleteAPostFromPost;
+    deletePost(request: Forum.DeletePostPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deletePost;
 }