diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 77de4d3..0faddaf 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -507,9 +507,9 @@ paths: value: sync_behavior: api url: https://www.example.com - "/ai/content_import_sources/{id}": + "/ai/content_import_sources/{source_id}": parameters: - - name: id + - name: source_id in: path description: The unique identifier for the content import source which is given by Intercom. @@ -794,9 +794,9 @@ paths: source_id: 44 title: Test url: https://www.example.com - "/ai/external_pages/{id}": + "/ai/external_pages/{page_id}": parameters: - - name: id + - name: page_id in: path description: The unique identifier for the external page which is given by Intercom. required: true @@ -1226,7 +1226,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: article_id in: path required: true description: The unique identifier for the article which is given by Intercom. @@ -1324,7 +1324,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: article_id in: path required: true description: The unique identifier for the article which is given by Intercom. @@ -1993,7 +1993,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: collection_id in: path required: true description: The unique identifier for the collection which is given by Intercom. @@ -2075,7 +2075,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: collection_id in: path required: true description: The unique identifier for the collection which is given by Intercom. @@ -2359,7 +2359,7 @@ paths: value: title: Thanks for everything body: Body of the Internal Article - "/internal_articles/{id}": + "/internal_articles/{internal_article_id}": get: summary: Retrieve an internal article parameters: @@ -2367,7 +2367,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: internal_article_id in: path required: true description: The unique identifier for the article which is given by Intercom. @@ -2429,7 +2429,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: internal_article_id in: path required: true description: The unique identifier for the internal article which is given by Intercom. @@ -2507,7 +2507,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: internal_article_id in: path required: true description: The unique identifier for the internal article which is given by Intercom. @@ -2924,7 +2924,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3004,7 +3004,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3370,7 +3370,7 @@ paths: required: true description: The unique identifier for the contact which is given by Intercom schema: - type: string + type: integer tags: - Companies - Contacts @@ -3475,7 +3475,7 @@ paths: get: summary: List attached companies for contact parameters: - - name: id + - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 @@ -3658,7 +3658,7 @@ paths: required: true description: The unique identifier of a contact. schema: - type: integer + type: string - name: Intercom-Version in: header schema: @@ -3750,7 +3750,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path required: true description: The unique identifier of a given contact. @@ -3819,10 +3819,6 @@ paths: type: string description: The text of the note. example: New note - contact_id: - type: string - description: The unique identifier of a given contact. - example: '123' admin_id: type: string description: The unique identifier of a given admin. @@ -4718,9 +4714,9 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path - description: id + description: contact_id example: 63a07ddf05a32042dffac965 required: true schema: @@ -4853,9 +4849,9 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path - description: id + description: contact_id required: true schema: type: string @@ -5518,9 +5514,9 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path - description: id + description: contact_id example: 63a07ddf05a32042dffac965 required: true schema: @@ -5544,9 +5540,9 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path - description: id + description: contact_id example: 63a07ddf05a32042dffac965 required: true schema: @@ -5562,7 +5558,7 @@ paths: application/json: schema: "$ref": "#/components/schemas/contact_unarchived" - "/contacts/{id}/block": + "/contacts/{contact_id}/block": post: summary: Block contact parameters: @@ -5570,9 +5566,9 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path - description: id + description: contact_id example: 63a07ddf05a32042dffac965 required: true schema: @@ -6273,7 +6269,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The id of the conversation to target @@ -6557,7 +6553,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path description: id required: true @@ -8517,7 +8513,7 @@ paths: $ref: "#/components/responses/Unauthorized" '404': $ref: "#/components/responses/ObjectNotFound" - "/custom_object_instances/{custom_object_type_identifier}/{id}": + "/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}": parameters: - name: custom_object_type_identifier in: path @@ -8530,7 +8526,7 @@ paths: get: summary: Get Custom Object Instance by ID parameters: - - name: id + - name: custom_object_instance_id in: path description: The id or external_id of the custom object instance required: true @@ -8571,7 +8567,7 @@ paths: delete: summary: Delete a Custom Object Instance by ID parameters: - - name: id + - name: custom_object_instance_id in: path description: The Intercom defined id of the custom object instance required: true @@ -9510,7 +9506,7 @@ paths: responses: '200': description: successful - "/jobs/status/{id}": + "/jobs/status/{job_id}": get: summary: Retrieve job status parameters: @@ -9518,7 +9514,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: job_id in: path required: true description: The unique identifier for the job which is given by Intercom @@ -10018,7 +10014,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: news_item_id in: path required: true description: The unique identifier for the news item which is given by Intercom. @@ -10113,7 +10109,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: news_item_id in: path required: true description: The unique identifier for the news item which is given by Intercom. @@ -10721,7 +10717,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/calls/{id}": + "/calls/{call_id}": get: summary: Get a call parameters: @@ -10729,7 +10725,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: call_id in: path required: true description: The id of the call to retrieve @@ -10795,7 +10791,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/calls/{id}/recording": + "/calls/{call_id}/recording": get: summary: Get call recording by call id parameters: @@ -10803,7 +10799,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: call_id in: path required: true description: The id of the call @@ -10850,7 +10846,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/calls/{id}/transcript": + "/calls/{call_id}/transcript": get: summary: Get call transcript by call id parameters: @@ -10858,7 +10854,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: call_id in: path required: true description: The id of the call @@ -11236,7 +11232,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: tag_id in: path description: The unique identifier of a given tag example: '123' @@ -12145,7 +12141,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_type_id in: path required: true description: The unique identifier for the ticket type which is given by Intercom. @@ -13172,7 +13168,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_id in: path required: true description: The unique identifier for the ticket which is given by Intercom. @@ -13311,7 +13307,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_id in: path required: true description: The unique identifier for the ticket which is given by Intercom. diff --git a/fern/fern.config.json b/fern/fern.config.json index e670cd9..15b79fd 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "intercom", - "version": "0.63.25" + "version": "0.70.1" } \ No newline at end of file diff --git a/fern/generators.yml b/fern/generators.yml index e7a112b..98dd1c9 100644 --- a/fern/generators.yml +++ b/fern/generators.yml @@ -1,7 +1,7 @@ # yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json api: specs: - - openapi: ../descriptions/2.11/api.intercom.io.yaml + - openapi: ../descriptions/2.14/api.intercom.io.yaml overrides: ./openapi-overrides.yml settings: title-as-schema-name: false diff --git a/fern/openapi-overrides.yml b/fern/openapi-overrides.yml index 169ecaa..227ebe7 100644 --- a/fern/openapi-overrides.yml +++ b/fern/openapi-overrides.yml @@ -38,6 +38,26 @@ paths: - articles x-fern-sdk-method-name: list x-fern-request-name: ListArticlesRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer post: x-fern-sdk-group-name: - articles @@ -75,6 +95,26 @@ paths: - collections x-fern-sdk-method-name: list x-fern-request-name: ListCollectionsRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer post: x-fern-sdk-group-name: - helpCenters @@ -109,6 +149,26 @@ paths: - helpCenters x-fern-sdk-method-name: list x-fern-request-name: ListHelpCentersRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer /help_center/help_centers/{help_center_id}: get: x-fern-sdk-group-name: @@ -192,6 +252,32 @@ paths: - contacts x-fern-sdk-method-name: list x-fern-request-name: ListContactsRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string post: x-fern-sdk-group-name: - contacts @@ -222,6 +308,32 @@ paths: - contacts x-fern-sdk-method-name: listAttachedCompanies x-fern-request-name: ListAttachedCompaniesRequest + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer post: x-fern-sdk-group-name: - companies @@ -249,11 +361,49 @@ paths: - notes x-fern-sdk-method-name: list x-fern-request-name: ListContactNotesRequest + parameters: + - name: contact_id + in: path + required: true + description: The unique identifier of a contact. + schema: + type: string + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer post: x-fern-sdk-group-name: - notes x-fern-sdk-method-name: create x-fern-request-name: CreateContactNoteRequest + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + required: true + description: The unique identifier of a given contact. + example: '123' + schema: + type: string /contacts/{contact_id}/segments: get: x-fern-sdk-group-name: @@ -442,6 +592,42 @@ 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 + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + /custom_channel_events/notify_new_conversation: + post: + x-fern-sdk-group-name: + - customChannelEvents + x-fern-sdk-method-name: notifyNewConversation + x-fern-request-name: NotifyNewConversationRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' + /custom_channel_events/notify_new_message: + post: + x-fern-sdk-group-name: + - customChannelEvents + x-fern-sdk-method-name: notifyNewMessage + x-fern-request-name: NotifyNewMessageRequest + parameters: + - name: Intercom-Version + in: header + required: true + schema: + $ref: '#/components/schemas/intercom_version' /data_attributes: get: x-fern-sdk-group-name: @@ -537,12 +723,62 @@ paths: - dataExport x-fern-sdk-method-name: cancel x-fern-request-name: CancelDataExportRequest + /export/reporting_data/{job_identifier}: + get: + x-fern-sdk-group-name: + - dataExport + x-fern-sdk-method-name: exportReportingData + x-fern-request-name: ExportReportingDataRequest + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: app_id + in: query + description: The Intercom defined code of the workspace the company is associated + to. + required: true + schema: + type: string + - name: client_id + in: query + required: true + schema: + type: string + - name: job_identifier + description: Unique identifier of the job. + in: path + required: true + schema: + type: string /download/content/data/{job_identifier}: get: x-fern-sdk-group-name: - dataExport x-fern-sdk-method-name: download x-fern-request-name: DownloadDataExportRequest + /download/reporting_data/{job_identifier}: + get: + x-fern-sdk-group-name: + - dataExport + x-fern-sdk-method-name: downloadReportingDataExport + x-fern-request-name: DownloadReportingDataExportRequest + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: app_id + in: query + required: true + schema: + type: string + - name: job_identifier + in: path + required: true + schema: + type: string /messages: post: requestBody: @@ -1384,6 +1620,8 @@ components: title: Custom atttributes type: object description: Custom data set for this data. + example: + monthly_spend: '155.5' # enum additions contact: @@ -1603,6 +1841,28 @@ components: - created_at - order + create_ticket_request: + x-fern-type-name: CreateTicketRequestBody + properties: + ticket_attributes: null + update_article_request: + x-fern-type-name: UpdateArticleRequestBody + # TODO: fern-support + # Remove nullable: false once java generator updated to handle this case. + nullable: false + update_data_attribute_request: + x-fern-type-name: UpdateDataAttributeRequestBody + update_internal_article_request: + x-fern-type-name: UpdateInternalArticleRequestBody + # TODO: fern-support + # Remove nullable: false once java generator updated to handle this case. + nullable: false + update_ticket_type_request: + x-fern-type-name: UpdateTicketTypeRequestBody + # TODO: fern-support + # Remove nullable: false once java generator updated to handle this case. + nullable: false + securitySchemes: bearerAuth: x-fern-bearer: diff --git a/fern/unstable-openapi-overrides.yml b/fern/unstable-openapi-overrides.yml index d16f018..6192450 100644 --- a/fern/unstable-openapi-overrides.yml +++ b/fern/unstable-openapi-overrides.yml @@ -91,31 +91,55 @@ paths: - customChannelEvents x-fern-sdk-method-name: notifyAttributeCollected x-fern-request-name: NotifyAttributeCollectedRequest + parameters: + - name: Intercom-Version + in: header + required: null + schema: + $ref: '#/components/schemas/intercom_version_unstable' '/custom_channel_events/notify_new_message': post: x-fern-sdk-group-name: - customChannelEvents x-fern-sdk-method-name: notifyNewMessage x-fern-request-name: NotifyNewMessageRequest + parameters: + - name: Intercom-Version + in: header + required: null + schema: + $ref: '#/components/schemas/intercom_version_unstable' '/custom_channel_events/notify_new_conversation': post: x-fern-sdk-group-name: - customChannelEvents x-fern-sdk-method-name: notifyNewConversation x-fern-request-name: NotifyNewConversationRequest + parameters: + - name: Intercom-Version + in: header + required: null + schema: + $ref: '#/components/schemas/intercom_version_unstable' '/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 + parameters: + - name: Intercom-Version + in: header + required: null + schema: + $ref: '#/components/schemas/intercom_version_unstable' components: schemas: create_data_attribute_request: x-fern-type-name: CreateDataAttributeRequest update_data_attribute_request: - x-fern-type-name: UpdateDataAttributeRequest + x-fern-type-name: UpdateDataAttributeRequestBody custom_attributes: example: monthly_spend: '155.5'