Skip to content

Generate unstable SDK alongside v2.11 #265

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Generate unstable SDK alongside v2.11 #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e3ed62
Generate unstable SDK alongside v2.11
mattblank11 Jun 2, 2025
d48d2e5
Update unstable overrides
mattblank11 Jun 3, 2025
5b4eb7a
Remove custom channel event endpoints from overrides file
mattblank11 Jun 3, 2025
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
6 changes: 6 additions & 0 deletions fern/generators.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ api:
settings:
title-as-schema-name: false
inline-path-parameters: true
- openapi: ../descriptions/0/api.intercom.io.yaml
overrides: ./unstable-openapi-overrides.yml
namespace: unstable
settings:
title-as-schema-name: false
inline-path-parameters: true
groups:
ts-sdk:
generators:
Expand Down
24 changes: 0 additions & 24 deletions fern/openapi-overrides.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,30 +442,6 @@ paths:
- conversations
x-fern-sdk-method-name: redactConversationPart
x-fern-request-name: RedactConversationPartRequest
/custom_channel_events/notify_attribute_collected:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyAttributeCollected
x-fern-request-name: NotifyAttributeCollectedRequest
/custom_channel_events/notify_new_message:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyNewMessage
x-fern-request-name: NotifyNewMessageRequest
/custom_channel_events/notify_new_conversation:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyNewConversation
x-fern-request-name: NotifyNewConversationRequest
/custom_channel_events/notify_quick_reply_selected:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyQuickReplySelected
x-fern-request-name: NotifyQuickReplySelectedRequest
/data_attributes:
get:
x-fern-sdk-group-name:
Expand Down
87 changes: 87 additions & 0 deletions fern/unstable-openapi-overrides.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
paths:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattblank11 none of the Custom Channel references need to go in here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Eclairemoy You shouldn't need to add anything else here - this file just overwrites certain parts of the unstable spec so that our generator can parse it properly. Anything added to this file was basically generating an error when we tried to generate your SDK without this file

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it may happening because we added them in openapi-overrides.yml? If yes, should we remove/move them from there?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@auroralimin can you clarify the question?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was asked to add Custom Channel references in openapi-overrides: https://github.com/intercom/Intercom-OpenAPI/blob/main/fern/openapi-overrides.yml#L445

So I'm wondering if we don't need to add here because it is already added there. And/or if we should move the reference from there (either because is not necessary or because we could prioritise adding here only and not there, given that we do not want the SDK to implement these in the version 2.11).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, thanks for clarifying! You should be safe to remove from openapi-overrides since we're not actually implementing the methods there. Let's move to unstable-api-overrides!

'/articles':
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateArticleRequestBody'
'/companies':
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrUpdateCompanyRequestBody'
'/phone_call_redirects':
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePhoneSwitchRequestBody'
'/ticket_types':
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTicketTypeRequestBody'
'/contacts/{id}/companies':
post:
requestBody:
content:
application/json:
schema:
required:
- company_id
properties:
company_id:
type: string
description: The unique identifier for the company which is given
by Intercom
example: 58a430d35458202d41b1e65b
id: null
examples:
successful:
summary: Successful
value:
company_id: 6762f09a1bb69f9f2193bb34
bad_request:
summary: Bad Request
value:
company_not_found:
summary: Company Not Found
value:
company_id: '123'
'/messages/status':
get:
responses:
'500':
content:
application/json:
examples: null

components:
schemas:
custom_attributes:
example:
monthly_spend: '155.5'
create_ticket_request:
x-fern-type-name: CreateTicketRequestBody
reply_conversation_request:
x-fern-type-name: ReplyConversationRequestBody
update_article_request:
x-fern-type-name: UpdateArticleRequestBody
update_ticket_type_request:
x-fern-type-name: UpdateTicketTypeRequestBody
single_filter_search_request:
properties:
operator:
enum:
- '='
- '!='
- IN
- NIN
- '<'
- '>'
Loading