Skip to content

Commit 15f7dc2

Browse files
jsklanjsklan
committed
update overrides paths id params
1 parent 95e8b5c commit 15f7dc2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+51107
-36
lines changed

‎fern/.definition/__package__.yml‎

Lines changed: 6132 additions & 0 deletions
Large diffs are not rendered by default.

‎fern/.definition/admins.yml‎

Lines changed: 386 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,386 @@
1+
imports:
2+
root: __package__.yml
3+
types:
4+
Admin:
5+
docs: Admins are teammate accounts that have access to a workspace.
6+
properties:
7+
avatar:
8+
docs: Image for the associated team or teammate
9+
type: optional<string>
10+
validation:
11+
format: uri
12+
away_mode_enabled:
13+
docs: Identifies if this admin is currently set in away mode.
14+
type: boolean
15+
away_mode_reassign:
16+
docs: >-
17+
Identifies if this admin is set to automatically reassign new
18+
conversations to the apps default inbox.
19+
type: boolean
20+
away_status_reason_id:
21+
docs: The unique identifier of the away status reason
22+
type: optional<integer>
23+
email:
24+
docs: The email of the admin.
25+
type: string
26+
has_inbox_seat:
27+
docs: >-
28+
Identifies if this admin has a paid inbox seat to restrict/allow
29+
features that require them.
30+
type: boolean
31+
id:
32+
docs: The id representing the admin.
33+
type: string
34+
job_title:
35+
docs: The job title of the admin.
36+
type: optional<string>
37+
name:
38+
docs: The name of the admin.
39+
type: string
40+
team_ids:
41+
docs: This object represents the avatar associated with the admin.
42+
type: list<integer>
43+
team_priority_level:
44+
type: optional<root.TeamPriorityLevel>
45+
type:
46+
docs: String representing the object's type. Always has the value `admin`.
47+
type: optional<string>
48+
source:
49+
openapi: ../descriptions/2.14/api.intercom.io.yaml
50+
docs: Everything about your Admins
51+
service:
52+
auth: false
53+
base-path: ''
54+
display-name: Admins
55+
endpoints:
56+
away:
57+
auth: true
58+
examples:
59+
- path-parameters:
60+
admin_id: admin_id
61+
method: PUT
62+
path: /admins/{admin_id}/away
63+
request:
64+
name: ConfigureAwayAdminRequest
65+
path-parameters:
66+
admin_id: string
67+
source:
68+
openapi: ../descriptions/2.14/api.intercom.io.yaml
69+
find:
70+
auth: true
71+
examples:
72+
- path-parameters:
73+
admin_id: admin_id
74+
method: GET
75+
path: /admins/{admin_id}
76+
request:
77+
name: FindAdminRequest
78+
path-parameters:
79+
admin_id: string
80+
source:
81+
openapi: ../descriptions/2.14/api.intercom.io.yaml
82+
identify:
83+
auth: true
84+
display-name: Identify an admin
85+
docs: >
86+
87+
You can view the currently authorised admin along with the embedded app
88+
object (a "workspace" in legacy terminology).
89+
90+
91+
> 🚧 Single Sign On
92+
93+
>
94+
95+
> If you are building a custom "Log in with Intercom" flow for your
96+
site, and you call the `/me` endpoint to identify the logged-in user,
97+
you should not accept any sign-ins from users with unverified email
98+
addresses as it poses a potential impersonation security risk.
99+
examples:
100+
- name: Successful response
101+
response:
102+
body:
103+
app:
104+
created_at: 1734537243
105+
id_code: this_is_an_id1_that_should_be_at_least_40
106+
identity_verification: false
107+
name: MyApp 1
108+
region: US
109+
timezone: America/Los_Angeles
110+
type: app
111+
avatar:
112+
image_url: >-
113+
https://static.intercomassets.com/assets/default-avatars/admins/128.png
114+
type: avatar
115+
away_mode_enabled: false
116+
away_mode_reassign: false
117+
email: [email protected]
118+
email_verified: true
119+
has_inbox_seat: true
120+
id: '991267459'
121+
job_title: Associate
122+
name: Ciaran1 Lee
123+
team_ids:
124+
- 814865
125+
type: admin
126+
method: GET
127+
path: /me
128+
response:
129+
docs: Successful response
130+
status-code: 200
131+
type: optional<root.AdminWithApp>
132+
source:
133+
openapi: ../descriptions/2.14/api.intercom.io.yaml
134+
list:
135+
auth: true
136+
display-name: List all admins
137+
docs: You can fetch a list of admins for a given workspace.
138+
errors:
139+
- root.UnauthorizedError
140+
examples:
141+
- name: Successful response
142+
response:
143+
body:
144+
admins:
145+
- avatar: https://picsum.photos/200/300
146+
away_mode_enabled: false
147+
away_mode_reassign: false
148+
away_status_reason_id: 12345
149+
email: [email protected]
150+
has_inbox_seat: true
151+
id: '991267466'
152+
job_title: Associate
153+
name: Ciaran7 Lee
154+
team_ids:
155+
- 814865
156+
type: admin
157+
type: admin.list
158+
method: GET
159+
path: /admins
160+
response:
161+
docs: Successful response
162+
status-code: 200
163+
type: root.AdminList
164+
source:
165+
openapi: ../descriptions/2.14/api.intercom.io.yaml
166+
listAllActivityLogs:
167+
auth: true
168+
display-name: List all activity logs
169+
docs: You can get a log of activities by all admins in an app.
170+
errors:
171+
- root.UnauthorizedError
172+
examples:
173+
- name: Successful response
174+
query-parameters:
175+
created_at_after: '1677253093'
176+
created_at_before: '1677861493'
177+
response:
178+
body:
179+
activity_logs:
180+
- activity_description: Ciaran5 Lee changed your app name from before to after.
181+
activity_type: app_name_change
182+
created_at: 1734537253
183+
id: fca05814-4b72-4dce-ad4f-77a786a2c136
184+
performed_by:
185+
email: [email protected]
186+
id: '991267464'
187+
ip: 127.0.0.1
188+
type: admin
189+
- activity_description: >-
190+
Ciaran5 Lee changed your Initial message title message from
191+
Initial message title to Eventual message title.
192+
activity_type: message_state_change
193+
created_at: 1734537253
194+
id: f48c653b-0185-48ac-a276-23d11006bafb
195+
performed_by:
196+
email: [email protected]
197+
id: '991267464'
198+
ip: 127.0.0.1
199+
type: admin
200+
pages:
201+
page: 1
202+
per_page: 20
203+
total_pages: 1
204+
type: pages
205+
type: activity_log.list
206+
method: GET
207+
path: /admins/activity_logs
208+
request:
209+
name: ListAllActivityLogsRequest
210+
query-parameters:
211+
created_at_after:
212+
docs: >-
213+
The start date that you request data for. It must be formatted as
214+
a UNIX timestamp.
215+
type: string
216+
created_at_before:
217+
docs: >-
218+
The end date that you request data for. It must be formatted as a
219+
UNIX timestamp.
220+
type: optional<string>
221+
response:
222+
docs: Successful response
223+
status-code: 200
224+
type: root.ActivityLogList
225+
source:
226+
openapi: ../descriptions/2.14/api.intercom.io.yaml
227+
retrieveAdmin:
228+
auth: true
229+
display-name: Retrieve an admin
230+
docs: You can retrieve the details of a single admin.
231+
errors:
232+
- root.UnauthorizedError
233+
- root.NotFoundError
234+
examples:
235+
- name: Admin found
236+
path-parameters:
237+
id: 1
238+
response:
239+
body:
240+
avatar: https://picsum.photos/200/300
241+
away_mode_enabled: false
242+
away_mode_reassign: false
243+
email: [email protected]
244+
has_inbox_seat: true
245+
id: '991267468'
246+
job_title: Associate
247+
name: Ciaran9 Lee
248+
team_ids:
249+
- 814865
250+
team_priority_level:
251+
primary_team_ids:
252+
- 814865
253+
secondary_team_ids:
254+
- 493881
255+
type: admin
256+
method: GET
257+
path: /admins/{id}
258+
request:
259+
name: RetrieveAdminRequest
260+
path-parameters:
261+
id:
262+
docs: The unique identifier of a given admin
263+
type: integer
264+
response:
265+
docs: Admin found
266+
status-code: 200
267+
type: optional<Admin>
268+
source:
269+
openapi: ../descriptions/2.14/api.intercom.io.yaml
270+
setAwayAdmin:
271+
auth: true
272+
display-name: Set an admin to away
273+
docs: You can set an Admin as away for the Inbox.
274+
errors:
275+
- root.BadRequestError
276+
- root.UnauthorizedError
277+
- root.NotFoundError
278+
examples:
279+
- name: Successful response
280+
path-parameters:
281+
id: 1
282+
request:
283+
away_mode_enabled: true
284+
away_mode_reassign: true
285+
away_status_reason_id: 12345
286+
response:
287+
body:
288+
avatar: https://picsum.photos/200/300
289+
away_mode_enabled: true
290+
away_mode_reassign: true
291+
away_status_reason_id: 12345
292+
email: [email protected]
293+
has_inbox_seat: true
294+
id: '991267460'
295+
job_title: Associate
296+
name: Ciaran2 Lee
297+
team_ids:
298+
- 814865
299+
team_priority_level:
300+
primary_team_ids:
301+
- 814865
302+
secondary_team_ids:
303+
- 493881
304+
type: admin
305+
- name: Admin not found
306+
path-parameters:
307+
id: 1
308+
request:
309+
away_mode_enabled: true
310+
away_mode_reassign: true
311+
response:
312+
body:
313+
avatar: https://picsum.photos/200/300
314+
away_mode_enabled: true
315+
away_mode_reassign: true
316+
away_status_reason_id: 12345
317+
email: [email protected]
318+
has_inbox_seat: true
319+
id: '991267460'
320+
job_title: Associate
321+
name: Ciaran2 Lee
322+
team_ids:
323+
- 814865
324+
team_priority_level:
325+
primary_team_ids:
326+
- 814865
327+
secondary_team_ids:
328+
- 493881
329+
type: admin
330+
- name: Unauthorized
331+
path-parameters:
332+
id: 1
333+
request:
334+
away_mode_enabled: true
335+
away_mode_reassign: true
336+
response:
337+
body:
338+
avatar: https://picsum.photos/200/300
339+
away_mode_enabled: true
340+
away_mode_reassign: true
341+
away_status_reason_id: 12345
342+
email: [email protected]
343+
has_inbox_seat: true
344+
id: '991267460'
345+
job_title: Associate
346+
name: Ciaran2 Lee
347+
team_ids:
348+
- 814865
349+
team_priority_level:
350+
primary_team_ids:
351+
- 814865
352+
secondary_team_ids:
353+
- 493881
354+
type: admin
355+
method: PUT
356+
path: /admins/{id}/away
357+
request:
358+
body:
359+
properties:
360+
away_mode_enabled:
361+
default: true
362+
docs: Set to "true" to change the status of the admin to away.
363+
type: boolean
364+
away_mode_reassign:
365+
default: false
366+
docs: >-
367+
Set to "true" to assign any new conversation replies to your
368+
default inbox.
369+
type: boolean
370+
away_status_reason_id:
371+
docs: The unique identifier of the away status reason
372+
type: optional<integer>
373+
content-type: application/json
374+
name: SetAwayAdminRequest
375+
path-parameters:
376+
id:
377+
docs: The unique identifier of a given admin
378+
type: integer
379+
response:
380+
docs: Successful response
381+
status-code: 200
382+
type: optional<Admin>
383+
source:
384+
openapi: ../descriptions/2.14/api.intercom.io.yaml
385+
source:
386+
openapi: ../descriptions/2.14/api.intercom.io.yaml

0 commit comments

Comments
 (0)