Add MessageGateway ID to MessageWebhookData and to requests for message operations

- Add the missing RestoreMessage operation

Author: kifril

v1/client.go

@@ -942,6 +942,43 @@ func (c *MgClient) UploadFileByURL(request UploadFileByUrlRequest) (UploadFileRe
 	return resp, status, err
 }
 
+// RestoreMessage restores deleted message.
+//
+// Example:
+//
+//	client := New("https://message-gateway.url", "cb8ccf05e38a47543ad8477d4999be73bff503ea6")
+//
+//	resp, status, err := client.RestoreMessage(RestoreMessageRequest{
+//		Message: RestoreMessageRequestMessage{
+//			ExternalID: "message_id_1",
+//		},
+//		ChannelID: 305,
+//	})
+//	if err != nil {
+//		log.Fatalf("request error: %s (%d)", err, status)
+//	}
+//
+//	log.Printf("status: %d, message ID: %d", status, resp.MessageID)
+func (c *MgClient) RestoreMessage(request RestoreMessageRequest) (MessagesResponse, int, error) {
+	var resp MessagesResponse
+	outgoing, _ := json.Marshal(&request)
+
+	data, status, err := c.PostRequest("/messages/restore", bytes.NewBuffer(outgoing))
+	if err != nil {
+		return resp, status, err
+	}
+
+	if e := json.Unmarshal(data, &resp); e != nil {
+		return resp, status, e
+	}
+
+	if status != http.StatusOK {
+		return resp, status, NewAPIClientError(data)
+	}
+
+	return resp, status, err
+}
+
 // MakeTimestamp returns current unix timestamp in milliseconds.
 //
 // Example:

v1/client_test.go

@@ -1123,3 +1123,26 @@ func (t *MGClientTest) Test_SuccessHandleError() {
 	t.Assert().IsType(new(HTTPClientError), err)
 	t.Assert().Equal("Channel not found", err.Error())
 }
+
+func (t *MGClientTest) Test_RestoreMessage() {
+	client := t.client()
+	t.gock().
+		Post(t.transportURL("messages/restore")).
+		Reply(http.StatusOK).
+		JSON(MessagesResponse{
+			MessageID: 1,
+			Time:      time.Now(),
+		})
+
+	data, status, err := client.RestoreMessage(RestoreMessageRequest{
+		ChannelID: 30,
+		Message: RestoreMessageRequestMessage{
+			ExternalID: "external_1",
+		},
+	})
+
+	t.Require().NoError(err)
+	t.Assert().Equal(http.StatusOK, status)
+	t.Assert().NotEmpty(data.Time.String())
+	t.Assert().Equal(1, data.MessageID)
+}

v1/types.go

@@ -319,7 +319,8 @@ type Utm struct {
 
 // Message struct.
 type Message struct {
-	ExternalID string              `json:"external_id"`
+	ID         *int64              `json:"id,omitempty"`
+	ExternalID string              `json:"external_id,omitempty"`
 	Type       string              `json:"type,omitempty"`
 	Text       string              `json:"text,omitempty"`
 	Note       string              `json:"note,omitempty"`
@@ -343,7 +344,8 @@ type EditMessageRequest struct {
 
 // EditMessageRequestMessage type.
 type EditMessageRequestMessage struct {
-	ExternalID string `json:"external_id"`
+	ID         *int64 `json:"id,omitempty"`
+	ExternalID string `json:"external_id,omitempty"`
 	Text       string `json:"text"`
 	EditedAt   int64  `json:"edited_at"`
 	PageLink   string `json:"page_link,omitempty"`
@@ -366,7 +368,8 @@ type ReactionRequest struct {
 }
 
 type ReactionMessageReference struct {
-	ExternalID string `json:"external_id"`
+	ID         *int64 `json:"id,omitempty"`
+	ExternalID string `json:"external_id,omitempty"`
 }
 
 type SendMessageRequestMessage struct {
@@ -413,15 +416,23 @@ type MarkMessageReadRequest struct {
 
 // MarkMessageReadRequestMessage type.
 type MarkMessageReadRequestMessage struct {
-	ExternalID string `json:"external_id"`
+	ID         *int64 `json:"id,omitempty"`
+	ExternalID string `json:"external_id,omitempty"`
 }
 
 // AckMessageRequest type.
 type AckMessageRequest struct {
-	ExternalMessageID  string            `json:"external_message_id"`
-	TransportMessageID string            `json:"transport_message_id,omitempty"`
-	Channel            uint64            `json:"channel"`
-	Error              *MessageSentError `json:"error,omitempty"`
+	ExternalMessageID  string                    `json:"external_message_id,omitempty"`
+	TransportMessageID string                    `json:"transport_message_id,omitempty"`
+	Channel            uint64                    `json:"channel"`
+	Error              *MessageSentError         `json:"error,omitempty"`
+	Message            *AckMessageRequestMessage `json:"message,omitempty"`
+}
+
+// AckMessageRequestMessage type.
+type AckMessageRequestMessage struct {
+	ID         *int64 `json:"id,omitempty"`
+	ExternalID string `json:"external_id,omitempty"`
 }
 
 // MarkMessagesReadUntilRequest type.
@@ -442,6 +453,18 @@ type DeleteData struct {
 	Channel uint64  `json:"channel"`
 }
 
+// RestoreMessageRequest type.
+type RestoreMessageRequest struct {
+	ChannelID int64                        `json:"channel_id"`
+	Message   RestoreMessageRequestMessage `json:"message"`
+}
+
+// RestoreMessageRequestMessage type.
+type RestoreMessageRequestMessage struct {
+	ID         *int64 `json:"id,omitempty"`
+	ExternalID string `json:"external_id,omitempty"`
+}
+
 // MessagesResponse message event response.
 type MessagesResponse struct {
 	MessageID int       `json:"message_id,omitempty"`
@@ -468,6 +491,7 @@ type MessageSentError struct {
 
 // MessageWebhookData request data.
 type MessageWebhookData struct {
+	ID                int64               `json:"id"`
 	ExternalUserID    string              `json:"external_user_id"`
 	ExternalMessageID string              `json:"external_message_id,omitempty"`
 	ExternalChatID    string              `json:"external_chat_id"`

v1/types_test.go

@@ -21,9 +21,7 @@ func TestSendData_MarshalJSON(t *testing.T) {
 				"nickname": ""
 			},
 			"external_chat_id": "",
-			"message": {
-				"external_id": ""
-			}
+			"message": {}
 		}`
 		assert.JSONEq(t, expected, string(data))
 	})
@@ -51,9 +49,7 @@ func TestSendData_MarshalJSON(t *testing.T) {
 				"nickname": ""
 			},
 			"external_chat_id": "",
-			"message": {
-				"external_id": ""
-			}
+			"message": {}
 		}`
 
 		for _, c := range cases {