Skip to content

Commit 8111298

Browse files
jsklanjsklan
committed
fixes
1 parent 3bb8a0d commit 8111298

File tree

1 file changed

+236
-3
lines changed

1 file changed

+236
-3
lines changed

‎fern/openapi-overrides.yml‎

Lines changed: 236 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,8 @@ paths:
299299
- contacts
300300
x-fern-sdk-method-name: delete
301301
x-fern-request-name: DeleteContactRequest
302-
/contacts/{id}/companies:
302+
/contacts/{id}/companies: null
303+
/contacts/{contact_id}/companies:
303304
get:
304305
x-fern-pagination:
305306
offset: $request.page
@@ -314,7 +315,7 @@ paths:
314315
required: true
315316
schema:
316317
$ref: '#/components/schemas/intercom_version'
317-
- name: id
318+
- name: contact_id
318319
in: path
319320
required: true
320321
description: The unique identifier for the contact which is given by Intercom
@@ -334,18 +335,199 @@ paths:
334335
example: 15
335336
schema:
336337
type: integer
338+
summary: List attached companies for contact
339+
tags:
340+
- Contacts
341+
- Companies
342+
operationId: listCompaniesForAContact
343+
description: You can fetch a list of companies that are associated to a contact.
344+
responses:
345+
'200':
346+
description: successful
347+
content:
348+
application/json:
349+
examples:
350+
successful:
351+
value:
352+
type: list
353+
data:
354+
- type: company
355+
company_id: '1'
356+
id: 6762f0a61bb69f9f2193bb55
357+
app_id: this_is_an_id213_that_should_be_at_least_
358+
name: company12
359+
remote_created_at: 1734537382
360+
created_at: 1734537382
361+
updated_at: 1734537382
362+
last_request_at: 1734364582
363+
monthly_spend: 0
364+
session_count: 0
365+
user_count: 1
366+
tags:
367+
type: tag.list
368+
tags: []
369+
segments:
370+
type: segment.list
371+
segments: []
372+
plan: {}
373+
custom_attributes: {}
374+
pages:
375+
type: pages
376+
next:
377+
page: 1
378+
per_page: 50
379+
total_pages: 1
380+
total_count: 1
381+
schema:
382+
"$ref": "#/components/schemas/contact_attached_companies"
383+
'404':
384+
description: Contact not found
385+
content:
386+
application/json:
387+
examples:
388+
Contact not found:
389+
value:
390+
type: error.list
391+
request_id: 32c856ba-901b-49c4-8e8d-d43fc3ee6ea5
392+
errors:
393+
- code: not_found
394+
message: User Not Found
395+
schema:
396+
"$ref": "#/components/schemas/error"
397+
'401':
398+
description: Unauthorized
399+
content:
400+
application/json:
401+
examples:
402+
Unauthorized:
403+
value:
404+
type: error.list
405+
request_id: 565a4f38-5fa9-451d-bcf0-32076f79517f
406+
errors:
407+
- code: unauthorized
408+
message: Access Token Invalid
409+
schema:
410+
"$ref": "#/components/schemas/error"
337411
post:
338412
x-fern-sdk-group-name:
339413
- companies
340414
x-fern-sdk-method-name: attachContact
341415
x-fern-request-name: AttachContactToCompanyRequest
416+
417+
summary: Attach a Contact to a Company
418+
parameters:
419+
- name: Intercom-Version
420+
in: header
421+
schema:
422+
"$ref": "#/components/schemas/intercom_version"
423+
- name: contact_id
424+
in: path
425+
required: true
426+
description: The unique identifier for the contact which is given by Intercom
427+
schema:
428+
type: string
429+
tags:
430+
- Companies
431+
- Contacts
432+
operationId: attachContactToACompany
433+
description: You can attach a company to a single contact.
434+
responses:
435+
'200':
436+
description: Successful
437+
content:
438+
application/json:
439+
examples:
440+
Successful:
441+
value:
442+
type: company
443+
company_id: '1'
444+
id: 6762f09a1bb69f9f2193bb34
445+
app_id: this_is_an_id197_that_should_be_at_least_
446+
name: company6
447+
remote_created_at: 1734537370
448+
created_at: 1734537370
449+
updated_at: 1734537370
450+
monthly_spend: 0
451+
session_count: 0
452+
user_count: 1
453+
tags:
454+
type: tag.list
455+
tags: []
456+
segments:
457+
type: segment.list
458+
segments: []
459+
plan: {}
460+
custom_attributes: {}
461+
schema:
462+
"$ref": "#/components/schemas/company"
463+
'400':
464+
description: Bad Request
465+
content:
466+
application/json:
467+
examples:
468+
Bad Request:
469+
value:
470+
type: error.list
471+
request_id: 8879ee29-ade4-4b5a-a275-ab1ac531b82a
472+
errors:
473+
- code: parameter_not_found
474+
message: company not specified
475+
schema:
476+
"$ref": "#/components/schemas/error"
477+
'404':
478+
description: Company Not Found
479+
content:
480+
application/json:
481+
examples:
482+
Company Not Found:
483+
value:
484+
type: error.list
485+
request_id: 981799ea-f19b-432d-828c-491a3b29ad29
486+
errors:
487+
- code: company_not_found
488+
message: Company Not Found
489+
schema:
490+
"$ref": "#/components/schemas/error"
491+
'401':
492+
description: Unauthorized
493+
content:
494+
application/json:
495+
examples:
496+
Unauthorized:
497+
value:
498+
type: error.list
499+
request_id: 1f187e85-cd9a-4be4-964e-cdbb8c66334a
500+
errors:
501+
- code: unauthorized
502+
message: Access Token Invalid
503+
schema:
504+
"$ref": "#/components/schemas/error"
342505
requestBody:
343506
content:
344507
application/json:
345508
schema:
509+
type: object
510+
required:
511+
- id
346512
properties:
347513
id:
514+
type: string
515+
description: The unique identifier for the company which is given
516+
by Intercom
517+
example: 58a430d35458202d41b1e65b
348518
x-fern-property-name: company_id
519+
examples:
520+
successful:
521+
summary: Successful
522+
value:
523+
id: 6762f09a1bb69f9f2193bb34
524+
bad_request:
525+
summary: Bad Request
526+
value:
527+
company_not_found:
528+
summary: Company Not Found
529+
value:
530+
id: '123'
349531
/contacts/{contact_id}/companies/{id}:
350532
delete:
351533
x-fern-sdk-group-name:
@@ -710,13 +892,62 @@ paths:
710892
x-fern-sdk-group-name:
711893
- dataExport
712894
x-fern-sdk-method-name: cancel
713-
x-fern-request-name: CancelDataExportRequest
895+
/export/reporting_data/{job_identifier}:
896+
get:
897+
x-fern-sdk-group-name:
898+
- dataExport
899+
x-fern-sdk-method-name: exportReportingData
900+
x-fern-request-name: ExportReportingDataRequest
901+
parameters:
902+
- name: Intercom-Version
903+
in: header
904+
schema:
905+
"$ref": "#/components/schemas/intercom_version"
906+
- name: app_id
907+
in: query
908+
description: The Intercom defined code of the workspace the company is associated
909+
to.
910+
required: true
911+
schema:
912+
type: string
913+
- name: client_id
914+
in: query
915+
required: true
916+
schema:
917+
type: string
918+
- name: job_identifier
919+
description: Unique identifier of the job.
920+
in: path
921+
required: true
922+
schema:
923+
type: string
714924
/download/content/data/{job_identifier}:
715925
get:
716926
x-fern-sdk-group-name:
717927
- dataExport
718928
x-fern-sdk-method-name: download
719929
x-fern-request-name: DownloadDataExportRequest
930+
/download/reporting_data/{job_identifier}:
931+
get:
932+
x-fern-sdk-group-name:
933+
- dataExport
934+
x-fern-sdk-method-name: downloadReportingDataExport
935+
x-fern-request-name: DownloadReportingDataExportRequest
936+
parameters:
937+
- name: Intercom-Version
938+
in: header
939+
schema:
940+
"$ref": "#/components/schemas/intercom_version"
941+
- name: app_id
942+
in: query
943+
required: true
944+
schema:
945+
type: string
946+
- name: job_identifier
947+
in: path
948+
required: true
949+
schema:
950+
type: string
720951
/messages:
721952
post:
722953
requestBody:
@@ -1512,6 +1743,7 @@ components:
15121743
x-fern-type-name: UpdateDataAttributeRequestBody
15131744
update_ticket_type_request:
15141745
x-fern-type-name: UpdateTicketTypeRequestBody
1746+
nullable: false
15151747
update_visitor_request:
15161748
properties: null
15171749
anyOf:
@@ -1637,6 +1869,7 @@ components:
16371869
- files
16381870
update_article_request:
16391871
x-fern-type-name: UpdateArticleRequestBody
1872+
nullable: false
16401873
properties:
16411874
parent_type:
16421875
enum:

0 commit comments

Comments
 (0)