diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index cb2c00f7..c8e4f160 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -38005,59 +38005,80 @@ components: type: string description: The text of the matched guidance rule. example: If the customer asks about pricing, ask which plan they're interested in before answering - ai_topic_subtopic_list: + ai_topic_subtopic: title: AI Topic and Subtopic - type: array - readOnly: true - description: The topics Fin detected in a conversation, returned under the "AI - Topic and Subtopic" key of a conversation's custom attributes. Generated by - Fin and returned in responses only; it cannot be set on a request. - items: - type: object - properties: - topic_name: - type: string - description: The name of the topic. - example: Billing - subtopic_name: - type: string - nullable: true - description: The name of the subtopic, where the topic has one. - example: Refund request - id: - type: integer - nullable: true - description: The unique identifier for the subtopic. - example: 12345 - cx_score_reason_list: - title: CX Score reasons - type: array - readOnly: true - description: The reasons behind a conversation's CX Score, returned under the - "CX Score reasons" key of a conversation's custom attributes. Generated by - Fin and returned in responses only; it cannot be set on a request. - items: - type: object - properties: - name: - type: string - description: The name of the reason. - example: Resolution speed - value: - type: string - description: The value recorded for the reason. - example: Fast + type: object + description: >- + A single AI-generated topic and subtopic classification for a + conversation. Surfaced inside `custom_attributes` under the "AI Topic + and Subtopic" key as an array of these objects. Requires the AI add-on; + the key is omitted when the conversation has no classification. + properties: + topic_name: + type: string + description: The name of the AI-generated topic. + example: Billing + subtopic_name: + type: string + nullable: true + description: The name of the AI-generated subtopic, if any. + example: Payment Issues + id: + type: integer + nullable: true + description: The id of the subtopic. + example: 42 + cx_score_reason: + title: CX Score reason + type: object + description: >- + A single reason behind a conversation's CX Score. Surfaced inside + `custom_attributes` under the "CX Score reasons" key as an array of + these objects. + properties: + name: + type: string + description: The name of the reason. + example: Resolution speed + value: + type: string + description: The value recorded for the reason. + example: Fast custom_attributes: title: Custom Attributes type: object - description: An object containing the different custom attributes associated - to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. Attributes that Intercom - generates — such as "CX Score rating", "CX Score explanation", "AI - Topic and Subtopic" and "CX Score reasons" — may also be included. Two of - them, "AI Topic and Subtopic" and "CX Score reasons", carry lists of objects - as their values, and are returned in responses only — they cannot be set on - a write request. + description: >- + An object containing the custom attributes on a conversation as key-value + pairs. For relationship attributes the value is a list of custom object + instance models. System-defined attributes such as "AI Topic and Subtopic", + "CX Score rating", "CX Score explanation" and "CX Score reasons" may also be + included. + properties: + "AI Topic and Subtopic": + type: array + readOnly: true + description: >- + Read-only AI Insights classification of the conversation. Present + only with the AI add-on; omitted when the conversation has no + classification. + example: + - topic_name: Billing + subtopic_name: Payment Issues + id: 42 + items: + "$ref": "#/components/schemas/ai_topic_subtopic" + "CX Score reasons": + type: array + readOnly: true + description: >- + Read-only reasons behind the conversation's CX Score. Intercom + generates this attribute, so it cannot be set. Omitted when the + conversation has no CX Score reasons. + example: + - name: Resolution speed + value: Fast + items: + "$ref": "#/components/schemas/cx_score_reason" additionalProperties: anyOf: - type: string @@ -38066,8 +38087,6 @@ components: - type: boolean - $ref: "#/components/schemas/datetime" - "$ref": "#/components/schemas/custom_object_instance_list" - - "$ref": "#/components/schemas/ai_topic_subtopic_list" - - "$ref": "#/components/schemas/cx_score_reason_list" example: paid_subscriber: true monthly_spend: 155.5 @@ -38079,8 +38098,8 @@ components: expressed satisfaction with the outcome. AI Topic and Subtopic: - topic_name: Billing - subtopic_name: Refund request - id: 12345 + subtopic_name: Payment Issues + id: 42 CX Score reasons: - name: Resolution speed value: Fast @@ -38089,7 +38108,7 @@ components: type: object description: The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object - instance models. Only attributes a caller may set are accepted here — attributes + instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only. additionalProperties: anyOf: diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index b6b484a5..9f570e75 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -33593,59 +33593,80 @@ components: example: 0 pages: "$ref": "#/components/schemas/cursor_pages" - ai_topic_subtopic_list: + ai_topic_subtopic: title: AI Topic and Subtopic - type: array - readOnly: true - description: The topics Fin detected in a conversation, returned under the "AI - Topic and Subtopic" key of a conversation's custom attributes. Generated by - Fin and returned in responses only; it cannot be set on a request. - items: - type: object - properties: - topic_name: - type: string - description: The name of the topic. - example: Billing - subtopic_name: - type: string - nullable: true - description: The name of the subtopic, where the topic has one. - example: Refund request - id: - type: integer - nullable: true - description: The unique identifier for the subtopic. - example: 12345 - cx_score_reason_list: - title: CX Score reasons - type: array - readOnly: true - description: The reasons behind a conversation's CX Score, returned under the - "CX Score reasons" key of a conversation's custom attributes. Generated by - Fin and returned in responses only; it cannot be set on a request. - items: - type: object - properties: - name: - type: string - description: The name of the reason. - example: Resolution speed - value: - type: string - description: The value recorded for the reason. - example: Fast + type: object + description: >- + A single AI-generated topic and subtopic classification for a + conversation. Surfaced inside `custom_attributes` under the "AI Topic + and Subtopic" key as an array of these objects. Requires the AI add-on; + the key is omitted when the conversation has no classification. + properties: + topic_name: + type: string + description: The name of the AI-generated topic. + example: Billing + subtopic_name: + type: string + nullable: true + description: The name of the AI-generated subtopic, if any. + example: Payment Issues + id: + type: integer + nullable: true + description: The id of the subtopic. + example: 42 + cx_score_reason: + title: CX Score reason + type: object + description: >- + A single reason behind a conversation's CX Score. Surfaced inside + `custom_attributes` under the "CX Score reasons" key as an array of + these objects. + properties: + name: + type: string + description: The name of the reason. + example: Resolution speed + value: + type: string + description: The value recorded for the reason. + example: Fast custom_attributes: title: Custom Attributes type: object - description: An object containing the different custom attributes associated - to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. Attributes that Intercom - generates — such as "CX Score rating", "CX Score explanation", "AI - Topic and Subtopic" and "CX Score reasons" — may also be included. Two of - them, "AI Topic and Subtopic" and "CX Score reasons", carry lists of objects - as their values, and are returned in responses only — they cannot be set on - a write request. + description: >- + An object containing the custom attributes on a conversation as key-value + pairs. For relationship attributes the value is a list of custom object + instance models. System-defined attributes such as "AI Topic and Subtopic", + "CX Score rating", "CX Score explanation" and "CX Score reasons" may also be + included. + properties: + "AI Topic and Subtopic": + type: array + readOnly: true + description: >- + Read-only AI Insights classification of the conversation. Present + only with the AI add-on; omitted when the conversation has no + classification. + example: + - topic_name: Billing + subtopic_name: Payment Issues + id: 42 + items: + "$ref": "#/components/schemas/ai_topic_subtopic" + "CX Score reasons": + type: array + readOnly: true + description: >- + Read-only reasons behind the conversation's CX Score. Intercom + generates this attribute, so it cannot be set. Omitted when the + conversation has no CX Score reasons. + example: + - name: Resolution speed + value: Fast + items: + "$ref": "#/components/schemas/cx_score_reason" additionalProperties: anyOf: - type: string @@ -33654,8 +33675,6 @@ components: - type: boolean - $ref: "#/components/schemas/datetime" - "$ref": "#/components/schemas/custom_object_instance_list" - - "$ref": "#/components/schemas/ai_topic_subtopic_list" - - "$ref": "#/components/schemas/cx_score_reason_list" example: paid_subscriber: true monthly_spend: 155.5 @@ -33667,8 +33686,8 @@ components: expressed satisfaction with the outcome. AI Topic and Subtopic: - topic_name: Billing - subtopic_name: Refund request - id: 12345 + subtopic_name: Payment Issues + id: 42 CX Score reasons: - name: Resolution speed value: Fast @@ -33677,7 +33696,7 @@ components: type: object description: The custom attributes which are set on this object, as key-value pairs. For relationship attributes the value should be a list of custom object - instance models. Only attributes a caller may set are accepted here — attributes + instance models. Only attributes a caller may set should be sent here — attributes Intercom generates are returned in responses only. additionalProperties: anyOf: