Skip to content

Commit 5aa0b4b

Browse files
authored
Updating specs with fern feedback and new version 2.12 (#194)
* remove unused linter * fix search request in other versions * remove custom objects from all except unstable * remove formatted phone from all except unstable * fix admonitions (affects docs)
1 parent 8ca4732 commit 5aa0b4b

File tree

8 files changed

+18997
-485
lines changed

8 files changed

+18997
-485
lines changed

.github/workflows/linter.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

descriptions/0/api.intercom.io.yaml

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1918,7 +1918,7 @@ paths:
19181918

19191919
Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.
19201920

1921-
{% admonition type="attention" name="Using `company_id`" %}
1921+
{% admonition type="warning" name="Using `company_id`" %}
19221922
You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.
19231923
{% /admonition %}
19241924
responses:
@@ -2221,7 +2221,7 @@ paths:
22212221
description: |
22222222
You can update a single company using the Intercom provisioned `id`.
22232223

2224-
{% admonition type="attention" name="Using `company_id`" %}
2224+
{% admonition type="warning" name="Using `company_id`" %}
22252225
When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.
22262226
{% /admonition %}
22272227
responses:
@@ -4299,7 +4299,7 @@ paths:
42994299

43004300
### Accepted Operators
43014301

4302-
{% admonition type="attention" name="Searching based on `created_at`" %}
4302+
{% admonition type="warning" name="Searching based on `created_at`" %}
43034303
You cannot use the `<=` or `>=` operators to search by `created_at`.
43044304
{% /admonition %}
43054305

@@ -6722,7 +6722,7 @@ paths:
67226722
operationId: autoAssignConversation
67236723
description: |
67246724
You can let a conversation be automatically assigned following assignment rules.
6725-
{% admonition type="attention" name="When using workflows" %}
6725+
{% admonition type="warning" name="When using workflows" %}
67266726
It is not possible to use this endpoint with Workflows.
67276727
{% /admonition %}
67286728
responses:
@@ -6873,7 +6873,7 @@ paths:
68736873
description: |+
68746874
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
68756875

6876-
{% admonition type="attention" name="Contacts without an email" %}
6876+
{% admonition type="warning" name="Contacts without an email" %}
68776877
If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.
68786878
{% /admonition %}
68796879

@@ -6978,7 +6978,7 @@ paths:
69786978
description: |+
69796979
You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.
69806980

6981-
{% admonition type="attention" name="Contacts without an email" %}
6981+
{% admonition type="warning" name="Contacts without an email" %}
69826982
If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.
69836983
{% /admonition %}
69846984

@@ -17324,6 +17324,11 @@ components:
1732417324
- created_at
1732517325
- body
1732617326
- message_type
17327+
multiple_or_single_filter_search_request:
17328+
title: Multiple or Single Filter Search Request
17329+
oneOf:
17330+
- "$ref": "#/components/schemas/multiple_filter_search_request"
17331+
- "$ref": "#/components/schemas/single_filter_search_request"
1732717332
multiple_filter_search_request:
1732817333
title: Multiple Filter Search Request
1732917334
description: Search using Intercoms Search APIs with more than one filter.
@@ -17337,17 +17342,9 @@ components:
1733717342
description: An operator to allow boolean inspection between multiple fields.
1733817343
example: AND
1733917344
value:
17340-
oneOf:
17341-
- type: array
17342-
description: Add mutiple filters.
17343-
title: multiple filter search request
17344-
items:
17345-
"$ref": "#/components/schemas/multiple_filter_search_request"
17346-
- type: array
17347-
description: Add a single filter field.
17348-
title: single filter search request
17349-
items:
17350-
"$ref": "#/components/schemas/single_filter_search_request"
17345+
type: array
17346+
items:
17347+
"$ref": "#/components/schemas/multiple_or_single_filter_search_request"
1735117348
news_item:
1735217349
title: News Item
1735317350
type: object
@@ -17903,9 +17900,18 @@ components:
1790317900
search for the value.
1790417901
example: ">"
1790517902
value:
17906-
type: string
17903+
oneOf:
17904+
- type: string
17905+
- type: integer
17906+
- type: array
17907+
items:
17908+
type: string
17909+
- type: array
17910+
items:
17911+
type: integer
1790717912
description: The value that you want to search on.
1790817913
example: '73732934'
17914+
nullable: true
1790917915
sla_applied:
1791017916
title: Applied SLA
1791117917
type: object

0 commit comments

Comments
 (0)