feat(api): accept unarchive_thread in phone upsert request

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: AchoArnold

api/docs/docs.go

@@ -3379,7 +3379,7 @@ const docTemplate = `{
                 },
                 "request_id": {
                     "type": "string",
-                    "example": "bulk-csv-a1B2c3D4e5"
+                    "example": "bulk-httpsms-file.csv"
                 },
                 "scheduled_count": {
                     "type": "integer",
@@ -3760,6 +3760,7 @@ const docTemplate = `{
                 "messages_per_minute",
                 "phone_number",
                 "sim",
+                "unarchive_thread",
                 "updated_at",
                 "user_id"
             ],
@@ -3804,6 +3805,11 @@ const docTemplate = `{
                 "sim": {
                     "$ref": "#/definitions/entities.SIM"
                 },
+                "unarchive_thread": {
+                    "description": "UnarchiveThread moves an archived message thread back to the inbox when a new message is received on this phone.",
+                    "type": "boolean",
+                    "example": false
+                },
                 "updated_at": {
                     "type": "string",
                     "example": "2022-06-05T14:26:10.303278+03:00"
@@ -4436,7 +4442,8 @@ const docTemplate = `{
                 "messages_per_minute",
                 "missed_call_auto_reply",
                 "phone_number",
-                "sim"
+                "sim",
+                "unarchive_thread"
             ],
             "properties": {
                 "fcm_token": {
@@ -4473,6 +4480,11 @@ const docTemplate = `{
                     "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
                     "type": "string",
                     "example": "SIM1"
+                },
+                "unarchive_thread": {
+                    "description": "UnarchiveThread moves an archived thread back to the inbox when a new message is received on this phone.",
+                    "type": "boolean",
+                    "example": false
                 }
             }
         },

api/docs/swagger.json

@@ -3376,7 +3376,7 @@
                 },
                 "request_id": {
                     "type": "string",
-                    "example": "bulk-csv-a1B2c3D4e5"
+                    "example": "bulk-httpsms-file.csv"
                 },
                 "scheduled_count": {
                     "type": "integer",
@@ -3757,6 +3757,7 @@
                 "messages_per_minute",
                 "phone_number",
                 "sim",
+                "unarchive_thread",
                 "updated_at",
                 "user_id"
             ],
@@ -3801,6 +3802,11 @@
                 "sim": {
                     "$ref": "#/definitions/entities.SIM"
                 },
+                "unarchive_thread": {
+                    "description": "UnarchiveThread moves an archived message thread back to the inbox when a new message is received on this phone.",
+                    "type": "boolean",
+                    "example": false
+                },
                 "updated_at": {
                     "type": "string",
                     "example": "2022-06-05T14:26:10.303278+03:00"
@@ -4433,7 +4439,8 @@
                 "messages_per_minute",
                 "missed_call_auto_reply",
                 "phone_number",
-                "sim"
+                "sim",
+                "unarchive_thread"
             ],
             "properties": {
                 "fcm_token": {
@@ -4470,6 +4477,11 @@
                     "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
                     "type": "string",
                     "example": "SIM1"
+                },
+                "unarchive_thread": {
+                    "description": "UnarchiveThread moves an archived thread back to the inbox when a new message is received on this phone.",
+                    "type": "boolean",
+                    "example": false
                 }
             }
         },

api/docs/swagger.yaml

@@ -58,7 +58,7 @@ definitions:
         example: 30
         type: integer
       request_id:
-        example: bulk-csv-a1B2c3D4e5
+        example: bulk-httpsms-file.csv
         type: string
       scheduled_count:
         example: 50
@@ -388,6 +388,11 @@ definitions:
         type: string
       sim:
         $ref: '#/definitions/entities.SIM'
+      unarchive_thread:
+        description: UnarchiveThread moves an archived message thread back to the
+          inbox when a new message is received on this phone.
+        example: false
+        type: boolean
       updated_at:
         example: "2022-06-05T14:26:10.303278+03:00"
         type: string
@@ -402,6 +407,7 @@ definitions:
     - messages_per_minute
     - phone_number
     - sim
+    - unarchive_thread
     - updated_at
     - user_id
     type: object
@@ -908,6 +914,11 @@ definitions:
           1 SIM slot
         example: SIM1
         type: string
+      unarchive_thread:
+        description: UnarchiveThread moves an archived thread back to the inbox when
+          a new message is received on this phone.
+        example: false
+        type: boolean
     required:
     - fcm_token
     - max_send_attempts
@@ -916,6 +927,7 @@ definitions:
     - missed_call_auto_reply
     - phone_number
     - sim
+    - unarchive_thread
     type: object
   requests.UserNotificationUpdate:
     properties:

api/pkg/requests/phone_update_request.go

@@ -29,6 +29,9 @@ type PhoneUpsert struct {
 
 	MissedCallAutoReply *string `json:"missed_call_auto_reply" example:"e.g. This phone cannot receive calls. Please send an SMS instead."`
 
+	// UnarchiveThread moves an archived thread back to the inbox when a new message is received on this phone.
+	UnarchiveThread bool `json:"unarchive_thread" example:"false"`
+
 	// SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot
 	SIM string `json:"sim" example:"SIM1"`
 
@@ -75,6 +78,11 @@ func (input *PhoneUpsert) ToUpsertParams(user entities.AuthContext, source strin
 		maxSendAttempts = &input.MaxSendAttempts
 	}
 
+	var unarchiveThread *bool
+	if _, exists := fields["unarchive_thread"]; exists {
+		unarchiveThread = &input.UnarchiveThread
+	}
+
 	var scheduleID *uuid.UUID
 	if _, exists := fields["message_send_schedule_id"]; exists {
 		if parsed, err := uuid.Parse(strings.TrimSpace(input.MessageSendScheduleID)); err == nil {
@@ -92,6 +100,7 @@ func (input *PhoneUpsert) ToUpsertParams(user entities.AuthContext, source strin
 		FcmToken:                  fcmToken,
 		UserID:                    user.ID,
 		SIM:                       entities.SIM(input.SIM),
+		UnarchiveThread:           unarchiveThread,
 		MessageSendScheduleID:     scheduleID,
 	}
 }

api/pkg/services/phone_service.go

@@ -104,6 +104,7 @@ type PhoneUpsertParams struct {
 	WebhookURL                *string
 	MessageExpirationDuration *time.Duration
 	MissedCallAutoReply       *string
+	UnarchiveThread           *bool
 	SIM                       entities.SIM
 	MessageSendScheduleID     *uuid.UUID
 	Source                    string
@@ -312,6 +313,10 @@ func (service *PhoneService) update(phone *entities.Phone, params *PhoneUpsertPa
 		phone.MissedCallAutoReply = params.MissedCallAutoReply
 	}
 
+	if params.UnarchiveThread != nil {
+		phone.UnarchiveThread = *params.UnarchiveThread
+	}
+
 	phone.SIM = params.SIM
 	phone.MessageSendScheduleID = params.MessageSendScheduleID