Skip to content

Support all chat integration origins in generated API types #63

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.

Sign up for GitHub

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

Open
thedogwiththedataonit wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support all chat integration origins in generated API types #63

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d288620
Support all chat integration origins in generated API types
thedogwiththedataonit Oct 12, 2026
dd37015
test: pin complete chat origin contract
thedogwiththedataonit Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 88 additions & 6 deletions openapi/public-api-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2807,7 +2807,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -3665,6 +3666,44 @@ components:
- "null"
enum:
- slack
- teams
- telegram
- whatsapp
- discord
- gchat
- github
- linear
- notion
- gmail
- twilio
- messenger
- instagram
- x
- xchat
- web
- agentphone
- dial
- kapso
- lark
- linq
- liveblocks
- matrix
- novu
- photon
- resend
- sendblue
- velt
- zernio
- webex
- line
- baileys
- blooio
- zalo
- mattermost
- weixin
- qq
- wecom
- zaileys
- null
description: The chat app the conversation started in; null for the Brew web app.
updatedAt:
Expand Down Expand Up @@ -12578,7 +12617,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -12880,7 +12920,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -13041,7 +13082,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -13165,7 +13207,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -13311,7 +13354,8 @@ components:
- form
- import
- app
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox)."
- integration
description: "Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in)."
capturedAt:
type: string
format: date-time
Expand Down Expand Up @@ -17552,6 +17596,44 @@ components:
- "null"
enum:
- slack
- teams
- telegram
- whatsapp
- discord
- gchat
- github
- linear
- notion
- gmail
- twilio
- messenger
- instagram
- x
- xchat
- web
- agentphone
- dial
- kapso
- lark
- linq
- liveblocks
- matrix
- novu
- photon
- resend
- sendblue
- velt
- zernio
- webex
- line
- baileys
- blooio
- zalo
- mattermost
- weixin
- qq
- wecom
- zaileys
- null
description: The chat app the conversation started in; null for the Brew web app.
updatedAt:
Expand Down
28 changes: 14 additions & 14 deletions src/generated/openapi-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3554,10 +3554,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -3853,7 +3853,7 @@ export interface components {
* @description The chat app the conversation started in; null for the Brew web app.
* @enum {string|null}
*/
origin: "slack" | null;
origin: "slack" | "teams" | "telegram" | "whatsapp" | "discord" | "gchat" | "github" | "linear" | "notion" | "gmail" | "twilio" | "messenger" | "instagram" | "x" | "xchat" | "web" | "agentphone" | "dial" | "kapso" | "lark" | "linq" | "liveblocks" | "matrix" | "novu" | "photon" | "resend" | "sendblue" | "velt" | "zernio" | "webex" | "line" | "baileys" | "blooio" | "zalo" | "mattermost" | "weixin" | "qq" | "wecom" | "zaileys" | null;
/** Format: date-time */
updatedAt: string;
/** @description Opens the chat in the Brew app. */
Expand Down Expand Up @@ -6939,10 +6939,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -7083,10 +7083,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -7164,10 +7164,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -7224,10 +7224,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -7290,10 +7290,10 @@ export interface components {
subscribed?: boolean;
consent?: {
/**
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox).
* @description Who captured it: `api` (an API caller asserted it), `form` (a signup form), `import` (a bulk import), `app` (the in-app CSV wizard checkbox), `integration` (an integration sync such as Stripe created the contact; provenance only, not an opt-in).
* @enum {string}
*/
source: "api" | "form" | "import" | "app";
source: "api" | "form" | "import" | "app" | "integration";
/**
* Format: date-time
* @description When it was captured.
Expand Down Expand Up @@ -8659,7 +8659,7 @@ export interface components {
* @description The chat app the conversation started in; null for the Brew web app.
* @enum {string|null}
*/
origin: "slack" | null;
origin: "slack" | "teams" | "telegram" | "whatsapp" | "discord" | "gchat" | "github" | "linear" | "notion" | "gmail" | "twilio" | "messenger" | "instagram" | "x" | "xchat" | "web" | "agentphone" | "dial" | "kapso" | "lark" | "linq" | "liveblocks" | "matrix" | "novu" | "photon" | "resend" | "sendblue" | "velt" | "zernio" | "webex" | "line" | "baileys" | "blooio" | "zalo" | "mattermost" | "weixin" | "qq" | "wecom" | "zaileys" | null;
/** Format: date-time */
updatedAt: string;
/** @description Opens the chat in the Brew app. */
Expand Down
5 changes: 4 additions & 1 deletion tests/resources/chats/list.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,10 @@ describe('chats.list', () => {
})

it('types the rows', () => {
expectTypeOf<ChatSummary['origin']>().toEqualTypeOf<'slack' | null>()
expectTypeOf<'slack' | 'teams' | 'telegram' | 'whatsapp'>().toExtend<
ChatSummary['origin']
>()
expectTypeOf<null>().toExtend<ChatSummary['origin']>()
Comment thread
thedogwiththedataonit marked this conversation as resolved.
Outdated
expectTypeOf<{ limit: 10; cursor: 'c' }>().toExtend<ListChatsInput>()
})
})
Expand Down
Loading