@foru-ms/sdk 2.0.7 → 2.1.0

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

@@ -7,11 +7,16 @@ export declare namespace PrivateMessagesClient {
     interface RequestOptions extends BaseRequestOptions {
     }
 }
+/**
+ * Operations for private messages
+ */
 export declare class PrivateMessagesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PrivateMessagesClient.Options>;
     constructor(options: PrivateMessagesClient.Options);
     /**
-     * @param {Forum.GetPrivateMessagesRequest} request
+     * Retrieve a paginated list of private messages. Use cursor for pagination.
+     *
+     * @param {Forum.ListPrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -20,12 +25,14 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.listAllPrivateMessages()
+     *     await client.privateMessages.list()
      */
-    listAllPrivateMessages(request?: Forum.GetPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.GetPrivateMessagesResponse>;
-    private __listAllPrivateMessages;
+    list(request?: Forum.ListPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PrivateMessageListResponse>;
+    private __list;
     /**
-     * @param {Forum.PostPrivateMessagesRequest} request
+     * Create a new private message.
+     *
+     * @param {Forum.CreatePrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -35,15 +42,17 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.createAPrivateMessage({
+     *     await client.privateMessages.create({
      *         recipientId: "recipientId",
      *         body: "body"
      *     })
      */
-    createAPrivateMessage(request: Forum.PostPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PostPrivateMessagesResponse>;
-    private __createAPrivateMessage;
+    create(request: Forum.CreatePrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PrivateMessageResponse>;
+    private __create;
     /**
-     * @param {Forum.GetPrivateMessagesIdRequest} request
+     * Retrieve a private message by ID or slug (if supported).
+     *
+     * @param {Forum.RetrievePrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -53,14 +62,16 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.getAPrivateMessage({
+     *     await client.privateMessages.retrieve({
      *         id: "id"
      *     })
      */
-    getAPrivateMessage(request: Forum.GetPrivateMessagesIdRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.GetPrivateMessagesIdResponse>;
-    private __getAPrivateMessage;
+    retrieve(request: Forum.RetrievePrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PrivateMessageResponse>;
+    private __retrieve;
     /**
-     * @param {Forum.DeletePrivateMessagesIdRequest} request
+     * Permanently delete a private message.
+     *
+     * @param {Forum.DeletePrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -70,14 +81,16 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.deleteAPrivateMessage({
+     *     await client.privateMessages.delete({
      *         id: "id"
      *     })
      */
-    deleteAPrivateMessage(request: Forum.DeletePrivateMessagesIdRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePrivateMessagesIdResponse>;
-    private __deleteAPrivateMessage;
+    delete(request: Forum.DeletePrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __delete;
     /**
-     * @param {Forum.GetPrivateMessagesIdRepliesRequest} request
+     * Retrieve a paginated list of replies for Private Message.
+     *
+     * @param {Forum.ListRepliesPrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -86,14 +99,16 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.listPrivateMessageReplies({
+     *     await client.privateMessages.listReplies({
      *         id: "id"
      *     })
      */
-    listPrivateMessageReplies(request: Forum.GetPrivateMessagesIdRepliesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.GetPrivateMessagesIdRepliesResponse>;
-    private __listPrivateMessageReplies;
+    listReplies(request: Forum.ListRepliesPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PrivateMessageReplyListResponse>;
+    private __listReplies;
     /**
-     * @param {Forum.PostPrivateMessagesIdRepliesRequest} request
+     * Create a Reply in Private Message.
+     *
+     * @param {Forum.CreateReplyPrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.BadRequestError}
@@ -103,16 +118,16 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.createAReplyInPrivateMessage({
+     *     await client.privateMessages.createReply({
      *         id: "id",
      *         recipientId: "recipientId",
      *         body: "body"
      *     })
      */
-    createAReplyInPrivateMessage(request: Forum.PostPrivateMessagesIdRepliesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PostPrivateMessagesIdRepliesResponse>;
-    private __createAReplyInPrivateMessage;
+    createReply(request: Forum.CreateReplyPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.PrivateMessageReplyResponse>;
+    private __createReply;
     /**
-     * @param {Forum.GetPrivateMessagesIdRepliesSubIdRequest} request
+     * @param {Forum.RetrieveReplyPrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -121,15 +136,15 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.getAReplyFromPrivateMessage({
+     *     await client.privateMessages.retrieveReply({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    getAReplyFromPrivateMessage(request: Forum.GetPrivateMessagesIdRepliesSubIdRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.GetPrivateMessagesIdRepliesSubIdResponse>;
-    private __getAReplyFromPrivateMessage;
+    retrieveReply(request: Forum.RetrieveReplyPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.RetrieveReplyPrivateMessagesResponse>;
+    private __retrieveReply;
     /**
-     * @param {Forum.DeletePrivateMessagesIdRepliesSubIdRequest} request
+     * @param {Forum.DeleteReplyPrivateMessagesRequest} request
      * @param {PrivateMessagesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Forum.UnauthorizedError}
@@ -138,11 +153,11 @@ export declare class PrivateMessagesClient {
      * @throws {@link Forum.InternalServerError}
      *
      * @example
-     *     await client.privateMessages.deleteAReplyFromPrivateMessage({
+     *     await client.privateMessages.deleteReply({
      *         id: "id",
      *         subId: "subId"
      *     })
      */
-    deleteAReplyFromPrivateMessage(request: Forum.DeletePrivateMessagesIdRepliesSubIdRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.DeletePrivateMessagesIdRepliesSubIdResponse>;
-    private __deleteAReplyFromPrivateMessage;
+    deleteReply(request: Forum.DeleteReplyPrivateMessagesRequest, requestOptions?: PrivateMessagesClient.RequestOptions): core.HttpResponsePromise<Forum.SuccessResponse>;
+    private __deleteReply;
 }