1export const gmailIntegrationSpec = defineIntegration({
2	meta: {
3		key: 'email.gmail',
4		version: '1.0.0',
5		category: 'email',
6		title: 'Google Gmail API',
7		description:
8			'Gmail integration supporting inbound thread ingestion and outbound transactional email.',
9		domain: 'communications',
10		owners: ['platform.messaging'],
11		tags: ['email', 'gmail'],
12		stability: StabilityEnum.Beta,
13	},
14	supportedModes: ['managed', 'byok'],
15	transports: [
16		{ type: 'rest', baseUrl: 'https://gmail.googleapis.com' },
17		{ type: 'sdk', packageName: 'googleapis', minVersion: '130.0.0' },
18	],
19	preferredTransport: 'rest',
20	supportedAuthMethods: [
21		{
22			type: 'oauth2',
23			grantType: 'authorization_code',
24			authorizationUrl: 'https://accounts.google.com/o/oauth2/v2/auth',
25			tokenUrl: 'https://oauth2.googleapis.com/token',
26			scopes: ['https://www.googleapis.com/auth/gmail.modify'],
27			pkce: true,
28		},
29		{ type: 'service-account', credentialFormat: 'json-key' },
30	],
31	capabilities: {
32		provides: [
33			{ key: 'email.inbound', version: '1.0.0' },
34			{ key: 'email.outbound', version: '1.0.0' },
35		],
36	},
37	configSchema: {
38		schema: {
39			type: 'object',
40			properties: {
41				labelIds: {
42					type: 'array',
43					items: { type: 'string' },
44					description: 'Optional list of label IDs to scope inbound sync.',
45				},
46				includeSpamTrash: {
47					type: 'boolean',
48					description: 'Whether to include spam or trash messages during sync.',
49				},
50			},
51		},
52		example: {
53			labelIds: ['INBOX'],
54			includeSpamTrash: false,
55		},
56	},
57	secretSchema: {
58		schema: {
59			type: 'object',
60			required: ['clientId', 'clientSecret', 'refreshToken'],
61			properties: {
62				clientId: {
63					type: 'string',
64					description: 'OAuth client ID for the Google Cloud project.',
65				},
66				clientSecret: {
67					type: 'string',
68					description: 'OAuth client secret for the Google Cloud project.',
69				},
70				refreshToken: {
71					type: 'string',
72					description: 'OAuth refresh token for delegated Gmail access.',
73				},
74				redirectUri: {
75					type: 'string',
76					description:
77						'Optional redirect URI used when issuing the refresh token.',
78				},
79			},
80		},
81		example: {
82			clientId: 'xxx.apps.googleusercontent.com',
83			clientSecret: 'secret',
84			refreshToken: 'refresh-token',
85		},
86	},
87	healthCheck: {
88		method: 'custom',
89		timeoutMs: 4000,
90	},
91	docsUrl: 'https://developers.google.com/gmail/api',
92	constraints: {
93		rateLimit: {
94			rpm: 600,
95		},
96	},
97	byokSetup: {
98		setupInstructions:
99			'Create an OAuth consent screen and credentials within Google Cloud Console, then authorize the Gmail scopes and store the resulting refresh token.',
100		keyRotationSupported: false,
101		quotaTrackingSupported: false,
102	},
103});