TypeScript Examples

import Metigan from 'metigan';
import type { EmailApiResponse, EmailSuccessResponse, EmailErrorResponse } from 'metigan';

const metigan = new Metigan({
  apiKey: process.env.METIGAN_API_KEY!
});

// Type guard function
function isEmailSuccess(response: EmailApiResponse): response is EmailSuccessResponse {
  return 'success' in response && response.success === true;
}

function isEmailError(response: EmailApiResponse): response is EmailErrorResponse {
  return 'success' in response && response.success === false;
}

// Type-safe email sending
async function sendEmailTyped(): Promise<EmailSuccessResponse | null> {
  const result: EmailApiResponse = await metigan.email.sendEmail({
    from: 'sender@example.com',
    recipients: ['recipient@example.com'],
    subject: 'Hello from TypeScript!',
    content: '<p>Type-safe email sending.</p>'
  });

  if (isEmailSuccess(result)) {
    // TypeScript knows result is EmailSuccessResponse here
    console.log('Tracking ID:', result.successfulEmails[0]?.trackingId);
    return result;
  }

  if (isEmailError(result)) {
    // TypeScript knows result is EmailErrorResponse here
    console.error('Error:', result.error, result.message);
    return null;
  }

  return null;
}