Skip to content

Conversation

@VedranZoricic
Copy link
Contributor

@VedranZoricic VedranZoricic commented Aug 25, 2025

Context

Summary

  • Added comprehensive OpenAPI documentation for new Brands and Email Settings APIs
  • These endpoints are added to the Unstable version only as they are new features
  • Documentation follows existing patterns and conventions from the codebase

Changes

New API Endpoints (4 total)

  • GET /brands - List all brands in the workspace
  • GET /brands/{id} - Retrieve a specific brand by ID
  • GET /emails - List all email settings for the workspace
  • GET /emails/{id} - Retrieve a specific email setting by ID

Schema Definitions

  • brand - Individual brand object schema
  • brand_list - List container for brands
  • email_setting - Individual email setting object schema
  • email_list - List container for email settings

API Tags

  • Added Brands tag for brand-related operations
  • Added Emails tag for email settings operations

Technical Details

  • All endpoints include proper authentication requirements
  • Comprehensive examples provided for each endpoint
  • Error responses follow standard Intercom error format
  • Unix timestamps used for date fields (consistent with existing APIs)
  • String IDs used throughout (consistent with existing patterns)
  • Nullable fields properly marked in schemas

Testing

  • OpenAPI specification validated with @apidevtools/swagger-cli
  • All schema references resolve correctly
  • Endpoints placed at end of paths section for easier review

Related Documentation

This PR implements the API documentation based on the specifications provided in the internal documentation files.

🤖 Generated with Claude Code

- Add GET /brands endpoint to list all brands
- Add GET /brands/{id} endpoint to retrieve a specific brand
- Add GET /email_address_settings endpoint to list email settings
- Add GET /email_address_settings/{id} endpoint to retrieve specific settings
- Include complete schema definitions for brand and email_address_settings models

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@VedranZoricic VedranZoricic self-assigned this Aug 25, 2025
@VedranZoricic VedranZoricic merged commit 25f6288 into intercom:main Aug 25, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants