@foru-ms/sdk 2.0.8 → 2.1.0

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

@@ -7,11 +7,16 @@ export declare namespace ThreadsClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
+/**
+ * Operations for threads
+ */
 export declare class ThreadsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ThreadsClient.Options>;
     constructor(options: ThreadsClient.Options);
     /**
-     * @param {Forum.GetThreadsRequest} request
+     * Retrieve a paginated list of threads. Use cursor for pagination.
+     *
+     * @param {Forum.ListThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -20,12 +25,14 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.listAllThreads()
+     *     await client.threads.list()
      */
-    listAllThreads(request?: Forum.GetThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsResponse>;
-    private __listAllThreads;
+    list(request?: Forum.ListThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadListResponse>;
+    private __list;
     /**
-     * @param {Forum.PostThreadsRequest} request
+     * Create a new thread.
+     *
+     * @param {Forum.CreateThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -35,15 +42,17 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.createAThread({
+     *     await client.threads.create({
      *         title: "title",
      *         body: "body"
      *     })
      */
-    createAThread(request: Forum.PostThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.PostThreadsResponse>;
-    private __createAThread;
+    create(request: Forum.CreateThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadResponse>;
+    private __create;
     /**
-     * @param {Forum.GetThreadsIdRequest} request
+     * Retrieve a thread by ID or slug (if supported).
+     *
+     * @param {Forum.RetrieveThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -53,14 +62,16 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.getAThread({
+     *     await client.threads.retrieve({
      *         id: "id"
      *     })
      */
-    getAThread(request: Forum.GetThreadsIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdResponse>;
-    private __getAThread;
+    retrieve(request: Forum.RetrieveThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadResponse>;
+    private __retrieve;
     /**
-     * @param {Forum.DeleteThreadsIdRequest} request
+     * Permanently delete a thread.
+     *
+     * @param {Forum.DeleteThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -70,14 +81,16 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.deleteAThread({
+     *     await client.threads.delete({
      *         id: "id"
      *     })
      */
-    deleteAThread(request: Forum.DeleteThreadsIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteThreadsIdResponse>;
-    private __deleteAThread;
+    delete(request: Forum.DeleteThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __delete;
     /**
-     * @param {Forum.PatchThreadsIdRequest} request
+     * Update an existing thread. Only provided fields will be modified.
+     *
+     * @param {Forum.UpdateThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -88,14 +101,16 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.updateAThread({
+     *     await client.threads.update({
      *         id: "id"
      *     })
      */
-    updateAThread(request: Forum.PatchThreadsIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.PatchThreadsIdResponse>;
-    private __updateAThread;
+    update(request: Forum.UpdateThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.UpdateThreadsResponse>;
+    private __update;
     /**
-     * @param {Forum.GetThreadsIdPostsRequest} request
+     * Retrieve a paginated list of posts for Thread.
+     *
+     * @param {Forum.ListPostsThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -104,14 +119,14 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.listThreadPosts({
+     *     await client.threads.listPosts({
      *         id: "id"
      *     })
      */
-    listThreadPosts(request: Forum.GetThreadsIdPostsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdPostsResponse>;
-    private __listThreadPosts;
+    listPosts(request: Forum.ListPostsThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadPostListResponse>;
+    private __listPosts;
     /**
-     * @param {Forum.GetThreadsIdPostsSubIdRequest} request
+     * @param {Forum.RetrievePostThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -120,15 +135,15 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.getAPostFromThread({
+     *     await client.threads.retrievePost({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAPostFromThread(request: Forum.GetThreadsIdPostsSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdPostsSubIdResponse>;
-    private __getAPostFromThread;
+    retrievePost(request: Forum.RetrievePostThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrievePostThreadsResponse>;
+    private __retrievePost;
     /**
-     * @param {Forum.DeleteThreadsIdPostsSubIdRequest} request
+     * @param {Forum.DeletePostThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -137,15 +152,17 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.deleteAPostFromThread({
+     *     await client.threads.deletePost({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAPostFromThread(request: Forum.DeleteThreadsIdPostsSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteThreadsIdPostsSubIdResponse>;
-    private __deleteAPostFromThread;
+    deletePost(request: Forum.DeletePostThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deletePost;
     /**
-     * @param {Forum.GetThreadsIdReactionsRequest} request
+     * Retrieve a paginated list of reactions for Thread.
+     *
+     * @param {Forum.ListReactionsThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -154,14 +171,16 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.listThreadReactions({
+     *     await client.threads.listReactions({
      *         id: "id"
      *     })
      */
-    listThreadReactions(request: Forum.GetThreadsIdReactionsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdReactionsResponse>;
-    private __listThreadReactions;
+    listReactions(request: Forum.ListReactionsThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadReactionListResponse>;
+    private __listReactions;
     /**
-     * @param {Forum.PostThreadsIdReactionsRequest} request
+     * Create a Reaction in Thread.
+     *
+     * @param {Forum.CreateReactionThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -171,33 +190,15 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.createAReactionInThread({
+     *     await client.threads.createReaction({
      *         id: "id",
      *         type: "LIKE"
      *     })
      */
-    createAReactionInThread(request: Forum.PostThreadsIdReactionsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.PostThreadsIdReactionsResponse>;
-    private __createAReactionInThread;
-    /**
-     * Removes the authenticated user's reaction. No subId needed.
-     *
-     * @param {Forum.DeleteThreadsIdReactionsRequest} request
-     * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Forum.UnauthorizedError}
-     * @throws {@link Forum.NotFoundError}
-     * @throws {@link Forum.TooManyRequestsError}
-     * @throws {@link Forum.InternalServerError}
-     *
-     * @example
-     *     await client.threads.removeYourReactionFromThread({
-     *         id: "id"
-     *     })
-     */
-    removeYourReactionFromThread(request: Forum.DeleteThreadsIdReactionsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteThreadsIdReactionsResponse>;
-    private __removeYourReactionFromThread;
+    createReaction(request: Forum.CreateReactionThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadReactionResponse>;
+    private __createReaction;
     /**
-     * @param {Forum.GetThreadsIdReactionsSubIdRequest} request
+     * @param {Forum.DeleteReactionThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -206,15 +207,15 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.getAReactionFromThread({
+     *     await client.threads.deleteReaction({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAReactionFromThread(request: Forum.GetThreadsIdReactionsSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdReactionsSubIdResponse>;
-    private __getAReactionFromThread;
+    deleteReaction(request: Forum.DeleteReactionThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteReaction;
     /**
-     * @param {Forum.DeleteThreadsIdReactionsSubIdRequest} request
+     * @param {Forum.RetrieveReactionThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -223,15 +224,17 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.deleteAReactionFromThread({
+     *     await client.threads.retrieveReaction({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAReactionFromThread(request: Forum.DeleteThreadsIdReactionsSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteThreadsIdReactionsSubIdResponse>;
-    private __deleteAReactionFromThread;
+    retrieveReaction(request: Forum.RetrieveReactionThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveReactionThreadsResponse>;
+    private __retrieveReaction;
     /**
-     * @param {Forum.GetThreadsIdSubscribersRequest} request
+     * Retrieve a paginated list of subscribers for Thread.
+     *
+     * @param {Forum.ListSubscribersThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -240,14 +243,14 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.listThreadSubscribers({
+     *     await client.threads.listSubscribers({
      *         id: "id"
      *     })
      */
-    listThreadSubscribers(request: Forum.GetThreadsIdSubscribersRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdSubscribersResponse>;
-    private __listThreadSubscribers;
+    listSubscribers(request: Forum.ListSubscribersThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadSubscriberListResponse>;
+    private __listSubscribers;
     /**
-     * @param {Forum.GetThreadsIdSubscribersSubIdRequest} request
+     * @param {Forum.RetrieveSubscriberThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -256,15 +259,15 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.getASubscriberFromThread({
+     *     await client.threads.retrieveSubscriber({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getASubscriberFromThread(request: Forum.GetThreadsIdSubscribersSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdSubscribersSubIdResponse>;
-    private __getASubscriberFromThread;
+    retrieveSubscriber(request: Forum.RetrieveSubscriberThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveSubscriberThreadsResponse>;
+    private __retrieveSubscriber;
     /**
-     * @param {Forum.DeleteThreadsIdSubscribersSubIdRequest} request
+     * @param {Forum.DeleteSubscriberThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -273,15 +276,15 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.deleteASubscriberFromThread({
+     *     await client.threads.deleteSubscriber({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteASubscriberFromThread(request: Forum.DeleteThreadsIdSubscribersSubIdRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteThreadsIdSubscribersSubIdResponse>;
-    private __deleteASubscriberFromThread;
+    deleteSubscriber(request: Forum.DeleteSubscriberThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteSubscriber;
     /**
-     * @param {Forum.GetThreadsIdPollRequest} request
+     * @param {Forum.RetrievePollThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -290,14 +293,14 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.getThreadPoll({
+     *     await client.threads.retrievePoll({
      *         id: "id"
      *     })
      */
-    getThreadPoll(request: Forum.GetThreadsIdPollRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.GetThreadsIdPollResponse>;
-    private __getThreadPoll;
+    retrievePoll(request: Forum.RetrievePollThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadPollResponse>;
+    private __retrievePoll;
     /**
-     * @param {Forum.PostThreadsIdPollRequest} request
+     * @param {Forum.CreatePollThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -307,7 +310,7 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.createThreadPoll({
+     *     await client.threads.createPoll({
      *         id: "id",
      *         title: "title",
      *         options: [{
@@ -315,10 +318,10 @@ export declare class ThreadsClient {
      *             }]
      *     })
      */
-    createThreadPoll(request: Forum.PostThreadsIdPollRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.PostThreadsIdPollResponse>;
-    private __createThreadPoll;
+    createPoll(request: Forum.CreatePollThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadPollResponse>;
+    private __createPoll;
     /**
-     * @param {Forum.PatchThreadsIdPollRequest} request
+     * @param {Forum.UpdatePollThreadsRequest} request
      * @param {ThreadsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -328,10 +331,10 @@ export declare class ThreadsClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.threads.updateThreadPoll({
+     *     await client.threads.updatePoll({
      *         id: "id"
      *     })
      */
-    updateThreadPoll(request: Forum.PatchThreadsIdPollRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.PatchThreadsIdPollResponse>;
-    private __updateThreadPoll;
+    updatePoll(request: Forum.UpdatePollThreadsRequest, requestOptions?: ThreadsClient.RequestOptions): core.HttpResponsePromise<Forum.ThreadPollResponse>;
+    private __updatePoll;
 }