@foru-ms/sdk 2.0.8 → 2.1.1

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

@@ -14,22 +14,12 @@ 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("./DeleteThreadsIdPostsSubIdResponse.js"), exports);
-__exportStar(require("./DeleteThreadsIdReactionsResponse.js"), exports);
-__exportStar(require("./DeleteThreadsIdReactionsSubIdResponse.js"), exports);
-__exportStar(require("./DeleteThreadsIdResponse.js"), exports);
-__exportStar(require("./DeleteThreadsIdSubscribersSubIdResponse.js"), exports);
-__exportStar(require("./GetThreadsIdPollResponse.js"), exports);
-__exportStar(require("./GetThreadsIdPostsResponse.js"), exports);
-__exportStar(require("./GetThreadsIdPostsSubIdResponse.js"), exports);
-__exportStar(require("./GetThreadsIdReactionsResponse.js"), exports);
-__exportStar(require("./GetThreadsIdReactionsSubIdResponse.js"), exports);
-__exportStar(require("./GetThreadsIdResponse.js"), exports);
-__exportStar(require("./GetThreadsIdSubscribersResponse.js"), exports);
-__exportStar(require("./GetThreadsIdSubscribersSubIdResponse.js"), exports);
-__exportStar(require("./GetThreadsResponse.js"), exports);
-__exportStar(require("./PatchThreadsIdPollResponse.js"), exports);
-__exportStar(require("./PatchThreadsIdResponse.js"), exports);
-__exportStar(require("./PostThreadsIdPollResponse.js"), exports);
-__exportStar(require("./PostThreadsIdReactionsResponse.js"), exports);
-__exportStar(require("./PostThreadsResponse.js"), exports);
+__exportStar(require("./DeleteReactionThreadsResponse.js"), exports);
+__exportStar(require("./ListPostsThreadsRequestSort.js"), exports);
+__exportStar(require("./ListPostsThreadsRequestType.js"), exports);
+__exportStar(require("./ListReactionsThreadsRequestType.js"), exports);
+__exportStar(require("./ListThreadsRequestSort.js"), exports);
+__exportStar(require("./RetrievePostThreadsResponse.js"), exports);
+__exportStar(require("./RetrieveReactionThreadsResponse.js"), exports);
+__exportStar(require("./RetrieveSubscriberThreadsResponse.js"), exports);
+__exportStar(require("./UpdateThreadsResponse.js"), exports);

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

@@ -7,11 +7,16 @@ export declare namespace UsersClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
+/**
+ * Operations for users
+ */
 export declare class UsersClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<UsersClient.Options>;
-    constructor(options: UsersClient.Options);
+    constructor(options?: UsersClient.Options);
     /**
-     * @param {Forum.GetUsersRequest} request
+     * Retrieve a paginated list of users. Use cursor for pagination.
+     *
+     * @param {Forum.ListUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -20,12 +25,33 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.listAllUsers()
+     *     await client.users.list()
      */
-    listAllUsers(request?: Forum.GetUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersResponse>;
-    private __listAllUsers;
+    list(request?: Forum.ListUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UserListResponse>;
+    private __list;
     /**
-     * @param {Forum.GetUsersIdRequest} request
+     * Create a new user.
+     *
+     * @param {Forum.CreateUsersRequest} request
+     * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.PaymentRequiredError}
+     * @throws {@link Forum.TooManyRequestsError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.users.create({
+     *         username: "username"
+     *     })
+     */
+    create(request: Forum.CreateUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UserResponse>;
+    private __create;
+    /**
+     * Retrieve a user by ID or slug (if supported).
+     *
+     * @param {Forum.RetrieveUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -35,14 +61,16 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.getAUser({
+     *     await client.users.retrieve({
      *         id: "id"
      *     })
      */
-    getAUser(request: Forum.GetUsersIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersIdResponse>;
-    private __getAUser;
+    retrieve(request: Forum.RetrieveUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UserResponse>;
+    private __retrieve;
     /**
-     * @param {Forum.DeleteUsersIdRequest} request
+     * Permanently delete a user.
+     *
+     * @param {Forum.DeleteUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -52,14 +80,16 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.deleteAUser({
+     *     await client.users.delete({
      *         id: "id"
      *     })
      */
-    deleteAUser(request: Forum.DeleteUsersIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteUsersIdResponse>;
-    private __deleteAUser;
+    delete(request: Forum.DeleteUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __delete;
     /**
-     * @param {Forum.PatchUsersIdRequest} request
+     * Update an existing user. Only provided fields will be modified.
+     *
+     * @param {Forum.UpdateUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -70,14 +100,16 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.updateAUser({
+     *     await client.users.update({
      *         id: "id"
      *     })
      */
-    updateAUser(request: Forum.PatchUsersIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.PatchUsersIdResponse>;
-    private __updateAUser;
+    update(request: Forum.UpdateUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UpdateUsersResponse>;
+    private __update;
     /**
-     * @param {Forum.GetUsersIdFollowersRequest} request
+     * Retrieve a paginated list of followers for User.
+     *
+     * @param {Forum.ListFollowersUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -86,14 +118,14 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.listUserFollowers({
+     *     await client.users.listFollowers({
      *         id: "id"
      *     })
      */
-    listUserFollowers(request: Forum.GetUsersIdFollowersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersIdFollowersResponse>;
-    private __listUserFollowers;
+    listFollowers(request: Forum.ListFollowersUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UserFollowerListResponse>;
+    private __listFollowers;
     /**
-     * @param {Forum.GetUsersIdFollowersSubIdRequest} request
+     * @param {Forum.RetrieveFollowerUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -102,15 +134,15 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.getAFollowerFromUser({
+     *     await client.users.retrieveFollower({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAFollowerFromUser(request: Forum.GetUsersIdFollowersSubIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersIdFollowersSubIdResponse>;
-    private __getAFollowerFromUser;
+    retrieveFollower(request: Forum.RetrieveFollowerUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveFollowerUsersResponse>;
+    private __retrieveFollower;
     /**
-     * @param {Forum.DeleteUsersIdFollowersSubIdRequest} request
+     * @param {Forum.DeleteFollowerUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -119,15 +151,17 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.deleteAFollowerFromUser({
+     *     await client.users.deleteFollower({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAFollowerFromUser(request: Forum.DeleteUsersIdFollowersSubIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteUsersIdFollowersSubIdResponse>;
-    private __deleteAFollowerFromUser;
+    deleteFollower(request: Forum.DeleteFollowerUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteFollower;
     /**
-     * @param {Forum.GetUsersIdFollowingRequest} request
+     * Retrieve a paginated list of following for User.
+     *
+     * @param {Forum.ListFollowingUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -136,14 +170,14 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.listUserFollowing({
+     *     await client.users.listFollowing({
      *         id: "id"
      *     })
      */
-    listUserFollowing(request: Forum.GetUsersIdFollowingRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersIdFollowingResponse>;
-    private __listUserFollowing;
+    listFollowing(request: Forum.ListFollowingUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.UserFollowingListResponse>;
+    private __listFollowing;
     /**
-     * @param {Forum.GetUsersIdFollowingSubIdRequest} request
+     * @param {Forum.RetrieveFollowingUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -152,15 +186,15 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.getAFollowingFromUser({
+     *     await client.users.retrieveFollowing({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAFollowingFromUser(request: Forum.GetUsersIdFollowingSubIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsersIdFollowingSubIdResponse>;
-    private __getAFollowingFromUser;
+    retrieveFollowing(request: Forum.RetrieveFollowingUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveFollowingUsersResponse>;
+    private __retrieveFollowing;
     /**
-     * @param {Forum.DeleteUsersIdFollowingSubIdRequest} request
+     * @param {Forum.DeleteFollowingUsersRequest} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -169,11 +203,11 @@ export declare class UsersClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.users.deleteAFollowingFromUser({
+     *     await client.users.deleteFollowing({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAFollowingFromUser(request: Forum.DeleteUsersIdFollowingSubIdRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteUsersIdFollowingSubIdResponse>;
-    private __deleteAFollowingFromUser;
+    deleteFollowing(request: Forum.DeleteFollowingUsersRequest, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteFollowing;
 }