Open haydenbleasel opened 1 month ago
Example in spec shows that intended response is:
{ type: "conversation.list", pages: object; total_count: number; conversations: Conversation[]; }
The 200 response schema points to a paginated_response which is:
{ type: "conversation.list", pages: object; total_count: number; data: Conversation[]; }
When using GET /conversations, expecting to map over response.data. Instead, receiving response.conversations. Causes a TypeScript issue.
/conversations
response.data
response.conversations
npx openapi-typescript@6.7.6 https://raw.githubusercontent.com/intercom/Intercom-OpenAPI/main/descriptions/2.11/api.intercom.io.yaml -o ./src/types.d.ts
import createFetchClient from 'openapi-fetch'; import type { paths } from './types'; const client = createFetchClient<paths>({ baseUrl: 'https://api.intercom.io', headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${accessToken}`, 'Intercom-Version': '2.11', }, });
const conversations = await intercom.GET('/conversations');
console.log(conversations.data.data);
conversations.data.data
thanks Hayden we will take a look
Schema Inaccuracy
Example in spec shows that intended response is:
The 200 response schema points to a paginated_response which is:
Expected
When using GET
/conversations
, expecting to map overresponse.data
. Instead, receivingresponse.conversations
. Causes a TypeScript issue.Reproduction Steps
conversations.data.data
is undefined 😂