fix: schema updates for message update

Author: andris9

lib/email-client/gmail-client.js

@@ -769,14 +769,25 @@ class GmailClient extends BaseClient {
             switch (err?.oauthRequest?.response?.error?.code) {
                 case 400: {
                     // invalid name
-                    let error = new Error('Invalid label');
+                    let error = new Error(err?.oauthRequest?.response?.error?.message || 'Invalid label');
                     error.info = {
                         response: err?.oauthRequest?.response?.error?.message
                     };
                     error.code = err?.oauthRequest?.response?.error?.status;
                     error.statusCode = 400;
                     throw error;
                 }
+
+                case 403: {
+                    // invalid name
+                    let error = new Error(err?.oauthRequest?.response?.error?.message || 'Permission Denied');
+                    error.info = {
+                        response: err?.oauthRequest?.response?.error?.message
+                    };
+                    error.code = err?.oauthRequest?.response?.error?.status;
+                    error.statusCode = 403;
+                    throw error;
+                }
             }
 
             throw err;
@@ -1154,7 +1165,25 @@ class GmailClient extends BaseClient {
             payload.threadId = referencedMessage.threadId;
         }
 
-        const uploadInfo = await this.request(`${GMAIL_API_BASE}/gmail/v1/users/me/messages?internalDateSource=dateHeader`, 'post', payload);
+        let uploadInfo;
+        try {
+            uploadInfo = await this.request(`${GMAIL_API_BASE}/gmail/v1/users/me/messages?internalDateSource=dateHeader`, 'post', payload);
+        } catch (err) {
+            switch (err?.oauthRequest?.response?.error?.code) {
+                case 403: {
+                    // permission denied
+                    let error = new Error(err?.oauthRequest?.response?.error?.message || 'Permission Denied');
+                    error.info = {
+                        response: err?.oauthRequest?.response?.error?.message
+                    };
+                    error.code = err?.oauthRequest?.response?.error?.status;
+                    error.statusCode = 403;
+                    throw error;
+                }
+            }
+
+            throw err;
+        }
 
         let response = {
             id: uploadInfo?.id,

lib/schemas.js

@@ -1197,21 +1197,44 @@ const searchSchema = Joi.object({
 
 const messageUpdateSchema = Joi.object({
     flags: Joi.object({
-        add: Joi.array().items(Joi.string().max(128)).single().description('Add new flags').example(['\\Seen']).label('AddFlags'),
-        delete: Joi.array().items(Joi.string().max(128)).single().description('Delete specific flags').example(['\\Flagged']).label('DeleteFlags'),
-        set: Joi.array().items(Joi.string().max(128)).single().description('Override all flags').example(['\\Seen', '\\Flagged']).label('SetFlags')
+        add: Joi.array().items(Joi.string().max(128)).single().description('Add flags.').example(['\\Seen']).label('AddFlags'),
+        delete: Joi.array().items(Joi.string().max(128)).single().description('Remove flags.').example(['\\Flagged']).label('DeleteFlags'),
+        set: Joi.array().items(Joi.string().max(128)).single().description('Replace all existing flags.').example(['\\Seen', '\\Flagged']).label('SetFlags')
     })
-        .description('Flag updates')
+        .description('Updates for message flags.')
         .label('FlagUpdate'),
 
     labels: Joi.object({
-        add: Joi.array().items(Joi.string().max(128)).single().description('Add new labels').example(['Some label']).label('AddLabels'),
-        delete: Joi.array().items(Joi.string().max(128)).single().description('Delete specific labels').example(['Some label']).label('DeleteLabels'),
-        set: Joi.array().items(Joi.string().max(128)).single().description('Override all labels').example(['First label', 'Second label']).label('SetLabels')
+        add: Joi.array()
+            .items(Joi.string().max(128))
+            .single()
+            .description('Add labels. Each label is a mailbox ID or a path if the ID is not set.')
+            .example(['Label_971539351003152516'])
+            .label('AddLabels'),
+        delete: Joi.array()
+            .items(Joi.string().max(128))
+            .single()
+            .description('Remove labels. Each label is a mailbox ID or a path if the ID is not set.')
+            .example(['Label_971539351003152516'])
+            .label('DeleteLabels'),
+        set: Joi.array()
+            .items(Joi.string().max(128))
+            .single()
+            .description('Replace all existing labels.')
+            .example(['Inbox', 'Important'])
+            .label('SetLabels')
+            .meta({ swaggerHidden: true })
     })
-        .description('Label updates. Labels can only be used with Gmail IMAP and Gmail API accounts.')
+        .description('Updates for message labels. Labels can only be used with Gmail IMAP or Gmail API.')
         .label('LabelUpdate')
-}).label('MessageUpdate');
+})
+    .label('MessageUpdate')
+    .example({
+        flags: {
+            add: '\\Seen',
+            delete: '\\Flagged'
+        }
+    });
 
 const accountSchemas = {
     syncFrom: Joi.date()