Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contact schema companies property not properly exposed in generated Node.js client #191

Closed
devin-ai-integration bot opened this issue Jan 12, 2025 · 0 comments

Comments

@devin-ai-integration
Copy link

Issue Description

This issue is related to intercom-node#457, where it was reported that the companies property is missing from the Contact object in the generated Node.js client (v6).

Current State

The OpenAPI specification (2.11) already includes the companies property in the Contact schema:

And the referenced contact_companies schema is properly defined with:

Problem

Despite the property being correctly defined in the OpenAPI spec, it's not being properly exposed in the generated Node.js client's TypeScript definitions. This affects methods like client.contacts.update where the returned Contact object should include the companies property.

Expected Behavior

The Contact interface in the Node.js client should include the companies property as defined in the OpenAPI spec:

Request

Since this repository's OpenAPI descriptions are automatically generated from Intercom's internal codebase, we request:

  1. Verification that the current companies property definition in the OpenAPI spec is correct
  2. Investigation into why the Fern-based code generation isn't properly including this property in the Node.js client
  3. Updates to the internal generation logic or Fern configuration to ensure the companies property is properly exposed in the generated client

This is blocking customers from upgrading to v6 of the Node.js client as the companies property is needed for their implementations.

Additional Context

  • The companies property was working correctly in v5 of the Node.js client
  • The property appears correctly in the API documentation
  • This appears to be a gap between the OpenAPI spec and the Fern-generated TypeScript definitions
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

No branches or pull requests

1 participant